znyg-frontend-common 1.0.26 → 1.0.28

package/es/components/index.d.ts

@@ -4,9 +4,10 @@ import ZnTreeFilter from './znTreeFilter/index';
 import ZnCountTo from './znCountTo/index';
 import { default as ZnForm } from './znForm/index';
 import { default as ZnTimeline, type ZnTimelineItemPro } from './znTimeLine/index';
+import { default as ZnGrid, ZnGridItem, type ZnGridProps, type ZnGridItemProps } from './znGrid/index';
 import ZnTest from './znTest/index';
 import ZnWorkGrid from './znWorkGrid';
 export { type ZnFormProps, useZnForm } from './znForm/index';
 export type { ZnWorkGridProps, ZnWorkGridItemsProps, ZnWorkGridWrokListProps } from './znWorkGrid/index';
-export type { ZnTableProps, SearchProps, ColumnProps, ZnTimelineItemPro };
-export { ZnTable, ZnTreeFilter, ZnChart, ZnCountTo, ZnTest, ZnForm, ZnTimeline, ZnWorkGrid };
+export type { ZnTableProps, SearchProps, ColumnProps, ZnTimelineItemPro, ZnGridProps, ZnGridItemProps };
+export { ZnTable, ZnTreeFilter, ZnChart, ZnCountTo, ZnTest, ZnForm, ZnTimeline, ZnWorkGrid, ZnGrid, ZnGridItem };

package/es/components/index.mjs

@@ -1,2 +1,2 @@
-export{ZnChart}from"./znChart/index.mjs";export{ZnTable}from"./znTable/index.mjs";export{ZnTreeFilter}from"./znTreeFilter/index.mjs";export{ZnCountTo}from"./znCountTo/index.mjs";export{ZnForm}from"./znForm/index.mjs";export{ZnTimeline}from"./znTimeLine/index.mjs";export{ZnTest}from"./znTest/index.mjs";export{ZnWorkGrid}from"./znWorkGrid/index.mjs";export{useZnForm}from"./znForm/src/hooks/useZnForm.mjs";
+export{ZnChart}from"./znChart/index.mjs";export{ZnTable}from"./znTable/index.mjs";export{ZnTreeFilter}from"./znTreeFilter/index.mjs";export{ZnCountTo}from"./znCountTo/index.mjs";export{ZnForm}from"./znForm/index.mjs";export{ZnTimeline}from"./znTimeLine/index.mjs";export{ZnGrid,ZnGridItem}from"./znGrid/index.mjs";export{ZnTest}from"./znTest/index.mjs";export{ZnWorkGrid}from"./znWorkGrid/index.mjs";export{useZnForm}from"./znForm/src/hooks/useZnForm.mjs";
 //# sourceMappingURL=index.mjs.map

package/es/components/znCountTo/src/countUp.d.ts

