From 54335380ec87dc5600a902bcbab29ff1d6cfb841 Mon Sep 17 00:00:00 2001 From: RUNZE LU <36724300+lurunze1226@users.noreply.github.com> Date: Thu, 27 Oct 2022 18:49:15 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20CURD=E5=88=97=E9=85=8D=E7=BD=AE?= =?UTF-8?q?=E6=96=87=E6=A1=A3=E4=BC=98=E5=8C=96=20(#5625)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh-CN/components/crud.md | 34 ++++++++++++++++-- docs/zh-CN/components/table.md | 65 +++++++--------------------------- 2 files changed, 45 insertions(+), 54 deletions(-) diff --git a/docs/zh-CN/components/crud.md b/docs/zh-CN/components/crud.md index d3d4dcdec..e0ce370e7 100755 --- a/docs/zh-CN/components/crud.md +++ b/docs/zh-CN/components/crud.md @@ -2872,11 +2872,41 @@ itemAction 里的 onClick 还能通过 `data` 参数拿到当前行的数据， 注意除了上面这些属性，CRUD 在不同模式下的属性需要参考各自的文档，比如 -- 默认 [Table](./table) 模式里的列配置。 +- 默认[Table](./table)模式里的[列配置](./table#列配置属表)。 - [Cards](./cards) 模式。 - [List](./list) 模式。 -## columns-toggler 属性表 +### 列配置属性表 + +除了 Table 组件默认支持的列配置，CRUD 的列配置还额外支持以下属性： + +| 属性名 | 类型 | 默认值 | 说明 | +| ---------- | --------------------------------------------------------------- | ------- | --------------------------------------------------------------------------- | +| sortable | `boolean` | `false` | 是否可排序 | +| searchable | `boolean` \| `Schema` | `false` | 是否可快速搜索，开启`autoGenerateFilter`后，`searchable`支持配置`Schema` | +| filterable | `boolean` \| [`QuickFilterConfig`](./crud.md#quickfilterconfig) | `false` | 是否可快速搜索，`options`属性为静态选项，支持设置`source`属性从接口获取选项 | +| quickEdit | `boolean` \| [`QuickEditConfig`](./crud.md#quickeditconfig) | - | 快速编辑，一般需要配合`quickSaveApi`接口使用 | + +#### QuickFilterConfig + +| 属性名 | 类型 | 默认值 | 说明 | 版本 | +| ---------- | ----------------------------- | ------- | -------------------------------------------------------- | ------- | +| options | `Array` | - | 静态选项 | | +| multiple | `boolean` | `false` | 是否支持多选 | | +| source | [`Api`](../../docs/types/api) | - | 选项 API 接口 | | +| strictMode | `string` | `false` | 严格模式，开启严格模式后，会采用 JavaScript 严格想等比较 | `2.3.0` | + +#### QuickEditConfig + +| 属性名 | 类型 | 默认值 | 说明 | 版本 | +| ------------------ | ------------------------- | ----------- | ------------------------------------------------------------------------------------------------------- | ---- | +| type | `SchemaType` | - | 表单项组件类型 | | +| body | `SchemaCollection` | - | 组件容器，支持多个表单项组件 | | +| mode | `'inline' \| 'popOver'` | `'popOver'` | 编辑模式，inline 为行内编辑，popOver 为浮层编辑 | | +| saveImmediately | `boolean` 或 `{api: Api}` | `false` | 是否修改后即时保存，一般需要配合`quickSaveItemApi`接口使用，也可以直接配置[`Api`](../../docs/types/api) | | +| quickEditEnabledOn | `SchemaExpression` | - | 开启快速编辑条件[表达式](../../docs/concepts/expression) | | + +### columns-toggler 属性表 | 属性名 | 类型 | 默认值 | 说明 | | --------------- | ------------------------------ | --------- | -------------------------------------- | diff --git a/docs/zh-CN/components/table.md b/docs/zh-CN/components/table.md index ce2b5c2a8..47c728b21 100755 --- a/docs/zh-CN/components/table.md +++ b/docs/zh-CN/components/table.md @@ -1730,14 +1730,7 @@ popOver 的其它配置请参考 [popover](./popover) "columns": [ { "name": "id", - "label": "ID", - "searchable": { - "type": "input-text", - "name": "id", - "label": "主键", - "placeholder": "输入id", - "size": "sm", - } + "label": "ID" }, { "name": "engine", @@ -1745,28 +1738,7 @@ popOver 的其它配置请参考 [popover](./popover) }, { "name": "browser", - "label": "Browser", - "searchable": { - "type": "select", - "name": "browser", - "label": "浏览器", - "placeholder": "选择浏览器", - "size": "sm", - "options": [ - { - "label": "Internet Explorer ", - "value": "ie" - }, - { - "label": "AOL browser", - "value": "aol" - }, - { - "label": "Firefox", - "value": "firefox" - } - ] - } + "label": "Browser" }, { "name": "platform", @@ -1774,15 +1746,7 @@ popOver 的其它配置请参考 [popover](./popover) }, { "name": "version", - "label": "Engine version", - "searchable": { - "type": "input-number", - "name": "version", - "label": "版本号", - "placeholder": "输入版本号", - "size": "sm", - "mode": "horizontal" - } + "label": "Engine version" }, { "name": "grade", @@ -1882,17 +1846,14 @@ popOver 的其它配置请参考 [popover](./popover) | selectable | `boolean` | `false` | 支持勾选 | | multiple | `boolean` | `false` | 勾选 icon 是否为多选样式`checkbox`， 默认为`radio` | -## 列配置属性表 +### 列配置属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| ---------- | --------------------------------------------- | ------- | ---------------- | -| label | [模板](../../docs/concepts/template) | | 表头文本内容 | -| name | `string` | | 通过名称关联数据 | -| fixed | `left` \| `right` \| `none` | | 是否固定当前列 | -| popOver | | | 弹出框 | -| quickEdit | | | 快速编辑 | -| copyable | `boolean` 或 `{icon: string, content:string}` | | 是否可复制 | -| sortable | `boolean` | `false` | 是否可排序 | -| searchable | `boolean` \| `Schema` | `false` | 是否可快速搜索 | -| width | `number` \| `string` | 列宽 | -| remark | | | 提示信息 | +| 属性名 | 类型 | 默认值 | 说明 | +| -------- | --------------------------------------------- | ------ | ---------------- | +| label | [模板](../../docs/concepts/template) | | 表头文本内容 | +| name | `string` | | 通过名称关联数据 | +| width | `number` \| `string` | | 列宽 | +| remark | | | 提示信息 | +| fixed | `left` \| `right` \| `none` | | 是否固定当前列 | +| popOver | | | 弹出框 | +| copyable | `boolean` 或 `{icon: string, content:string}` | | 是否可复制 |