@next-bricks/advanced 0.1.6 → 0.1.8

package/dist/manifest.json

@@ -8,216 +8,168 @@
       "properties": [
         {
           "name": "showCard",
-          "description": "",
-          "required": true,
+          "description": "是否显示外层卡片",
           "default": "true"
         },
         {
           "name": "rowSelection",
-          "description": "",
-          "required": true,
-          "default": "-",
+          "description": "表格行是否可选择，具体查阅：[rowSelection](https://ant.design/components/table-cn/#rowSelection)",
           "attribute": false,
           "type": "false | TableRowSelection<any>"
         },
         {
           "name": "rowKey",
-          "description": "",
-          "required": true,
-          "default": "\"key\"",
+          "description": "指定每一行的 key，不指定则默认为索引 index。强烈建议设置该属性，否则在某些情况下可能行为不如预期。",
           "type": "string"
         },
         {
           "name": "hiddenColumns",
-          "description": "",
-          "required": true,
-          "default": "-",
+          "description": "隐藏相应列（输入对应的 dataIndex 或者 key 即可）",
           "attribute": false,
           "type": "Array<string | number>"
         },
         {
           "name": "showSelectInfo",
-          "description": "",
-          "required": true,
+          "description": "是否显示已选择信息和清除按钮。仅在设置了`rowSelection`时有效。默认不显示",
           "default": "false"
         },
         {
           "name": "filters",
-          "description": "",
-          "required": true,
-          "default": "-",
+          "description": "表头过滤的过滤项，key 为 column 的 dataIndex，value 为过滤值集合。",
           "attribute": false,
           "type": "Record<string, string[]>"
         },
         {
           "name": "configProps",
-          "description": "",
-          "required": true,
-          "default": "-",
+          "description": "ant-design 的 Table 相关配置项,具体查阅：[Table](https://ant.design/components/table-cn/#Table)，其中分页配置和行选择配值在构件中设置了常用的默认配置，也可自行覆盖，具体描述见下表",
           "attribute": false,
           "type": "any"
         },
         {
           "name": "sort",
-          "description": "",
-          "required": true,
-          "default": "-",
+          "description": "被排序列的 dataIndex。通常来自于 url 参数，可以设置成 ${QUERY.sort}。",
           "type": "string | null"
         },
         {
           "name": "order",
-          "description": "",
-          "required": true,
-          "default": "-",
+          "description": "升序/降序，可以设置成 ${QUERY.order}。",
           "attribute": false,
           "type": "string | number | null"
         },
         {
           "name": "rowDisabledConfig",
-          "description": "",
-          "required": true,
-          "default": "-",
+          "description": "配置每一行是否禁用，其中 `field` 表示数据源中的字段路径， `value` 表示与其字段比较的值， `operator` 表示两者比较的方法，结果为 `true` 时会禁用当前行, 需要注意的是该配置需要在 `rowSelection: true` 的前提下使用，并且设置 `rowKey` 属性赋予每行唯一的 key，防止顺序变化时造成的错误勾选（如上 demo 所示）",
           "attribute": false,
           "type": "RowDisabledProps | RowDisabledProps[]"
         },
         {
           "name": "expandedRowBrick",
-          "description": "",
+          "description": "自定义行展开的构件 [UseBrickConf](/next-docs/docs/api-reference/brick-types.usesinglebrickconf)",
           "attribute": false,
           "type": "{\n        useBrick?: UseSingleBrickConf;\n      }"
         },
         {
           "name": "expandIcon",
-          "description": "",
+          "description": "自定义展开图标。",
+          "default": "{collapsedIcon:{lib:'antd',icon:'down',theme:'outlined'},expandedIcon:{lib:'antd',icon:'right',theme:'outlined'}}",
           "attribute": false,
           "type": "{\n        collapsedIcon: GeneralIconProps;\n        expandedIcon: GeneralIconProps;\n      }"
         },
         {
           "name": "expandIconAsCell",
-          "description": "",
-          "required": true,
+          "description": "展开的图标是否为一个单元格，默认显示在第一列；设置为 false 的时候，可以通过`expandIconColumnIndex`属性设置展开的图标在哪一列",
           "default": "true",
           "attribute": false
         },
         {
           "name": "expandIconColumnIndex",
-          "description": "",
-          "required": true,
-          "default": "-",
+          "description": "展开的图标显示在哪一列，如果没有 rowSelection，默认显示在第一列，否则显示在选择框后面。当`expandIconAsCell`为 false 时，该属性生效。",
           "type": "number"
         },
         {
           "name": "expandRowByClick",
-          "description": "",
-          "required": true,
-          "default": "false",
+          "description": "通过点击行来展开子行",
           "type": "boolean"
         },
         {
           "name": "optimizedColumns",
-          "description": "",
-          "required": true,
-          "default": "-",
+          "description": "优化渲染的列（输入对应的 dataIndex），针对配置了 useBrick 的列。当前 antd 在更新 state 的时候，会全量渲染单元格，如果确定某一列在后续操作中不需要重新渲染，例如仅作为展示的单元格，可通过该属性设置以优化性能。注意，在树形表格中，当某一列内包含展开/收起按钮，则不应该设置该列。",
           "attribute": false,
           "type": "Array<string | number>"
         },
         {
           "name": "stripEmptyExpandableChildren",
-          "description": "",
-          "required": true,
+          "description": "树形数据展示时是否需要去除空数组",
           "default": "false",
           "attribute": false
         },
         {
           "name": "defaultExpandAllRows",
-          "description": "",
-          "required": true,
-          "default": "false",
+          "description": "初始时，是否展开所有行",
           "type": "boolean"
         },
         {
           "name": "ellipsisInfo",
-          "description": "",
-          "required": true,
-          "default": "false",
+          "description": "是否显示省略信息",
           "type": "boolean"
         },
         {
           "name": "expandedRowKeys",
-          "description": "",
-          "required": true,
-          "default": "-",
+          "description": "展开的行的 rowKey",
           "attribute": false,
           "type": "string[]"
         },
         {
           "name": "selectAllChildren",
-          "description": "",
-          "required": true,
-          "default": "false",
+          "description": "表格树形数据展示的时候，行选择父节点的时候是否同步勾选/取消勾选所有子节点，并且被同步勾选的子节点不能单独取消。注意，该属性必须设置 `rowKey` 属性。",
           "type": "boolean"
         },
         {
           "name": "defaultSelectAll",
-          "description": "",
-          "required": true,
-          "default": "false",
+          "description": "是否默认选择所有行。注意，该属性必须设置 `rowKey` 属性。",
           "type": "boolean"
         },
         {
           "name": "childrenColumnName",
-          "description": "",
-          "required": true,
+          "description": "指定树形结构的列名",
           "default": "children",
           "attribute": false
         },
         {
           "name": "sortable",
-          "description": "",
-          "required": true,
+          "description": "是否支持排序。默认开启，当对应列的sorter设置成true时则可排序。sortable为false时则排序都不生效。",
           "default": "true",
           "attribute": false
         },
         {
           "name": "frontSearch",
-          "description": "",
-          "required": true,
-          "default": "false",
+          "description": "是否前端进行搜索，配合`presentational-bricks.brick-input`使用",
           "type": "boolean"
         },
         {
           "name": "frontSearchQuery",
-          "description": "",
-          "required": true,
-          "default": "-"
+          "description": "前端搜索参数",
+          "default": "\"\""
         },
         {
           "name": "exactSearch",
-          "description": "",
-          "required": true,
-          "default": "false",
+          "description": "是否精确搜索",
           "type": "boolean"
         },
         {
           "name": "frontSearchFilterKeys",
-          "description": "",
-          "required": true,
-          "default": "-",
+          "description": "进行前端搜索的字段，支持嵌套的写法如[\"name\",\"value.a\"]，不配置的时候默认为对所有 columns 的 dataIndex[]进行前端搜索",
           "attribute": false,
           "type": "string[]"
         },
         {
           "name": "page",
-          "description": "",
-          "required": true,
-          "default": "-",
+          "description": "页码。后台搜索的时候一般不需要配置，列表接口返回格式通常为{list:[],page:1,pageSize:10,total:20}，即默认取自 page；前台搜索的时候，一般配置成 \"${query.page=1|number}\"",
           "type": "number"
         },
         {
           "name": "pageSize",
-          "description": "",
-          "required": true,
-          "default": "-",
+          "description": "页码条数。后台搜索的时候一般不需要配置，列表接口返回格式通常为{list:[],page:1,pageSize:10,total:20}，即默认取自 pageSize/page_size；前台搜索的时候，一般配置成 \"${query.pageSize=10|number}\"",
           "type": "number"
         },
         {
@@ -229,98 +181,76 @@
         },
         {
           "name": "qField",
-          "description": "",
-          "required": true,
+          "description": "把过滤条件更新到 url 时的字段名",
           "default": "\"q\""
         },
         {
           "name": "tableDraggable",
-          "description": "",
-          "required": true,
-          "default": "false",
+          "description": "表格行是否可拖拽，注意，树形数据的表格不支持该功能",
           "type": "boolean"
         },
         {
           "name": "zebraPattern",
-          "description": "",
-          "required": true,
-          "default": "false",
+          "description": "是否展示斑马纹",
           "type": "boolean"
         },
         {
           "name": "storeCheckedByUrl",
-          "description": "",
-          "required": true,
-          "default": "false",
+          "description": "翻页时是否记住之前选中的项。注意，选中项的rowKey将保存在url中，如果不设置rowKey，该设置不生效。如果选择太多可能会造成url过长，请谨慎使用",
           "type": "boolean"
         },
         {
           "name": "extraRows",
-          "description": "",
-          "required": true,
-          "default": "-",
+          "description": "额外的行，通常为跨页勾选时，不在当前页的行",
+          "default": "[]",
           "attribute": false,
           "type": "Record<string, unknown>[]"
         },
         {
           "name": "autoSelectParentWhenAllChildrenSelected",
-          "description": "",
-          "required": true,
-          "default": "false",
+          "description": "当所有子节点选中时，自动选中父节点",
           "type": "boolean"
         },
         {
           "name": "thTransparent",
-          "description": "",
-          "required": true,
-          "default": "-",
+          "description": "表格表头是否透明",
           "type": "boolean"
         },
         {
           "name": "showHeader",
-          "description": "",
-          "required": true,
+          "description": "是否显示表头",
           "default": "true"
         },
         {
           "name": "pagination",
-          "description": "",
-          "required": true,
-          "default": "-",
+          "description": "是否显示分页",
           "attribute": false,
           "type": "false | TablePaginationConfig"
         },
         {
           "name": "size",
-          "description": "",
-          "required": true,
-          "default": "-",
+          "description": "表格大小（antd原生size）",
           "type": "SizeType"
         },
         {
           "name": "type",
-          "description": "",
-          "required": true,
-          "default": "-",
+          "description": "选框类型（单选/多选）",
           "attribute": false,
           "type": "RowSelectionType"
         },
         {
           "name": "shouldUpdateUrlParams",
-          "description": "",
-          "required": true,
+          "description": "是否更新 url 参数。设置为否之后，如果是后台进行分页/排序等功能，则需要结合事件进行编排。如果是前台进行分页/排序，则不需要。",
           "default": "true"
         },
         {
           "name": "shouldRenderWhenUrlParamsUpdate",
-          "description": "",
-          "required": true,
+          "description": "更新 url 参数时是否触发页面重新渲染。仅在`shouldUpdateUrlParams`为true时有效。",
           "default": "true"
         },
         {
           "name": "selectedRowKeys",
-          "description": "",
-          "required": true,
+          "description": "指定选中项的 key 数组",
           "default": "[]",
           "attribute": false,
           "type": "React.Key[]"
@@ -329,65 +259,57 @@
       "events": [
         {
           "name": "page.update",
-          "description": "",
+          "description": "页码变化,pagePath 可在 fields.page 中设置，默认为 page",
           "detail": {
-            "description": "{[pagePath]: xxx}",
             "type": "Record<string, number>"
           }
         },
         {
           "name": "filter.update",
-          "description": "",
+          "description": "每页条数变化 ,pagePath 可在 fields.page 中设置,pageSizePath 可在 fields.pageSize 中设置，默认为 pageSize",
           "detail": {
-            "description": "{[pagePath]:1,[pageSizePath]:xxx}",
             "type": "Record<string, number>"
           }
         },
         {
           "name": "select.update",
-          "description": "",
+          "description": "勾选框变化，detail 中为所选的行数据",
           "detail": {
-            "description": "Record<string,any>[]",
             "type": "Record<string, any>[]"
           }
         },
         {
           "name": "select.row.keys.update",
-          "description": "",
+          "description": "勾选框变化，detail 中为所选的行key集合",
           "detail": {
-            "description": "Record<string,any>[]",
             "type": "string[]"
           }
         },
         {
           "name": "sort.update",
-          "description": "",
+          "description": "排序变化，detail 中的 sort 为对应排序列的 key/dataIndex，order 为升序/降序",
           "detail": {
-            "description": "{sort:string;order:string|number}",
             "type": "{\n    sort: string;\n    order: string | number;\n  }"
           }
         },
         {
           "name": "row.expand",
-          "description": "",
+          "description": "点击展开图标时触发的事件，事件详情中`expanded`为是否展开，`record`被点击的行信息",
           "detail": {
-            "description": "{expanded:boolean;record:Record<string,any>}",
             "type": "{\n    expanded: boolean;\n    record: Record<string, any>;\n  }"
           }
         },
         {
           "name": "expand.rows.change",
-          "description": "",
+          "description": "展开的行变化时触发的事件，事件详情为当前展开的所有行的`rowKey`集合",
           "detail": {
-            "description": "{expandedRows:string[]| number[]}",
             "type": "{\n    expandedRows: React.Key[];\n  }"
           }
         },
         {
           "name": "row.drag",
-          "description": "",
+          "description": "表格行拖拽结束发生的事件，事件详情为拖拽后重新排序的所有行数据",
           "detail": {
-            "description": "{data:Record<string,any>[]}",
             "type": "{\n    data: Record<string, any>[];\n  }"
           }
         }
@@ -399,7 +321,7 @@
           "params": [
             "event: CustomEvent"
           ],
-          "description": "",
+          "description": "搜索过滤",
           "return": {
             "type": "void"
           }
@@ -407,10 +329,10 @@
         {
           "name": "expandAll",
           "params": [],
-          "description": ""
+          "description": "展开所有行"
         }
       ],
-      "description": ""
+      "description": "通用表格构件"
     },
     {
       "name": "advanced.general-cascader",