@@ -46,6 +46,12 @@ export declare class CountUp {
     once: boolean;
     constructor(target: string | HTMLElement | HTMLInputElement, endVal: number, options?: CountUpOptions);
     handleScroll(self: CountUp): void;
+    /**
+     * Smart easing works by breaking the animation into 2 parts, the second part being the
+     * smartEasingAmount and first part being the total amount minus the smartEasingAmount. It works
+     * by disabling easing for the first part and enabling it on the second part. It is used if
+     * useEasing is true and the total animation amount exceeds the smartEasingThreshold.
+     */
     private determineDirectionAndSmartEasing;
     start(callback?: (args?: any) => any): void;
     pauseResume(): void;

package/es/components/znForm/src/helper/index.d.ts

@@ -1,14 +1,56 @@
 export declare const isResponsive: (obj: any) => boolean;
+/**
+ * @description 处理 ProForm 多级 prop，将多级 prop 转为对象
+ * 如 prop 为 meta.title，则转为 { meta: { title: "" } }
+ */
 export declare const handleNestProp: (obj: Record<string, any>, delimiter?: string) => Record<string, any>;
+/**
+ * @description 处理 prop 为多级嵌套的情况，返回的数据 (列如: prop: user.name)
+ */
 export declare const getFormProp: (form: Record<string, any>, prop: string, valueFormat?: "default" | "string" | "number" | "boolean") => any;
+/**
+ * @description 对 form 对象的 pro 赋值
+ */
 export declare const setFormProp: (form: Record<string, any>, prop: string, value: any) => void;
+/**
+ * @description 是否是有效的数字（包含正负整数，0以及正负浮点数）
+ */
 export declare const isNumber: (val: string) => boolean;
+/**
+ * @description 是否为字符串
+ */
 export declare function isString(val: unknown): val is string;
 export declare const isObject: (val: any) => val is Record<any, any>;
+/**
+ * @description 补 px 单位
+ * @param val 值
+ * @returns 补 px 单位的 string
+ */
 export declare const getPx: (val: number | string | undefined) => string;
+/**
+ * @description 是否为空值项
+ */
 export declare const isEmptyVal: (val: any) => boolean;
+/**
+ * @description 将连字符转换为大驼峰格式
+ */
 export declare const hyphenToCamelCase: (val?: string) => string;
+/**
+ *
+ * @param slots 插槽属性
+ */
 export declare const setComponentSlots: (slots?: Record<string, any>) => Record<string, any>;
+/**
+ * 删除对象中的属性，包括嵌套属性
+ * @param obj 对象
+ * @param prop 对象的key
+ */
 export declare const deleteObjProperty: (obj: Record<string, any>, prop: string) => boolean;
+/**
+ * @description 处理 prop 为多级嵌套的情况，返回的数据 (列如: prop: user.name)
+ */
 export declare const getProp: (form: Record<string, any>, prop: string, valueFormat?: "default" | "string" | "number" | "boolean") => any;
+/**
+ * @description 对 form 对象的 pro 赋值
+ */
 export declare const setProp: (form: Record<string, any>, prop: string, value: any) => void;

package/es/components/znForm/src/hooks/useZnForm.d.ts

@@ -49,7 +49,9 @@ export declare const useZnForm: () => {
                 };
                 readonly labelPosition: import("element-plus/es/utils").EpPropFinalized<StringConstructor, "top" | "left" | "right", unknown, "right", boolean>;
                 readonly requireAsteriskPosition: import("element-plus/es/utils").EpPropFinalized<StringConstructor, "left" | "right", unknown, "left", boolean>;
-                readonly labelWidth: import("element-plus/es/utils").EpPropFinalized<readonly [StringConstructor, NumberConstructor], unknown, unknown, "", boolean>;
+                readonly labelWidth: import("element-plus/es/utils" /**
+                 * 动态创建表单。使用该函数，控制台会有 warning： Slot "XXX" invoked outside of the render function，可以忽略
+                 */).EpPropFinalized<readonly [StringConstructor, NumberConstructor], unknown, unknown, "", boolean>;
                 readonly labelSuffix: import("element-plus/es/utils").EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
                 readonly inline: BooleanConstructor;
                 readonly inlineMessage: BooleanConstructor;
@@ -225,14 +227,53 @@ export declare const useZnForm: () => {
         };
     };
     formMethods: {
+        /**
+         * @description 设置 ProForm 组件的 props
+         * @param props ProForm 组件的 props
+         */
         setProps: (props?: ZnFormProps) => Promise<void>;
+        /**
+         * @description 设置 form 的值
+         * @param data 需要设置的数据
+         */
         setValues: (data: Record<string, any>) => Promise<void>;
+        /**
+         * @description 设置 schema
+         * @param schemaProps 需要设置的 schemaProps
+         */
         setSchema: (schemaProps: FormSetProps[]) => Promise<void>;
+        /**
+         * @description 新增 schema
+         * @param prop 在哪里新增，number 为下标，字符串为指定的 prop
+         * @param position 如果 prop 为字符串，则指定新增到 prop 前还是后
+         */
         addSchema: (formSchema: ZnFormSchemaProps, prop?: number | string, position?: "before" | "after") => Promise<void>;
+        /**
+         * @description 删除 schema
+         * @param field 删除哪个数据
+         */
         delSchema: (prop: string) => Promise<void>;
+        /**
+         * @description 获取表单数据
+         * @returns form data
+         */
         getFormData: <T = Record<string, any>>(filterEmptyVal?: boolean) => Promise<T>;
+        /**
+         * @description 获取表单组件的实例
+         * @param prop 表单项唯一标识
+         * @returns ElForm instance
+         */
         getComponentExpose: (prop: string) => Promise<any>;
+        /**
+         * @description 获取 ElFormItem 组件的实例
+         * @param prop 表单项唯一标识
+         * @returns formItem instance
+         */
         getFormItemExpose: (prop: string) => Promise<any>;
+        /**
+         * @description 获取 ElForm 组件的实例
+         * @returns ElForm instance
+         */
         getElFormExpose: () => Promise<{
             $: import("vue").ComponentInternalInstance;
             $data: {};
@@ -451,13 +492,23 @@ export declare const useZnForm: () => {
                 default?(_: {}): any;
             };
         }>;
+        /**
+         * @description 获取 ProForm 组件的实例
+         * @returns ProForm instance
+         */
         getFormExpose: () => Promise<ProFormInstance>;
     };
     formRegister: (ref?: ProFormInstance, elRef?: FormInstance) => void;
     createMethods: {
+        /**
+         * 返回 ProForm 组件的虚拟 DOM，直接在页面中渲染该虚拟 DOM 即可。可以理解为返回一个 Vue 组件
+         */
         createFormComponent: (ZnFormProps?: ZnFormProps & Partial<ProFormOnEmits>, context?: Record<string, any>) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
             [key: string]: any;
         }>;
