@a2simcode/ui 0.0.264 → 0.0.266

package/docs/components/meta/table.ts

@@ -1,421 +1,427 @@
-export default {
-  "props": [
-    {
-      "name": "id",
-      "description": "",
-      "type": "string",
-      "default": "''"
-    },
-    {
-      "name": "modelValue",
-      "description": "输入值【作为表单的编辑表格使用】",
-      "type": "Record<string, any>[]",
-      "default": "() => []"
-    },
-    {
-      "name": "columns",
-      "description": "表格列配置（支持树形结构）",
-      "type": "ColumnSchemaConfig[]",
-      "default": "() => []"
-    },
-    {
-      "name": "columnFilter",
-      "description": "列过滤（用于隐藏列）",
-      "type": "string[]",
-      "default": "() => []"
-    },
-    {
-      "name": "records",
-      "description": "表格数据",
-      "type": "Record<string, any>[]",
-      "default": "() => []"
-    },
-    {
-      "name": "isTree",
-      "description": "是否是树形结构",
-      "type": "boolean",
-      "default": "false"
-    },
-    {
-      "name": "defaultExpandAll",
-      "description": "是否默认全部展开（仅 isTree 为 true 且非懒加载时生效）",
-      "type": "boolean",
-      "default": "false"
-    },
-    {
-      "name": "parentKey",
-      "description": "父级字段名（isTree 为 true 时用于将扁平数据转换成树形数据）",
-      "type": "string",
-      "default": "''"
-    },
-    {
-      "name": "isShowNumber",
-      "description": "是否显示序号",
-      "type": "boolean",
-      "default": "true"
-    },
-    {
-      "name": "isMultiple",
-      "description": "是否开启多选",
-      "type": "boolean",
-      "default": "false"
-    },
-    {
-      "name": "selectStateKey",
-      "description": "选状态字段名",
-      "type": "string",
-      "default": "''"
-    },
-    {
-      "name": "multipleDisabled",
-      "description": "多选禁用判断",
-      "type": "(record: Record<string, any>) => boolean",
-      "default": "null"
-    },
-    {
-      "name": "isPage",
-      "description": "是否分页",
-      "type": "boolean",
-      "default": "false"
-    },
-    {
-      "name": "pageLayoutSimple",
-      "description": "分页样式是否是简洁模式",
-      "type": "boolean",
-      "default": "false"
-    },
-    {
-      "name": "pageSizes",
-      "description": "每页显示个数选择器的选项设置",
-      "type": "array"
-    },
-    {
-      "name": "pageTotal",
-      "description": "总的数据条数",
-      "type": "number",
-      "default": "0"
-    },
-    {
-      "name": "tablePage",
-      "description": "当前页面",
-      "type": "number",
-      "default": "1"
-    },
-    {
-      "name": "pageSize",
-      "description": "当前显示页数",
-      "type": "number",
-      "default": "100"
-    },
-    {
-      "name": "rowKey",
-      "description": "行主键",
-      "type": "string",
-      "default": "'id'"
-    },
-    {
-      "name": "rowDrag",
-      "description": "是否支持行拖动排序",
-      "type": "boolean",
-      "default": "false"
-    },
-    {
-      "name": "actions",
-      "description": "行内操作按钮配置",
-      "type": "ButtonCompType[]",
-      "default": "() => []"
-    },
-    {
-      "name": "actionFilter",
-      "description": "行内操作按钮过滤方法",
-      "type": "(params: {\n  action: ButtonCompType\n  record: Record<string, any>\n  recordIndex: number\n  col: number\n  row: number\n  table: any\n}) =>\n  | boolean\n  | {\n      display?: boolean\n      disabled?: boolean\n    }\n  | null\n  | undefined",
-      "default": "null"
-    },
-    {
-      "name": "actionsMaxCount",
-      "description": "操作列最大显示按钮数量",
-      "type": "number",
-      "default": "3"
-    },
-    {
-      "name": "actionsLabel",
-      "description": "操作列标题",
-      "type": "string",
-      "default": "'操作'"
-    },
-    {
-      "name": "isAnimationAppear",
-      "description": "是否开启动画出现",
-      "type": "boolean",
-      "default": "false"
-    },
-    {
-      "name": "heightMode",
-      "description": "高度模式 full 充满父容器 auto 根据内容自适应",
-      "type": "'full' | 'auto'",
-      "default": "'full'"
-    },
-    {
-      "name": "maxHeight",
-      "description": "最大高度，仅在 heightMode 为 auto 时生效",
-      "type": "string|number",
-      "default": "undefined"
-    },
-    {
-      "name": "isRowFixed",
-      "description": "是否固定行数",
-      "type": "boolean",
-      "default": "false"
-    },
-    {
-      "name": "rowNum",
-      "description": "固定行数，仅在 isRowFixed 为 true 时生效",
-      "type": "number",
-      "default": "0"
-    },
-    {
-      "name": "highlightMode",
-      "description": "高亮模式 cross 十字 row 行 column 列 cell 单元格",
-      "type": "'cross' | 'row' | 'column' | 'cell'",
-      "default": "'row'"
-    },
-    {
-      "name": "editConfig",
-      "description": "编辑参数",
-      "type": "EditConfigType",
-      "default": "() => ({})"
-    },
-    {
-      "name": "emptyTipText",
-      "description": "空数据提示文本",
-      "type": "string",
-      "default": "'暂无数据'"
-    },
-    {
-      "name": "subColumns",
-      "description": "子表列配置",
-      "type": "any[]",
-      "default": "() => []"
-    },
-    {
-      "name": "isSubShowNumber",
-      "description": "是否显示子表序号",
-      "type": "boolean",
-      "default": "true"
-    },
-    {
-      "name": "subActions",
-      "description": "子表行内操作按钮配置",
-      "type": "ButtonCompType[]",
-      "default": "() => []"
-    },
-    {
-      "name": "loadChildren",
-      "description": "懒加载子节点数据",
-      "type": "(record: Record<string, any>) => Promise<any[]>",
-      "default": "null"
-    }
-  ],
-  "events": [
-    {
-      "name": "ready",
-      "description": "表格实例创建完成时触发",
-      "type": "any"
-    },
-    {
-      "name": "selectionChanged",
-      "description": "选中数据变化时触发",
-      "type": "{\n  isMultiple: boolean\n  selections: Record<string, any>[]\n  record: Record<string, any>\n  checked: boolean\n}"
-    },
-    {
-      "name": "selectRecordsChanged",
-      "description": "根据 selectStateKey 初始化多选选中项时触发",
-      "type": "Array"
-    },
-    {
-      "name": "update:tablePage",
-      "description": "",
-      "type": "number"
-    },
-    {
-      "name": "update:pageSize",
-      "description": "",
-      "type": "number"
-    },
-    {
-      "name": "loadPageData",
-      "description": "当前页面",
-      "type": "{ rows: number; page: number }"
-    },
-    {
-      "name": "rowChange",
-      "description": "行数据变化",
-      "type": "Record"
-    },
-    {
-      "name": "update:modelValue",
-      "description": "v-model 双向绑定更新事件",
-      "type": "Array"
-    },
-    {
-      "name": "change",
-      "description": "变更事件",
-      "type": "{\n  id: string\n  value: any\n  data: any\n  formData: Record<string, any>\n  tableData: Record<string, any>[]\n  type: 'add' | 'delete' | 'update' | 'sort'\n}"
-    }
-  ],
-  "slots": [],
-  "methods": [
-    {
-      "name": "getInstance",
-      "description": "输入值【作为表单的编辑表格使用】",
-      "type": "() => void"
-    },
-    {
-      "name": "setRecords",
-      "description": "输入值【作为表单的编辑表格使用】",
-      "type": "() => void"
-    },
-    {
-      "name": "getRecords",
-      "description": "",
-      "type": "() => void"
-    },
-    {
-      "name": "getSelection",
-      "description": "输入值【作为表单的编辑表格使用】",
-      "type": "() => void"
-    },
-    {
-      "name": "setSelection",
-      "description": "输入值【作为表单的编辑表格使用】",
-      "type": "() => void"
-    },
-    {
-      "name": "renderTable",
-      "description": "",
-      "type": "() => void"
-    }
-  ],
-  "types": [
-    {
-      "name": "TableColumnConfig",
-      "properties": [
-        {
-          "name": "width",
-          "type": "number",
-          "description": "列的宽度"
-        },
-        {
-          "name": "minWidth",
-          "type": "number",
-          "description": "列的最小宽度"
-        },
-        {
-          "name": "maxWidth",
-          "type": "number",
-          "description": "列的最大宽度"
-        },
-        {
-          "name": "align",
-          "type": "'left' | 'center' | 'right'",
-          "description": "列的对齐方式"
-        },
-        {
-          "name": "headerAlign",
-          "type": "'left' | 'center' | 'right'",
-          "description": "列标题的对齐方式，不设置时默认使用 align"
-        },
-        {
-          "name": "dataType",
-          "type": "string",
-          "description": "数据类型 dataItem 数据字典 dataView 数据视图 options 选项 user 用户 department 部门 company 公司"
-        },
-        {
-          "name": "dataCode",
-          "type": "string",
-          "description": "数据编码"
-        },
-        {
-          "name": "options",
-          "type": "Record<string, any>",
-          "description": "数据"
-        },
-        {
-          "name": "valueType",
-          "type": "string",
-          "description": "数据值类型 text, number, text_list, number_list"
-        },
-        {
-          "name": "filter",
-          "type": "TableColumnFilter",
-          "description": "列的过滤器"
-        },
-        {
-          "name": "sorter",
-          "type": "TableColumnSorter",
-          "description": "列的排序器"
-        },
-        {
-          "name": "fieldFormat",
-          "type": "(row: Record<string, any>) => any",
-          "description": "列的格式化函数"
-        },
-        {
-          "name": "frozen",
-          "type": "'left' | 'right'",
-          "description": "冻结列 left 左侧冻结 right 右侧冻结"
-        }
-      ]
-    },
-    {
-      "name": "TableColumnFilter",
-      "properties": [
-        {
-          "name": "isSearchKeyword",
-          "type": "boolean",
-          "description": "是否是搜索关键字"
-        }
-      ]
-    },
-    {
-      "name": "TableColumnSorter",
-      "properties": [
-        {
-          "name": "isNot",
-          "type": "boolean",
-          "description": "是否不需要排序"
-        }
-      ]
-    },
-    {
-      "name": "ColumnSchemaConfig",
-      "properties": [
-        {
-          "name": "id",
-          "type": "string",
-          "description": "id"
-        },
-        {
-          "name": "type",
-          "type": "string",
-          "description": "类型"
-        },
-        {
-          "name": "customLayout",
-          "type": "(args: any) => any",
-          "description": "自定义布局函数"
-        },
-        {
-          "name": "config",
-          "type": "TableColumnCompConfig & {\n    /**\n     * @zh 列的标题\n     */\n    label: string\n  }",
-          "description": "列配置"
-        },
-        {
-          "name": "children",
-          "type": "ColumnSchemaConfig[]",
-          "description": "子集"
-        }
-      ]
-    }
-  ]
-}
+export default {
+  "props": [
+    {
+      "name": "id",
+      "description": "",
+      "type": "string",
+      "default": "''"
+    },
+    {
+      "name": "label",
+      "description": "",
+      "type": "string",
+      "default": "''"
+    },
+    {
+      "name": "modelValue",
+      "description": "输入值【作为表单的编辑表格使用】",
+      "type": "Record<string, any>[]",
+      "default": "() => []"
+    },
+    {
+      "name": "columns",
+      "description": "表格列配置（支持树形结构）",
+      "type": "ColumnSchemaConfig[]",
+      "default": "() => []"
+    },
+    {
+      "name": "columnFilter",
+      "description": "列过滤（用于隐藏列）",
+      "type": "string[]",
+      "default": "() => []"
+    },
+    {
+      "name": "records",
+      "description": "表格数据",
+      "type": "Record<string, any>[]",
+      "default": "() => []"
+    },
+    {
+      "name": "isTree",
+      "description": "是否是树形结构",
+      "type": "boolean",
+      "default": "false"
+    },
+    {
+      "name": "defaultExpandAll",
+      "description": "是否默认全部展开（仅 isTree 为 true 且非懒加载时生效）",
+      "type": "boolean",
+      "default": "false"
+    },
+    {
+      "name": "parentKey",
+      "description": "父级字段名（isTree 为 true 时用于将扁平数据转换成树形数据）",
+      "type": "string",
+      "default": "''"
+    },
+    {
+      "name": "isShowNumber",
+      "description": "是否显示序号",
+      "type": "boolean",
+      "default": "true"
+    },
+    {
+      "name": "isMultiple",
+      "description": "是否开启多选",
+      "type": "boolean",
+      "default": "false"
+    },
+    {
+      "name": "selectStateKey",
+      "description": "选状态字段名",
+      "type": "string",
+      "default": "''"
+    },
+    {
+      "name": "multipleDisabled",
+      "description": "多选禁用判断",
+      "type": "(record: Record<string, any>) => boolean",
+      "default": "null"
+    },
+    {
+      "name": "isPage",
+      "description": "是否分页",
+      "type": "boolean",
+      "default": "false"
+    },
+    {
+      "name": "pageLayoutSimple",
+      "description": "分页样式是否是简洁模式",
+      "type": "boolean",
+      "default": "false"
+    },
+    {
+      "name": "pageSizes",
+      "description": "每页显示个数选择器的选项设置",
+      "type": "array"
+    },
+    {
+      "name": "pageTotal",
+      "description": "总的数据条数",
+      "type": "number",
+      "default": "0"
+    },
+    {
+      "name": "tablePage",
+      "description": "当前页面",
+      "type": "number",
+      "default": "1"
+    },
+    {
+      "name": "pageSize",
+      "description": "当前显示页数",
+      "type": "number",
+      "default": "100"
+    },
+    {
+      "name": "rowKey",
+      "description": "行主键",
+      "type": "string",
+      "default": "'id'"
+    },
+    {
+      "name": "rowDrag",
+      "description": "是否支持行拖动排序",
+      "type": "boolean",
+      "default": "false"
+    },
+    {
+      "name": "actions",
+      "description": "行内操作按钮配置",
+      "type": "ButtonCompType[]",
+      "default": "() => []"
+    },
+    {
+      "name": "actionFilter",
+      "description": "行内操作按钮过滤方法",
+      "type": "(params: {\n  action: ButtonCompType\n  record: Record<string, any>\n  recordIndex: number\n  col: number\n  row: number\n  table: any\n}) =>\n  | boolean\n  | {\n      display?: boolean\n      disabled?: boolean\n    }\n  | null\n  | undefined",
+      "default": "null"
+    },
+    {
+      "name": "actionsMaxCount",
+      "description": "操作列最大显示按钮数量",
+      "type": "number",
+      "default": "3"
+    },
+    {
+      "name": "actionsLabel",
+      "description": "操作列标题",
+      "type": "string",
+      "default": "'操作'"
+    },
+    {
+      "name": "isAnimationAppear",
+      "description": "是否开启动画出现",
+      "type": "boolean",
+      "default": "false"
+    },
+    {
+      "name": "heightMode",
+      "description": "高度模式 full 充满父容器 auto 根据内容自适应",
+      "type": "'full' | 'auto'",
+      "default": "'full'"
+    },
+    {
+      "name": "maxHeight",
+      "description": "最大高度，仅在 heightMode 为 auto 时生效",
+      "type": "string|number",
+      "default": "undefined"
+    },
+    {
+      "name": "isRowFixed",
+      "description": "是否固定行数",
+      "type": "boolean",
+      "default": "false"
+    },
+    {
+      "name": "rowNum",
+      "description": "固定行数，仅在 isRowFixed 为 true 时生效",
+      "type": "number",
+      "default": "0"
+    },
+    {
+      "name": "highlightMode",
+      "description": "高亮模式 cross 十字 row 行 column 列 cell 单元格",
+      "type": "'cross' | 'row' | 'column' | 'cell'",
+      "default": "'row'"
+    },
+    {
+      "name": "editConfig",
+      "description": "编辑参数",
+      "type": "EditConfigType",
+      "default": "() => ({})"
+    },
+    {
+      "name": "emptyTipText",
+      "description": "空数据提示文本",
+      "type": "string",
+      "default": "'暂无数据'"
+    },
+    {
+      "name": "subColumns",
+      "description": "子表列配置",
+      "type": "any[]",
+      "default": "() => []"
+    },
+    {
+      "name": "isSubShowNumber",
+      "description": "是否显示子表序号",
+      "type": "boolean",
+      "default": "true"
+    },
+    {
+      "name": "subActions",
+      "description": "子表行内操作按钮配置",
+      "type": "ButtonCompType[]",
+      "default": "() => []"
+    },
+    {
+      "name": "loadChildren",
+      "description": "懒加载子节点数据",
+      "type": "(record: Record<string, any>) => Promise<any[]>",
+      "default": "null"
+    }
+  ],
+  "events": [
+    {
+      "name": "ready",
+      "description": "表格实例创建完成时触发",
+      "type": "any"
+    },
+    {
+      "name": "selectionChanged",
+      "description": "选中数据变化时触发",
+      "type": "{\n  isMultiple: boolean\n  selections: Record<string, any>[]\n  record: Record<string, any>\n  checked: boolean\n}"
+    },
+    {
+      "name": "selectRecordsChanged",
+      "description": "根据 selectStateKey 初始化多选选中项时触发",
+      "type": "Array"
+    },
+    {
+      "name": "update:tablePage",
+      "description": "",
+      "type": "number"
+    },
+    {
+      "name": "update:pageSize",
+      "description": "",
+      "type": "number"
+    },
+    {
+      "name": "loadPageData",
+      "description": "当前页面",
+      "type": "{ rows: number; page: number }"
+    },
+    {
+      "name": "rowChange",
+      "description": "行数据变化",
+      "type": "Record"
+    },
+    {
+      "name": "update:modelValue",
+      "description": "v-model 双向绑定更新事件",
+      "type": "Array"
+    },
+    {
+      "name": "change",
+      "description": "变更事件",
+      "type": "{\n  id: string\n  value: any\n  data: any\n  formData: Record<string, any>\n  tableData: Record<string, any>[]\n  type: 'add' | 'delete' | 'update' | 'sort'\n}"
+    }
+  ],
+  "slots": [],
+  "methods": [
+    {
+      "name": "getInstance",
+      "description": "输入值【作为表单的编辑表格使用】",
+      "type": "() => void"
+    },
+    {
+      "name": "setRecords",
+      "description": "输入值【作为表单的编辑表格使用】",
+      "type": "() => void"
+    },
+    {
+      "name": "getRecords",
+      "description": "",
+      "type": "() => void"
+    },
+    {
+      "name": "getSelection",
+      "description": "输入值【作为表单的编辑表格使用】",
+      "type": "() => void"
+    },
+    {
+      "name": "setSelection",
+      "description": "输入值【作为表单的编辑表格使用】",
+      "type": "() => void"
+    },
+    {
+      "name": "renderTable",
+      "description": "",
+      "type": "() => void"
+    }
+  ],
+  "types": [
+    {
+      "name": "TableColumnConfig",
+      "properties": [
+        {
+          "name": "width",
+          "type": "number",
+          "description": "列的宽度"
+        },
+        {
+          "name": "minWidth",
+          "type": "number",
+          "description": "列的最小宽度"
+        },
+        {
+          "name": "maxWidth",
+          "type": "number",
+          "description": "列的最大宽度"
+        },
+        {
+          "name": "align",
+          "type": "'left' | 'center' | 'right'",
+          "description": "列的对齐方式"
+        },
+        {
+          "name": "headerAlign",
+          "type": "'left' | 'center' | 'right'",
+          "description": "列标题的对齐方式，不设置时默认使用 align"
+        },
+        {
+          "name": "dataType",
+          "type": "string",
+          "description": "数据类型 dataItem 数据字典 dataView 数据视图 options 选项 user 用户 department 部门 company 公司"
+        },
+        {
+          "name": "dataCode",
+          "type": "string",
+          "description": "数据编码"
+        },
+        {
+          "name": "options",
+          "type": "Record<string, any>",
+          "description": "数据"
+        },
+        {
+          "name": "valueType",
+          "type": "string",
+          "description": "数据值类型 text, number, text_list, number_list"
+        },
+        {
+          "name": "filter",
+          "type": "TableColumnFilter",
+          "description": "列的过滤器"
+        },
+        {
+          "name": "sorter",
+          "type": "TableColumnSorter",
+          "description": "列的排序器"
+        },
+        {
+          "name": "fieldFormat",
+          "type": "(row: Record<string, any>) => any",
+          "description": "列的格式化函数"
+        },
+        {
+          "name": "frozen",
+          "type": "'left' | 'right'",
+          "description": "冻结列 left 左侧冻结 right 右侧冻结"
+        }
+      ]
+    },
+    {
+      "name": "TableColumnFilter",
+      "properties": [
+        {
+          "name": "isSearchKeyword",
+          "type": "boolean",
+          "description": "是否是搜索关键字"
+        }
+      ]
+    },
+    {
+      "name": "TableColumnSorter",
+      "properties": [
+        {
+          "name": "isNot",
+          "type": "boolean",
+          "description": "是否不需要排序"
+        }
+      ]
+    },
+    {
+      "name": "ColumnSchemaConfig",
+      "properties": [
+        {
+          "name": "id",
+          "type": "string",
+          "description": "id"
+        },
+        {
+          "name": "type",
+          "type": "string",
+          "description": "类型"
+        },
+        {
+          "name": "customLayout",
+          "type": "(args: any) => any",
+          "description": "自定义布局函数"
+        },
+        {
+          "name": "config",
+          "type": "TableColumnCompConfig & {\n    /**\n     * @zh 列的标题\n     */\n    label: string\n  }",
+          "description": "列配置"
+        },
+        {
+          "name": "children",
+          "type": "ColumnSchemaConfig[]",
+          "description": "子集"
+        }
+      ]
+    }
+  ]
+}