@aoao-y33/ui 0.0.2 → 0.0.3

package/dist/table/hoc/useTable.d.ts

@@ -1,6 +1,47 @@
 import { AxTableOptions } from '..';
 import { AxFormItemOptions } from '../../form';
 import { AxButtonOptions } from '../../button';
+/**
+ * 表格 Hook，用于创建功能完整的高级表格组件
+ *
+ * 该 Hook 封装了表格的核心逻辑，包括：
+ * - 表格数据展示和分页
+ * - 搜索表单（支持动态字段配置）
+ * - 工具栏按钮（新增、删除、导出等）
+ * - 表格列配置（支持动态列）
+ * - 折叠/展开搜索区域
+ * - 数据请求和状态管理
+ *
+ * @param options - 表格初始配置选项
+ * @returns [Table 组件, Table API] 元组
+ *
+ * @example
+ * const [Table, tableApi] = useTable({
+ *   api: getUserList,
+ *   columnConfig: {
+ *     username: { label: '用户名', prop: 'username' },
+ *     email: { label: '邮箱', prop: 'email' }
+ *   },
+ *   searchConfig: {
+ *     fieldConfig: {
+ *       keyword: { label: '关键词', type: 'input' }
+ *     },
+ *     over: 2  // 超过2个字段显示折叠按钮
+ *   },
+ *   toolConfig: {
+ *     add: { text: '新增', onClick: handleAdd }
+ *   },
+ *   pageConfig: { pageSize: 10 }
+ * })
+ *
+ * // 在模板中使用
+ * <Table />
+ *
+ * // 通过 API 操作表格
+ * tableApi.requestApi.fetch()        // 刷新数据
+ * tableApi.setTable({ data: [] })    // 更新表格属性
+ * tableApi.toolsApi.addField(...)    // 动态添加工具栏按钮
+ */
 export declare function useTable<T extends Record<string, any>, R extends Record<string, any> = any>(options?: AxTableOptions<T, R>): readonly [import('vue').DefineComponent<{}, () => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
     [key: string]: any;
 }>, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>, {

package/dist/table/hoc/useTable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useTable.d.ts","sourceRoot":"","sources":["../../../src/table/hoc/useTable.ts"],"names":[],"mappings":"AAAA,OAAO,EAKH,KAAK,cAAc,EAEtB,MAAM,SAAS,CAAC;AAIjB,OAAO,EAAa,KAAK,iBAAiB,EAA8B,MAAM,QAAQ,CAAC;AACvF,OAAO,EAAW,KAAK,eAAe,EAAC,MAAM,UAAU,CAAC;AAExD,wBAAgB,QAAQ,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,OAAO,GAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqG9H"}
+{"version":3,"file":"useTable.d.ts","sourceRoot":"","sources":["../../../src/table/hoc/useTable.ts"],"names":[],"mappings":"AAAA,OAAO,EAKH,KAAK,cAAc,EAEtB,MAAM,SAAS,CAAC;AAIjB,OAAO,EAAa,KAAK,iBAAiB,EAA8B,MAAM,QAAQ,CAAC;AACvF,OAAO,EAAW,KAAK,eAAe,EAAC,MAAM,UAAU,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,OAAO,GAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsJ9H"}

package/dist/table/hoc/useTableExpose.d.ts

@@ -1,6 +1,33 @@
 import { Ref } from 'vue';
 import { AxTableInstance } from '..';
+/**
+ * TableApi 类型定义
+ * 由 useTableExpose 函数返回的 API 对象类型
+ */
 export type TableApi = ReturnType<typeof useTableExpose>;
+/**
+ * 表格暴露 API Hook，用于获取和控制表格实例的方法
+ *
+ * 该 Hook 提供了访问底层表格实例的能力，包括：
+ * - 获取 Element Plus 原生 ElTable 实例
+ * - 可调用 ElTable 的所有方法（如 clearSort、clearFilter、toggleRowSelection 等）
+ *
+ * @param table - 表格组件的 Ref 引用，指向 AxTableInstance 实例
+ * @returns 包含表格控制方法的 API 对象
+ *
+ * @example
+ * const tableRef = ref<AxTableInstance>();
+ * const tableApi = useTableExpose(tableRef);
+ *
+ * // 获取原生 ElTable 实例
+ * const elTable = tableApi.getElTable()
+ *
+ * // 调用 ElTable 的原生方法
+ * elTable?.clearSort()              // 清除排序
+ * elTable?.clearFilter()            // 清除筛选
+ * elTable?.toggleAllSelection()     // 切换全选状态
+ * elTable?.setCurrentRow(row)       // 设置当前行
+ */
 export declare function useTableExpose(table: Ref<AxTableInstance>): {
     getElTable: () => import('element-plus').TableInstance;
 };

package/dist/table/hoc/useTableExpose.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useTableExpose.d.ts","sourceRoot":"","sources":["../../../src/table/hoc/useTableExpose.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,GAAG,EAAC,MAAM,KAAK,CAAC;AAC7B,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,SAAS,CAAC;AAE7C,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAA;AAExD,wBAAgB,cAAc,CAAC,KAAK,EAAE,GAAG,CAAC,eAAe,CAAC;;EAQzD"}
+{"version":3,"file":"useTableExpose.d.ts","sourceRoot":"","sources":["../../../src/table/hoc/useTableExpose.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,GAAG,EAAC,MAAM,KAAK,CAAC;AAC7B,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,SAAS,CAAC;AAE7C;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAA;AAExD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,GAAG,CAAC,eAAe,CAAC;;EAazD"}

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

@@ -1,4 +1,30 @@
 import { Component } from 'vue';
+/**
+ * 表格列组件注册表
+ * 存储表格列类型与对应 Vue 组件的映射关系
+ * 用于扩展表格列的自定义渲染方式
+ * @example
+ * // 注册自定义列类型
+ * addTableColumnField('custom-render', CustomColumnComponent)
+ */
 export declare const tableColumnFields: Record<string, Component>;
+/**
+ * 注册新的表格列类型组件
+ * 将自定义列组件添加到表格列类型注册表中
+ *
+ * @param type - 列类型标识符（唯一）
+ * @param component - 对应的 Vue 组件，用于渲染该类型的列内容
+ *
+ * @warning 如果类型已存在，会输出警告信息并阻止重复注册
+ *
+ * @example
+ * import StatusColumn from './StatusColumn.vue'
+ * addTableColumnField('status', StatusColumn)
+ *
+ * // 在表格列配置中使用
+ * columnConfig: {
+ *   status: { type: 'status', label: '状态' }
+ * }
+ */
 export declare const addTableColumnField: (type: string, component: Component) => void;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/table/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,KAAK,CAAC;AAEnC,eAAO,MAAM,iBAAiB,EAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAI,CAAC;AAE5D,eAAO,MAAM,mBAAmB,GAAE,MAAK,MAAM,EAAC,WAAU,SAAS,SAMhE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/table/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,KAAK,CAAC;AAEnC;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,EAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAI,CAAC;AAE5D;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,mBAAmB,GAAE,MAAK,MAAM,EAAC,WAAU,SAAS,SAMhE,CAAA"}

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@aoao-y33/ui",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "private": false,
   "description": "elementPlus二次封装组件",
+
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -23,15 +24,15 @@
   "scripts": {
     "build": "vue-tsc && vite build",
     "ins": "pnpm install",
-    "pub": "npm publish --access public"
+    "pub": "npm publish  --access public"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "packageManager": "pnpm@10.32.1",
   "dependencies": {
-    "@aoao-y33/hooks": "workspace:*",
-    "@aoao-y33/utils": "workspace:*",
+    "@aoao-y33/hooks": "^0.0.3",
+    "@aoao-y33/utils": "^0.0.2",
     "@element-plus/icons-vue": "^2.3.2",
     "element-plus": "^2.14.0"
   },