Code 代码编辑器

代码编辑器字段，用于编辑代码内容。

注意

此组件仅在编辑器环境中可用，需要配合 @tmagic/editor 使用。

基础用法

{
  type: 'vs-code',
  name: 'code',
  text: '代码'
}

指定语言

{
  type: 'vs-code',
  name: 'code',
  text: '代码',
  language: 'javascript'
}

自动调整大小

{
  type: 'vs-code',
  name: 'code',
  text: '代码',
  autosize: {
    minRows: 3,
    maxRows: 10
  }
}

Attributes

参数	说明	类型	可选值	默认值
name	绑定值	string	—	—
text	表单标签	string	—	—
disabled	是否禁用	boolean / FilterFunction	—	false
language	代码语言	string	javascript/typescript/json等	—
height	编辑器高度	string	—	—
parse	是否解析代码	boolean	—	false
options	编辑器配置项	object	—	—
autosize	自动调整大小配置	object	—	—
mFormItemType	传入代码编辑器的自定义类型	string	—	—
onChange	值变化时触发的函数	OnChangeHandler	—	-

查看 FilterFunction / OnChangeHandler 及关联类型定义

export type FilterFunction<T = boolean> = (
  mForm: FormState | undefined,
  data: {
    model: FormValue;
    values: FormValue;
    parent?: FormValue;
    formValue: FormValue;
    prop: string;
    config: any;
    index?: number;
    getFormValue: (prop: string) => any;
  },
) => T;

export type OnChangeHandler = (mForm: FormState | undefined, value: any, data: OnChangeHandlerData) => any;

export interface OnChangeHandlerData {
  model: FormValue;
  values?: Readonly<FormValue> | null;
  parent?: FormValue;
  formValue?: FormValue;
  config: Readonly<any>;
  prop: string;
  changeRecords: ChangeRecord[];
  setModel: (prop: string, value: any) => void;
  setFormValue: (prop: string, value: any) => void;
}

export interface ChangeRecord {
  propPath?: string;
  value: any;
}

export type FormValue = Record<string | number, any>;

配置类型

查看 CodeConfig 配置类型定义

export interface CodeConfig extends FormItem {
  type: 'vs-code';
  language?: string;
  options?: {
    [key: string]: any;
  };
  height?: string;
  parse?: boolean;
  autosize?: {
    minRows?: number;
    maxRows?: number;
  };
  mFormItemType?: string;
}

export interface FormItem {
  /** vnode的key值，默认是遍历数组时的index */
  __key?: string | number;
  /** 表单域标签的的宽度，例如 '50px'。支持 auto。 */
  labelWidth?: string | number;
  /** label 标签的title属性 */
  labelTitle?: string;
  className?: string;
  /** 字段名 */
  name?: string | number;
  /** 额外的提示信息，和 help 类似，当提示文案同时出现时，可以使用这个。 */
  extra?: string | FilterFunction<string>;
  /** 配置提示信息 */
  tooltip?: ToolTipConfigType | FilterFunction<ToolTipConfigType>;
  /** 是否置灰 */
  disabled?: boolean | FilterFunction;
  /** 使用表单中的值作为key，例如配置了text，则使用model.text作为key */
  key?: string;
  /** 是否显示 */
  display?: boolean | 'expand' | FilterFunction<boolean | 'expand'>;
  /** 值发生改变时调用的方法 */
  onChange?: OnChangeHandler;
  /** label 标签的文本 */
  text?: string | FilterFunction<string>;
  /** 右侧感叹号 */
  tip?: string;

  filter?: 'number' | OnChangeHandler;
  /** 是否去除首尾空格 */
  trim?: boolean;
  /** 默认值 */
  defaultValue?: any | DefaultValueFunction;
  /** 表单验证规则 */
  rules?: Rule[];
  extensible?: boolean;
  dynamicKey?: string;
  /** 是否需要显示`展开更多配置` */
  expand?: boolean;
  style?: Record<string, any>;
  fieldStyle?: Record<string, any>;
  labelPosition?: 'top' | 'left' | 'right';
}

autosize Attributes

参数	说明	类型	可选值	默认值
minRows	最小行数	number	—	—
maxRows	最大行数	number	—	—