@ohayojp/form/src/schema/ui.d.ts

import { ACLCanType } from '@ohayojp/acl';
import { ErrorSchema } from '../errors';
export declare type SFPlacement = 'top' | 'left' | 'right' | 'bottom' | 'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight' | 'leftTop' | 'leftBottom' | 'rightTop' | 'rightBottom';
export declare type SFTrigger = 'click' | 'focus' | 'hover';
export declare type SFLSSize = 'large' | 'small';
export declare type SFDLSSize = 'default' | 'large' | 'small';
export interface SFGridSizeSchema {
    span?: number | null;
    order?: number | null;
    offset?: number | null;
    push?: number | null;
    pull?: number | null;
}
export interface SFGridSchema {
    /**
     * 栅格间隔
     */
    gutter?: number | null;
    /**
     * 栅格占位格数，为 `0` 时相当于 `display: none`
     */
    span?: number | null;
    /**
     * 数据栅格占位格数，为 `0` 时相当于 `display: none`
     */
    arraySpan?: number | null;
    /**
     * 栅格左侧的间隔格数，间隔内不可以有栅格
     */
    offset?: number | null;
    xs?: number | SFGridSizeSchema;
    sm?: number | SFGridSizeSchema;
    md?: number | SFGridSizeSchema;
    lg?: number | SFGridSizeSchema;
    xl?: number | SFGridSizeSchema;
    xxl?: number | SFGridSizeSchema;
}
export interface SFRenderSchema {
    /**
     * 指定采用什么小部件渲染，所有小部件名可[查阅文档](https://ohayojp.com/)
     */
    widget?: string;
    /**
     * 自定义类，等同 `[ngClass]` 值
     */
    class?: string | string[];
    /**
     * 元素组件大小
     */
    size?: SFDLSSize;
    /**
     * 指定宽度，单位：`px`
     */
    width?: number;
    /**
     * 响应式属性
     */
    grid?: SFGridSchema;
    /**
     * 标签可选信息
     */
    optional?: string;
    /**
     * 标签可选帮助，使用 `nz-tooltip` 展示
     */
    optionalHelp?: string | SFOptionalHelp;
}
export interface SFOptionalHelp {
    text?: string;
    i18n?: string;
    /** 文字提示背景颜色 */
    bgColor?: string;
    /** 图标，默认：`question-circle` */
    icon?: string;
    placement?: SFPlacement;
    trigger?: SFTrigger;
    mouseEnterDelay?: number;
    mouseLeaveDelay?: number;
    overlayClassName?: string;
    overlayStyle?: {
        [key: string]: string;
    };
}
export interface SFHorizontalLayoutSchema {
    /**
     * `label` 栅格占位格数，默认：`5`
     * - `0` 时相当于 `display: none`
     * - 限 `horizontal` 水平布局有效
     */
    spanLabel?: number | null;
    /**
     * `control` 栅格占位格数，默认：`19`
     * - `0` 时相当于 `display: none`
     * - 限 `horizontal` 水平布局有效
     */
    spanControl?: number | null;
    /**
     * `control` 栅格左侧的间隔格数，间隔内不可以有栅格
     * - 限 `horizontal` 水平布局有效
     */
    offsetControl?: number | null;
    /**
     * `label` 固定宽度
     * - 限 `horizontal` 水平布局有效
     */
    spanLabelFixed?: number | null;
}
export interface SFSchemaI18n {
    /**
     * 指 `schema.title` 的国际化键值
     */
    i18n?: string;
    /**
     * 对应 `schema.description` 国际化
     */
    descriptionI18n?: string;
}
/** 指定如何渲染 `Schema` */
export interface SFUISchemaItem extends SFRenderSchema, SFHorizontalLayoutSchema, ErrorSchema, SFSchemaI18n {
    [key: string]: any;
    /** 是否开启调试模式，在数据变更、校验会打印出相信信息，不建议在生产环境中使用 */
    debug?: boolean;
    /**
     * 属性顺序
     *
     * 当你只想某几个属性靠前时，则允许使用通配符 `*` 来表示剩余部分，且只允许出现一次
     *
     * @example
     *
     * [ 'a', 'b', 'c', 'd' ] + [ 'c', 'b', '*' ] = [ 'c', 'b', 'a', 'd']
     */
    order?: string[];
    /**
     * 是否隐藏
     */
    hidden?: boolean;
    /**
     * 指定条件时才显示，但需要**注意**：
     * - 键值表示监听对象属性名
     * - JSON Schema 校验是各属性独立运行，监听对象属性每一次值变化都会重新做一次整个JSON结构计算
     *
     * 有效格式包括：
     * - `visibleIf: { shown: [ true ] }`：当 `shown: true` 时才显示当前属性
     * - `visibleIf: { shown: [ '$ANY$' ] }`：当 `shown` 包括任意值时
     * - `visibleIf: { shown: (value: any) => value > 0 }`：复杂表达式
     */
    visibleIf?: {
        [key: string]: any[] | ((value: any) => boolean);
    };
    /**
     * ACL 配置
     */
    acl?: ACLCanType;
}
/**
 * UI Schema，KEY名**务必**是 `$` 开头（例如：`$name`、`$id`），以便能区分KEY值还是UI选项
 * - 结构层级应同 `SFSchema` 一致
 * - 当KEY为 `*` 时表示对所有子表单元素都有效
 */
export interface SFUISchema {
    [key: string]: SFUISchemaItem | SFUISchemaItemRun;
}
/**
 * 内部运行时使用
 */
export interface SFUISchemaItemRun extends SFUISchemaItem {
}