@shaonq/vue 1.1.8 → 1.1.9

package/lib/index.d.ts

@@ -7,12 +7,36 @@ import { PublicProps } from 'vue';
 import { Ref } from 'vue';
 import { TablePublicMethods } from 'vxe-table';
 import { VxeColumnPropTypes } from 'vxe-table';
+import { VxeTable } from 'vxe-table';
 import { VxeTableDataRow } from 'vxe-table';
 import { VxeTableDefines } from 'vxe-table';
+import { VxeTableEventProps } from 'vxe-table';
+import { VxeTableProps } from 'vxe-table';
 import { VxeTablePropTypes } from 'vxe-table';
 import { VxeToolbarConstructor } from 'vxe-table';
 import { VxeToolbarInstance } from 'vxe-table';
 
+declare type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+
+declare type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+
+declare type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: PropType<T[K]>;
+        required: true;
+    };
+};
+
+declare type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+
 declare type __VLS_WithTemplateSlots<T, S> = T & {
     new (): {
         $slots: S;
@@ -25,6 +49,12 @@ declare type __VLS_WithTemplateSlots_2<T, S> = T & {
     };
 };
 
+declare type __VLS_WithTemplateSlots_3<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
 declare interface CssType extends Partial<CSSStyleDeclaration>, RecordAny_2 {
 }
 
@@ -45,7 +75,24 @@ export declare const download: (url: string, fileName?: string) => boolean;
  * @param {string} option.className 例 class = 'one-page-pdf' ,大量打印必填
  * @param {string} option.success  successCallback worker:any => void
  */
-export declare function downLoadPdf(name: string, element: HTMLElement, option?: RecordAny): Promise<void>;
+export declare function downLoadPdf(name: string, element: HTMLElement, option?: {
+    /** `pdf page margin`: `[top, left, bottom, right]`  */
+    margin?: number[];
+    /** 启用 `worker` */
+    className?: string;
+    /** 缩放比例 */
+    scale?: number;
+    /** 横向 `landscape` ,竖向 `portrait` */
+    letterRendering?: 'landscape' | 'portrait';
+    pagebreak?: {
+        mode?: any;
+        before?: any;
+        after?: any;
+        avoid?: any;
+    };
+    html2canvas?: any;
+    jsPDF?: any;
+} & RecordAny): Promise<void>;
 
 export declare function findObject<T extends RecordAny>(obj: T, keys?: string | string[]): T;
 
@@ -484,11 +531,83 @@ export declare function mergeConfig(defaults: RecordAny, overrides: RecordAny, i
 /** omit object  */
 export declare function omitObject<T extends RecordAny>(obj: T, keys?: string | string[]): T;
 
-export declare const OrchiskyPrint: DefineComponent<{}, {
+export declare const OrcDesign: DefineComponent<{
+    readonly: BooleanConstructor;
+    data: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    models: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    remoteFuncs: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    moduleConfig: ArrayConstructor;
+}, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+    save: (...args: any[]) => void;
+}, string, PublicProps, Readonly< ExtractPropTypes<{
+    readonly: BooleanConstructor;
+    data: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    models: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    remoteFuncs: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    moduleConfig: ArrayConstructor;
+}>> & {
+    onSave?: ((...args: any[]) => any) | undefined;
+}, {
+    data: Record<string, any>;
+    readonly: boolean;
+    models: Record<string, any>;
+    remoteFuncs: Record<string, any>;
+}, {}>;
+
+export declare const OrcDesignPrint: DefineComponent<{}, {
     getHtml(): any;
 }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{}>>, {}, {}>;
 
-export declare const OrchiskySearch: __VLS_WithTemplateSlots_2< DefineComponent<{
+export declare const OrcProvider: __VLS_WithTemplateSlots_3< DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, {}>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, {}>>>, {}, {}>, {
+    default?(_: {}): any;
+}>;
+
+export declare const OrcQuill: DefineComponent<{
+    modelValue: {
+        type: StringConstructor;
+        default: string;
+    };
+    toolbar: {
+        type: (StringConstructor | ArrayConstructor)[];
+        default: string;
+    };
+}, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+    "update:modelValue": (...args: any[]) => void;
+}, string, PublicProps, Readonly< ExtractPropTypes<{
+    modelValue: {
+        type: StringConstructor;
+        default: string;
+    };
+    toolbar: {
+        type: (StringConstructor | ArrayConstructor)[];
+        default: string;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+}, {
+    modelValue: string;
+    toolbar: string | unknown[];
+}, {}>;
+
+export declare const OrcSearch: __VLS_WithTemplateSlots_2< DefineComponent<{
     loading: BooleanConstructor;
     readonly: BooleanConstructor;
     options: {
@@ -541,27 +660,27 @@ export declare const OrchiskySearch: __VLS_WithTemplateSlots_2< DefineComponent<
     "onUpdate:model-value"?: ((...args: any[]) => any) | undefined;
     onOnSearch?: ((...args: any[]) => any) | undefined;
 }, {
+    loading: boolean;
+    size: string;
+    modelValue: Record<string, any>;
     options: TypeSearchItem[];
     readonly: boolean;
-    size: string;
     labelWidth: string;
-    modelValue: Record<string, any>;
-    loading: boolean;
     inputWidth: string;
 }, {}>, {
     head?(_: {}): any;
     default?(_: {}): any;
 }>;
 
-export declare const OrchiskyTable: __VLS_WithTemplateSlots< DefineComponent<{
+export declare const OrcTable: __VLS_WithTemplateSlots< DefineComponent<{
     title: StringConstructor;
     /** auto(铺满父容器,必须确保存在父节点且不允许存在相邻元素 ,), %, px */
-    height: (NumberConstructor | StringConstructor)[];
+    height: (StringConstructor | NumberConstructor)[];
     /** 隐藏工具栏  */
     hideToolbar: BooleanConstructor;
     hidePagination: BooleanConstructor;
     size: {
-        type: PropType<"small" | "mini" | "medium">;
+        type: PropType<"medium" | "small" | "mini">;
         default: string;
     };
     /** 用户选择列表 */
@@ -576,7 +695,7 @@ export declare const OrchiskyTable: __VLS_WithTemplateSlots< DefineComponent<{
     };
     /** 配置文件  */
     option: {
-        type: PropType<OrchiskyTableOptionType>;
+        type: PropType<OrcTableOption>;
         default: () => {
             columns: never[];
         };
@@ -601,7 +720,7 @@ export declare const OrchiskyTable: __VLS_WithTemplateSlots< DefineComponent<{
     checkRows(list?: RecordAny_2[] | undefined): Promise<[string, RecordAny_2[]]>;
     getRowSeq(row: any): string | number;
     getRowIndex(row: any): number;
-    removerRowIndex(rowIndex: number): void; /** 未修改之前的数据 */
+    removerRowIndex(rowIndex: number): void;
     loading: Ref<boolean, boolean>;
     setLoading: typeof setLoading;
     /** 执行搜索 ,是否返回第一页 */
@@ -609,20 +728,20 @@ export declare const OrchiskyTable: __VLS_WithTemplateSlots< DefineComponent<{
     /** 加载数据 */
     loadData(list: any[]): void;
 }, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-    change: (...args: any[]) => void;
-    onReset: (...args: any[]) => void;
     "update:selectedKeys": (...args: any[]) => void;
     cellClick: (...args: any[]) => void;
+    onReset: (...args: any[]) => void;
+    change: (...args: any[]) => void;
     confirm: (...args: any[]) => void;
 }, string, PublicProps, Readonly< ExtractPropTypes<{
     title: StringConstructor;
     /** auto(铺满父容器,必须确保存在父节点且不允许存在相邻元素 ,), %, px */
-    height: (NumberConstructor | StringConstructor)[];
+    height: (StringConstructor | NumberConstructor)[];
     /** 隐藏工具栏  */
     hideToolbar: BooleanConstructor;
     hidePagination: BooleanConstructor;
     size: {
-        type: PropType<"small" | "mini" | "medium">;
+        type: PropType<"medium" | "small" | "mini">;
         default: string;
     };
     /** 用户选择列表 */
@@ -637,7 +756,7 @@ export declare const OrchiskyTable: __VLS_WithTemplateSlots< DefineComponent<{
     };
     /** 配置文件  */
     option: {
-        type: PropType<OrchiskyTableOptionType>;
+        type: PropType<OrcTableOption>;
         default: () => {
             columns: never[];
         };
@@ -648,15 +767,15 @@ export declare const OrchiskyTable: __VLS_WithTemplateSlots< DefineComponent<{
         setColumn: (list: RecordAny_2[]) => void;
     }>;
 }>> & {
-    onChange?: ((...args: any[]) => any) | undefined;
-    onOnReset?: ((...args: any[]) => any) | undefined;
     "onUpdate:selectedKeys"?: ((...args: any[]) => any) | undefined;
     onCellClick?: ((...args: any[]) => any) | undefined;
+    onOnReset?: ((...args: any[]) => any) | undefined;
+    onChange?: ((...args: any[]) => any) | undefined;
     onConfirm?: ((...args: any[]) => any) | undefined;
 }, {
-    size: "small" | "mini" | "medium";
     data: unknown[];
-    option: OrchiskyTableOptionType;
+    option: OrcTableOption;
+    size: "medium" | "small" | "mini";
     hideToolbar: boolean;
     hidePagination: boolean;
     selectedKeys: unknown[];
@@ -688,9 +807,10 @@ export declare const OrchiskyTable: __VLS_WithTemplateSlots< DefineComponent<{
  * }
  * ```
  */
-export declare interface OrchiskyTableOptionType extends RecordAny_2 {
-    /** 请求地址 */
+export declare interface OrcTableOption extends RecordAny_2 {
+    /** 可使用 `orc-provider` 全局注入 */
     useErrData?: <T = RecordAny_2>(config: RecordAny_2) => Promise<[boolean, T]>;
+    /** 请求地址 */
     url?: string;
     /** 请求类型 */
     method?: 'GET' | 'POST' | 'PUT' | 'DELETE';
@@ -756,40 +876,17 @@ export declare interface OrchiskyTableOptionType extends RecordAny_2 {
     skinRowText?: string;
     /** 同 edit-rules , demo :  {  sex: [ { required: true, message: '性别必须填写' } ] } */
     rules?: VxeTablePropTypes.EditRules;
-    /** 数据筛选 {remote:服务器筛选 ,filterMethod :({ options, values, cellValue, row, column }) => boolean } */
-    filterConfig?: VxeTablePropTypes.FilterConfig;
     /** 横向虚拟滚动配置  { enabled, gt }  */
     scrollX?: VxeTablePropTypes.ScrollX;
     /** 纵向虚拟滚动配置  { enabled, gt }  */
     scrollY?: VxeTablePropTypes.ScrollY;
+    selectedProps?: any;
+    tableProps?: TableInstance['$props'];
 }
 
-export declare const OrchiskyTextarea: DefineComponent<{
-    modelValue: {
-        type: StringConstructor;
-        default: string;
-    };
-    toolbar: {
-        type: (ArrayConstructor | StringConstructor)[];
-        default: string;
-    };
-}, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
-    "update:modelValue": (...args: any[]) => void;
-}, string, PublicProps, Readonly< ExtractPropTypes<{
-    modelValue: {
-        type: StringConstructor;
-        default: string;
-    };
-    toolbar: {
-        type: (ArrayConstructor | StringConstructor)[];
-        default: string;
-    };
-}>> & {
-    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
-}, {
-    modelValue: string;
-    toolbar: string | unknown[];
-}, {}>;
+declare interface Props {
+    useErrData?: <T = Record<string, any>>(config: Record<string, any>) => Promise<[boolean, T]>;
+}
 
 export declare type RecordAny = Record<string, any>;
 
@@ -830,9 +927,7 @@ declare interface TableColumnType extends RecordAny_2 {
     style?: CssType | ((record: RecordAny_2) => CssType);
     /** 同 :title-prefix "{ content: '必填', icon: 'vxe-cell--required-icon' }" */
     help?: VxeColumnPropTypes.TitlePrefix;
-    filters?: VxeColumnPropTypes.Filter[];
-    filterMultiple?: VxeColumnPropTypes.FilterMultiple;
-    filterMethod?: VxeColumnPropTypes.FilterMethod;
+    columnProps?: any;
 }
 
 declare interface TableExposeType extends TableGridTwoType {
@@ -885,6 +980,8 @@ declare interface TableGridTwoType extends RecordAny_2 {
     removerRowIndex(rowIndex: number): void;
 }
 
+declare type TableInstance = InstanceType<typeof VxeTable>;
+
 /** array */
 export declare function toArray<T>(target: T | T[]): T[];
 
@@ -943,7 +1040,7 @@ declare interface TypeSearchItem extends RecordAny {
  *  { type: 'date', name: 'd2', label: '日期范围', multiple: true, defaultValue: '2024-07-01,2024-08-07' },
  * ```
  */
-export declare function useOrchiskySearch(list: TypeSearchItem[]): readonly [ Ref<{
+export declare function useOrcSearch(list: TypeSearchItem[]): readonly [ Ref<{
     [x: string]: any;
     type?: string | undefined;
     name: string;
@@ -983,7 +1080,7 @@ export declare function useOrchiskySearch(list: TypeSearchItem[]): readonly [ Re
     rules?: RecordAny | RecordAny[] | undefined;
 }[]>, Ref<RecordAny, RecordAny>];
 
-export declare const useOrchiskyVxe: (option: OrchiskyTableOptionType) => {
+export declare const useOrcTable: (option: OrcTableOption) => {
     tableRef: Ref<{
         [x: string]: any;
         loading: boolean;
@@ -1039,11 +1136,11 @@ export declare const useOrchiskyVxe: (option: OrchiskyTableOptionType) => {
         columns: TableColumnType[];
         pageSize?: number | undefined;
         pageSizeOptions?: number[] | undefined;
-        selectedType?: "radio" | "checkbox" | undefined;
+        selectedType?: "checkbox" | "radio" | undefined;
         requiredKeys?: string[] | undefined;
         firstLoad?: boolean | undefined;
-        tooltip?: boolean | "tooltip" | "title" | "ellipsis" | undefined;
-        footerTooltip?: boolean | "tooltip" | "title" | "ellipsis" | undefined;
+        tooltip?: boolean | "title" | "tooltip" | "ellipsis" | undefined;
+        footerTooltip?: boolean | "title" | "tooltip" | "ellipsis" | undefined;
         headerStyle?: ((record: RecordAny_2 & {
             column: {
                 property: string;
@@ -1067,9 +1164,10 @@ export declare const useOrchiskyVxe: (option: OrchiskyTableOptionType) => {
         skinRowStyle?: CssType | undefined;
         skinRowText?: string | undefined;
         rules?: VxeTablePropTypes<VxeTableDataRow> | undefined;
-        filterConfig?: VxeTablePropTypes<VxeTableDataRow> | undefined;
         scrollX?: VxeTablePropTypes | undefined;
         scrollY?: VxeTablePropTypes | undefined;
+        selectedProps?: any;
+        tableProps?: ( VxeTableProps<any> & VxeTableEventProps<any>) | undefined;
     };
     tableUtils: {
         getRowKey(): string;