宜搭+
    正在准备搜索索引...

    接口 YidaComponent

    宜搭组件的标准操作接口。

    该接口封装了宜搭表单/自定义页面中组件的通用行为， 包括读写值、重置、行为控制以及校验规则配置。 所有 YidaPageContext.$ 返回的组件对象均应遵循此接口。

    26.7.1

    YidaPageContext

    interface YidaComponent {
        disableValid(): void;
        enableValid(validateAtOnce?: boolean): void;
        get<T>(key: string): T;
        getBehavior(): string;
        getValue<T>(): T;
        reset(): void;
        resetBehavior(): void;
        resetValidation(validateAtOnce?: boolean): void;
        set(key: string, value: unknown): void;
        setBehavior(behavior: string): void;
        setValidation(
            rules: {
                message: string;
                param: (value: unknown, rule: unknown) => boolean;
                type: "customValidate";
            }[],
            validateAtOnce?: boolean,
        ): void;
        setValue(value: unknown): void;
        validate(
            callback?: (
                errors?: string[],
                values?: Record<string, unknown>,
            ) => void,
        ): void;
    }
    索引

    方法

    disableValid enableValid get getBehavior getValue reset resetBehavior resetValidation set setBehavior setValidation setValue validate

    方法

    • 启用组件校验。

      参数

      • 可选validateAtOnce: boolean

        是否在启用后立即触发一次校验。默认为 false。

      返回 void

    • 获取组件的某个内部属性值。

      类型参数

      • T

        返回值类型。

      参数

      • key: string

        属性键名。

      返回 T

      属性对应的值。

    • 获取组件当前的业务值。

      类型参数

      • T

        业务值类型。

      返回 T

      组件当前值。

    • 重置组件校验规则。

      参数

      • 可选validateAtOnce: boolean

        是否在重置后立即触发一次校验。默认为 false。

      返回 void

    • 设置组件的某个内部属性值。

      参数

      • key: string

        属性键名。

      • value: unknown

        要设置的属性值。

      返回 void

    • 设置组件的行为类型。

      参数

      • behavior: string

        行为类型字符串。

      返回 void

    • 设置自定义校验规则。

      参数

      • rules: {
            message: string;
            param: (value: unknown, rule: unknown) => boolean;
            type: "customValidate";
        }[]

        自定义校验规则数组。每条规则包含类型、校验函数与错误提示信息。

        • message: string

          校验失败时向用户展示的提示文本。

        • param: (value: unknown, rule: unknown) => boolean

          校验函数。

        • type: "customValidate"

          规则类型，当前仅支持 "customValidate"。

      • 可选validateAtOnce: boolean

        是否在设置后立即触发一次校验。默认为 false。

      返回 void

    • 设置组件当前的业务值。

      参数

      • value: unknown

        要设置的业务值。

      返回 void

    • 触发组件校验。

      校验完成后，回调函数会收到错误信息数组与当前值记录。 若校验通过，errors 通常为 undefined 或空数组。

      参数

      • 可选callback: (errors?: string[], values?: Record<string, unknown>) => void

        校验完成后的回调函数。 参数 errors 为错误信息列表，values 为当前值快照。

      返回 void

    显示设置

    成员可见性

    目录

    方法