@yelon/util/config/sf/sf.type.d.ts

import type { Options as AjvOptions } from 'ajv';
export interface YunzaiSFConfigFormatMap {
    'date-time': {
        widget?: string;
        showTime?: boolean;
        format?: string;
    };
    date: {
        widget?: string;
        format?: string;
    };
    'full-date': {
        widget?: string;
        format?: string;
    };
    time: {
        widget?: string;
        format?: string;
    };
    'full-time': {
        widget?: string;
        format?: string;
    };
    week: {
        widget?: string;
        mode?: string;
        format?: string;
    };
    month: {
        widget?: string;
        mode?: string;
        format?: string;
    };
    uri: {
        widget?: string;
    };
    email: {
        widget?: string;
        type?: string;
    };
    color: {
        widget?: string;
        type?: string;
    };
    '': {
        widget?: string;
    };
}
export interface YunzaiSFConfig {
    formatMap?: YunzaiSFConfigFormatMap;
    /**
     * 是否忽略某些数据类型校验 `ERRORSDEFAULT`，默认：`[ 'type', 'enum' ]`
     *
     * - `type` 限定 Schema 中 `type` 类型
     * - `enum` 限定应当是预设定的枚举值之一
     */
    ignoreKeywords?: string[];
    /**
     * [ajv](https://ajv.js.org/options.html) 参数
     */
    ajv?: AjvOptions;
    /**
     * 是否实时校验，默认：`true`
     * - `true` 每一次都校验
     * - `false` 提交时校验
     */
    liveValidate?: boolean;
    /**
     * 指定表单 `autocomplete` 值，默认：`on`
     */
    autocomplete?: 'on' | 'off' | null;
    /**
     * 是否立即呈现错误视觉，默认：`false`
     */
    firstVisual?: boolean;
    /**
     * 是否只展示错误视觉不显示错误文本，默认：`false`
     */
    onlyVisual?: boolean;
    /**
     * 自定义通用错误信息，默认：`{}`
     */
    errors?: Record<string, string>;
    /**
     * 默认全局布局，类型为：`SFUISchemaItem`，使用时加上可智能提示，例如：
     *
     * ```ts
     * ui: {} as SFUISchemaItem
     * ```
     */
    ui?: any;
    /**
     * 元素组件大小，用于 `nzSize` 值
     */
    size?: 'default' | 'large' | 'small';
    /**
     * 按钮风格，类型为：`SFButton`，使用时加上可智能提示，例如：
     *
     * ```ts
     * button: {} as SFButton
     * ```
     */
    button?: any;
    /**
     * date小部件：`type="string"` 且不指定 `schema.format` 和 `ui.format` 时日期格式，默认：`yyyy-MM-dd HH:mm:ss`
     */
    uiDateStringFormat?: string;
    /**
     * date小部件：`type="number"` 且不指定 `schema.format` 和 `ui.format` 时日期格式，默认：`T` 13位 Unix Timestamp
     */
    uiDateNumberFormat?: string;
    /**
     * time小部件：`type="string"` 且不指定 `schema.format` 和 `ui.format` 时日期格式，默认：`HH:mm:ss`
     */
    uiTimeStringFormat?: string;
    /**
     * time小部件：`type="number"` 且不指定 `schema.format` 和 `ui.format` 时日期格式，默认：`T` 13位 Unix Timestamp，日期统一使用 `1970-01-01`
     */
    uiTimeNumberFormat?: string;
    /**
     * 指定 `format: 'email'` 的默认Email后缀，默认：`['qq.com', '163.com', 'gmail.com', '126.com', 'aliyun.com']`
     */
    uiEmailSuffixes?: string[];
    /**
     * Whether to delay rendering, should be manually call `refreshSchema()`
     *
     * 是否延迟渲染，需要手动调用 `refreshSchema()`
     */
    delay?: boolean;
}