@shaonq/vue 1.4.2 → 1.4.4

package/lib/index.d.ts

@@ -4,6 +4,7 @@ import { Component } from 'vue';
 import { ComponentOptionsMixin } from 'vue';
 import { ComponentProvideOptions } from 'vue';
 import { ComputedOptions } from 'vue';
+import { CSSProperties } from 'vue';
 import { DefineComponent } from 'vue';
 import { ExtractPropTypes } from 'vue';
 import { FormItem } from '@arco-design/web-vue';
@@ -238,8 +239,15 @@ declare type ComponentAttrHandler = (util: OrcFormUtilBind, index?: any) => unkn
 /** componentAttr 支持的静态值类型 */
 declare type ComponentAttrValue = null | boolean | number | string | RecordAny_3 | RecordAny_3[] | ComponentAttrHandler;
 
-export declare interface CssType extends Partial<CSSStyleDeclaration>, RecordAny_2 {
-}
+/**
+ * 单元格样式：对象 | 支持动态函数
+ * @param {Object} params
+ * @param {any} params.row - 行数据
+ * @param {number} params.rowIndex - 行索引
+ * @param {RecordAny} params.column - 列配置
+ * @param {number} params.columnIndex - 列索引
+ */
+export declare type CssType = Partial<CSSProperties> & RecordAny_2;
 
 export declare const deepClone: <T = RecordAny | RecordAny[]>(origin: T) => T;
 
@@ -254,26 +262,7 @@ declare type DictLoadFn = (code: string) => Promise<unknown[]>;
 
 export declare const download: (url: string, fileName?: string) => boolean;
 
