@yidun/antd-super-table 0.1.1 → 0.1.3

package/dist/SuperTable.vue.d.ts

@@ -0,0 +1,311 @@
+import 'dayjs/locale/zh-cn';
+import type { PropType } from 'vue';
+import type { TableProps } from 'ant-design-vue';
+import type { SuperTableFormItem, SuperTableColumn, SuperTableRequestFunction, SuperTableDefaultSceneConfig, SuperTableSceneRequestConfig, SuperTableSlots } from './interface';
+type __VLS_Slots = SuperTableSlots;
+declare const __VLS_component: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * 查询场景类型，用于管理场景和缓存表格设置等
+     * @type {string}
+     * @default ''
+     */
+    sceneType: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * 最大场景数量
+     * @type {number}
+     * @default 100
+     */
+    maxSceneCount: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /** 查询防抖时间，ms */
+    debounceWait: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /** 查询条件配置 */
+    formItems: {
+        type: PropType<SuperTableFormItem[]>;
+        default: () => never[];
+    };
+    /** 查询条件列数 */
+    formItemColSpan: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /** 依赖刷新选项 */
+    refreshDeps: {
+        type: ArrayConstructor;
+        default: () => never[];
+    };
+    /** 表格列配置 */
+    columns: {
+        type: PropType<SuperTableColumn[]>;
+        default: () => never[];
+    };
+    /** 数据请求方法 */
+    request: {
+        type: PropType<SuperTableRequestFunction>;
+        required: true;
+    };
+    /** 表格属性，仅开发部分能力，与默认配置进行合并*/
+    tableProps: {
+        type: PropType<TableProps>;
+        default: () => {};
+    };
+    /** 转换表格数据 */
+    formatDataSource: {
+        type: PropType<(data: any[]) => any[]>;
+        default: (data: any[]) => any[];
+    };
+    /** 可排序 */
+    sortable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** 容器样式 */
+    wrapperStyle: {
+        type: ObjectConstructor;
+        default: () => {};
+    };
+    /** 表格容器样式 */
+    tableWrapperStyle: {
+        type: ObjectConstructor;
+        default: () => {};
+    };
+    /** 默认设置的查询条件，适用于url内带查询参数的场景，格式 { [name: string]: value } */
+    customQueryParams: {
+        type: ObjectConstructor;
+        default: () => {};
+    };
+    /** 展示刷新按钮*/
+    showRefreshButton: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** 是否使用场景 */
+    enableScene: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * 是否显示展开/收起按钮
+     * 默认 false，可通过开关控制，不受 enableScene 影响
+     * @type {boolean}
+     */
+    showExpandButton: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * 是否显示重置按钮
+     * 默认 false，当 enableScene 为 false 时，如果未显式设置则自动显示
+     * @type {boolean | undefined}
+     */
+    showResetButton: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    /** 默认场景 */
+    defaultScene: {
+        type: PropType<SuperTableDefaultSceneConfig | SuperTableDefaultSceneConfig[]>;
+        default: undefined;
+    };
+    /** 场景存储位置 */
+    sceneStorageType: {
+        type: PropType<"local" | "api">;
+        default: string;
+    };
+    /** 场景请求函数配置 */
+    sceneRequest: {
+        type: PropType<SuperTableSceneRequestConfig>;
+        default: undefined;
+    };
+    /** 开启表格设置 */
+    enableTableConfig: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, {
+    onRefresh: () => void;
+    isInitialized: import("vue").Ref<boolean, boolean>;
+    getTableData(): import("./interface").SuperTableDataItem[];
+    setTableData(data: import("./interface").SuperTableDataItem[]): void;
+    setTableDataItem(index: number, data: Partial<import("./interface").SuperTableDataItem>): void;
+    getFormItem(name: string): SuperTableFormItem | undefined;
+    setFormItem(name: string, keyPath: string, newConfig: any): void;
+    getFormValues(name?: string | string[]): Record<string, any>;
+    setFormValues(values: Record<string, any>): void;
+    getFormValue(name: string): any;
+    setFormValue(name: string, value: any): void;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
+    "form-item-change": (name: string, value: any, formItem: any, formOperations: any, tableOperations: any) => any;
+    "sort-change": (value: any) => any;
+    "row-sort-end": (value: any) => any;
+    "scene-change": (value: any) => any;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * 查询场景类型，用于管理场景和缓存表格设置等
+     * @type {string}
+     * @default ''
+     */
+    sceneType: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * 最大场景数量
+     * @type {number}
+     * @default 100
+     */
+    maxSceneCount: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /** 查询防抖时间，ms */
+    debounceWait: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /** 查询条件配置 */
+    formItems: {
+        type: PropType<SuperTableFormItem[]>;
+        default: () => never[];
+    };
+    /** 查询条件列数 */
+    formItemColSpan: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /** 依赖刷新选项 */
+    refreshDeps: {
+        type: ArrayConstructor;
+        default: () => never[];
+    };
+    /** 表格列配置 */
+    columns: {
+        type: PropType<SuperTableColumn[]>;
+        default: () => never[];
+    };
+    /** 数据请求方法 */
+    request: {
+        type: PropType<SuperTableRequestFunction>;
+        required: true;
+    };
+    /** 表格属性，仅开发部分能力，与默认配置进行合并*/
+    tableProps: {
+        type: PropType<TableProps>;
+        default: () => {};
+    };
+    /** 转换表格数据 */
+    formatDataSource: {
+        type: PropType<(data: any[]) => any[]>;
+        default: (data: any[]) => any[];
+    };
+    /** 可排序 */
+    sortable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** 容器样式 */
+    wrapperStyle: {
+        type: ObjectConstructor;
+        default: () => {};
+    };
+    /** 表格容器样式 */
+    tableWrapperStyle: {
+        type: ObjectConstructor;
+        default: () => {};
+    };
+    /** 默认设置的查询条件，适用于url内带查询参数的场景，格式 { [name: string]: value } */
+    customQueryParams: {
+        type: ObjectConstructor;
+        default: () => {};
+    };
+    /** 展示刷新按钮*/
+    showRefreshButton: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** 是否使用场景 */
+    enableScene: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * 是否显示展开/收起按钮
+     * 默认 false，可通过开关控制，不受 enableScene 影响
+     * @type {boolean}
+     */
+    showExpandButton: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * 是否显示重置按钮
+     * 默认 false，当 enableScene 为 false 时，如果未显式设置则自动显示
+     * @type {boolean | undefined}
+     */
+    showResetButton: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    /** 默认场景 */
+    defaultScene: {
+        type: PropType<SuperTableDefaultSceneConfig | SuperTableDefaultSceneConfig[]>;
+        default: undefined;
+    };
+    /** 场景存储位置 */
+    sceneStorageType: {
+        type: PropType<"local" | "api">;
+        default: string;
+    };
+    /** 场景请求函数配置 */
+    sceneRequest: {
+        type: PropType<SuperTableSceneRequestConfig>;
+        default: undefined;
+    };
+    /** 开启表格设置 */
+    enableTableConfig: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{
+    "onForm-item-change"?: ((name: string, value: any, formItem: any, formOperations: any, tableOperations: any) => any) | undefined;
+    "onSort-change"?: ((value: any) => any) | undefined;
+    "onRow-sort-end"?: ((value: any) => any) | undefined;
+    "onScene-change"?: ((value: any) => any) | undefined;
+}>, {
+    columns: SuperTableColumn[];
+    sortable: boolean;
+    formItems: SuperTableFormItem[];
+    formItemColSpan: number;
+    enableScene: boolean;
+    showExpandButton: boolean;
+    showResetButton: boolean;
+    sceneType: string;
+    maxSceneCount: number;
+    debounceWait: number;
+    refreshDeps: unknown[];
+    tableProps: TableProps<any>;
+    formatDataSource: (data: any[]) => any[];
+    wrapperStyle: Record<string, any>;
+    tableWrapperStyle: Record<string, any>;
+    customQueryParams: Record<string, any>;
+    showRefreshButton: boolean;
+    defaultScene: SuperTableDefaultSceneConfig | SuperTableDefaultSceneConfig[];
+    sceneStorageType: "local" | "api";
+    sceneRequest: SuperTableSceneRequestConfig;
+    enableTableConfig: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};