@aoao-y33/ui 0.0.2 → 0.0.5

package/README.md

@@ -27,17 +27,6 @@ yarn add @aoao-y33/ui
 
 ## 🚀 快速开始
 
-### 全局引入
-
-````typescript
-import { createApp } from 'vue' 
-import AoaoUI from '@aoao-y33/ui' 
-import App from './App.vue'
-const app = createApp(App) 
-app.use(AoaoUI) 
-app.mount('#app')
-````
-
 ### 按需引入
 
 ```typescript

package/dist/button/components/button/props.d.ts

@@ -2,20 +2,63 @@ import { buttonFields } from '../..';
 import { ButtonProps } from 'element-plus';
 import { EmitsToEventProps } from '@aoao-y33/utils';
 import { Component } from 'vue';
+/**
+ * AxButton 按钮组件属性接口
+ * @template E - 事件数据类型，用于控制按钮显示/隐藏的上下文数据
+ * @template T - Element Plus ButtonProps 类型扩展
+ */
 export interface AxButtonProps<E = any, T = ButtonProps> {
+    /** 按钮显示的文本内容 */
     text?: string;
+    /**
+     * 按钮类型，对应预定义的按钮样式配置
+     * @see buttonFields - 预定义的按钮类型映射表
+     */
     type?: keyof typeof buttonFields;
+    /** Element Plus 按钮的额外属性配置 */
     componentProps?: T;
+    /** 自定义 CSS 类名 */
     className?: string;
+    /**
+     * 按钮图标，支持字符串（图标类名）或 Vue 组件形式
+     * @example "el-icon-search" | IconComponent
+     */
     icon?: string | Component;
+    /**
+     * 按钮禁用状态控制
+     * - 布尔值：直接设置禁用状态
+     * - 函数：根据上下文数据动态计算禁用状态
+     * @param data - 传入的上下文数据
+     * @returns 是否禁用
+     */
     disabled?: ((data: E) => boolean) | (boolean);
+    /**
+     * 按钮隐藏状态控制
+     * - 布尔值：直接设置隐藏状态
+     * - 函数：根据上下文数据动态计算隐藏状态
+     * @param data - 传入的上下文数据
+     * @returns 是否隐藏
+     */
     hidden?: ((data: E) => boolean) | (boolean);
+    /** 是否添加左边距，用于按钮间距控制 */
     isMl?: boolean;
 }
+/**
+ * AxButton 按钮组件事件发射接口
+ * @template T - 事件携带的数据类型
+ */
 export interface AxButtonEmits<T = any> {
+    /** 单击事件 */
     "click": [data: T];
+    /** 双击事件 */
     "dblClick": [data: T];
 }
+/**
+ * AxButton 按钮配置选项接口
+ * 继承自 AxButtonProps 并合并事件处理属性
+ * @template E - 事件数据类型
+ * @template T - Element Plus ButtonProps 类型扩展
+ */
 export interface AxButtonOptions<E = any, T = ButtonProps> extends AxButtonProps<E, T>, Partial<EmitsToEventProps<AxButtonEmits<E>>> {
 }
 //# sourceMappingURL=props.d.ts.map

package/dist/button/components/button/props.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../../src/button/components/button/props.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,UAAU,CAAC;AACtC,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,iBAAiB,CAAC;AACvD,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,KAAK,CAAC;AAEnC,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,WAAW;IACnD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,OAAO,YAAY,CAAA;IAChC,cAAc,CAAC,EAAE,CAAC,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAC,MAAM,GAAC,SAAS,CAAC;IACvB,QAAQ,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IAC7C,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IAC3C,IAAI,CAAC,EAAC,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,GAAG;IAClC,OAAO,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;IAClB,UAAU,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;CACxB;AAED,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,WAAW,CACrD,SAAQ,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,EACvB,OAAO,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;CACnD"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../../src/button/components/button/props.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,UAAU,CAAC;AACtC,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,iBAAiB,CAAC;AACvD,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,KAAK,CAAC;AAEnC;;;;GAIG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,WAAW;IACnD,gBAAgB;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,OAAO,YAAY,CAAA;IAEhC,6BAA6B;IAC7B,cAAc,CAAC,EAAE,CAAC,CAAA;IAElB,iBAAiB;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,IAAI,CAAC,EAAC,MAAM,GAAC,SAAS,CAAC;IAEvB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IAE7C;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IAE3C,uBAAuB;IACvB,IAAI,CAAC,EAAC,OAAO,CAAA;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,GAAG;IAClC,WAAW;IACX,OAAO,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;IAClB,WAAW;IACX,UAAU,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,WAAW,CACrD,SAAQ,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,EACvB,OAAO,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;CACnD"}

package/dist/button/utils/index.d.ts

@@ -1,4 +1,24 @@
 import { Component } from 'vue';
+/**
+ * 按钮类型注册表
+ * 存储自定义按钮类型与对应组件的映射关系
+ * @example
+ * // 注册自定义按钮
+ * addButtonField('primary', CustomButtonComponent)
+ */
 export declare const buttonFields: Record<string, Component>;
+/**
+ * 注册新的按钮类型
+ * 将自定义按钮组件添加到按钮类型注册表中
+ *
+ * @param type - 按钮类型标识符（唯一）
+ * @param component - 对应的 Vue 组件
+ *
+ * @warning 如果类型已存在，会输出警告信息但不会阻止注册
+ *
+ * @example
+ * import CustomButton from './CustomButton.vue'
+ * addButtonField('custom', CustomButton)
+ */
 export declare const addButtonField: (type: string, component: Component) => void;
 //# sourceMappingURL=index.d.ts.map

package/dist/button/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/button/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,KAAK,CAAC;AACnC,eAAO,MAAM,YAAY,EAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAK,CAAC;AACxD,eAAO,MAAM,cAAc,GAAG,MAAK,MAAM,EAAC,WAAU,SAAS,SAK5D,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/button/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,KAAK,CAAC;AAEnC;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,EAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAK,CAAC;AAExD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,cAAc,GAAG,MAAK,MAAM,EAAC,WAAU,SAAS,SAO5D,CAAA"}

package/dist/common/utils/iconUtils.d.ts

@@ -1,2 +1,18 @@
+/**
+ * 根据图标名称获取 Element Plus 图标组件
+ *
+ * @param icon - 图标名称（需与 Element Plus Icons 中的导出名称一致）
+ * @returns 对应的图标组件，如果不存在则返回 undefined
+ *
+ * @example
+ * // 获取搜索图标
+ * const SearchIcon = getIcons('Search')
+ *
+ * @example
+ * // 在模板中使用
+ * <component :is="getIcons('HomeFilled')" />
+ *
+ * @see {@link https://element-plus.org/zh-CN/component/icon.html Element Plus Icons}
+ */
 export declare const getIcons: (icon: string) => any;
 //# sourceMappingURL=iconUtils.d.ts.map

package/dist/common/utils/iconUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"iconUtils.d.ts","sourceRoot":"","sources":["../../../src/common/utils/iconUtils.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,QAAQ,GAAI,MAAM,MAAM,QAEpC,CAAA"}
+{"version":3,"file":"iconUtils.d.ts","sourceRoot":"","sources":["../../../src/common/utils/iconUtils.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,QAAQ,GAAI,MAAM,MAAM,QAEpC,CAAA"}

package/dist/form/components/fields/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/components/fields/index.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,cAAc,YAM1B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/form/components/fields/index.ts"],"names":[],"mappings":"AAeA,eAAO,MAAM,cAAc,YAmB1B,CAAA"}

package/dist/form/components/form/form.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"form.vue.d.ts","sourceRoot":"","sources":["../../../../src/form/components/form/form.vue"],"names":[],"mappings":"AAmIA,OAAO,EAA+B,KAAK,YAAY,EAAC,MAAM,cAAc,CAAC;AAE7E,OAAO,KAAK,EAAc,WAAW,EAAC,MAAM,SAAS,CAAC;AAKtD,KAAK,WAAW,GAAG,WAAW,CAAC;AA2M/B,QAAA,IAAuB,QAAQ,IAAW,EAAE,QAAQ,IAAY,CAAE;AAClE,KAAK,WAAW,GAAG,EAAE,GACnB;IAAE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,QAAQ,KAAK,GAAG,CAAA;CAAE,GAC7C;IAAE,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,QAAQ,KAAK,GAAG,CAAA;CAAE,CAAC;AAO/C,QAAA,MAAM,UAAU;;;;;;;;;;;0BAjJa,MAAM;;;wBAWR,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;;;;;;;;;kFA0I5C,CAAC;AACH,QAAA,MAAM,YAAY,EAAS,eAAe,CAAC,OAAO,UAAU,EAAE,WAAW,CAAC,CAAC;wBACtD,OAAO,YAAY;AAAxC,wBAAyC;AACzC,KAAK,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAChC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KACV,CAAA;CACD,CAAC"}
+{"version":3,"file":"form.vue.d.ts","sourceRoot":"","sources":["../../../../src/form/components/form/form.vue"],"names":[],"mappings":"AAqIA,OAAO,EAA+B,KAAK,YAAY,EAAC,MAAM,cAAc,CAAC;AAE7E,OAAO,KAAK,EAAc,WAAW,EAAC,MAAM,SAAS,CAAC;AAKtD,KAAK,WAAW,GAAG,WAAW,CAAC;AA6M/B,QAAA,IAAuB,QAAQ,IAAW,EAAE,QAAQ,IAAY,CAAE;AAClE,KAAK,WAAW,GAAG,EAAE,GACnB;IAAE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,QAAQ,KAAK,GAAG,CAAA;CAAE,GAC7C;IAAE,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,QAAQ,KAAK,GAAG,CAAA;CAAE,CAAC;AAO/C,QAAA,MAAM,UAAU;;;;;;;;;;;0BAjJa,MAAM;;;wBAWR,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;;;;;;;;;kFA0I5C,CAAC;AACH,QAAA,MAAM,YAAY,EAAS,eAAe,CAAC,OAAO,UAAU,EAAE,WAAW,CAAC,CAAC;wBACtD,OAAO,YAAY;AAAxC,wBAAyC;AACzC,KAAK,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAChC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KACV,CAAA;CACD,CAAC"}

package/dist/form/components/form/props.d.ts

@@ -3,19 +3,62 @@ import { AxButtonOptions, AxButtonProps } from '../../../button';
 import { FetchOptions, FieldsConfig, RequestFetch } from '@aoao-y33/hooks';
 import { EmitsToEventProps } from '@aoao-y33/utils';
 import { AxFormItemOptions } from '../..';
+/**
+ * AxForm 表单组件属性接口
+ * 继承自 Element Plus FormProps，扩展了自定义功能
+ * @template T - 表单数据类型，必须是对象类型
+ */
 export interface AxFormProps<T extends Record<string, any> = any> extends Omit<FormProps, 'model'> {
+    /** 是否使用默认配置，启用后将自动应用预设的表单样式和行为 */
     isDefault?: boolean;
+    /** 提交按钮的配置项，用于自定义表单提交按钮的外观和行为 */
     submitButton?: AxButtonProps;
+    /** 表单提交时的加载状态，通常在异步请求期间显示 */
     loading?: boolean;
+    /**
+     * API 请求函数，用于表单数据提交
+     * @see RequestFetch - 请求函数类型定义
+     */
     api?: RequestFetch<T, any>;
+    /**
+     * API 请求配置项，包含请求参数、拦截器等配置
+     * @see FetchOptions - 请求配置选项类型
+     */
     apiConfig?: FetchOptions<T, any>;
 }
+/**
+ * AxForm 表单组件事件发射接口
+ * @template T - 表单数据类型
+ */
 export interface AxFormEmits<T extends Record<string, any> = Record<string, any>> {
+    /**
+     * 表单提交事件
+     * @param data - 表单提交的数据
+     */
     'submit': [data: T];
+    /**
+     * 表单数据变化事件
+     * @param data - 变化后的表单数据
+     */
     'change': [data: T];
 }
+/**
+ * AxForm 表单配置选项接口
+ * 继承自 AxFormProps 并合并事件处理属性和字段配置
+ * @template T - 表单数据类型
+ */
 export interface AxFormOptions<T extends Record<string, any> = any> extends AxFormProps<T>, Partial<EmitsToEventProps<AxFormEmits<T>>> {
+    /**
+     * 按钮配置映射表，用于配置表单中的各种按钮（提交、重置等）
+     * @see FieldsConfig - 字段配置类型
+     * @see AxButtonOptions - 按钮选项类型
+     */
     buttonConfig?: FieldsConfig<AxButtonOptions>;
+    /**
+     * 表单项配置映射表，用于配置表单中各个字段的属性、验证规则等
+     * @see FieldsConfig - 字段配置类型
+     * @see AxFormItemOptions - 表单项选项类型
+     */
     fieldConfig?: FieldsConfig<AxFormItemOptions>;
 }
 //# sourceMappingURL=props.d.ts.map

package/dist/form/components/form/props.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../../src/form/components/form/props.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EAAC,eAAe,EAAE,aAAa,EAAC,MAAM,UAAU,CAAC;AAC7D,OAAO,KAAK,EAAC,YAAY,EAAE,YAAY,EAAE,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAC9E,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,iBAAiB,CAAC;AACvD,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,QAAQ,CAAC;AAG9C,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,CAAE,SAAQ,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC;IAC9F,SAAS,CAAC,EAAC,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,aAAa,CAAC;IAC7B,OAAO,CAAC,EAAC,OAAO,CAAC;IACjB,GAAG,CAAC,EAAC,YAAY,CAAC,CAAC,EAAC,GAAG,CAAC,CAAC;IACzB,SAAS,CAAC,EAAC,YAAY,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAC5E,QAAQ,EAAC,CAAC,IAAI,EAAC,CAAC,CAAC,CAAC;IAClB,QAAQ,EAAC,CAAC,IAAI,EAAC,CAAC,CAAC,CAAC;CACrB;AAED,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,CAClE,SAAQ,WAAW,CAAC,CAAC,CAAC,EAAC,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7D,YAAY,CAAC,EAAC,YAAY,CAAC,eAAe,CAAC,CAAA;IAC3C,WAAW,CAAC,EAAC,YAAY,CAAC,iBAAiB,CAAC,CAAA;CAC/C"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../../src/form/components/form/props.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EAAC,eAAe,EAAE,aAAa,EAAC,MAAM,UAAU,CAAC;AAC7D,OAAO,KAAK,EAAC,YAAY,EAAE,YAAY,EAAE,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAC9E,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,iBAAiB,CAAC;AACvD,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,QAAQ,CAAC;AAE9C;;;;GAIG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,CAAE,SAAQ,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC;IAC9F,kCAAkC;IAClC,SAAS,CAAC,EAAC,OAAO,CAAC;IAEnB,iCAAiC;IACjC,YAAY,CAAC,EAAE,aAAa,CAAC;IAE7B,6BAA6B;IAC7B,OAAO,CAAC,EAAC,OAAO,CAAC;IAEjB;;;OAGG;IACH,GAAG,CAAC,EAAC,YAAY,CAAC,CAAC,EAAC,GAAG,CAAC,CAAC;IAEzB;;;OAGG;IACH,SAAS,CAAC,EAAC,YAAY,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAC5E;;;OAGG;IACH,QAAQ,EAAC,CAAC,IAAI,EAAC,CAAC,CAAC,CAAC;IAElB;;;OAGG;IACH,QAAQ,EAAC,CAAC,IAAI,EAAC,CAAC,CAAC,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,CAC9D,SAAQ,WAAW,CAAC,CAAC,CAAC,EAAC,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IACjE;;;;OAIG;IACH,YAAY,CAAC,EAAC,YAAY,CAAC,eAAe,CAAC,CAAA;IAE3C;;;;OAIG;IACH,WAAW,CAAC,EAAC,YAAY,CAAC,iBAAiB,CAAC,CAAA;CAC/C"}

package/dist/form/components/form-item/props.d.ts

@@ -1,14 +1,43 @@
 import { FormItemProps } from 'element-plus';
+/**
+ * AxFormItem 表单项组件属性接口
+ * 继承自 Element Plus FormItemProps，扩展了自定义字段配置功能
+ */
 export interface AxFormItemProps extends FormItemProps {
+    /** 字段名称，用于表单数据绑定和验证的唯一标识 */
     fieldName: string;
+    /** 表单项的标签文本，显示在输入框左侧或上方 */
     label?: string;
+    /**
+     * 表单项类型，决定渲染的输入组件类型
+     * @example 'input' | 'select' | 'textarea' | 'date-picker' 等
+     */
     type?: string;
+    /**
+     * 验证规则类型数组，用于表单字段验证
+     * @example ['required', 'email', 'phone'] 等预定义验证规则
+     */
     vtypes?: string[];
+    /** 字段的默认值，当表单初始化时自动填充 */
     defaultValue?: any;
+    /**
+     * 底层组件的额外属性配置
+     * 透传给实际渲染的输入组件（如 Input、Select 等）
+     */
     componentProps?: Record<string, any>;
+    /** 输入框的占位符文本，提示用户输入内容 */
     placeholder?: string;
 }
+/**
+ * AxFormItem 表单项配置选项接口
+ * 继承自 AxFormItemProps，增加了插槽配置能力
+ */
 export interface AxFormItemOptions extends AxFormItemProps {
+    /**
+     * 自定义插槽配置，用于覆盖表单项的默认渲染内容
+     * key 为插槽名称，value 为插槽内容或渲染函数
+     * @example { default: () => h('div', '自定义内容') }
+     */
     slots?: Record<string, any>;
 }
 //# sourceMappingURL=props.d.ts.map

package/dist/form/components/form-item/props.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../../src/form/components/form-item/props.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,cAAc,CAAC;AAEhD,MAAM,WAAW,eAAgB,SAAQ,aAAa;IAClD,SAAS,EAAC,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,cAAc,CAAC,EAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACnC,WAAW,CAAC,EAAC,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACtD,KAAK,CAAC,EAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC7B"}
+{"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../../../src/form/components/form-item/props.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,cAAc,CAAC;AAEhD;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,aAAa;IAClD,4BAA4B;IAC5B,SAAS,EAAC,MAAM,CAAC;IAEjB,2BAA2B;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB,yBAAyB;IACzB,YAAY,CAAC,EAAE,GAAG,CAAC;IAEnB;;;OAGG;IACH,cAAc,CAAC,EAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAEnC,yBAAyB;IACzB,WAAW,CAAC,EAAC,MAAM,CAAA;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACtD;;;;OAIG;IACH,KAAK,CAAC,EAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC7B"}

package/dist/form/hoc/useForm.d.ts

@@ -2,12 +2,55 @@ import { AxFormItemOptions, AxFormOptions, FormApi, FormFetchApi } from '..';
 import { AxButtonOptions } from '../../button';
 import { FieldsApi, StateApi } from '@aoao-y33/hooks';
 import { Component } from 'vue';
+/**
+ * UseForm 返回值中的 API 接口
+ * 扩展了基础表单 API，提供完整的表单控制能力
+ * @template T - 表单数据类型
+ */
 export interface UseFormApi<T extends Record<string, any>> extends FormApi<T> {
+    /**
+     * 表单属性状态管理器
+     * 用于动态更新表单配置（不包含 buttonConfig 和 fieldConfig）
+     */
     setForm: StateApi<Omit<AxFormOptions, 'buttonConfig' | 'fieldConfig'>>;
+    /** 表单请求 API，用于执行表单提交等异步操作 */
     requestApi: FormFetchApi<T>;
+    /** 按钮组件池 API，用于管理表单中的按钮配置 */
     buttonsApi: FieldsApi<AxButtonOptions>;
+    /** 表单项组件池 API，用于管理表单字段的配置 */
     fieldsApi: FieldsApi<AxFormItemOptions>;
 }
+/**
+ * UseForm Hook 的返回类型
+ * 包含渲染组件和 API 接口的元组
+ * @template T - 表单数据类型
+ */
 export type UseFormReturn<T extends Record<string, any>> = [Component, UseFormApi<T>];
+/**
+ * 表单 Hook，用于创建可配置的表单组件
+ *
+ * 该 Hook 封装了表单的核心逻辑，包括：
+ * - 表单状态管理
+ * - 按钮和表单项的动态配置
+ * - 表单验证和提交
+ * - 组件渲染
+ *
+ * @param options - 表单初始配置选项
+ * @returns [Form 组件, Form API] 元组
+ *
+ * @example
+ * const [Form, formApi] = useForm({
+ *   api: submitData,
+ *   fieldConfig: { /* 字段配置 *\/ },
+ *   buttonConfig: { /* 按钮配置 *\/ }
+ * })
+ *
+ * // 在模板中使用
+ * <Form />
+ *
+ * // 通过 API 操作表单
+ * formApi.fieldsApi.addField('username', { label: '用户名', type: 'input' })
+ * formApi.requestApi.submit()
+ */
 export declare function useForm<T extends Record<string, any>>(options?: AxFormOptions<T>): UseFormReturn<T>;
 //# sourceMappingURL=useForm.d.ts.map

package/dist/form/hoc/useForm.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useForm.d.ts","sourceRoot":"","sources":["../../../src/form/hoc/useForm.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,iBAAiB,EAA8B,MAAM,QAAQ,CAAC;AAE/F,OAAO,EAAE,KAAK,eAAe,EAAC,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAC,KAAK,SAAS,EAA6B,MAAM,iBAAiB,CAAC;AAE3E,OAAO,KAAK,EAAiB,aAAa,EAAE,OAAO,EAAE,YAAY,EAAC,MAAM,QAAQ,CAAC;AACjF,OAAO,KAAK,EAAE,QAAQ,EAAC,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAC,KAAK,SAAS,EAAoC,MAAM,KAAK,CAAC;AAGtE,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAE,SAAQ,OAAO,CAAC,CAAC,CAAC;IACzE,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,cAAc,GAAC,aAAa,CAAC,CAAC,CAAA;IACpE,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;IAC3B,UAAU,EAAE,SAAS,CAAC,eAAe,CAAC,CAAA;IACtC,SAAS,EAAE,SAAS,CAAC,iBAAiB,CAAC,CAAA;CAC1C;AAED,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAEtF,wBAAgB,OAAO,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,GAAE,aAAa,CAAC,CAAC,CAAM,GAAG,aAAa,CAAC,CAAC,CAAC,CAyBvG"}
+{"version":3,"file":"useForm.d.ts","sourceRoot":"","sources":["../../../src/form/hoc/useForm.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,iBAAiB,EAA8B,MAAM,QAAQ,CAAC;AAE/F,OAAO,EAAE,KAAK,eAAe,EAAC,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAC,KAAK,SAAS,EAA6B,MAAM,iBAAiB,CAAC;AAE3E,OAAO,KAAK,EAAiB,aAAa,EAAE,OAAO,EAAE,YAAY,EAAC,MAAM,QAAQ,CAAC;AACjF,OAAO,KAAK,EAAE,QAAQ,EAAC,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAC,KAAK,SAAS,EAAoC,MAAM,KAAK,CAAC;AAEtE;;;;GAIG;AACH,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAE,SAAQ,OAAO,CAAC,CAAC,CAAC;IACzE;;;OAGG;IACH,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,cAAc,GAAC,aAAa,CAAC,CAAC,CAAA;IAEpE,6BAA6B;IAC7B,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;IAE3B,6BAA6B;IAC7B,UAAU,EAAE,SAAS,CAAC,eAAe,CAAC,CAAA;IAEtC,6BAA6B;IAC7B,SAAS,EAAE,SAAS,CAAC,iBAAiB,CAAC,CAAA;CAC1C;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAEtF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,OAAO,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,GAAE,aAAa,CAAC,CAAC,CAAM,GAAG,aAAa,CAAC,CAAC,CAAC,CAyCvG"}

package/dist/form/utils/index.d.ts

@@ -1,9 +1,74 @@
 import { Component } from 'vue';
 import { FormItemRule } from 'element-plus';
+/**
+ * 表单项验证规则类型
+ * 支持三种形式的规则定义：
+ * - 直接的 FormItemRule 对象
+ * - 返回 FormItemRule 的函数（无参数）
+ * - 返回 FormItemRule 的函数（接收类型和标签参数）
+ */
 export type VFormItemRule = FormItemRule | (() => FormItemRule) | ((type: string, label?: string) => FormItemRule);
+/**
+ * 表单字段组件注册表
+ * 存储字段类型与对应 Vue 组件的映射关系
+ * @example
+ * // 注册自定义输入组件
+ * formFields['custom-input'] = CustomInputComponent
+ */
 export declare const formFields: Record<string, Component>;
+/**
+ * 表单验证规则注册表
+ * 预定义了常用的表单验证规则
+ *
+ * 内置规则包括：
+ * - required: 必填验证，根据字段类型自动显示"请输入"或"请选择"
+ * - required2: 自定义验证器实现的必填验证
+ * - phone: 手机号格式验证（11位数字，以1开头，第二位3-9）
+ * - tel: 电话号码格式验证（带可选区号）
+ * - mail: 邮箱地址格式验证
+ */
 export declare const formRules: Record<string, VFormItemRule>;
+/**
+ * 注册新的表单字段组件
+ * 将自定义组件添加到表单字段注册表中
+ *
+ * @param type - 字段类型标识符（唯一）
+ * @param component - 对应的 Vue 组件
+ *
+ * @warning 如果类型已存在，会输出警告信息并阻止重复注册
+ *
+ * @example
+ * import CustomInput from './CustomInput.vue'
+ * addFormField('custom-input', CustomInput)
+ */
 export declare const addFormField: (type: string, component: Component) => void;
+/**
+ * 注册新的表单验证规则
+ * 将自定义验证规则添加到规则注册表中
+ *
+ * @param type - 规则类型标识符（唯一）
+ * @param rule - 验证规则对象或函数
+ *
+ * @throws 如果规则类型已存在，抛出错误信息
+ *
+ * @example
+ * addFormRules('idCard', (type, label) => ({
+ *   pattern: /^\d{17}[\dXx]$/,
+ *   message: `${label}身份证号格式错误`
+ * }))
+ */
 export declare const addFormRules: (type: string, rule: any) => void;
+/**
+ * 根据字段类型获取验证提示前缀
+ * 对于选择类组件返回"请选择"，其他类型返回"请输入"
+ *
+ * @param type - 字段类型
+ * @returns 提示文本前缀
+ *
+ * @example
+ * isTip('input')      // "请输入"
+ * isTip('select')     // "请选择"
+ * isTip('checkbox')   // "请选择"
+ */
 export declare const isTip: (type: string) => "请选择" | "请输入";
 //# sourceMappingURL=index.d.ts.map

package/dist/form/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/form/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,KAAK,CAAC;AACnC,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,aAAa,GACrB,YAAY,GACV,CAAC,MAAM,YAAY,CAAC,GACpB,CAAC,CAAC,IAAI,EAAE,MAAM,EAAC,KAAK,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,CAAA;AAGrD,eAAO,MAAM,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAM,CAAC;AAExD,eAAO,MAAM,SAAS,EAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAmBlD,CAAA;AAED,eAAO,MAAM,YAAY,GAAI,MAAM,MAAM,EAAE,WAAW,SAAS,SAM9D,CAAA;AAGD,eAAO,MAAM,YAAY,GAAE,MAAK,MAAM,EAAC,MAAK,GAAG,SAK9C,CAAA;AAED,eAAO,MAAM,KAAK,GAAE,MAAK,MAAM,kBAK9B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/form/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,KAAK,CAAC;AACnC,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,cAAc,CAAC;AAE/C;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GACrB,YAAY,GACV,CAAC,MAAM,YAAY,CAAC,GACpB,CAAC,CAAC,IAAI,EAAE,MAAM,EAAC,KAAK,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,CAAA;AAErD;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAM,CAAC;AAExD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,EAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAmDlD,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,MAAM,EAAE,WAAW,SAAS,SAM9D,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,YAAY,GAAE,MAAK,MAAM,EAAC,MAAK,GAAG,SAK9C,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,KAAK,GAAE,MAAK,MAAM,kBAK9B,CAAA"}

package/dist/index.d.ts

@@ -1,12 +1,7 @@
-import { App } from 'vue';
 export * from './modal';
 export * from './button';
 export * from './form';
 export * from './layout';
 export * from './table';
 export * from './common';
-declare const _default: {
-    install(app: App): void;
-};
-export default _default;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAC,GAAG,EAAC,MAAM,KAAK,CAAC;AAC7B,OAAO,UAAU,CAAC;AAOlB,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;;iBAOR,GAAG;;AADpB,wBAgBC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,CAAC;AAM3B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC"}