Skip to content

Latest commit

 

History

History
117 lines (114 loc) · 3.47 KB

File metadata and controls

117 lines (114 loc) · 3.47 KB
description 级联选择器(ElCascader)的定义和使用说明

级联选择器

级联选择器组件用于选择一个或多个选项,通常用于选择分类、地区、组织结构等。

export class ElCascader<T, V, P extends nasl.core.Boolean, M extends nasl.core.Boolean, C> extends ViewComponent {
    constructor(options?: Partial<ElCascaderOptions<T, V, P, M, C>>);
}
export class ElCascaderOptions<
    T,
    V,
    P extends nasl.core.Boolean,
    M extends nasl.core.Boolean,
    C,
> extends ViewComponentOptions {
    /**
     * 可清空
     * 是否允许清空已选择的选项
     */
    clearable: nasl.core.Boolean;
    /**
     * 禁用组件
     * 是否禁用组件
     */
    disabled: nasl.core.Boolean;
    /**
     * 是否可搜索
     * 是否可搜索,默认搜索规则不区分大小写,全文本任意位置匹配。如果默认搜索规则不符合业务需求,可以更为使用 `filter` 自定义过滤规则
     */
    filterable: nasl.core.Boolean;
    /**
     * 数据源
     * 展示数据的输入源,可设置为集合类型变量(List<T>)或输出参数为集合类型的逻辑。
     */
    dataSource:
        | {
              list: nasl.collection.List<T>;
              total: nasl.core.Integer;
          }
        | nasl.collection.List<T>;
    /**
     * 数据类型
     * 数据源返回的数据结构的类型,自动识别类型进行展示说明
     */
    dataSchema: T;
    /**
     * 文本字段
     * 集合的元素类型中,用于显示文本的属性名称
     */
    textField: (item: T) => any;
    /**
     * 值字段
     * 集合的元素类型中,用于标识选中值的属性
     */
    valueField: (item: T) => V;
    /**
     * 选中值
     * 选中值。支持语法糖 `v-model`。
     */
    modelValue: M extends true ? (C extends '' ? nasl.collection.List<V> : nasl.core.String) : V;
    /**
     * 父级值字段
     * 集合的元素类型中,用于标识父节点的属性
     */
    parentField: (item: T) => any;
    /**
     * 是否多选
     * 是否允许多选
     */
    multiple: M;
    /**
     * 占位符
     * 占位符
     */
    placeholder: nasl.core.String;
    /**
     * 组件尺寸
     * 组件尺寸。可选项:small/medium/large。
     */
    size: 'small' | 'default' | 'large';
    /**
     * 选中值变化时
     * 选中值变化时触发。`context.trigger` 表示触发变化的来源;`context.selectedOptions` 表示选中值的完整对象,数组长度一定和 `value` 相同;`context.option` 表示当前操作的选项,不一定存在。
     */
    onChange: (event: {
        value: M extends true ? (C extends '' ? nasl.collection.List<V> : nasl.core.String) : V;
        option: T;
        selectedOptions: T[];
        trigger: 'clear' | 'tag-remove' | 'backspace' | 'check' | 'uncheck' | 'default';
    }) => any;
    /**
     * 清除时触发
     * 点击清除按钮时触发
     */
    onClear: (event: {}) => any;
}
export class ElFormCascader<T, V, P extends nasl.core.Boolean, M extends nasl.core.Boolean, C> extends ViewComponent {
    constructor(
        options?: Partial<
            ElFormCascaderOptions<T, V, P, M, C> &
                ElFormItemProOptions &
                Omit<ElCascaderOptions<T, V, P, M, C>, keyof ElFormItemProOptions>
        >
    );
}
export class ElFormCascaderOptions<
    T,
    V,
    P extends nasl.core.Boolean,
    M extends nasl.core.Boolean,
    C,
> extends ViewComponentOptions {}