workdesktop-ai 1.2.1 → 1.2.3

package/dist/types/src/components/data/editable-grid/EditableGrid.vue.d.ts

@@ -0,0 +1,586 @@
+import { type PropType } from 'vue';
+/** 可编辑列配置 */
+export interface EditableColumn {
+    prop: string;
+    label: string;
+    width?: string | number;
+    minWidth?: string | number;
+    align?: 'left' | 'center' | 'right';
+    fixed?: boolean | 'left' | 'right';
+    /** 编辑器类型：input/number/select/date；默认 input */
+    editor?: 'input' | 'number' | 'select' | 'date';
+    editable?: boolean;
+    placeholder?: string;
+    /** select 选项 */
+    options?: {
+        text: string;
+        value: any;
+    }[];
+    /** number 约束 */
+    min?: number;
+    max?: number;
+    precision?: number;
+    /** 必填校验 */
+    required?: boolean;
+    /** 自定义校验：返回错误文案，空串/undefined 为通过 */
+    validator?: (value: any, row: Record<string, any>) => string | undefined;
+    /**
+     * 单元格内容校验规则（与 ElForm 的 rules 完全一致，基于 async-validator）。
+     * 规则不满足时单元格显示约束样式，并在保存/行内保存时中断并提示。
+     */
+    rules?: Array<Record<string, any>>;
+    /** 展示格式化（只读态） */
+    formatter?: (row: Record<string, any>, col: EditableColumn) => string;
+}
+declare function addRow(): void;
+/** 批量保存：先校验（rules 不满足中断并提示），通过后提交脏行 */
+declare function saveAll(): Promise<void>;
+declare function onChangeCurrentpage(val: number): void;
+declare function onChangePagesize(val: number): void;
+declare function requestApi(options?: {
+    apiParam?: Record<string, any>;
+}): Promise<void>;
+declare function refresh(): Promise<void>;
+declare function getSelection(): any[];
+declare function clearSelection(): void;
+declare function search(params?: Record<string, any>): Promise<void>;
+declare function resetSearch(): Promise<import("../../../lib/composables/useDataGrid").ListData>;
+/**
+ * 全量校验：默认校验所有行所有列；若传入 columns prop 数组，则只校验指定列；不满足则全部显示错误样式，首错提示并返回 false
+ */
+declare function validate(columns?: string[]): Promise<boolean>;
+declare function getDirtyRows(): Record<string, any>[];
+declare var __VLS_1: {
+    dirtyRows: Record<string, any>[];
+    rows: Record<string, any>[];
+    selection: any[];
+}, __VLS_19: {
+    dirtyRows: Record<string, any>[];
+    rows: Record<string, any>[];
+    selection: any[];
+}, __VLS_185: `edit-${string}`, __VLS_186: {
+    row: any;
+    index: any;
+    column: EditableColumn;
+}, __VLS_200: {
+    row: any;
+    column: EditableColumn;
+    index: any;
+}, __VLS_247: `edit-${string}`, __VLS_248: {
+    row: any;
+    index: any;
+    column: EditableColumn;
+}, __VLS_262: {
+    row: any;
+    column: EditableColumn;
+    index: any;
+}, __VLS_324: {
+    row: any;
+    index: any;
+}, __VLS_326: {}, __VLS_336: {
+    row: Record<string, any>;
+    index: number;
+};
+type __VLS_Slots = {} & {
+    [K in NonNullable<typeof __VLS_185>]?: (props: typeof __VLS_186) => any;
+} & {
+    [K in NonNullable<typeof __VLS_247>]?: (props: typeof __VLS_248) => any;
+} & {
+    toolbar?: (props: typeof __VLS_1) => any;
+} & {
+    actions?: (props: typeof __VLS_19) => any;
+} & {
+    'dirty-tip-{{ col.prop }}'?: (props: typeof __VLS_200) => any;
+} & {
+    'dirty-tip-{{ col.prop }}'?: (props: typeof __VLS_262) => any;
+} & {
+    'row-actions'?: (props: typeof __VLS_324) => any;
+} & {
+    empty?: (props: typeof __VLS_326) => any;
+} & {
+    'card-item'?: (props: typeof __VLS_336) => any;
+};
+declare const __VLS_component: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /** 可编辑列配置 */
+    columns: {
+        type: PropType<EditableColumn[]>;
+        default: () => never[];
+    };
+    /** 行数据（v-model，静态数据推荐用法） */
+    modelValue: {
+        type: PropType<Record<string, any>[]>;
+        default: () => never[];
+    };
+    /** 编辑模式：cell=单元格点击编辑（默认）；row=行编辑 */
+    editMode: {
+        type: PropType<"cell" | "row">;
+        default: string;
+    };
+    /** 批量保存地址；为空时仅本地保存并 emit save */
+    saveApi: {
+        type: StringConstructor;
+        default: string;
+    };
+    saveMethod: {
+        type: PropType<"post" | "put">;
+        default: string;
+    };
+    /** 新增行默认值（对象或工厂函数） */
+    defaultRow: {
+        type: PropType<Record<string, any> | (() => Record<string, any>)>;
+        default: undefined;
+    };
+    api: {
+        type: StringConstructor;
+        default: string;
+    };
+    apiMethod: {
+        type: PropType<"get" | "post" | "put" | "delete">;
+        default: string;
+    };
+    apiParam: {
+        type: PropType<Record<string, any>>;
+        default: () => {};
+    };
+    active: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** 静态数据（数组）；不传时回退到 modelValue */
+    dataSource: {
+        type: PropType<any[] | any>;
+        default: undefined;
+    };
+    withPager: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    withSearch: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    modeSwitch: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    dynamicColumn: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    columnStorageKey: {
+        type: StringConstructor;
+        default: string;
+    };
+    fix: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    border: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    stripe: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    height: {
+        type: PropType<string | number>;
+        default: undefined;
+    };
+    autoHeight: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    rowKey: {
+        type: StringConstructor;
+        default: string;
+    };
+    tableSize: {
+        type: PropType<"large" | "default" | "small">;
+        default: string;
+    };
+    pagerStyle: {
+        type: PropType<"simple" | "normal" | "full">;
+        default: string;
+    };
+    withIndex: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    withSelection: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    rowspanKey: {
+        type: StringConstructor;
+        default: string;
+    };
+    rowspanColumn: {
+        type: PropType<string[]>;
+        default: () => never[];
+    };
+    treeProps: {
+        type: ObjectConstructor;
+        default: () => {
+            children: string;
+            hasChildren: string;
+        };
+    };
+    defaultExpandAll: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    tools: {
+        type: PropType<{
+            refresh?: boolean;
+            columnSetting?: boolean;
+            modeSwitch?: boolean;
+            size?: boolean;
+        }>;
+        default: () => {};
+    };
+    /** 内置只读操作列配置（渲染行操作按钮，点击 emit row-action） */
+    rowActions: {
+        type: PropType<Array<{
+            text: string;
+            command?: string;
+            type?: string;
+        }>>;
+        default: () => never[];
+    };
+    withToolbar: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    withAdd: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    withSave: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    withDelete: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    withActions: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    addButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+    saveButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+    actionWidth: {
+        type: (NumberConstructor | StringConstructor)[];
+        default: number;
+    };
+    headRefreshDatagrid: {
+        type: PropType<boolean | string>;
+        default: boolean;
+    };
+    filter: {
+        type: StringConstructor;
+        default: string;
+    };
+}>, {
+    requestApi: typeof requestApi;
+    refresh: typeof refresh;
+    search: typeof search;
+    resetSearch: typeof resetSearch;
+    onChangePagesize: typeof onChangePagesize;
+    onChangeCurrentpage: typeof onChangeCurrentpage;
+    getSelection: typeof getSelection;
+    clearSelection: typeof clearSelection;
+    saveAll: typeof saveAll;
+    validate: typeof validate;
+    addRow: typeof addRow;
+    getDirtyRows: typeof getDirtyRows;
+    tableRef: import("vue").Ref<any, any>;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    apiBefore: (...args: any[]) => void;
+    apiSuccess: (...args: any[]) => void;
+    apiFail: (...args: any[]) => void;
+    apiException: (...args: any[]) => void;
+    apiAfter: (...args: any[]) => void;
+    "row-action": (...args: any[]) => void;
+    "page-change": (...args: any[]) => void;
+    "selection-change": (...args: any[]) => void;
+    "mode-change": (...args: any[]) => void;
+    loaded: (...args: any[]) => void;
+    "update:modelValue": (...args: any[]) => void;
+    change: (...args: any[]) => void;
+    save: (...args: any[]) => void;
+    "row-add": (...args: any[]) => void;
+    "row-remove": (...args: any[]) => void;
+    "validate-fail": (...args: any[]) => void;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /** 可编辑列配置 */
+    columns: {
+        type: PropType<EditableColumn[]>;
+        default: () => never[];
+    };
+    /** 行数据（v-model，静态数据推荐用法） */
+    modelValue: {
+        type: PropType<Record<string, any>[]>;
+        default: () => never[];
+    };
+    /** 编辑模式：cell=单元格点击编辑（默认）；row=行编辑 */
+    editMode: {
+        type: PropType<"cell" | "row">;
+        default: string;
+    };
+    /** 批量保存地址；为空时仅本地保存并 emit save */
+    saveApi: {
+        type: StringConstructor;
+        default: string;
+    };
+    saveMethod: {
+        type: PropType<"post" | "put">;
+        default: string;
+    };
+    /** 新增行默认值（对象或工厂函数） */
+    defaultRow: {
+        type: PropType<Record<string, any> | (() => Record<string, any>)>;
+        default: undefined;
+    };
+    api: {
+        type: StringConstructor;
+        default: string;
+    };
+    apiMethod: {
+        type: PropType<"get" | "post" | "put" | "delete">;
+        default: string;
+    };
+    apiParam: {
+        type: PropType<Record<string, any>>;
+        default: () => {};
+    };
+    active: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** 静态数据（数组）；不传时回退到 modelValue */
+    dataSource: {
+        type: PropType<any[] | any>;
+        default: undefined;
+    };
+    withPager: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    withSearch: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    modeSwitch: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    dynamicColumn: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    columnStorageKey: {
+        type: StringConstructor;
+        default: string;
+    };
+    fix: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    border: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    stripe: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    height: {
+        type: PropType<string | number>;
+        default: undefined;
+    };
+    autoHeight: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    rowKey: {
+        type: StringConstructor;
+        default: string;
+    };
+    tableSize: {
+        type: PropType<"large" | "default" | "small">;
+        default: string;
+    };
+    pagerStyle: {
+        type: PropType<"simple" | "normal" | "full">;
+        default: string;
+    };
+    withIndex: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    withSelection: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    rowspanKey: {
+        type: StringConstructor;
+        default: string;
+    };
+    rowspanColumn: {
+        type: PropType<string[]>;
+        default: () => never[];
+    };
+    treeProps: {
+        type: ObjectConstructor;
+        default: () => {
+            children: string;
+            hasChildren: string;
+        };
+    };
+    defaultExpandAll: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    tools: {
+        type: PropType<{
+            refresh?: boolean;
+            columnSetting?: boolean;
+            modeSwitch?: boolean;
+            size?: boolean;
+        }>;
+        default: () => {};
+    };
+    /** 内置只读操作列配置（渲染行操作按钮，点击 emit row-action） */
+    rowActions: {
+        type: PropType<Array<{
+            text: string;
+            command?: string;
+            type?: string;
+        }>>;
+        default: () => never[];
+    };
+    withToolbar: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    withAdd: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    withSave: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    withDelete: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    withActions: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    addButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+    saveButtonText: {
+        type: StringConstructor;
+        default: string;
+    };
+    actionWidth: {
+        type: (NumberConstructor | StringConstructor)[];
+        default: number;
+    };
+    headRefreshDatagrid: {
+        type: PropType<boolean | string>;
+        default: boolean;
+    };
+    filter: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & Readonly<{
+    onApiBefore?: ((...args: any[]) => any) | undefined;
+    onApiSuccess?: ((...args: any[]) => any) | undefined;
+    onApiFail?: ((...args: any[]) => any) | undefined;
+    onApiException?: ((...args: any[]) => any) | undefined;
+    onApiAfter?: ((...args: any[]) => any) | undefined;
+    "onRow-action"?: ((...args: any[]) => any) | undefined;
+    "onPage-change"?: ((...args: any[]) => any) | undefined;
+    "onSelection-change"?: ((...args: any[]) => any) | undefined;
+    "onMode-change"?: ((...args: any[]) => any) | undefined;
+    onLoaded?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    onChange?: ((...args: any[]) => any) | undefined;
+    onSave?: ((...args: any[]) => any) | undefined;
+    "onRow-add"?: ((...args: any[]) => any) | undefined;
+    "onRow-remove"?: ((...args: any[]) => any) | undefined;
+    "onValidate-fail"?: ((...args: any[]) => any) | undefined;
+}>, {
+    filter: string;
+    api: string;
+    apiMethod: "post" | "delete" | "get" | "put";
+    apiParam: Record<string, any>;
+    active: boolean;
+    dataSource: any;
+    withPager: boolean;
+    withSearch: boolean;
+    modeSwitch: boolean;
+    dynamicColumn: boolean;
+    columnStorageKey: string;
+    fix: boolean;
+    border: boolean;
+    stripe: boolean;
+    height: string | number;
+    autoHeight: boolean;
+    rowKey: string;
+    tableSize: "default" | "small" | "large";
+    pagerStyle: "simple" | "normal" | "full";
+    withIndex: boolean;
+    withSelection: boolean;
+    rowspanKey: string;
+    rowspanColumn: string[];
+    treeProps: Record<string, any>;
+    defaultExpandAll: boolean;
+    modelValue: Record<string, any>[];
+    tools: {
+        refresh?: boolean;
+        columnSetting?: boolean;
+        modeSwitch?: boolean;
+        size?: boolean;
+    };
+    rowActions: {
+        text: string;
+        command?: string;
+        type?: string;
+    }[];
+    columns: EditableColumn[];
+    editMode: "row" | "cell";
+    saveApi: string;
+    saveMethod: "post" | "put";
+    defaultRow: Record<string, any> | (() => Record<string, any>);
+    withToolbar: boolean;
+    withAdd: boolean;
+    withSave: boolean;
+    withDelete: boolean;
+    withActions: boolean;
+    addButtonText: string;
+    saveButtonText: string;
+    actionWidth: string | number;
+    headRefreshDatagrid: string | 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;
+    };
+};