@jay.kou/rak-ssr/lib/BusinessTreeSelectBuilder/types.d.ts

A react based UI components for admin system

import type { TreeSelectProps } from 'antd';
export type ApiType = {
    /**
     * @en                api request for options data
     * @zh-Hans           获取下拉数据的接口
     * @default           '-'
     */
    api: (params: {
        [key: string]: any;
    }) => Promise<any>;
    /**
     * @en                business tree select type
     * @zh-Hans       树形业务下拉的类型
     * @default           '-'
     */
    type: string;
    /**
     * @en                default props (higher priority than Builder-level settings)
     * @description       默认属性, 比 Builder 上的优先级更高
     * @default           '-'
     */
    defaultProps?: Omit<BusinessTreeSelectProps<string>, 'type'>;
};
export type BusinessTreeSelectBuilderProps = {
    /**
     * @en                define the business tree select
     * @description       定义所有的业务下拉;
     * @default           '-'
     */
    apis: ApiType[];
    /**
     * @en                default props
     * @description       默认属性;
     * @default
     */
    defaultProps?: Omit<BusinessTreeSelectProps<string>, 'type'>;
};
export interface BusinessTreeSelectSelfProps<Type> {
    /**
     * @en                business tree select type
     * @description       业务树下拉类型;
     */
    type: Type;
    /**
     * @en                disable option.
     * @description       禁用某节点;
     */
    nodeDisabled?: (node: any) => boolean;
    /**
     * @en                 customize fields as display text (higher priority)
     * @description        label的默认读取字段
     * @default           'name'
     */
    labelKey?: string;
    /**
     * @en                 customize fields as value (higher priority)
     * @description        value的默认读取字段
     * @default           'id'
     */
    valueKey?: string;
    /**
     * @en                pass params to api request. see demo.
     * @description       查询接口的参数. 用法见示例
     */
    queryParams?: Record<string, any>;
    /**
     * @en                disable cache (higher priority)
     * @description       不缓存数据
     * @default           false
     */
    noCache?: boolean;
    /**
     * @en               callback after options data finish request
     * @description      下拉数据加载完成后的回调;
     * @default -
     */
    onLoad?: (options: any) => void;
}
export type BusinessTreeSelectProps<Type> = BusinessTreeSelectSelfProps<Type> & TreeSelectProps;