+        /**
+         * 动态创建表单。使用该函数，控制台会有 warning： Slot "XXX" invoked outside of the render function，可以忽略
+         */
         createForm: (el: string | Ref<HTMLElement> | ShallowRef<HTMLElement>, ZnFormProps?: ZnFormProps & Partial<ProFormOnEmits>, slots?: any) => Promise<void>;
     };
 };

package/es/components/znForm/src/interface/index.d.ts

@@ -5,6 +5,9 @@ import type { TimeSelectProps } from 'element-plus/es/components/time-select/src
 import type { ComponentPublicInstance, ComputedRef, ExtractPropTypes, InjectionKey, Ref, VNode } from 'vue';
 import { type ZnFormProps } from '../index.vue';
 import type ProForm from '../index.vue';
+/**
+ * 组件内置导入需要
+ */
 export declare enum ComponentNameEnum {
     EL_INPUT = "ElInput",
     EL_INPUT_NUMBER = "ElInputNumber",
@@ -35,14 +38,41 @@ export declare enum ComponentNameEnum {
     USER_SELECT = "UserSelect",
     ICON_PICKER = "IconPicker"
 }
+/**
+ * el 字面量
+ */
 export type PascalCaseComponentName = keyof typeof ComponentNameEnum extends infer K ? K extends string ? K extends `${infer A}_${infer B}` ? K extends `${infer A}_${infer B}_${infer C}` ? `${Capitalize<Lowercase<A>>}${Capitalize<Lowercase<B>>}${Capitalize<Lowercase<C>>}` : `${Capitalize<Lowercase<A>>}${Capitalize<Lowercase<B>>}` : Capitalize<Lowercase<K>> : never : never;
+/**
+ * el 字面量
+ */
 export type HyphenCaseComponentName = keyof typeof ComponentNameEnum extends infer K ? K extends string ? K extends `${infer A}_${infer B}` ? K extends `${infer A}_${infer B}_${infer C}` ? `${Lowercase<A>}-${Lowercase<B>}-${Lowercase<C>}` : `${Lowercase<A>}-${Lowercase<B>}` : Lowercase<K> : never : never;
+/**
+ * el 字面量
+ */
 export type FormType = PascalCaseComponentName | HyphenCaseComponentName;
+/**
+ * 基本类型
+ */
 export type ValueType = string | number | boolean | any[];
+/**
+ * 字典数据类型
+ */
 export interface FormEnumProps {
+    /**
+     * 选项框显示的文字
+     */
     label?: string;
+    /**
+     * 选项框值
+     */
     value?: ValueType;
+    /**
+     * 是否禁用此选项
+     */
     disabled?: boolean;
+    /**
+     * 为树形选择时，可以通过 children 属性指定子选项
+     */
     children?: FormEnumProps[];
     [key: string]: any;
 }
@@ -50,52 +80,161 @@ export interface ZnElFormProps extends Partial<FormProps> {
     fixWidth?: boolean;
     width?: number | string;
 }
+/**
+ * 自定义字典的 key
+ */
 export interface FormFieldNamesProps {
     label: string;
     value: string;
     disabled?: string;
     children?: string;
 }
+/**
+ * 自定义 render 的参数类型
+ */
 export interface FormRenderScope {
     model: Record<string, any>;
     data: ValueType;
     enumData: Record<string, any>;
 }
+/**
+ * setSchema 函数的参数类型
+ */
 export interface FormSetProps {
     prop: string;
     field: string;
     value: ValueType;
 }
+/**
+ * 表单配置项
+ */
 export interface ZnFormSchemaProps<T = any> {
+    /**
+     * ElCol Props
+     */
     col?: Partial<ColProps>;
+    /**
+     * ElFormItem props
+     */
     formItem?: Partial<FormItemProps>;
+    /**
+     * 表单组件 Props
+     */
     prop: string;
+    /**
+     * ElFormItem 的 label 属性
+     */
     label: ValueType | ((model: T) => any);
+    /**
+     * 使用的表单组件名
+     */
     el?: FormType;
+    /**
+     * 字典编码，如何使用字典编码，则枚举值根据code从字典中去除，无需再设置enum
+     */
     dictCode?: string;
+    /**
+     * 字典数据，如果 enum 是接口调用，那么可以指定哪个 key 获取 enum 数据，默认返回的数据作为 enum
+     */
     enum?: FormEnumProps[] | ((model: T, enumMap: Map<string, Record<string, any>>) => Promise<any>) | ComputedRef<FormEnumProps[]> | ((params?: any, enumData?: any) => Promise<any>);
+    /**
+     * 是否缓存 enum 数据
+     * @default true
+     */
     useCacheEnum?: boolean;
+    /**
+     * 从 enumMap 中获取其他的 enum 数据
+     */
     useEnumMap?: string | ((enumMap: Map<string, Record<string, any>>) => Record<string, any>);
+    /**
+     * 搭配 useEnumMap 使用，指定 enumMap 的 key
+     */
     enumKey?: string;
+    /**
+     * 字典指定 label && value && children 的 key 值
+     * @default Object { label: "label", value: "value", children: "children" }
+     */
     fieldNames?: FormFieldNamesProps;
+    /**
+     * 级联表单的 prop
+     */
     subProp?: string;
+    /**
+     * 级联表单的 enum
+     */
     subEnum?: FormEnumProps[] | ((params?: any, enumData?: any) => Promise<any> | FormEnumProps[]);
+    /**
+     * 根据 element plus 官方文档来传递，该属性所有值会透传到表单组件
+     */
     props?: InputProps | InputNumberProps | ExtractPropTypes<typeof SelectProps> | ExtractPropTypes<typeof SelectV2Props> | CascaderProps | DatePickerProps | TimePickerDefaultProps | TimeSelectProps | SwitchProps | SliderProps | RadioProps | RadioGroupProps | RadioButtonProps | CheckboxProps | CheckboxGroupProps | AutocompleteProps | RateProps | ColorPickerProps | TransferProps | DividerProps | UploadProps | any;
+    /**
+     * 表单排序（从大到小）
+     */
     order?: number;
+    /**
+     * 表单属性的默认值
+     */
     defaultValue?: ValueType | ((model: T, enumMap: Map<string, Record<string, any>>) => ValueType | any) | ComputedRef<ValueType>;
+    /**
+     * 表单组件宽度
+     */
     width?: string | number;
+    /**
+     * 自定义搜索内容渲染（tsx 语法）
+     */
     render?: (scope: FormRenderScope) => VNode;
+    /** 当isView时的自定义渲染 */
     renderInView?: (scope: FormRenderScope) => VNode;
+    /**
+     * 自定义 render 时候，需要填写 render 里表单组件使用 v-model 绑定的 prop
+     */
     renderUseProp?: string[];
+    /**
+     * 是否销毁表单，true 销毁，false 不销毁，类似于 v-if
+     * @default false
+     */
     destroy?: boolean | ((model: T) => boolean);
+    /**
+     * 是否隐藏表单，true 隐藏，false 不隐藏，类似于 v-show
+     * @default false
+     */
     hidden?: boolean | ((model: T) => boolean);
+    /**
+     * 是否在查看时隐藏表单，true 隐藏，false 不隐藏，类似于 v-show
+     * @default false
+     */
     hiddenInView?: boolean | ((model: T) => boolean);
+    /**
+     * 是否隐藏el-form-item的label
+     * @default false
+     */
     hiddenLabel?: boolean | ((model: T) => boolean);
+    /**
+     * 是否禁用表单，true 禁用，false 不禁用
+     * @default false
+     */
     disabled?: boolean | ((model: T) => boolean);
+    /**
+     * 表单绑定的值格式，针对 Enum Value 是 string "1"，而值是 number 1 导致编辑时无法匹配问题
+     * @default default
+     */
     valueFormat?: 'default' | 'string' | 'number' | 'boolean';
+    /**
+     * label 标题大小，默认 default。仅 el 为 el-divider | ElDivider 生效
+     * @default default
+     */
     labelSize?: 'default' | 'small' | 'large';
+    /**
+     * 表单组件的插槽
+     */
     slots?: any;
+    /**
+     * 其他拓展
+     */
     [key: string]: any;
 }
 export type ProFormInstance = Omit<InstanceType<typeof ProForm>, keyof ComponentPublicInstance | keyof ZnFormProps>;
+/**
+ * provide 类型
+ */
 export declare const formEnumMapKey: InjectionKey<Ref<Map<string, Record<string, any>[]>>>;

package/es/components/znGrid/index.d.ts

@@ -0,0 +1,194 @@
+import index from './src/index.vue';
+export { type ZnGridProps, type BreakPoint, type Responsive } from './src/index.vue';
+export { type ZnGridItemProps } from './src/components/GridItem.vue';
+export declare const ZnGrid: import("../../types").SFCWithInstall<import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    cols: {
+        type: (ObjectConstructor | NumberConstructor)[];
+        required: true;
+        default: () => {
+            xs: number;
+            sm: number;
+            md: number;
+            lg: number;
+            xl: number;
+        };
+    };
+    collapsed: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    collapsedRows: {
+        type: NumberConstructor;
+        required: false;
+        default: number;
+    };
+    gap: {
+        type: (ArrayConstructor | NumberConstructor)[];
+        required: false;
+        default: number;
+    };
+}>, {
+    props: any;
+    breakPoint: import("vue").Ref<import("./src/index.vue").BreakPoint, import("./src/index.vue").BreakPoint>;
+    gridCols: import("vue").ComputedRef<any>;
+    hiddenIndex: import("vue").Ref<number, number>;
+    resize: (e: UIEvent) => void;
+    slots: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+        [key: string]: any;
+    }>[];
+    findHiddenIndex: () => void;
+    gridGap: import("vue").ComputedRef<string>;
+    style: import("vue").ComputedRef<{
+        display: string;
+        gap: string;
+        gridTemplateColumns: string;
+    }>;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    cols: {
+        type: (ObjectConstructor | NumberConstructor)[];
+        required: true;
+        default: () => {
+            xs: number;
+            sm: number;
+            md: number;
+            lg: number;
+            xl: number;
+        };
+    };
+    collapsed: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    collapsedRows: {
+        type: NumberConstructor;
+        required: false;
+        default: number;
+    };
+    gap: {
+        type: (ArrayConstructor | NumberConstructor)[];
+        required: false;
+        default: number;
+    };
+}>> & Readonly<{}>, {
+    gap: number | unknown[];
+    cols: number | Record<string, any>;
+    collapsed: boolean;
+    collapsedRows: number;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>>;
+export declare const ZnGridItem: import("../../types").SFCWithInstall<import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    offset: {
+        type: NumberConstructor;
+        required: false;
+        default: number;
+    };
+    span: {
+        type: NumberConstructor;
+        required: false;
+        default: number;
+    };
+    suffix: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    xs: {
+        type: ObjectConstructor;
+        required: false;
+        default: any;
+    };
+    sm: {
+        type: ObjectConstructor;
+        required: false;
+        default: any;
+    };
+    md: {
+        type: ObjectConstructor;
+        required: false;
+        default: any;
+    };
+    lg: {
+        type: ObjectConstructor;
+        required: false;
+        default: any;
+    };
+    xl: {
+        type: ObjectConstructor;
+        required: false;
+        default: any;
+    };
+}>, {
+    props: any;
+    attrs: {
+        index: string;
+    };
+    isShow: import("vue").Ref<boolean, boolean>;
+    breakPoint: import("vue").Ref<import("./src/index.vue").BreakPoint, import("./src/index.vue").BreakPoint>;
+    shouldHiddenIndex: import("vue").Ref<number, number>;
+    gap: number;
+    cols: import("vue").Ref<number, number>;
+    style: import("vue").ComputedRef<{
+        gridColumnStart: number;
+        gridColumnEnd: string;
+        marginLeft: string;
+        gridColumn?: undefined;
+    } | {
+        gridColumn: string;
+        marginLeft: string;
+        gridColumnStart?: undefined;
+        gridColumnEnd?: undefined;
+    }>;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    offset: {
+        type: NumberConstructor;
+        required: false;
+        default: number;
+    };
+    span: {
+        type: NumberConstructor;
+        required: false;
+        default: number;
+    };
+    suffix: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    xs: {
+        type: ObjectConstructor;
+        required: false;
+        default: any;
+    };
+    sm: {
+        type: ObjectConstructor;
+        required: false;
+        default: any;
+    };
+    md: {
+        type: ObjectConstructor;
+        required: false;
+        default: any;
+    };
+    lg: {
+        type: ObjectConstructor;
+        required: false;
+        default: any;
+    };
+    xl: {
+        type: ObjectConstructor;
+        required: false;
+        default: any;
+    };
+}>> & Readonly<{}>, {
+    xs: Record<string, any>;
+    sm: Record<string, any>;
+    md: Record<string, any>;
+    lg: Record<string, any>;
+    xl: Record<string, any>;
+    offset: number;
+    span: number;
+    suffix: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>>;
+export type GridInstance = InstanceType<typeof index>;
+export default ZnGrid;

package/es/components/znGrid/index.mjs

@@ -0,0 +1,2 @@
+import{withInstall as m}from"../../utils/install.mjs";import o from"./src/index.vue.mjs";import r from"./src/components/GridItem.vue.mjs";const s=m(o),t=m(r);export{s as ZnGrid,t as ZnGridItem,s as default};
+//# sourceMappingURL=index.mjs.map

package/es/components/znGrid/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../../../../../packages/components/znGrid/index.ts"],"sourcesContent":["import { withInstall } from '../../utils/install'\r\nimport index from './src/index.vue'\r\nimport gridItem from './src/components/GridItem.vue'\r\n\r\nexport { type ZnGridProps, type BreakPoint, type Responsive } from './src/index.vue'\r\nexport { type ZnGridItemProps } from './src/components/GridItem.vue'\r\nexport const ZnGrid = withInstall(index)\r\nexport const ZnGridItem = withInstall(gridItem)\r\n\r\nexport type GridInstance = InstanceType<typeof index>\r\n\r\nexport default ZnGrid\r\n"],"names":["ZnGrid","withInstall","index","ZnGridItem","gridItem"],"mappings":"0IAMa,MAAAA,EAASC,EAAYC,GACrBC,EAAaF,EAAYG"}