-/**
- * 将指定 HTML 元素（及其子元素）渲染为 PDF 并下载。
- *
- * @param name - 下载的 PDF 文件名（不带扩展名）
- * @param element - 要转换为 PDF 的 HTML 元素
- * @param option - 可选配置项：
- *   - className?: 用于选择多个子元素的选择器类名
- *   - paddingBuffer?: 分页时忽略的小段高度阈值（单位 mm）
- *   - margin?: 页面边距（未在代码中使用，但保留兼容性）
- *   - 其他 jsPDF 支持的选项（如格式、方向等）
- *
- * @throws 如果未传入 element，则抛出错误
- *
- * 注意事项：
- * - 使用 snapdom(替换了htmlToImage) 将 HTML 渲染为 Canvas
- * - 使用 jsPDF 将 Canvas 添加到 PDF 文档
- * - 默认 A4 格式纵向，可自定义通过 `option.orientation`
- * - 当内容高度超过一页时会自动分页
- * - 存在逻辑错误：canvas 的裁剪方式不正确，会导致每一页都显示整个页面的内容
- */
+/** 指定element下载为pdf ,修改 pdfOption.orientation: "landscape" 更改导出方向  */
 export declare function downLoadPdf(name: string, element: HTMLElement, option?: {
     progress?: (...args: number[]) => void;
     className?: string;
@@ -297,15 +286,15 @@ declare interface FieldOption {
 
 export declare function findObject<T extends RecordAny>(obj: T, keys?: string | string[]): T;
 
-/** 行数据格式化 千分位|日期   */
+/** 行数据格式化工具：千分位|日期|百分比 */
 export declare const formatTable: {
-    /** 千分位|保留小数 */
+    /** 千分位格式化，支持小数位控制 */
     tf: (val: any, digits?: any) => any;
-    /** 快捷格式化日期 */
+    /** 快捷日期格式化 yyyy-MM-dd */
     t: (val: any) => string;
-    /** 完整格式化日期  yyyy-MM-dd HH:mm:ss */
+    /** 完整日期格式化，默认 yyyy-MM-dd HH:mm:ss */
     time: (val: any, f?: string) => string;
-    /** percent 格式化百分比 */
+    /** 百分比格式化，默认保留2位小数，数据自动×100 */
     p: (val: any, digits?: any, percent?: string) => string;
 };
 
@@ -420,7 +409,7 @@ declare const lang_2: {
 /** 日志 */
 export declare function log(...args: any[]): void;
 
-/** 合并配置文件 */
+/** 深度合并配置对象，数组拼接，函数直接报错。 @example mergeConfig({ a: 1 }, { b: 2 }) */
 export declare function mergeConfig(defaults: RecordAny, overrides: RecordAny): RecordAny;
 
 declare type ModalInstance = InstanceType<typeof Modal>;
@@ -517,11 +506,11 @@ export declare const OrcForm: __VLS_WithTemplateSlots_5< DefineComponent<Extract
     onSubmit?: ((...args: any[]) => any) | undefined;
     "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
 }>, {
-    grid: Record<string, any>;
     disabled: boolean;
     loading: boolean;
-    modelValue: Record<string, any>;
+    grid: Record<string, any>;
     span: number;
+    modelValue: Record<string, any>;
     config: OrcFormItem[];
     labelWidth: string;
     labelAlign: "left" | "right";
@@ -568,7 +557,7 @@ export declare const OrcFormButton: __VLS_WithTemplateSlots_6< DefineComponent<E
     "onUpdate:modelValue"?: ((data: RecordAny) => any) | undefined;
 }>, {
     title: string;
-    size: "large" | "medium" | "small" | "mini";
+    size: "medium" | "large" | "small" | "mini";
     modelValue: RecordAny;
     gutter: number;
 }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>, {
@@ -640,6 +629,7 @@ export declare type OrcFormItem = {
      *   - `'a-radio-group'` → `options`, `direction` 等
      *   - `'a-textarea'` → `maxLength`, `showWordLimit`, `autoSize` 等
      *   - `'a-tree-select'` → `treeData`, `allowSearch`, `treeCheckable` 等
+     *   - `OrcFormTable` → `height`, `hideTools`, `hideToolbar` 等
      * @example
      * ```ts
      * // 静态值
@@ -1123,7 +1113,7 @@ export declare const OrcQuill: DefineComponent<ExtractPropTypes<{
         default: string;
     };
     toolbar: {
-        type: (ArrayConstructor | StringConstructor)[];
+        type: (StringConstructor | ArrayConstructor)[];
         default: string;
     };
 }>, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
@@ -1134,14 +1124,14 @@ export declare const OrcQuill: DefineComponent<ExtractPropTypes<{
         default: string;
     };
     toolbar: {
-        type: (ArrayConstructor | StringConstructor)[];
+        type: (StringConstructor | ArrayConstructor)[];
         default: string;
     };
 }>> & Readonly<{
     "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
 }>, {
-    modelValue: string;
     toolbar: string | unknown[];
+    modelValue: string;
 }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
 
 export declare const OrcSearch: __VLS_WithTemplateSlots_4< DefineComponent<ExtractPropTypes<__VLS_WithDefaults_4<__VLS_TypePropsToRuntimeProps_4<{
@@ -1214,7 +1204,7 @@ export declare interface OrcSearchItem extends RecordAny {
      * - `'date'` — 日期选择器（配合 `multiple: true` 可实现日期范围）
      * - `'number'` — 数字输入框（配合 `min`/`max` 限制范围）
      */
-    type?: 'input' | 'select' | 'date' | 'number';
+    type?: 'input' | 'select' | 'date' | 'number' | string;
     /** 字段名（对应提交数据的 key） */
     name: string;
     /** 显示标签 */
@@ -1260,7 +1250,7 @@ export declare const OrcTable: __VLS_WithTemplateSlots_3< DefineComponent<Extrac
     getSelection(): RecordAny_2[];
     getCheckboxKeySelection(keys?: string[] | undefined): RecordAny_2[];
     getReserveSelection(): RecordAny_2[];
-    clearSelection(): void; /** 计算分页信息 */
+    clearSelection(): void;
     insertRow(record: RecordAny_2, row?: number | RecordAny_2 | undefined, isNext?: boolean | undefined): Promise<{
         row: RecordAny_2;
         rows: RecordAny_2[];
@@ -1273,16 +1263,14 @@ export declare const OrcTable: __VLS_WithTemplateSlots_3< DefineComponent<Extrac
     setSelectionRow(row: any, bool?: boolean | undefined): void;
     loading: Ref<boolean, boolean>;
     setLoading: typeof setLoading;
-    /** 执行搜索 ,是否返回第一页 */
     dataInit(isFirst?: boolean | undefined): Promise<void>;
-    /** 加载数据 */
     loadData(list: any[]): void;
 }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
     "update:selectedKeys": (...args: any[]) => void;
     confirm: (...args: any[]) => void;
     change: (...args: any[]) => void;
-    cellClick: (...args: any[]) => void;
     onReset: (...args: any[]) => void;
+    cellClick: (...args: any[]) => void;
     cellDblclick: (...args: any[]) => void;
 }, string, PublicProps, Readonly< ExtractPropTypes<__VLS_WithDefaults_3<__VLS_TypePropsToRuntimeProps_3<Props_2>, {
     isHover: boolean;
@@ -1297,13 +1285,13 @@ export declare const OrcTable: __VLS_WithTemplateSlots_3< DefineComponent<Extrac
     "onUpdate:selectedKeys"?: ((...args: any[]) => any) | undefined;
     onConfirm?: ((...args: any[]) => any) | undefined;
     onChange?: ((...args: any[]) => any) | undefined;
-    onCellClick?: ((...args: any[]) => any) | undefined;
     onOnReset?: ((...args: any[]) => any) | undefined;
+    onCellClick?: ((...args: any[]) => any) | undefined;
     onCellDblclick?: ((...args: any[]) => any) | undefined;
 }>, {
     data: RecordAny_2[];
     option: OrcTableOption;
-    size: "large" | "medium" | "small" | "mini";
+    size: "medium" | "large" | "small" | "mini";
     locale: I18nType;
     isHover: boolean;
     selectedKeys: string[];
@@ -1317,7 +1305,7 @@ export declare const OrcTable: __VLS_WithTemplateSlots_3< DefineComponent<Extrac
         rowIndex: number;
         columnIndex: number;
         value: any;
-        updateValue: (value: string | number | boolean | RecordAny_2 | null) => void;
+        updateValue: (newValue: any) => void;
         formatValue: any;
     }): any;
     footer?(_: {}): any;
@@ -1432,6 +1420,14 @@ export declare interface OrcTableItem extends RecordAny_2 {
     filterMultiple?: boolean;
     /** 自定义过滤方法 */
     filterMethod?: VxeColumnPropTypes.FilterMethod;
+    /** 数据类型 */
+    dataType?: 'link' | 'number' | 'date' | 'time' | 'string' | 'status';
+    /** orc-search 联动  */
+    search?: {
+        show?: boolean;
+        hidden?: boolean;
+        options?: RecordAny_2[];
+    } & RecordAny_2;
 }
 
 /**
@@ -1579,33 +1575,17 @@ declare interface Props {
 }
 
 declare type Props_2 = {
-    /** 表格标题，显示在工具栏左侧 */
     title?: string;
-    /** 表格高度（像素或百分比） */
     height?: number | string;
-    /** 多语言 */
     locale?: I18nType;
-    /** 是否隐藏工具栏 */
     hideToolbar?: boolean;
-    /** 是否隐藏列设置按钮 */
     hideSetting?: boolean;
-    /** 是否隐藏底部分页 */
     hidePagination?: boolean;
-    /** 是否启用行悬停效果，默认 true */
     isHover?: boolean;
-    /** 表格尺寸 */
     size?: 'large' | 'medium' | 'small' | 'mini';
-    /** 选中行 key 列表（v-model） */
     selectedKeys?: string[];
-    /** 静态数据源 */
     data?: RecordAny_2[];
-    /** 表格配置 */
     option?: OrcTableOption;
-    /**
-     * 列配置持久化钩子
-     * - getColumn: 异步获取用户保存的列配置，返回 `[err, columns]`
-     * - setColumn: 保存用户调整后的列配置
-     */
     hook?: {
         getColumn: () => Promise<[boolean, RecordAny_2[]]>;
         setColumn: (list: RecordAny_2[]) => void;
@@ -1641,20 +1621,7 @@ declare type Props_4 = {
     printData?: Record<string, any>;
 };
 
-/**
- * 并发执行一组异步任务函数，并返回按顺序排列的结果数组。
- * 如果某个任务出错，则对应位置返回 `null`，不会中断其他任务。
- *
- * @description https://github.com/sindresorhus/p-queue
- * @template T - 每个任务成功时返回的数据类型
- * @param {(() => Promise<T>)[]} tasks - 要并发执行的一组无参异步任务函数数组
- * @param {number} [concurrency=5] - 最大并发数量，默认为 5
- *   - 最小值：1
- *   - 最大值：Infinity
- * @returns {Promise<(T | null)[]>} - 返回一个 Promise，解析为结果数组：
- *   - 成功：T 类型的值
- *   - 失败：null
- */
+/** 并发执行异步任务，失败项null @example const results = await queueMap([fn1, fn2]) */
 export declare function queueMap<T>(tasks: (() => Promise<T>)[], concurrency?: number): Promise<(T | null)[]>;
 
 export declare type RecordAny = Record<string, any>;
@@ -1802,7 +1769,7 @@ export declare const useDictStore: StoreDefinition<"orc-dict", Pick<{
  */
 export declare function useOrcSearch(initialList: OrcSearchItem[] | (() => OrcSearchItem[]), local?: Ref<string>): readonly [Ref<{
     [x: string]: any;
-    type?: "number" | "input" | "select" | "date" | undefined;
+    type?: string | undefined;
     name: string;
     label: string;
     defaultValue?: string | number | boolean | string[] | undefined;
@@ -1821,7 +1788,7 @@ export declare function useOrcSearch(initialList: OrcSearchItem[] | (() => OrcSe
     rules?: RecordAny | RecordAny[] | undefined;
 }[], OrcSearchItem[] | {
     [x: string]: any;
-    type?: "number" | "input" | "select" | "date" | undefined;
+    type?: string | undefined;
     name: string;
     label: string;
     defaultValue?: string | number | boolean | string[] | undefined;