br-dionysus 1.1.2 → 1.1.4

package/README.md

@@ -26,6 +26,8 @@
 
 + TabPage([标签页组件](#标签页组件))
 
++ usePackageConfig([配置保存与获取-hook](#配置保存与获取-hook))
+
 + useRemainingSpace([计算获取剩余空间-hook](#计算获取剩余空间-hook))
 
 + useTableConfig([表格组合-hook](#表格组合-hook))
@@ -1958,6 +1960,8 @@ const list = ref<{ name: string, className: string }[]>([
 
 ## Hook列表
 
++ usePackageConfig([配置保存与获取-hook](#配置保存与获取-hook))
+
 + useRemainingSpace([计算获取剩余空间-hook](#计算获取剩余空间-hook))
 
 + useTableConfig([表格组合-hook](#表格组合-hook))
@@ -1965,6 +1969,53 @@ const list = ref<{ name: string, className: string }[]>([
 + useZIndex([全局层级-hook](#全局层级-hook))
 
 
+
+
+配置保存与获取 hook
+=================
+
+### 1) 基础用法
+
+
+
+
+### 1) 所需参数
+
+| 名称         | 描述     | 类型           | 可选值 | 默认值 |
+|------------|--------|--------------|:---:|:---:|
+| name       | 表格唯一标识 | string       |  -  |  -  |
+| tableTitle | 列配置    | tableTitle[] |  -  |  -  |
+| tableData  | 表格数据   | ref<any[]>   |  -  |  -  |
+
+### 2) 返回值
+
+| 名称               | 描述      | 类型                                      |
+|------------------|---------|-----------------------------------------|
+| tableTitle       | 处理之后的表头 | TableTitle[]                            |
+| tableConfig      | 表头的配置项  | {  [propName: string]: TableConfigItem} |
+| headerDragend    | 表格拖拽事件  | function                                |
+| initColumnFilter | 列的筛选    | function                                |
+| filtersValue     | 过滤条件    | { [key: string]: Array<string,number>}  |
+
+### 3) TableTitle
+
+| 名称            | 描述                                                                   | 类型                                          |
+|---------------|----------------------------------------------------------------------|---------------------------------------------|
+| label         | 显示的标题                                                                | string                                      |
+| prop          | 字段对应列的字段名字也可以使用 property属性                                           | string                                      |
+| minWidth?     | 对应列的最小宽度与 width 的区别是 width 是固定的，min-width 会按比例分配剩余宽度                 | number ,string,                             |
+| className?    | 列的className                                                          | string                                      |
+| sortable      | 列是否能够排序 则代表用户希望远程排序，需要监听 Table 的 sort-change 事件 */                   | Boolean                                     |
+| filters?      | 据过滤的选项， 数组格式，数组中的元素需要有 text 和 value 属性。 数组中的每个元素都需要有 text 和 value 属性 | {text:string,number,value:string,number} [] |
+| filterMethod? | 数据过滤使用的方法， 如果是多选的筛选项，对每一条数据会执行多次，任意一次返回 true 就会显示                    | Function                                    |
+| headerAlign?  | 表头对齐方式， 若不设置该项，则使用表格的对齐方式                                            | 'left' , 'center' , 'right'                 |
+
+
+
+
+
+
+
 计算获取剩余空间 hook
 =================