import{ax as i,z as a,A as n,b5 as h}from"./chunks/framework.V2ssSR2R.js";const E=JSON.parse('{"title":"DisplayConds 显示条件配置","description":"","frontmatter":{},"headers":[],"relativePath":"form-config/editor-fields/display-conds.md","filePath":"form-config/editor-fields/display-conds.md"}'),k={name:"form-config/editor-fields/display-conds.md"};function t(l,s,p,e,d,r){return n(),a("div",null,[...s[0]||(s[0]=[h(`

DisplayConds 显示条件配置 ​

用于配置组件显示条件的表单组件。

注意

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

基础用法 ​

js
{
  type: 'display-conds',
  name: 'displayConds',
  text: '显示条件'
}

带标题前缀 ​

js
{
  type: 'display-conds',
  name: 'displayConds',
  text: '显示条件',
  titlePrefix: '条件'
}

Attributes ​

参数说明类型可选值默认值
name绑定值string——
text表单标签string——
disabled是否禁用boolean / FilterFunction—false
titlePrefix标题前缀string——
parentFields父级字段string[] / FilterFunction——
onChange值变化时触发的函数OnChangeHandler—-
查看 FilterFunction / OnChangeHandler 及关联类型定义
ts
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;
ts
export type OnChangeHandler = (mForm: FormState | undefined, value: any, data: OnChangeHandlerData) => any;
ts
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;
}
ts
export interface ChangeRecord {
  propPath?: string;
  value: any;
}
ts
export type FormValue = Record<string | number, any>;

配置类型 ​

查看 DisplayCondsConfig 配置类型定义
ts
export interface DisplayCondsConfig extends FormItem {
  type: 'display-conds';
  titlePrefix?: string;
  parentFields?: string[] | FilterFunction<string[]>;
}
ts
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';
}
`,12)])])}const F=i(k,[["render",t]]);export{E as __pageData,F as default};