@shaonq/vue 1.1.9 → 1.1.11

package/lib/index.d.ts

@@ -1,7 +1,10 @@
 import { App } from 'vue';
+import { Button } from '@arco-design/web-vue';
+import { Component } from 'vue';
 import { ComponentOptionsMixin } from 'vue';
 import { DefineComponent } from 'vue';
 import { ExtractPropTypes } from 'vue';
+import { Modal } from '@arco-design/web-vue';
 import { PropType } from 'vue';
 import { PublicProps } from 'vue';
 import { Ref } from 'vue';
@@ -18,10 +21,22 @@ import { VxeToolbarInstance } from 'vxe-table';
 
 declare type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
 
+declare type __VLS_NonUndefinedable_2<T> = T extends undefined ? never : T;
+
+declare type __VLS_NonUndefinedable_3<T> = T extends undefined ? never : T;
+
 declare type __VLS_Prettify<T> = {
     [K in keyof T]: T[K];
 } & {};
 
+declare type __VLS_Prettify_2<T> = {
+    [K in keyof T]: T[K];
+} & {};
+
+declare type __VLS_Prettify_3<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]>>;
@@ -31,12 +46,42 @@ declare type __VLS_TypePropsToRuntimeProps<T> = {
     };
 };
 
+declare type __VLS_TypePropsToRuntimeProps_2<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: PropType<__VLS_NonUndefinedable_2<T[K]>>;
+    } : {
+        type: PropType<T[K]>;
+        required: true;
+    };
+};
+
+declare type __VLS_TypePropsToRuntimeProps_3<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: PropType<__VLS_NonUndefinedable_3<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_WithDefaults_2<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify_2<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+
+declare type __VLS_WithDefaults_3<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify_3<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+
 declare type __VLS_WithTemplateSlots<T, S> = T & {
     new (): {
         $slots: S;
@@ -55,18 +100,34 @@ declare type __VLS_WithTemplateSlots_3<T, S> = T & {
     };
 };
 
+declare type __VLS_WithTemplateSlots_4<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+declare type __VLS_WithTemplateSlots_5<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+declare type __VLS_WithTemplateSlots_6<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+declare type ButtonInstance = InstanceType<typeof Button>;
+
 declare interface CssType extends Partial<CSSStyleDeclaration>, RecordAny_2 {
 }
 
-export declare const deepClone: <T = RecordAny | RecordAny[]>(origin: T) => T;
-
 declare const _default: {
     install(Vue: App): void;
 };
 export default _default;
 
-export declare const download: (url: string, fileName?: string) => boolean;
-
 /**
  * @param name 下载名称
  * @param element  HTMLElement
@@ -75,7 +136,7 @@ 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?: {
+declare function downLoadPdf(name: string, element: HTMLElement, option?: {
     /** `pdf page margin`: `[top, left, bottom, right]`  */
     margin?: number[];
     /** 启用 `worker` */
@@ -94,49 +155,82 @@ export declare function downLoadPdf(name: string, element: HTMLElement, option?:
     jsPDF?: any;
 } & RecordAny): Promise<void>;
 
-export declare function findObject<T extends RecordAny>(obj: T, keys?: string | string[]): T;
+declare function findObject<T extends RecordAny>(obj: T, keys?: string | string[]): T;
 
-/** 行数据格式化 千分位|日期   */
-export declare const formatTable: {
-    /** 千分位|保留小数 */
-    tf: (val: any, digits?: any) => any;
-    /** 快捷格式化日期 */
-    t: (val: any) => string;
-    /** 完整格式化日期  yyyy-MM-dd HH:mm:ss */
-    time: (val: any, f?: string) => string;
-    /** percent 格式化百分比 */
-    p: (val: any, digits?: any, percent?: string) => string;
+/**  描述表单项的属性。 */
+declare type FormItemType = {
+    /**
+     * 可以使使用的 Arco 组件类型 也可以使用自定义组件
+     * @example 'a-input', 'a-select' 等。
+     */
+    type?: string | Component;
+    /** 表单项的文本名称或标题 */
+    name: string;
+    /** 用于双向数据绑定的模型属性 */
+    model: string;
+    /** 控制表单项是否显示。 */
+    show?: boolean;
+    /** 表单项的默认值 */
+    defaultValue?: any;
+    /** 触发验证的时机 */
+    validateTrigger?: 'change' | 'input' | 'focus' | 'blur';
+    /** 组件属性对象 */
+    componentAttr?: Record<string, any>;
+    /** 自定义类名，可以是字符串或函数 */
+    customClass?: string | ((itemConfig: FormItemType, models: Record<string, any>) => string);
+    /** 开启多选 转义[a,b]=>'a,b' ,默认组件支持请开启 componentAttr:{multiple:true}  */
+    dotNotation?: boolean;
+    /** 数据字典键名 */
+    datadict?: string;
+    /** 配置项 */
+    options?: {
+        /** 必填 */
+        required?: boolean;
+        /** 栅格 24 */
+        span?: number;
+        /** 禁用 */
+        disabled?: boolean;
+        /** 占位符 */
+        placeholder?: string;
+        /** 帮助文案 */
+        help?: string;
+        /** 提示信息 */
+        tooltip?: string;
+    };
+    /** 验证规则 */
+    rules?: Record<string, any>[];
+    /** 事件处理器 */
+    events?: {
+        /** 组件挂载后执行 */
+        onMounted?: (util: FormUtilType & FormItemType['events']) => any | Promise<any>;
+        /** 值改变时触发 */
+        onChange?: (val: any, util: FormUtilType & FormItemType['events']) => void | Promise<void>;
+        /** watch 更新时触发   */
+        onUpdate?: (val: any, oldVal: any, util: FormUtilType & FormItemType['events']) => void | Promise<void>;
+    };
+    /** 扩展字符 */
+    note?: string;
 };
 
-/** 生成二维码  base64 */
-export declare function generateQRcodeBase64(options: RecordAny): string;
-
-/**
- *  get path object
- * @example
- * ```
- *  getData({a:{b:1}},'a.b')
- *  // 1
- * ```
- */
-export declare function getData(object: RecordAny, path: string, defaultValue?: any): any;
-
-export declare const getUniqueId: () => string;
-
-/** isArray  */
-export declare function isArray(obj: any): obj is any[];
-
-/** 是否是空数组 */
-export declare function isEmptyArray(obj: any): boolean;
-
-/** 是否是空对象 */
-export declare function isEmptyObject(obj: any): boolean;
+declare type FormSubmitEvent = {
+    data: Record<string, any>;
+    utils: {
+        setVisible: (a: boolean) => void;
+        setLoading: (a: boolean) => void;
+    };
+};
 
-/** isNumber */
-export declare function isNumber(obj: any): obj is number;
+declare type FormUtilType = {
+    getModelOption: (model: string) => any;
+    getModel: (model: string) => any;
+    getShow: (model: string) => boolean;
+    setModelOption: (model: string, val: any) => void;
+    setModel: (c: string | Record<string, any>, v?: any) => void;
+    setShow: (model: string, val: boolean) => void;
+};
 
-/** isObject  */
-export declare function isObject(value: unknown): value is Record<string, any>;
+/** 生成二维码  base64 */
+declare function generateQRcodeBase64(options: RecordAny): string;
 
 export declare const locale: {
     enUS: {
@@ -524,12 +618,16 @@ export declare const locale: {
 };
 
 /** 日志 */
-export declare function log(...args: any[]): void;
+declare function log(...args: any[]): void;
+
+declare function mergeConfig(defaults: RecordAny, overrides: RecordAny, isRoot?: boolean): RecordAny;
 
-export declare function mergeConfig(defaults: RecordAny, overrides: RecordAny, isRoot?: boolean): RecordAny;
+declare type ModalInstance = InstanceType<typeof Modal>;
 
 /** omit object  */
-export declare function omitObject<T extends RecordAny>(obj: T, keys?: string | string[]): T;
+declare function omitObject<T extends RecordAny>(obj: T, keys?: string | string[]): T;
+
+declare function onSubmit(): Promise<[boolean, any]>;
 
 export declare const OrcDesign: DefineComponent<{
     readonly: BooleanConstructor;
@@ -576,7 +674,151 @@ export declare const OrcDesignPrint: DefineComponent<{}, {
     getHtml(): any;
 }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{}>>, {}, {}>;
 
-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>, {}>>>, {}, {}>, {
+export declare const OrcForm: __VLS_WithTemplateSlots_3< DefineComponent<{
+    /** @example ``` [{ type: 'a-input', model: 'billNumber', name: '类型编码', options: { disabled: true, placeholder: '' }] ``` */
+    config: {
+        type: PropType<FormItemType[]>;
+        default(): never[];
+    };
+    labelWidth: {
+        type: StringConstructor;
+        default: string;
+    };
+    labelAlign: {
+        type: PropType<"left" | "right">;
+        default: string;
+    };
+    loading: BooleanConstructor;
+    disabled: BooleanConstructor;
+    hideSubmit: BooleanConstructor;
+    modelValue: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /** 栅格间距 */
+    gutter: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /** 栅格 24 */
+    span: {
+        type: NumberConstructor;
+        default: number;
+    };
+    formProps: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /** 栅格grid 优先级低于行 span */
+    grid: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+}, {
+    onSubmit: typeof onSubmit;
+    onReset: (defValue?: Partial<{
+        [x: string]: any;
+    }> | undefined) => void;
+    resetFields(): void;
+}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+    error: (...args: any[]) => void;
+    "update:modelValue": (...args: any[]) => void;
+    submit: (...args: any[]) => void;
+}, string, PublicProps, Readonly< ExtractPropTypes<{
+    /** @example ``` [{ type: 'a-input', model: 'billNumber', name: '类型编码', options: { disabled: true, placeholder: '' }] ``` */
+    config: {
+        type: PropType<FormItemType[]>;
+        default(): never[];
+    };
+    labelWidth: {
+        type: StringConstructor;
+        default: string;
+    };
+    labelAlign: {
+        type: PropType<"left" | "right">;
+        default: string;
+    };
+    loading: BooleanConstructor;
+    disabled: BooleanConstructor;
+    hideSubmit: BooleanConstructor;
+    modelValue: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /** 栅格间距 */
+    gutter: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /** 栅格 24 */
+    span: {
+        type: NumberConstructor;
+        default: number;
+    };
+    formProps: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+    /** 栅格grid 优先级低于行 span */
+    grid: {
+        type: ObjectConstructor;
+        default(): {};
+    };
+}>> & {
+    onSubmit?: ((...args: any[]) => any) | undefined;
+    onError?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+}, {
+    grid: Record<string, any>;
+    loading: boolean;
+    disabled: boolean;
+    modelValue: Record<string, any>;
+    span: number;
+    formProps: Record<string, any>;
+    config: FormItemType[];
+    labelWidth: string;
+    labelAlign: "left" | "right";
+    hideSubmit: boolean;
+    gutter: number;
+}, {}>, {
+    row?(_: {}): any;
+    default?(_: {
+        onSubmit: typeof onSubmit;
+    }): any;
+}>;
+
+export declare const OrcFormButton: __VLS_WithTemplateSlots_4< DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, {
+    title: string;
+    modelValue: undefined;
+}>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+    submit: (data: FormSubmitEvent) => void;
+    error: (data: any) => void;
+}, string, PublicProps, Readonly< ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<Props>, {
+    title: string;
+    modelValue: undefined;
+}>>> & {
+    onSubmit?: ((data: FormSubmitEvent) => any) | undefined;
+    onError?: ((data: any) => any) | undefined;
+}, {
+    title: string;
+    modelValue: RecordAny;
+}, {}>, {
+    default?(_: {}): any;
+}>;
+
+export declare const OrcHiddenView: __VLS_WithTemplateSlots_5< DefineComponent<__VLS_WithDefaults_2<__VLS_TypePropsToRuntimeProps_2<{
+    isShow?: boolean | undefined;
+    isDirection?: boolean | undefined;
+    formProps?: Record<string, any> | undefined;
+}>, {}>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<__VLS_WithDefaults_2<__VLS_TypePropsToRuntimeProps_2<{
+    isShow?: boolean | undefined;
+    isDirection?: boolean | undefined;
+    formProps?: Record<string, any> | undefined;
+}>, {}>>>, {}, {}>, {
+    default?(_: {}): any;
+}>;
+
+export declare const OrcProvider: __VLS_WithTemplateSlots_6< DefineComponent<__VLS_WithDefaults_3<__VLS_TypePropsToRuntimeProps_3<Props_2>, {}>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<__VLS_WithDefaults_3<__VLS_TypePropsToRuntimeProps_3<Props_2>, {}>>>, {}, {}>, {
     default?(_: {}): any;
 }>;
 
@@ -885,6 +1127,18 @@ export declare interface OrcTableOption extends RecordAny_2 {
 }
 
 declare interface Props {
+    disabled?: boolean;
+    title?: string;
+    span?: number;
+    gutter?: number;
+    config: FormItemType[];
+    modelValue?: RecordAny;
+    labelWidth?: string;
+    buttonAttrs?: ButtonInstance['$props'];
+    modalAttrs?: ModalInstance['$props'];
+}
+
+declare interface Props_2 {
     useErrData?: <T = Record<string, any>>(config: Record<string, any>) => Promise<[boolean, T]>;
 }
 
@@ -892,17 +1146,6 @@ export declare type RecordAny = Record<string, any>;
 
 declare type RecordAny_2 = Record<string, any>;
 
-/**
- *  set path object
- * @example
- * ```
- *  var b = {a:{b:1}}
- *  setData(b,'a.b',2)
- *  // {a:{b:2}}
- * ```
- */
-export declare function setData(object: RecordAny, path: string, defaultValue?: any): RecordAny;
-
 declare function setLoading(val?: boolean): void;
 
 /**  column type */
@@ -982,12 +1225,6 @@ declare interface TableGridTwoType extends RecordAny_2 {
 
 declare type TableInstance = InstanceType<typeof VxeTable>;
 
-/** array */
-export declare function toArray<T>(target: T | T[]): T[];
-
-/** 读取数据类型 */
-export declare function typeName(o: unknown): string;
-
 declare interface TypeSearchItem extends RecordAny {
     /** input 类型 */
     type?: string;
@@ -1544,4 +1781,26 @@ export declare const useOrcTable: (option: OrcTableOption) => {
     selectedKeys: Ref<string[], string[]>;
 };
 
+declare function useState<T extends RecordAny>(initValue: T, formsRef?: Ref<{
+    resetFields?: () => void;
+}>): readonly [Ref<T, T>, (defValue?: Partial<T>) => void];
+
+export declare const utils: {
+    formatTable: {
+        tf: (val: any, digits?: any) => any;
+        t: (val: any) => string;
+        time: (val: any, f?: string) => string;
+        p: (val: any, digits?: any, percent?: string) => string;
+    };
+    mergeConfig: typeof mergeConfig;
+    generateQRcodeBase64: typeof generateQRcodeBase64;
+    downLoadPdf: typeof downLoadPdf;
+    useState: typeof useState;
+    findObject: typeof findObject;
+    omitObject: typeof omitObject;
+    deepClone: <T = RecordAny | RecordAny[]>(origin: T) => T;
+    download: (url: string, fileName?: string) => boolean;
+    log: typeof log;
+};
+
 export { }