From 54e56402d267c08cdffa2b60f2758d3fe8111bb0 Mon Sep 17 00:00:00 2001 From: RickCole Date: Mon, 1 Feb 2021 20:44:49 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=87=E6=A1=A3=E6=8B=86=E5=88=86=E7=BB=84?= =?UTF-8?q?=E4=BB=B6=E9=83=A8=E5=88=86=20(#1502)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 文档样式一点小优化 * 文档拆分组件部分 --- docs/zh-CN/components/action.md | 60 +- docs/zh-CN/components/alert.md | 14 +- docs/zh-CN/components/card.md | 32 +- docs/zh-CN/components/cards.md | 22 +- docs/zh-CN/components/chart.md | 34 +- docs/zh-CN/components/collapse.md | 18 +- docs/zh-CN/components/container.md | 14 +- docs/zh-CN/components/crud.md | 110 +- docs/zh-CN/components/dialog.md | 28 +- docs/zh-CN/components/drawer.md | 26 +- docs/zh-CN/components/each.md | 12 +- docs/zh-CN/components/form/array.md | 22 +- docs/zh-CN/components/form/button-group.md | 20 +- docs/zh-CN/components/form/chain-select.md | 20 +- docs/zh-CN/components/form/checkboxes.md | 42 +- docs/zh-CN/components/form/combo.md | 56 +- docs/zh-CN/components/form/fieldset.md | 22 +- docs/zh-CN/components/form/file.md | 46 +- docs/zh-CN/components/form/formitem.md | 46 +- docs/zh-CN/components/form/formula.md | 16 +- docs/zh-CN/components/form/grid.md | 56 +- docs/zh-CN/components/form/hbox.md | 2 +- docs/zh-CN/components/form/hidden.md | 2 +- docs/zh-CN/components/form/image.md | 2 +- docs/zh-CN/components/form/index.md | 16 +- docs/zh-CN/components/form/list.md | 20 +- docs/zh-CN/components/form/matrix.md | 16 +- docs/zh-CN/components/form/nestedselect.md | 30 +- docs/zh-CN/components/form/number.md | 14 +- docs/zh-CN/components/form/options.md | 26 +- docs/zh-CN/components/form/panel.md | 20 +- docs/zh-CN/components/form/picker.md | 28 +- docs/zh-CN/components/form/radios.md | 16 +- docs/zh-CN/components/form/rich-text.md | 16 +- docs/zh-CN/components/form/select.md | 50 +- docs/zh-CN/components/form/service.md | 2 +- docs/zh-CN/components/form/table.md | 52 +- docs/zh-CN/components/form/tag.md | 24 +- docs/zh-CN/components/form/text.md | 36 +- docs/zh-CN/components/form/transfer.md | 38 +- docs/zh-CN/components/form/tree.md | 66 +- docs/zh-CN/components/grid-2d.md | 36 +- docs/zh-CN/components/grid.md | 52 +- docs/zh-CN/components/hbox.md | 14 +- .../components/{component.md => index.md} | 9 +- docs/zh-CN/components/list.md | 36 +- docs/zh-CN/components/nav.md | 26 +- docs/zh-CN/components/page.md | 46 +- docs/zh-CN/components/pagination-wrapper.md | 2 +- docs/zh-CN/components/panel.md | 28 +- docs/zh-CN/components/qrcode.md | 20 +- docs/zh-CN/components/radios.md | 16 +- docs/zh-CN/components/service.md | 40 +- docs/zh-CN/components/table.md | 48 +- docs/zh-CN/components/tabs.md | 2 + docs/zh-CN/components/tasks.md | 48 +- docs/zh-CN/components/tpl.md | 14 +- docs/zh-CN/components/wizard.md | 62 +- docs/zh-CN/components/wrapper.md | 12 +- docs/zh-CN/index.md | 2 +- examples/components/App.tsx | 52 +- examples/components/Components.tsx | 1092 +++++++++++++++++ examples/components/DocNavCN.ts | 1037 +--------------- mock/server.conf | 2 +- 64 files changed, 1987 insertions(+), 1901 deletions(-) rename docs/zh-CN/components/{component.md => index.md} (88%) create mode 100644 examples/components/Components.tsx diff --git a/docs/zh-CN/components/action.md b/docs/zh-CN/components/action.md index f357dadec..5340b9806 100755 --- a/docs/zh-CN/components/action.md +++ b/docs/zh-CN/components/action.md @@ -312,12 +312,12 @@ icon 也可以是 url 地址，比如 **属性表** -| 属性名 | 类型 | 默认值 | 说明 | -| -------- | -------------------------------------------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------- | -| api | [Api](../types/api) | - | 请求地址，参考 [api](../types/api) 格式说明。 | -| redirect | [模板字符串](../concepts/template#%E6%A8%A1%E6%9D%BF%E5%AD%97%E7%AC%A6%E4%B8%B2) | - | 指定当前请求结束后跳转的路径，可用 `${xxx}` 取值。 | -| feedback | `DialogObject` | - | 如果 ajax 类型的，当 ajax 返回正常后，还能接着弹出一个 dialog 做其他交互。返回的数据可用于这个 dialog 中。格式可参考[Dialog](./Dialog.md) | -| messages | `object` | - | `success`：ajax 操作成功后提示，可以不指定，不指定时以 api 返回为准。`failed`：ajax 操作失败提示。 | +| 属性名 | 类型 | 默认值 | 说明 | +| -------- | ---------------------------------------------------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------- | +| api | [Api](../../docs/types/api) | - | 请求地址，参考 [api](../../docs/types/api) 格式说明。 | +| redirect | [模板字符串](../../docs/concepts/template#%E6%A8%A1%E6%9D%BF%E5%AD%97%E7%AC%A6%E4%B8%B2) | - | 指定当前请求结束后跳转的路径，可用 `${xxx}` 取值。 | +| feedback | `DialogObject` | - | 如果 ajax 类型的，当 ajax 返回正常后，还能接着弹出一个 dialog 做其他交互。返回的数据可用于这个 dialog 中。格式可参考[Dialog](./Dialog.md) | +| messages | `object` | - | `success`：ajax 操作成功后提示，可以不指定，不指定时以 api 返回为准。`failed`：ajax 操作失败提示。 | ## 跳转链接 @@ -481,10 +481,10 @@ icon 也可以是 url 地址，比如 **属性表** -| 属性名 | 类型 | 默认值 | 说明 | -| ---------- | ---------------------------- | ------ | ------------------------------------ | -| actionType | `string` | `copy` | 复制一段内容到粘贴板 | -| content | [模板](../concepts/template) | - | 指定复制的内容。可用 `${xxx}` 取值。 | +| 属性名 | 类型 | 默认值 | 说明 | +| ---------- | ------------------------------------ | ------ | ------------------------------------ | +| actionType | `string` | `copy` | 复制一段内容到粘贴板 | +| content | [模板](../../docs/concepts/template) | - | 指定复制的内容。可用 `${xxx}` 取值。 | ## 刷新其他组件 @@ -546,23 +546,23 @@ icon 也可以是 url 地址，比如 所有`actionType`都支持的通用配置项 -| 属性名 | 类型 | 默认值 | 说明 | -| ---------------- | ---------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| type | `string` | `action` | 指定为 Page 渲染器。 | -| actionType | `string` | - | 【必填】这是 action 最核心的配置，来指定该 action 的作用类型，支持：`ajax`、`link`、`url`、`drawer`、`dialog`、`confirm`、`cancel`、`prev`、`next`、`copy`、`close`。 | -| label | `string` | - | 按钮文本。可用 `${xxx}` 取值。 | -| level | `string` | `default` | 按钮样式，支持：`link`、`primary`、`secondary`、`info`、`success`、`warning`、`danger`、`light`、`dark`、`default`。 | -| size | `string` | - | 按钮大小，支持：`xs`、`sm`、`md`、`lg`。 | -| icon | `string` | - | 设置图标，例如`fa fa-plus`。 | -| iconClassName | `string` | - | 给图标上添加类名。 | -| active | `boolean` | - | 按钮是否高亮。 | -| activeLevel | `string` | - | 按钮高亮时的样式，配置支持同`level`。 | -| activeClassName | `string` | `is-active` | 给按钮高亮添加类名。 | -| block | `boolean` | - | 用`display:"block"`来显示按钮。 | -| confirmText | [模板](../concepts/template) | - | 当设置后，操作在开始前会询问用户。可用 `${xxx}` 取值。 | -| reload | `string` | - | 指定此次操作完后，需要刷新的目标组件名字（组件的`name`值，自己配置的），多个请用 `,` 号隔开。 | -| tooltip | `string` | - | 鼠标停留时弹出该段文字，也可以配置对象类型：字段为`title`和`content`。可用 `${xxx}` 取值。 | -| disabledTip | `string` | - | 被禁用后鼠标停留时弹出该段文字，也可以配置对象类型：字段为`title`和`content`。可用 `${xxx}` 取值。 | -| tooltipPlacement | `string` | `top` | 如果配置了`tooltip`或者`disabledTip`，指定提示信息位置，可配置`top`、`bottom`、`left`、`right`。 | -| close | `boolean` or `string` | - | 当`action`配置在`dialog`或`drawer`的`actions`中时，配置为`true`指定此次操作完后关闭当前`dialog`或`drawer`。当值为字符串，并且是祖先层弹框的名字的时候，会把祖先弹框关闭掉。 | -| required | `Array` | - | 配置字符串数组，指定在`form`中进行操作之前，需要指定的字段名的表单项通过验证 | +| 属性名 | 类型 | 默认值 | 说明 | +| ---------------- | ------------------------------------ | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| type | `string` | `action` | 指定为 Page 渲染器。 | +| actionType | `string` | - | 【必填】这是 action 最核心的配置，来指定该 action 的作用类型，支持：`ajax`、`link`、`url`、`drawer`、`dialog`、`confirm`、`cancel`、`prev`、`next`、`copy`、`close`。 | +| label | `string` | - | 按钮文本。可用 `${xxx}` 取值。 | +| level | `string` | `default` | 按钮样式，支持：`link`、`primary`、`secondary`、`info`、`success`、`warning`、`danger`、`light`、`dark`、`default`。 | +| size | `string` | - | 按钮大小，支持：`xs`、`sm`、`md`、`lg`。 | +| icon | `string` | - | 设置图标，例如`fa fa-plus`。 | +| iconClassName | `string` | - | 给图标上添加类名。 | +| active | `boolean` | - | 按钮是否高亮。 | +| activeLevel | `string` | - | 按钮高亮时的样式，配置支持同`level`。 | +| activeClassName | `string` | `is-active` | 给按钮高亮添加类名。 | +| block | `boolean` | - | 用`display:"block"`来显示按钮。 | +| confirmText | [模板](../../docs/concepts/template) | - | 当设置后，操作在开始前会询问用户。可用 `${xxx}` 取值。 | +| reload | `string` | - | 指定此次操作完后，需要刷新的目标组件名字（组件的`name`值，自己配置的），多个请用 `,` 号隔开。 | +| tooltip | `string` | - | 鼠标停留时弹出该段文字，也可以配置对象类型：字段为`title`和`content`。可用 `${xxx}` 取值。 | +| disabledTip | `string` | - | 被禁用后鼠标停留时弹出该段文字，也可以配置对象类型：字段为`title`和`content`。可用 `${xxx}` 取值。 | +| tooltipPlacement | `string` | `top` | 如果配置了`tooltip`或者`disabledTip`，指定提示信息位置，可配置`top`、`bottom`、`left`、`right`。 | +| close | `boolean` or `string` | - | 当`action`配置在`dialog`或`drawer`的`actions`中时，配置为`true`指定此次操作完后关闭当前`dialog`或`drawer`。当值为字符串，并且是祖先层弹框的名字的时候，会把祖先弹框关闭掉。 | +| required | `Array` | - | 配置字符串数组，指定在`form`中进行操作之前，需要指定的字段名的表单项通过验证 | diff --git a/docs/zh-CN/components/alert.md b/docs/zh-CN/components/alert.md index 72cdbf171..6a61fd75f 100755 --- a/docs/zh-CN/components/alert.md +++ b/docs/zh-CN/components/alert.md @@ -59,10 +59,10 @@ order: 27 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| --------------- | --------------------------------- | --------- | -------------------------------------------------------- | -| type | `string` | `"alert"` | 指定为 alert 渲染器 | -| className | `string` | | 外层 Dom 的类名 | -| level | `string` | `info` | 级别，可以是：`info`、`success`、`warning` 或者 `danger` | -| body | [SchemaNode](../types/schemanode) | | 显示内容 | -| showCloseButton | `boolean` | false | 是否显示关闭按钮 | +| 属性名 | 类型 | 默认值 | 说明 | +| --------------- | ----------------------------------------- | --------- | -------------------------------------------------------- | +| type | `string` | `"alert"` | 指定为 alert 渲染器 | +| className | `string` | | 外层 Dom 的类名 | +| level | `string` | `info` | 级别，可以是：`info`、`success`、`warning` 或者 `danger` | +| body | [SchemaNode](../../docs/types/schemanode) | | 显示内容 | +| showCloseButton | `boolean` | false | 是否显示关闭按钮 | diff --git a/docs/zh-CN/components/card.md b/docs/zh-CN/components/card.md index 878a80c9e..ce2fe8976 100755 --- a/docs/zh-CN/components/card.md +++ b/docs/zh-CN/components/card.md @@ -46,19 +46,19 @@ order: 31 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| ---------------------- | ---------------------------- | ----------------------------------- | -------------------------------------- | -| type | `string` | `"card"` | 指定为 Card 渲染器 | -| className | `string` | `"panel-default"` | 外层 Dom 的类名 | -| header | `Object` | | Card 头部内容设置 | -| header.className | `string` | | 头部类名 | -| header.title | [模板](../concepts/template) | | 标题 | -| header.subTitle | [模板](../concepts/template) | | 副标题 | -| header.desc | [模板](../concepts/template) | | 描述 | -| header.avatar | [模板](../concepts/template) | | 图片 | -| header.avatarText | [模板](../concepts/template) | | 如果不配置图片，则会在图片处显示该文本 | -| header.highlight | `boolean` | | 是否显示激活样式 | -| header.avatarClassName | `string` | `"pull-left thumb avatar b-3x m-r"` | 图片类名 | -| body | `Array` | | 内容容器，主要用来放置非表单项组件 | -| bodyClassName | `string` | `"padder m-t-sm m-b-sm"` | 内容区域类名 | -| actions | Array<[Action](./action)> | | 配置按钮集合 | +| 属性名 | 类型 | 默认值 | 说明 | +| ---------------------- | ------------------------------------ | ----------------------------------- | -------------------------------------- | +| type | `string` | `"card"` | 指定为 Card 渲染器 | +| className | `string` | `"panel-default"` | 外层 Dom 的类名 | +| header | `Object` | | Card 头部内容设置 | +| header.className | `string` | | 头部类名 | +| header.title | [模板](../../docs/concepts/template) | | 标题 | +| header.subTitle | [模板](../../docs/concepts/template) | | 副标题 | +| header.desc | [模板](../../docs/concepts/template) | | 描述 | +| header.avatar | [模板](../../docs/concepts/template) | | 图片 | +| header.avatarText | [模板](../../docs/concepts/template) | | 如果不配置图片，则会在图片处显示该文本 | +| header.highlight | `boolean` | | 是否显示激活样式 | +| header.avatarClassName | `string` | `"pull-left thumb avatar b-3x m-r"` | 图片类名 | +| body | `Array` | | 内容容器，主要用来放置非表单项组件 | +| bodyClassName | `string` | `"padder m-t-sm m-b-sm"` | 内容区域类名 | +| actions | Array<[Action](./action)> | | 配置按钮集合 | diff --git a/docs/zh-CN/components/cards.md b/docs/zh-CN/components/cards.md index 5b3e93b7a..8d5ea4989 100755 --- a/docs/zh-CN/components/cards.md +++ b/docs/zh-CN/components/cards.md @@ -115,14 +115,14 @@ order: 32 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| --------------- | ------------------------------------ | ------------------- | ------------------------------ | -| type | `string` | | `"cards"` 指定为卡片组。 | -| title | [模板](../concepts/template) | | 标题 | -| source | [数据映射](../concepts/data-mapping) | `${items}` | 数据源, 获取当前数据域中的变量 | -| placeholder | [模板](../concepts/template) | ‘暂无数据’ | 当没数据的时候的文字提示 | -| className | `string` | | 外层 CSS 类名 | -| headerClassName | `string` | `amis-grid-header` | 顶部外层 CSS 类名 | -| footerClassName | `string` | `amis-grid-footer` | 底部外层 CSS 类名 | -| itemClassName | `string` | `col-sm-4 col-md-3` | 卡片 CSS 类名 | -| card | [Card](./card) | | 配置卡片信息 | +| 属性名 | 类型 | 默认值 | 说明 | +| --------------- | -------------------------------------------- | ------------------- | ------------------------------ | +| type | `string` | | `"cards"` 指定为卡片组。 | +| title | [模板](../../docs/concepts/template) | | 标题 | +| source | [数据映射](../../docs/concepts/data-mapping) | `${items}` | 数据源, 获取当前数据域中的变量 | +| placeholder | [模板](../../docs/concepts/template) | ‘暂无数据’ | 当没数据的时候的文字提示 | +| className | `string` | | 外层 CSS 类名 | +| headerClassName | `string` | `amis-grid-header` | 顶部外层 CSS 类名 | +| footerClassName | `string` | `amis-grid-footer` | 底部外层 CSS 类名 | +| itemClassName | `string` | `col-sm-4 col-md-3` | 卡片 CSS 类名 | +| card | [Card](./card) | | 配置卡片信息 | diff --git a/docs/zh-CN/components/chart.md b/docs/zh-CN/components/chart.md index 2792f4ab9..8d6f1f24d 100755 --- a/docs/zh-CN/components/chart.md +++ b/docs/zh-CN/components/chart.md @@ -156,7 +156,7 @@ api 返回支持两种格式，一种是直接返回完整 echarts 配置，数 } ``` -其中 api 返回内容是如下写法，可以看到通过[数据映射](../concepts/data-mapping)语法，我们可以将 api 放回结果中的 line 字段作为折线的数据。 +其中 api 返回内容是如下写法，可以看到通过[数据映射](../../docs/concepts/data-mapping)语法，我们可以将 api 放回结果中的 line 字段作为折线的数据。 ```json { @@ -206,7 +206,7 @@ api 返回支持两种格式，一种是直接返回完整 echarts 配置，数 可以通过配置`"clickAction": {}`，来指定图表节点的点击行为，支持 amis 的 [行为](./action)。 -然后在配置的行为中可以通过 [数据链](../concepts/datascope-and-datachain) 获取到 [echarts 鼠标事件](https://echarts.apache.org/zh/api.html#events.%E9%BC%A0%E6%A0%87%E4%BA%8B%E4%BB%B6.click) 的值，例如下面例子中可以通过`${value|json}`获取到点击节点的`传入的数据值` +然后在配置的行为中可以通过 [数据链](../../docs/concepts/datascope-and-datachain) 获取到 [echarts 鼠标事件](https://echarts.apache.org/zh/api.html#events.%E9%BC%A0%E6%A0%87%E4%BA%8B%E4%BB%B6.click) 的值，例如下面例子中可以通过`${value|json}`获取到点击节点的`传入的数据值` > 点击下面坐标中的节点查看效果！ @@ -435,18 +435,18 @@ window.echarts = amisRequire('echarts'); ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------------ | ------------------------------------ | --------- | ------------------------------------------------------------------ | -| type | `string` | `"chart"` | 指定为 chart 渲染器 | -| className | `string` | | 外层 Dom 的类名 | -| body | [SchemaNode](../types/schemanode) | | 内容容器 | -| api | [api](../types/api) | | 配置项接口地址 | -| source | [数据映射](../concepts/data-mapping) | | 通过数据映射获取数据链中变量值作为配置 | -| initFetch | `boolean` | | 组件初始化时，是否请求接口 | -| interval | `number` | | 刷新时间(最小 1000) | -| config | `object` 或 `string` | | 设置 eschars 的配置项,当为`string`的时候可以设置 function 等配置项 | -| style | `object` | | 设置根元素的 style | -| width | `string` | | 设置根元素的宽度 | -| height | `string` | | 设置根元素的高度 | -| replaceChartOption | `boolean` | `false` | 每次更新是完全覆盖配置项还是追加？ | -| `trackExpression` | `string` | | 当这个表达式的值有变化时更新图表 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------------ | -------------------------------------------- | --------- | ------------------------------------------------------------------ | +| type | `string` | `"chart"` | 指定为 chart 渲染器 | +| className | `string` | | 外层 Dom 的类名 | +| body | [SchemaNode](../../docs/types/schemanode) | | 内容容器 | +| api | [api](../../docs/types/api) | | 配置项接口地址 | +| source | [数据映射](../../docs/concepts/data-mapping) | | 通过数据映射获取数据链中变量值作为配置 | +| initFetch | `boolean` | | 组件初始化时，是否请求接口 | +| interval | `number` | | 刷新时间(最小 1000) | +| config | `object` 或 `string` | | 设置 eschars 的配置项,当为`string`的时候可以设置 function 等配置项 | +| style | `object` | | 设置根元素的 style | +| width | `string` | | 设置根元素的宽度 | +| height | `string` | | 设置根元素的高度 | +| replaceChartOption | `boolean` | `false` | 每次更新是完全覆盖配置项还是追加？ | +| `trackExpression` | `string` | | 当这个表达式的值有变化时更新图表 | diff --git a/docs/zh-CN/components/collapse.md b/docs/zh-CN/components/collapse.md index c9c69cc9f..0edb72421 100755 --- a/docs/zh-CN/components/collapse.md +++ b/docs/zh-CN/components/collapse.md @@ -20,12 +20,12 @@ order: 36 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| ---------------- | --------------------------------- | -------------------------------------- | ---------------------- | -| type | `string` | `"collapse"` | 指定为 Collapse 渲染器 | -| title | [SchemaNode](../types/schemanode) | | 标题 | -| body | [SchemaNode](../types/schemanode) | | 内容 | -| className | `string` | `bg-white wrapper` | CSS 类名 | -| headingClassName | `string` | `font-thin b-b b-light text-lg p-b-xs` | 标题 CSS 类名 | -| bodyClassName | `string` | | 内容 CSS 类名。 | -| collapsed | `boolean` | `false` | 默认是否要收起。 | +| 属性名 | 类型 | 默认值 | 说明 | +| ---------------- | ----------------------------------------- | -------------------------------------- | ---------------------- | +| type | `string` | `"collapse"` | 指定为 Collapse 渲染器 | +| title | [SchemaNode](../../docs/types/schemanode) | | 标题 | +| body | [SchemaNode](../../docs/types/schemanode) | | 内容 | +| className | `string` | `bg-white wrapper` | CSS 类名 | +| headingClassName | `string` | `font-thin b-b b-light text-lg p-b-xs` | 标题 CSS 类名 | +| bodyClassName | `string` | | 内容 CSS 类名。 | +| collapsed | `boolean` | `false` | 默认是否要收起。 | diff --git a/docs/zh-CN/components/container.md b/docs/zh-CN/components/container.md index 58a0fe659..61602d72a 100755 --- a/docs/zh-CN/components/container.md +++ b/docs/zh-CN/components/container.md @@ -35,10 +35,10 @@ container 可以通过 style 来设置样式，比如背景色或背景图，注 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------- | --------------------------------- | --------- | ------------------- | -| type | `string` | `"alert"` | 指定为 alert 渲染器 | -| className | `string` | | 外层 Dom 的类名 | -| bodyClassName | `string` | | 容器内容区的类名 | -| style | `Object` | | 自定义样式 | -| body | [SchemaNode](../types/schemanode) | | 容器内容 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------- | ----------------------------------------- | --------- | ------------------- | +| type | `string` | `"alert"` | 指定为 alert 渲染器 | +| className | `string` | | 外层 Dom 的类名 | +| bodyClassName | `string` | | 容器内容区的类名 | +| style | `Object` | | 自定义样式 | +| body | [SchemaNode](../../docs/types/schemanode) | | 容器内容 | diff --git a/docs/zh-CN/components/crud.md b/docs/zh-CN/components/crud.md index aa7060d71..d2c4a09c2 100755 --- a/docs/zh-CN/components/crud.md +++ b/docs/zh-CN/components/crud.md @@ -637,7 +637,7 @@ amis 只负责生成排序组件，并将排序参数传递给接口，而不会 } ``` -你可以通过[数据映射](../concepts/data-mapping)，在`api`中获取这些参数。 +你可以通过[数据映射](../../docs/concepts/data-mapping)，在`api`中获取这些参数。 ### 快速搜索 @@ -670,7 +670,7 @@ amis 只负责生成搜索组件，并将搜索参数传递给接口，而不会 } ``` -你可以通过[数据映射](../concepts/data-mapping)，在`api`中获取这些参数。 +你可以通过[数据映射](../../docs/concepts/data-mapping)，在`api`中获取这些参数。 ### 快速过滤 @@ -711,7 +711,7 @@ amis 只负责生成下拉选择器组件，并将搜索参数传递给接口， } ``` -你可以通过[数据映射](../concepts/data-mapping)，在`api`中获取这些参数。 +你可以通过[数据映射](../../docs/concepts/data-mapping)，在`api`中获取这些参数。 ### 快速编辑 @@ -952,7 +952,7 @@ crud 组件支持通过配置`headerToolbar`和`footerToolbar`属性，实现在 > 如果你不希望在顶部或者底部渲染默认组件，你可以设置`headerToolbar`和`footerToolbar`为空数组`[]` -除了可以配置[SchemaNode 类型](../types/schemanode)以外，`headerToolbar`和`footerToolbar`还支持一些针对列表场景而内置的一些常用组件，下面分别介绍： +除了可以配置[SchemaNode 类型](../../docs/types/schemanode)以外，`headerToolbar`和`footerToolbar`还支持一些针对列表场景而内置的一些常用组件，下面分别介绍： ### 分页 @@ -1022,7 +1022,7 @@ crud 组件支持通过配置`headerToolbar`和`footerToolbar`属性，实现在 } ``` -你可以通过[数据映射](../concepts/data-mapping)，在`api`中获取这些参数。 +你可以通过[数据映射](../../docs/concepts/data-mapping)，在`api`中获取这些参数。 ```json { @@ -1172,7 +1172,7 @@ crud 组件支持通过配置`headerToolbar`和`footerToolbar`属性，实现在 - `ids` `Array` 前提是行数据中有 id 字段，或者有指定的 `primaryField` 字段。 - `第一行所有行数据` 还有第一行的所有行数据也会包含进去。 -你可以通过[数据映射](../concepts/data-mapping)，在`api`中获取这些参数。 +你可以通过[数据映射](../../docs/concepts/data-mapping)，在`api`中获取这些参数。 ### 数据统计 @@ -1392,7 +1392,7 @@ crud 组件支持通过配置`headerToolbar`和`footerToolbar`属性，实现在 现在问题是，如何获取到当前操作行的数据呢？ -实际上，你操作当前行数据，会成为弹框这层节点的父级节点，因此你可以通过 [数据链](../concepts/datascope-and-datachain)，获取到上层，也就是点击的行的数据，具体获取方法和普通组件获取数据域中数据的方法相同， +实际上，你操作当前行数据，会成为弹框这层节点的父级节点，因此你可以通过 [数据链](../../docs/concepts/datascope-and-datachain)，获取到上层，也就是点击的行的数据，具体获取方法和普通组件获取数据域中数据的方法相同， ```schema: scope="body" { @@ -1519,7 +1519,7 @@ crud 组件支持通过配置`headerToolbar`和`footerToolbar`属性，实现在 表示：成员 1 和成员 3 插入到了成员 2 的后面。成员 4 和 成员 5 插入到了 成员 6 的后面。 -你可以通过[数据映射](../concepts/data-mapping)，在`api`中获取这些参数。 +你可以通过[数据映射](../../docs/concepts/data-mapping)，在`api`中获取这些参数。 如下: @@ -1548,7 +1548,7 @@ CRUD 中不限制有多少个单条操作、添加一个操作对应的添加一 - `prevIndex` `number` - `nextIndex` `number` -你可以通过[数据映射](../concepts/data-mapping)，在`api`中获取这些参数。 +你可以通过[数据映射](../../docs/concepts/data-mapping)，在`api`中获取这些参数。 如果你的按钮类型是 ajax，你也可以限定只发送部分数据比如。 @@ -1632,7 +1632,7 @@ CRUD 中不限制有多少个单条操作、添加一个操作对应的添加一 } ``` -配置一次性加载后，基本的分页、快速排序操作将会在前端进行完成。如果想实现前端检索，需要用到[数据映射](../concepts/data-mapping)功能： +配置一次性加载后，基本的分页、快速排序操作将会在前端进行完成。如果想实现前端检索，需要用到[数据映射](../../docs/concepts/data-mapping)功能： ```schema: scope="body" { @@ -1685,48 +1685,48 @@ CRUD 中不限制有多少个单条操作、添加一个操作对应的添加一 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------------------------------- | ------------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| type | `string` | | `type` 指定为 CRUD 渲染器 | -| mode | `string` | `"table"` | `"table" 、 "cards" 或者 "list"` | -| title | `string` | `""` | 可设置成空，当设置成空时，没有标题栏 | -| className | `string` | | 表格外层 Dom 的类名 | -| api | [API](../types/api) | | CRUD 用来获取列表数据的 api。 | -| loadDataOnce | `boolean` | | 是否一次性加载所有数据（前端分页） | -| loadDataOnceFetchOnFilter | `boolean` | `true` | 在开启 loadDataOnce 时，filter 时是否去重新请求 api | -| source | `string` | | 数据映射接口返回某字段的值，不设置会默认把接口返回的`items`或者`rows`填充进`mode`区域 | -| filter | [Form](./form/index) | | 设置过滤器，当该表单提交后，会把数据带给当前 `mode` 刷新列表。 | -| filterTogglable | `boolean` | `false` | 是否可显隐过滤器 | -| filterDefaultVisible | `boolean` | `true` | 设置过滤器默认是否可见。 | -| initFetch | `boolean` | `true` | 是否初始化的时候拉取数据, 只针对有 filter 的情况, 没有 filter 初始都会拉取数据 | -| interval | `number` | `3000` | 刷新时间(最低 1000) | -| silentPolling | `boolean` | `false` | 配置刷新时是否隐藏加载动画 | -| stopAutoRefreshWhen | `string` | `""` | 通过[表达式](../concepts/expression)来配置停止刷新的条件 | -| stopAutoRefreshWhenModalIsOpen | `boolean` | `false` | 当有弹框时关闭自动刷新，关闭弹框又恢复 | -| syncLocation | `boolean` | `true` | 是否将过滤条件的参数同步到地址栏 | -| draggable | `boolean` | `false` | 是否可通过拖拽排序 | -| itemDraggableOn | `boolean` | | 用[表达式](../concepts/expression)来配置是否可拖拽排序 | -| [saveOrderApi](#saveOrderApi) | [API](../types/api) | | 保存排序的 api。 | -| [quickSaveApi](#quickSaveApi) | [API](../types/api) | | 快速编辑后用来批量保存的 API。 | -| [quickSaveItemApi](#quickSaveItemApi) | [API](../types/api) | | 快速编辑配置成及时保存时使用的 API。 | -| bulkActions | Array<[Action](./action)> | | 批量操作列表，配置后，表格可进行选中操作。 | -| defaultChecked | `boolean` | `false` | 当可批量操作时，默认是否全部勾选。 | -| messages | `Object` | | 覆盖消息提示，如果不指定，将采用 api 返回的 message | -| messages.fetchFailed | `string` | | 获取失败时提示 | -| messages.saveOrderFailed | `string` | | 保存顺序失败提示 | -| messages.saveOrderSuccess | `string` | | 保存顺序成功提示 | -| messages.quickSaveFailed | `string` | | 快速保存失败提示 | -| messages.quickSaveSuccess | `string` | | 快速保存成功提示 | -| primaryField | `string` | `"id"` | 设置 ID 字段名。 | -| defaultParams | `Object` | | 设置默认 filter 默认参数，会在查询的时候一起发给后端 | -| pageField | `string` | `"page"` | 设置分页页码字段名。 | -| perPageField | `string` | `"perPage"` | 设置分页一页显示的多少条数据的字段名。注意：最好与 defaultParams 一起使用，请看下面例子。 | -| perPageAvailable | `Array` | `[5, 10, 20, 50, 100]` | 设置一页显示多少条数据下拉框可选条数。 | -| orderField | `string` | | 设置用来确定位置的字段名，设置后新的顺序将被赋值到该字段中。 | -| hideQuickSaveBtn | `boolean` | `false` | 隐藏顶部快速保存提示 | -| autoJumpToTopOnPagerChange | `boolean` | `false` | 当切分页的时候，是否自动跳顶部。 | -| syncResponse2Query | `boolean` | `true` | 将返回数据同步到过滤器上。 | -| keepItemSelectionOnPageChange | `boolean` | `true` | 保留条目选择，默认分页、搜素后，用户选择条目会被清空，开启此选项后会保留用户选择，可以实现跨页面批量操作。 | -| labelTpl | `string` | | 单条描述模板，`keepItemSelectionOnPageChange`设置为`true`后会把所有已选择条目列出来，此选项可以用来定制条目展示文案。 | -| headerToolbar | Array | `['bulkActions', 'pagination']` | 顶部工具栏配置 | -| footerToolbar | Array | `['statistics', 'pagination']` | 底部工具栏配置 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------------------------------- | --------------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| type | `string` | | `type` 指定为 CRUD 渲染器 | +| mode | `string` | `"table"` | `"table" 、 "cards" 或者 "list"` | +| title | `string` | `""` | 可设置成空，当设置成空时，没有标题栏 | +| className | `string` | | 表格外层 Dom 的类名 | +| api | [API](../../docs/types/api) | | CRUD 用来获取列表数据的 api。 | +| loadDataOnce | `boolean` | | 是否一次性加载所有数据（前端分页） | +| loadDataOnceFetchOnFilter | `boolean` | `true` | 在开启 loadDataOnce 时，filter 时是否去重新请求 api | +| source | `string` | | 数据映射接口返回某字段的值，不设置会默认把接口返回的`items`或者`rows`填充进`mode`区域 | +| filter | [Form](./form/index) | | 设置过滤器，当该表单提交后，会把数据带给当前 `mode` 刷新列表。 | +| filterTogglable | `boolean` | `false` | 是否可显隐过滤器 | +| filterDefaultVisible | `boolean` | `true` | 设置过滤器默认是否可见。 | +| initFetch | `boolean` | `true` | 是否初始化的时候拉取数据, 只针对有 filter 的情况, 没有 filter 初始都会拉取数据 | +| interval | `number` | `3000` | 刷新时间(最低 1000) | +| silentPolling | `boolean` | `false` | 配置刷新时是否隐藏加载动画 | +| stopAutoRefreshWhen | `string` | `""` | 通过[表达式](../../docs/concepts/expression)来配置停止刷新的条件 | +| stopAutoRefreshWhenModalIsOpen | `boolean` | `false` | 当有弹框时关闭自动刷新，关闭弹框又恢复 | +| syncLocation | `boolean` | `true` | 是否将过滤条件的参数同步到地址栏 | +| draggable | `boolean` | `false` | 是否可通过拖拽排序 | +| itemDraggableOn | `boolean` | | 用[表达式](../../docs/concepts/expression)来配置是否可拖拽排序 | +| [saveOrderApi](#saveOrderApi) | [API](../../docs/types/api) | | 保存排序的 api。 | +| [quickSaveApi](#quickSaveApi) | [API](../../docs/types/api) | | 快速编辑后用来批量保存的 API。 | +| [quickSaveItemApi](#quickSaveItemApi) | [API](../../docs/types/api) | | 快速编辑配置成及时保存时使用的 API。 | +| bulkActions | Array<[Action](./action)> | | 批量操作列表，配置后，表格可进行选中操作。 | +| defaultChecked | `boolean` | `false` | 当可批量操作时，默认是否全部勾选。 | +| messages | `Object` | | 覆盖消息提示，如果不指定，将采用 api 返回的 message | +| messages.fetchFailed | `string` | | 获取失败时提示 | +| messages.saveOrderFailed | `string` | | 保存顺序失败提示 | +| messages.saveOrderSuccess | `string` | | 保存顺序成功提示 | +| messages.quickSaveFailed | `string` | | 快速保存失败提示 | +| messages.quickSaveSuccess | `string` | | 快速保存成功提示 | +| primaryField | `string` | `"id"` | 设置 ID 字段名。 | +| defaultParams | `Object` | | 设置默认 filter 默认参数，会在查询的时候一起发给后端 | +| pageField | `string` | `"page"` | 设置分页页码字段名。 | +| perPageField | `string` | `"perPage"` | 设置分页一页显示的多少条数据的字段名。注意：最好与 defaultParams 一起使用，请看下面例子。 | +| perPageAvailable | `Array` | `[5, 10, 20, 50, 100]` | 设置一页显示多少条数据下拉框可选条数。 | +| orderField | `string` | | 设置用来确定位置的字段名，设置后新的顺序将被赋值到该字段中。 | +| hideQuickSaveBtn | `boolean` | `false` | 隐藏顶部快速保存提示 | +| autoJumpToTopOnPagerChange | `boolean` | `false` | 当切分页的时候，是否自动跳顶部。 | +| syncResponse2Query | `boolean` | `true` | 将返回数据同步到过滤器上。 | +| keepItemSelectionOnPageChange | `boolean` | `true` | 保留条目选择，默认分页、搜素后，用户选择条目会被清空，开启此选项后会保留用户选择，可以实现跨页面批量操作。 | +| labelTpl | `string` | | 单条描述模板，`keepItemSelectionOnPageChange`设置为`true`后会把所有已选择条目列出来，此选项可以用来定制条目展示文案。 | +| headerToolbar | Array | `['bulkActions', 'pagination']` | 顶部工具栏配置 | +| footerToolbar | Array | `['statistics', 'pagination']` | 底部工具栏配置 | diff --git a/docs/zh-CN/components/dialog.md b/docs/zh-CN/components/dialog.md index a8215642c..17f5e66ca 100755 --- a/docs/zh-CN/components/dialog.md +++ b/docs/zh-CN/components/dialog.md @@ -142,7 +142,7 @@ Dialog 弹框 主要由 [Action](./action) 触发，主要展示一个对话框 } ``` -上例弹框中的表单项 `Engine` 会自动映射到父级数据中的 `engine` 变量，如果想调整当前特性，如你想调整父级映射变量的字段，可以利用[数据映射](../concepts/data-mapping)，例如： +上例弹框中的表单项 `Engine` 会自动映射到父级数据中的 `engine` 变量，如果想调整当前特性，如你想调整父级映射变量的字段，可以利用[数据映射](../../docs/concepts/data-mapping)，例如： ```schema: scope="body" { @@ -694,16 +694,16 @@ feedback 反馈弹框是指，在 ajax 请求后，可以显示一个弹框， ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| --------------- | --------------------------------- | ------------------ | ---------------------------------------------------------------------------------------- | -| type | `string` | | `"dialog"` 指定为 Dialog 渲染器 | -| title | [SchemaNode](../types/schemanode) | | 弹出层标题 | -| body | [SchemaNode](../types/schemanode) | | 往 Dialog 内容区加内容 | -| size | `string` | | 指定 dialog 大小，支持: `xs`、`sm`、`md`、`lg` | -| bodyClassName | `string` | `modal-body` | Dialog body 区域的样式类名 | -| closeOnEsc | `boolean` | `false` | 是否支持按 `Esc` 关闭 Dialog | -| showCloseButton | `boolean` | `true` | 是否显示右上角的关闭按钮 | -| showErrorMsg | `boolean` | `true` | 是否在弹框左下角显示报错信息 | -| disabled | `boolean` | `false` | 如果设置此属性，则该 Dialog 只读没有提交操作。 | -| actions | Array<[Action](./action)> | 【确认】和【取消】 | 如果想不显示底部按钮，可以配置：`[]` | -| data | `object` | | 支持[数据映射](../concepts/data-mapping)，如果不设定将默认将触发按钮的上下文中继承数据。 | +| 属性名 | 类型 | 默认值 | 说明 | +| --------------- | ----------------------------------------- | ------------------ | ------------------------------------------------------------------------------------------------ | +| type | `string` | | `"dialog"` 指定为 Dialog 渲染器 | +| title | [SchemaNode](../../docs/types/schemanode) | | 弹出层标题 | +| body | [SchemaNode](../../docs/types/schemanode) | | 往 Dialog 内容区加内容 | +| size | `string` | | 指定 dialog 大小，支持: `xs`、`sm`、`md`、`lg` | +| bodyClassName | `string` | `modal-body` | Dialog body 区域的样式类名 | +| closeOnEsc | `boolean` | `false` | 是否支持按 `Esc` 关闭 Dialog | +| showCloseButton | `boolean` | `true` | 是否显示右上角的关闭按钮 | +| showErrorMsg | `boolean` | `true` | 是否在弹框左下角显示报错信息 | +| disabled | `boolean` | `false` | 如果设置此属性，则该 Dialog 只读没有提交操作。 | +| actions | Array<[Action](./action)> | 【确认】和【取消】 | 如果想不显示底部按钮，可以配置：`[]` | +| data | `object` | | 支持[数据映射](../../docs/concepts/data-mapping)，如果不设定将默认将触发按钮的上下文中继承数据。 | diff --git a/docs/zh-CN/components/drawer.md b/docs/zh-CN/components/drawer.md index 59c6b3790..323654932 100755 --- a/docs/zh-CN/components/drawer.md +++ b/docs/zh-CN/components/drawer.md @@ -212,16 +212,16 @@ order: 43 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| -------------- | --------------------------------- | ------------------ | ----------------------------------------------------------------------------------------- | -| type | `string` | | `"drawer"` 指定为 Drawer 渲染器 | -| title | [SchemaNode](../types/schemanode) | | 弹出层标题 | -| body | [SchemaNode](../types/schemanode) | | 往 Drawer 内容区加内容 | -| size | `string` | | 指定 Drawer 大小，支持: `xs`、`sm`、`md`、`lg` | -| bodyClassName | `string` | `modal-body` | Drawer body 区域的样式类名 | -| closeOnEsc | `boolean` | `false` | 是否支持按 `Esc` 关闭 Drawer | -| closeOnOutside | `boolean` | `false` | 点击内容区外是否关闭 Drawer | -| overlay | `boolean` | `true` | 是否显示蒙层 | -| resizable | `boolean` | `false` | 是否可通过拖拽改变 Drawer 大小 | -| actions | Array<[Action](./action)> | 【确认】和【取消】 | 可以不设置，默认只有两个按钮。 | -| data | `object` | | 支持 [数据映射](../concepts/data-mapping)，如果不设定将默认将触发按钮的上下文中继承数据。 | +| 属性名 | 类型 | 默认值 | 说明 | +| -------------- | ----------------------------------------- | ------------------ | ------------------------------------------------------------------------------------------------- | +| type | `string` | | `"drawer"` 指定为 Drawer 渲染器 | +| title | [SchemaNode](../../docs/types/schemanode) | | 弹出层标题 | +| body | [SchemaNode](../../docs/types/schemanode) | | 往 Drawer 内容区加内容 | +| size | `string` | | 指定 Drawer 大小，支持: `xs`、`sm`、`md`、`lg` | +| bodyClassName | `string` | `modal-body` | Drawer body 区域的样式类名 | +| closeOnEsc | `boolean` | `false` | 是否支持按 `Esc` 关闭 Drawer | +| closeOnOutside | `boolean` | `false` | 点击内容区外是否关闭 Drawer | +| overlay | `boolean` | `true` | 是否显示蒙层 | +| resizable | `boolean` | `false` | 是否可通过拖拽改变 Drawer 大小 | +| actions | Array<[Action](./action)> | 【确认】和【取消】 | 可以不设置，默认只有两个按钮。 | +| data | `object` | | 支持 [数据映射](../../docs/concepts/data-mapping)，如果不设定将默认将触发按钮的上下文中继承数据。 | diff --git a/docs/zh-CN/components/each.md b/docs/zh-CN/components/each.md index 69fd49c2b..6121b49df 100755 --- a/docs/zh-CN/components/each.md +++ b/docs/zh-CN/components/each.md @@ -118,9 +118,9 @@ List 的内容、Card 卡片的内容配置同上 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| ------ | -------- | -------- | ----------------------------------------------------------- | -| type | `string` | `"each"` | 指定为 Each 组件 | -| value | `array` | `[]` | 用于循环的值 | -| name | `string` | | 获取数据域中变量，支持 [数据映射](../concepts/data-mapping) | -| items | `object` | | 使用`value`中的数据，循环输出渲染器。 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------ | -------- | -------- | ------------------------------------------------------------------- | +| type | `string` | `"each"` | 指定为 Each 组件 | +| value | `array` | `[]` | 用于循环的值 | +| name | `string` | | 获取数据域中变量，支持 [数据映射](../../docs/concepts/data-mapping) | +| items | `object` | | 使用`value`中的数据，循环输出渲染器。 | diff --git a/docs/zh-CN/components/form/array.md b/docs/zh-CN/components/form/array.md index 4b9d8b66d..beb22676b 100755 --- a/docs/zh-CN/components/form/array.md +++ b/docs/zh-CN/components/form/array.md @@ -31,14 +31,14 @@ Array 是一种简化的 [Combo](./combo)，用于输入多个某种类型的[ 除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------- | --------------------------------- | --------- | ------------------------------------------------------------------------ | -| type | `string` | `"array"` | 指明为`array`组件 | -| items | `string`或 [API](../../types/api) | | 配置单项表单类型 | -| addable | `boolean` | | 是否可新增。 | -| removable | `boolean` | | 是否可删除 | -| draggable | `boolean` | `false` | 是否可以拖动排序, 需要注意的是当启用拖动排序的时候，会多一个\$id 字段 | -| draggableTip | `string` | | 可拖拽的提示文字，默认为：`"可通过拖动每行中的【交换】按钮进行顺序调整"` | -| addButtonText | `string` | `"新增"` | 新增按钮文字 | -| minLength | `number` | | 限制最小长度 | -| maxLength | `number` | | 限制最大长度 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------- | ----------------------------------------- | --------- | ------------------------------------------------------------------------ | +| type | `string` | `"array"` | 指明为`array`组件 | +| items | `string`或 [API](../../../docs/types/api) | | 配置单项表单类型 | +| addable | `boolean` | | 是否可新增。 | +| removable | `boolean` | | 是否可删除 | +| draggable | `boolean` | `false` | 是否可以拖动排序, 需要注意的是当启用拖动排序的时候，会多一个\$id 字段 | +| draggableTip | `string` | | 可拖拽的提示文字，默认为：`"可通过拖动每行中的【交换】按钮进行顺序调整"` | +| addButtonText | `string` | `"新增"` | 新增按钮文字 | +| minLength | `number` | | 限制最小长度 | +| maxLength | `number` | | 限制最大长度 | diff --git a/docs/zh-CN/components/form/button-group.md b/docs/zh-CN/components/form/button-group.md index 7a9cbb724..fb8f70dea 100755 --- a/docs/zh-CN/components/form/button-group.md +++ b/docs/zh-CN/components/form/button-group.md @@ -85,13 +85,13 @@ order: 6 当做选择器表单项使用时，除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------ | --------------------------------- | --------- | ------------------------------------------------------------------------------------------- | -| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | -| source | `string`或 [API](../../types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | -| multiple | `boolean` | `false` | [多选](./options#%E5%A4%9A%E9%80%89-multiple) | -| labelField | `boolean` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | -| valueField | `boolean` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | -| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | -| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | -| autoFill | `object` | | [自动填充](./options#%E8%87%AA%E5%8A%A8%E5%A1%AB%E5%85%85-autofill) | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------ | ----------------------------------------- | --------- | ------------------------------------------------------------------------------------------- | +| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | +| source | `string`或 [API](../../../docs/types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | +| multiple | `boolean` | `false` | [多选](./options#%E5%A4%9A%E9%80%89-multiple) | +| labelField | `boolean` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | +| valueField | `boolean` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | +| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | +| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | +| autoFill | `object` | | [自动填充](./options#%E8%87%AA%E5%8A%A8%E5%A1%AB%E5%85%85-autofill) | diff --git a/docs/zh-CN/components/form/chain-select.md b/docs/zh-CN/components/form/chain-select.md index a4463152a..d685e2880 100755 --- a/docs/zh-CN/components/form/chain-select.md +++ b/docs/zh-CN/components/form/chain-select.md @@ -44,13 +44,13 @@ order: 7 除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------ | --------------------------------- | --------- | ------------------------------------------------------------------------------------------- | -| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | -| source | `string`或 [API](../../types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | -| autoComplete | `string`或 [API](../../types/api) | | [自动选中](./options#%E8%87%AA%E5%8A%A8%E8%A1%A5%E5%85%A8-autocomplete) | -| delimiter | `string` | `,` | [拼接符](./options#%E6%8B%BC%E6%8E%A5%E7%AC%A6-delimiter) | -| labelField | `boolean` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | -| valueField | `boolean` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | -| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | -| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------ | ----------------------------------------- | --------- | ------------------------------------------------------------------------------------------- | +| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | +| source | `string`或 [API](../../../docs/types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | +| autoComplete | `string`或 [API](../../../docs/types/api) | | [自动选中](./options#%E8%87%AA%E5%8A%A8%E8%A1%A5%E5%85%A8-autocomplete) | +| delimiter | `string` | `,` | [拼接符](./options#%E6%8B%BC%E6%8E%A5%E7%AC%A6-delimiter) | +| labelField | `boolean` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | +| valueField | `boolean` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | +| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | +| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | diff --git a/docs/zh-CN/components/form/checkboxes.md b/docs/zh-CN/components/form/checkboxes.md index a425f7d15..1cdf834d9 100755 --- a/docs/zh-CN/components/form/checkboxes.md +++ b/docs/zh-CN/components/form/checkboxes.md @@ -111,24 +111,24 @@ order: 9 当做选择器表单项使用时，除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置 -| 属性名 | 类型 | 默认值 | 说明 | -| --------------- | --------------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------- | -| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | -| source | `string`或 [API](../../types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | -| delimeter | `string` | `false` | [拼接符](./options#%E6%8B%BC%E6%8E%A5%E7%AC%A6-delimiter) | -| labelField | `string` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | -| valueField | `string` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | -| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | -| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | -| columnsCount | `number` | `1` | 选项按几列显示，默认为一列 | -| checkAll | `boolean` | `false` | 是否支持全选 | -| defaultCheckAll | `boolean` | `false` | 默认是否全选 | -| creatable | `boolean` | `false` | [新增选项](./options#%E5%89%8D%E7%AB%AF%E6%96%B0%E5%A2%9E-creatable) | -| createBtnLabel | `string` | `"新增选项"` | [新增选项](./options#%E6%96%B0%E5%A2%9E%E9%80%89%E9%A1%B9) | -| addControls | Array<[表单项](./formitem)> | | [自定义新增表单项](./options#%E8%87%AA%E5%AE%9A%E4%B9%89%E6%96%B0%E5%A2%9E%E8%A1%A8%E5%8D%95%E9%A1%B9-addcontrols) | -| addApi | [API](../types/api) | | [配置新增选项接口](./options#%E9%85%8D%E7%BD%AE%E6%96%B0%E5%A2%9E%E6%8E%A5%E5%8F%A3-addapi) | -| editable | `boolean` | `false` | [编辑选项](./options#%E5%89%8D%E7%AB%AF%E7%BC%96%E8%BE%91-editable) | -| editControls | Array<[表单项](./formitem)> | | [自定义编辑表单项](./options#%E8%87%AA%E5%AE%9A%E4%B9%89%E7%BC%96%E8%BE%91%E8%A1%A8%E5%8D%95%E9%A1%B9-editcontrols) | -| editApi | [API](../types/api) | | [配置编辑选项接口](./options#%E9%85%8D%E7%BD%AE%E7%BC%96%E8%BE%91%E6%8E%A5%E5%8F%A3-editapi) | -| removable | `boolean` | `false` | [删除选项](./options#%E5%88%A0%E9%99%A4%E9%80%89%E9%A1%B9) | -| deleteApi | [API](../types/api) | | [配置删除选项接口](./options#%E9%85%8D%E7%BD%AE%E5%88%A0%E9%99%A4%E6%8E%A5%E5%8F%A3-deleteapi) | +| 属性名 | 类型 | 默认值 | 说明 | +| --------------- | ----------------------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------- | +| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | +| source | `string`或 [API](../../../docs/types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | +| delimeter | `string` | `false` | [拼接符](./options#%E6%8B%BC%E6%8E%A5%E7%AC%A6-delimiter) | +| labelField | `string` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | +| valueField | `string` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | +| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | +| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | +| columnsCount | `number` | `1` | 选项按几列显示，默认为一列 | +| checkAll | `boolean` | `false` | 是否支持全选 | +| defaultCheckAll | `boolean` | `false` | 默认是否全选 | +| creatable | `boolean` | `false` | [新增选项](./options#%E5%89%8D%E7%AB%AF%E6%96%B0%E5%A2%9E-creatable) | +| createBtnLabel | `string` | `"新增选项"` | [新增选项](./options#%E6%96%B0%E5%A2%9E%E9%80%89%E9%A1%B9) | +| addControls | Array<[表单项](./formitem)> | | [自定义新增表单项](./options#%E8%87%AA%E5%AE%9A%E4%B9%89%E6%96%B0%E5%A2%9E%E8%A1%A8%E5%8D%95%E9%A1%B9-addcontrols) | +| addApi | [API](../../docs/types/api) | | [配置新增选项接口](./options#%E9%85%8D%E7%BD%AE%E6%96%B0%E5%A2%9E%E6%8E%A5%E5%8F%A3-addapi) | +| editable | `boolean` | `false` | [编辑选项](./options#%E5%89%8D%E7%AB%AF%E7%BC%96%E8%BE%91-editable) | +| editControls | Array<[表单项](./formitem)> | | [自定义编辑表单项](./options#%E8%87%AA%E5%AE%9A%E4%B9%89%E7%BC%96%E8%BE%91%E8%A1%A8%E5%8D%95%E9%A1%B9-editcontrols) | +| editApi | [API](../../docs/types/api) | | [配置编辑选项接口](./options#%E9%85%8D%E7%BD%AE%E7%BC%96%E8%BE%91%E6%8E%A5%E5%8F%A3-editapi) | +| removable | `boolean` | `false` | [删除选项](./options#%E5%88%A0%E9%99%A4%E9%80%89%E9%A1%B9) | +| deleteApi | [API](../../docs/types/api) | | [配置删除选项接口](./options#%E9%85%8D%E7%BD%AE%E5%88%A0%E9%99%A4%E6%8E%A5%E5%8F%A3-deleteapi) | diff --git a/docs/zh-CN/components/form/combo.md b/docs/zh-CN/components/form/combo.md index 762bfe234..6eeb1a0fd 100755 --- a/docs/zh-CN/components/form/combo.md +++ b/docs/zh-CN/components/form/combo.md @@ -348,7 +348,7 @@ combo 还有一个作用是增加层级，比如返回的数据是一个深层 } ``` -这样就能结合 [definitions](../../types/definitions#树形结构) 实现无限层级结构。 +这样就能结合 [definitions](../../../docs/types/definitions#树形结构) 实现无限层级结构。 ## 唯一验证 @@ -752,30 +752,30 @@ combo 还有一个作用是增加层级，比如返回的数据是一个深层 当做选择器表单项使用时，除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置 -| 属性名 | 类型 | 默认值 | 说明 | -| --------------------------- | --------------------------- | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| formClassName | `string` | | 单组表单项的类名 | -| controls | Array<[表单项](./formitem)> | | 组合展示的表单项 | -| controls[x].columnClassName | `string` | | 列的类名，可以用它配置列宽度。默认平均分配。 | -| controls[x].unique | `boolean` | | 设置当前列值是否唯一，即不允许重复选择。 | -| multiple | `boolean` | `false` | 是否多选 | -| multiLine | `boolean` | `false` | 默认是横着展示一排，设置以后竖着展示 | -| minLength | `number` | | 最少添加的条数 | -| maxLength | `number` | | 最多添加的条数 | -| flat | `boolean` | `false` | 是否将结果扁平化(去掉 name),只有当 controls 的 length 为 1 且 multiple 为 true 的时候才有效。 | -| joinValues | `boolean` | `true` | 默认为 `true` 当扁平化开启的时候，是否用分隔符的形式发送给后端，否则采用 array 的方式。 | -| delimiter | `string` | `false` | 当扁平化开启并且 joinValues 为 true 时，用什么分隔符。 | -| addable | `boolean` | `false` | 是否可新增 | -| removable | `boolean` | `false` | 是否可删除 | -| deleteApi | [API](../../types/api) | | 如果配置了，则删除前会发送一个 api，请求成功才完成删除 | -| deleteConfirmText | `string` | `"确认要删除？"` | 当配置 `deleteApi` 才生效！删除时用来做用户确认 | -| draggable | `boolean` | `false` | 是否可以拖动排序, 需要注意的是当启用拖动排序的时候，会多一个\$id 字段 | -| draggableTip | `string` | `"可通过拖动每行中的【交换】按钮进行顺序调整"` | 可拖拽的提示文字 | -| addButtonText | `string` | `"新增"` | 新增按钮文字 | -| scaffold | `object` | `{}` | 单组表单项初始值 | -| canAccessSuperData | `boolean` | `false` | 指定是否可以自动获取上层的数据并映射到表单项上 | -| conditions | `object` | | 数组的形式包含所有条件的渲染类型，单个数组内的`test` 为判断条件，数组内的`controls`为符合该条件后渲染的`schema` | -| typeSwitchable | `boolean` | `false` | 是否可切换条件，配合`conditions`使用 | -| noBorder | `boolean` | `false` | 单组表单项是否显示边框 | -| strictMode | `boolean` | `true` | 默认为严格模式，设置为 false 时，当其他表单项更新是，里面的表单项也可以及时获取，否则不会。 | -| syncFields | `Array` | `true` | 配置同步字段。只有 strictMode 为 false 时有效。如果 combo 层级比较深，底层的获取外层的数据可能不同步。但是给 combo 配置这个属性就能同步下来。输入格式：`["os"]` | +| 属性名 | 类型 | 默认值 | 说明 | +| --------------------------- | ------------------------------ | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| formClassName | `string` | | 单组表单项的类名 | +| controls | Array<[表单项](./formitem)> | | 组合展示的表单项 | +| controls[x].columnClassName | `string` | | 列的类名，可以用它配置列宽度。默认平均分配。 | +| controls[x].unique | `boolean` | | 设置当前列值是否唯一，即不允许重复选择。 | +| multiple | `boolean` | `false` | 是否多选 | +| multiLine | `boolean` | `false` | 默认是横着展示一排，设置以后竖着展示 | +| minLength | `number` | | 最少添加的条数 | +| maxLength | `number` | | 最多添加的条数 | +| flat | `boolean` | `false` | 是否将结果扁平化(去掉 name),只有当 controls 的 length 为 1 且 multiple 为 true 的时候才有效。 | +| joinValues | `boolean` | `true` | 默认为 `true` 当扁平化开启的时候，是否用分隔符的形式发送给后端，否则采用 array 的方式。 | +| delimiter | `string` | `false` | 当扁平化开启并且 joinValues 为 true 时，用什么分隔符。 | +| addable | `boolean` | `false` | 是否可新增 | +| removable | `boolean` | `false` | 是否可删除 | +| deleteApi | [API](../../../docs/types/api) | | 如果配置了，则删除前会发送一个 api，请求成功才完成删除 | +| deleteConfirmText | `string` | `"确认要删除？"` | 当配置 `deleteApi` 才生效！删除时用来做用户确认 | +| draggable | `boolean` | `false` | 是否可以拖动排序, 需要注意的是当启用拖动排序的时候，会多一个\$id 字段 | +| draggableTip | `string` | `"可通过拖动每行中的【交换】按钮进行顺序调整"` | 可拖拽的提示文字 | +| addButtonText | `string` | `"新增"` | 新增按钮文字 | +| scaffold | `object` | `{}` | 单组表单项初始值 | +| canAccessSuperData | `boolean` | `false` | 指定是否可以自动获取上层的数据并映射到表单项上 | +| conditions | `object` | | 数组的形式包含所有条件的渲染类型，单个数组内的`test` 为判断条件，数组内的`controls`为符合该条件后渲染的`schema` | +| typeSwitchable | `boolean` | `false` | 是否可切换条件，配合`conditions`使用 | +| noBorder | `boolean` | `false` | 单组表单项是否显示边框 | +| strictMode | `boolean` | `true` | 默认为严格模式，设置为 false 时，当其他表单项更新是，里面的表单项也可以及时获取，否则不会。 | +| syncFields | `Array` | `true` | 配置同步字段。只有 strictMode 为 false 时有效。如果 combo 层级比较深，底层的获取外层的数据可能不同步。但是给 combo 配置这个属性就能同步下来。输入格式：`["os"]` | diff --git a/docs/zh-CN/components/form/fieldset.md b/docs/zh-CN/components/form/fieldset.md index 602eb9af0..da5748b6f 100755 --- a/docs/zh-CN/components/form/fieldset.md +++ b/docs/zh-CN/components/form/fieldset.md @@ -181,14 +181,14 @@ fieldSet 的另一种标题展现样式，不同的是展开的时候收起文 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| ---------------- | ------------------------------------ | ------- | -------------------------------------------------------------------------- | -| className | `string` | | CSS 类名 | -| headingClassName | `string` | | 标题 CSS 类名 | -| bodyClassName | `string` | | 内容区域 CSS 类名 | -| title | [SchemaNode](../../types/schemanode) | | 标题 | -| controls | Array<[表单项](./formitem)> | | 表单项集合 | -| mode | `string` | | 展示默认，同 [Form](./index#%E8%A1%A8%E5%8D%95%E5%B1%95%E7%A4%BA) 中的模式 | -| collapsable | `boolean` | `false` | 是否可折叠 | -| collapsed | `booelan` | `false` | 默认是否折叠 | -| collapseTitle | [SchemaNode](../../types/schemanode) | `收起` | 收起的标题 | +| 属性名 | 类型 | 默认值 | 说明 | +| ---------------- | -------------------------------------------- | ------- | -------------------------------------------------------------------------- | +| className | `string` | | CSS 类名 | +| headingClassName | `string` | | 标题 CSS 类名 | +| bodyClassName | `string` | | 内容区域 CSS 类名 | +| title | [SchemaNode](../../../docs/types/schemanode) | | 标题 | +| controls | Array<[表单项](./formitem)> | | 表单项集合 | +| mode | `string` | | 展示默认，同 [Form](./index#%E8%A1%A8%E5%8D%95%E5%B1%95%E7%A4%BA) 中的模式 | +| collapsable | `boolean` | `false` | 是否可折叠 | +| collapsed | `booelan` | `false` | 默认是否折叠 | +| collapseTitle | [SchemaNode](../../../docs/types/schemanode) | `收起` | 收起的标题 | diff --git a/docs/zh-CN/components/form/file.md b/docs/zh-CN/components/form/file.md index ade7f1081..0cf4d72a1 100755 --- a/docs/zh-CN/components/form/file.md +++ b/docs/zh-CN/components/form/file.md @@ -147,26 +147,26 @@ order: 21 除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置 -| 属性名 | 类型 | 默认值 | 说明 | -| ---------------- | ---------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| receiver | [API](../../types/api) | | 上传文件接口 | -| accept | `string` | `text/plain` | 默认只支持纯文本，要支持其他类型，请配置此属性为文件后缀`.xxx` | -| asBase64 | `boolean` | `false` | 将文件以`base64`的形式，赋值给当前组件 | -| asBlob | `boolean` | `false` | 将文件以二进制的形式，赋值给当前组件 | -| maxSize | `number` | | 默认没有限制，当设置后，文件大小大于此值将不允许上传。单位为`KB` | -| maxLength | `number` | | 默认没有限制，当设置后，一次只允许上传指定数量文件。 | -| multiple | `boolean` | `false` | 是否多选。 | -| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | -| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | -| delimiter | `string` | `,` | [拼接符](./options#%E6%8B%BC%E6%8E%A5%E7%AC%A6-delimiter) | -| autoUpload | `boolean` | `true` | 否选择完就自动开始上传 | -| hideUploadButton | `boolean` | `false` | 隐藏上传按钮 | -| stateTextMap | object | `{ init: '', pending: '等待上传', uploading: '上传中', error: '上传出错', uploaded: '已上传', ready: '' }` | 上传状态文案 | -| fileField | `string` | `file` | 如果你不想自己存储，则可以忽略此属性。 | -| btnLabel | `string` | | 上传按钮的文字 | -| downloadUrl | `boolean`或`string` | `""` | 默认显示文件路径的时候会支持直接下载，可以支持加前缀如：`http://xx.dom/filename=` ，如果不希望这样，可以把当前配置项设置为 `false`。 | -| useChunk | `boolean`或`"auto"` | `"auto"` | amis 所在服务器，限制了文件上传大小不得超出 10M，所以 amis 在用户选择大文件的时候，自动会改成分块上传模式。 | -| chunkSize | `number` | `5 * 1024 * 1024` | 分块大小 | -| startChunkApi | [API](../../types/api) | | startChunkApi | -| chunkApi | [API](../../types/api) | | chunkApi | -| finishChunkApi | [API](../../types/api) | | finishChunkApi | +| 属性名 | 类型 | 默认值 | 说明 | +| ---------------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| receiver | [API](../../../docs/types/api) | | 上传文件接口 | +| accept | `string` | `text/plain` | 默认只支持纯文本，要支持其他类型，请配置此属性为文件后缀`.xxx` | +| asBase64 | `boolean` | `false` | 将文件以`base64`的形式，赋值给当前组件 | +| asBlob | `boolean` | `false` | 将文件以二进制的形式，赋值给当前组件 | +| maxSize | `number` | | 默认没有限制，当设置后，文件大小大于此值将不允许上传。单位为`KB` | +| maxLength | `number` | | 默认没有限制，当设置后，一次只允许上传指定数量文件。 | +| multiple | `boolean` | `false` | 是否多选。 | +| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | +| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | +| delimiter | `string` | `,` | [拼接符](./options#%E6%8B%BC%E6%8E%A5%E7%AC%A6-delimiter) | +| autoUpload | `boolean` | `true` | 否选择完就自动开始上传 | +| hideUploadButton | `boolean` | `false` | 隐藏上传按钮 | +| stateTextMap | object | `{ init: '', pending: '等待上传', uploading: '上传中', error: '上传出错', uploaded: '已上传', ready: '' }` | 上传状态文案 | +| fileField | `string` | `file` | 如果你不想自己存储，则可以忽略此属性。 | +| btnLabel | `string` | | 上传按钮的文字 | +| downloadUrl | `boolean`或`string` | `""` | 默认显示文件路径的时候会支持直接下载，可以支持加前缀如：`http://xx.dom/filename=` ，如果不希望这样，可以把当前配置项设置为 `false`。 | +| useChunk | `boolean`或`"auto"` | `"auto"` | amis 所在服务器，限制了文件上传大小不得超出 10M，所以 amis 在用户选择大文件的时候，自动会改成分块上传模式。 | +| chunkSize | `number` | `5 * 1024 * 1024` | 分块大小 | +| startChunkApi | [API](../../../docs/types/api) | | startChunkApi | +| chunkApi | [API](../../../docs/types/api) | | chunkApi | +| finishChunkApi | [API](../../../docs/types/api) | | finishChunkApi | diff --git a/docs/zh-CN/components/form/formitem.md b/docs/zh-CN/components/form/formitem.md index dafbbe6ca..6bcd404e3 100755 --- a/docs/zh-CN/components/form/formitem.md +++ b/docs/zh-CN/components/form/formitem.md @@ -196,7 +196,7 @@ order: 1 ##### 通过条件配置是否禁用 -你也通过[表达式](../../concepts/expression)配置`disabledOn`，来实现在某个条件下禁用当前表单项. +你也通过[表达式](../../../docs/concepts/expression)配置`disabledOn`，来实现在某个条件下禁用当前表单项. ```schema: scope="body" { @@ -250,7 +250,7 @@ order: 1 ##### 通过条件配置显隐 -你也通过[表达式](../../concepts/expression)配置`hiddenOn`，来实现在某个条件下禁用当前表单项. +你也通过[表达式](../../../docs/concepts/expression)配置`hiddenOn`，来实现在某个条件下禁用当前表单项. ```schema: scope="body" { @@ -446,7 +446,7 @@ order: 1 ### 满足条件校验必填 -你也通过[表达式](../../concepts/expression)配置`requiredOn`，来实现在某个条件下使当前表单项必填。 +你也通过[表达式](../../../docs/concepts/expression)配置`requiredOn`，来实现在某个条件下使当前表单项必填。 ```schema: scope="body" { @@ -869,23 +869,23 @@ Table 类型的表单项，要实现服务端校验，可以使用 `路径key` ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| -------------- | ------------------------------------------ | ------ | ---------------------------------------------------------- | -| type | `string` | | 指定表单项类型 | -| className | `string` | | 表单最外层类名 | -| inputClassName | `string` | | 表单控制器类名 | -| labelClassName | `string` | | label 的类名 | -| name | `string` | | 字段名，指定该表单项提交时的 key | -| label | [模板](../../concepts/template) 或 `false` | | 表单项标签 | -| labelRemark | [Remark](../../components/remark) | | 表单项标签描述 | -| description | [模板](../../concepts/template) | | 表单项描述 | -| placeholder | `string` | | 表单项描述 | -| inline | `boolean` | | 是否为 内联 模式 | -| submitOnChange | `boolean` | | 是否该表单项值发生变化时就提交当前表单。 | -| disabled | `boolean` | | 当前表单项是否是禁用状态 | -| disabledOn | [表达式](../../concepts/expression) | | 当前表单项是否禁用的条件 | -| visible | [表达式](../../concepts/expression) | | 当前表单项是否禁用的条件 | -| visibleOn | [表达式](../../concepts/expression) | | 当前表单项是否禁用的条件 | -| required | `boolean` | | 是否为必填。 | -| requiredOn | [表达式](../../concepts/expression) | | 过[表达式](../Types.md#表达式)来配置当前表单项是否为必填。 | -| validations | [表达式](../../concepts/expression) | | 表单项值格式验证，支持设置多个，多个规则用英文逗号隔开。 | +| 属性名 | 类型 | 默认值 | 说明 | +| -------------- | -------------------------------------------------- | ------ | ---------------------------------------------------------- | +| type | `string` | | 指定表单项类型 | +| className | `string` | | 表单最外层类名 | +| inputClassName | `string` | | 表单控制器类名 | +| labelClassName | `string` | | label 的类名 | +| name | `string` | | 字段名，指定该表单项提交时的 key | +| label | [模板](../../../docs/concepts/template) 或 `false` | | 表单项标签 | +| labelRemark | [Remark](../../components/remark) | | 表单项标签描述 | +| description | [模板](../../../docs/concepts/template) | | 表单项描述 | +| placeholder | `string` | | 表单项描述 | +| inline | `boolean` | | 是否为 内联 模式 | +| submitOnChange | `boolean` | | 是否该表单项值发生变化时就提交当前表单。 | +| disabled | `boolean` | | 当前表单项是否是禁用状态 | +| disabledOn | [表达式](../../../docs/concepts/expression) | | 当前表单项是否禁用的条件 | +| visible | [表达式](../../../docs/concepts/expression) | | 当前表单项是否禁用的条件 | +| visibleOn | [表达式](../../../docs/concepts/expression) | | 当前表单项是否禁用的条件 | +| required | `boolean` | | 是否为必填。 | +| requiredOn | [表达式](../../../docs/concepts/expression) | | 过[表达式](../Types.md#表达式)来配置当前表单项是否为必填。 | +| validations | [表达式](../../../docs/concepts/expression) | | 表单项值格式验证，支持设置多个，多个规则用英文逗号隔开。 | diff --git a/docs/zh-CN/components/form/formula.md b/docs/zh-CN/components/form/formula.md index 1caa6d175..f144ae475 100755 --- a/docs/zh-CN/components/form/formula.md +++ b/docs/zh-CN/components/form/formula.md @@ -177,11 +177,11 @@ order: 22 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| --------- | ----------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------- | -| name | `string` | | 需要应用的表单项`name`值，公式结果将作用到此处指定的变量中去。 | -| formula | [表达式](../../concepts/expression) | | 应用的公式 | -| condition | [表达式](../../concepts/expression) | | 公式作用条件 | -| initSet | `boolean` | `true` | 初始化时是否设置 | -| autoSet | `boolean` | `true` | 观察公式结果，如果计算结果有变化，则自动应用到变量上 | -| id | `boolean` | `true` | 定义个名字，当某个按钮的目标指定为此值后，会触发一次公式应用。这个机制可以在 `autoSet` 为 false 时用来手动触发 | +| 属性名 | 类型 | 默认值 | 说明 | +| --------- | ------------------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------- | +| name | `string` | | 需要应用的表单项`name`值，公式结果将作用到此处指定的变量中去。 | +| formula | [表达式](../../../docs/concepts/expression) | | 应用的公式 | +| condition | [表达式](../../../docs/concepts/expression) | | 公式作用条件 | +| initSet | `boolean` | `true` | 初始化时是否设置 | +| autoSet | `boolean` | `true` | 观察公式结果，如果计算结果有变化，则自动应用到变量上 | +| id | `boolean` | `true` | 定义个名字，当某个按钮的目标指定为此值后，会触发一次公式应用。这个机制可以在 `autoSet` 为 false 时用来手动触发 | diff --git a/docs/zh-CN/components/form/grid.md b/docs/zh-CN/components/form/grid.md index 5c51ea424..0c4ce8d7a 100755 --- a/docs/zh-CN/components/form/grid.md +++ b/docs/zh-CN/components/form/grid.md @@ -49,33 +49,33 @@ order: 23 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| -------------------------- | --------------------------------- | -------- | -------------------------------------------------------------- | -| type | `string` | `"grid"` | 指定为 Grid 渲染器 | -| className | `string` | | 外层 Dom 的类名 | -| columns | `Array` | | 列集合 | -| columns[x] | [SchemaNode](../types/schemanode) | | 成员可以是其他渲染器 | -| columns[x].controls | Array<[表单项](./formitem)> | | 如果配置了表单集合，同时没有指定 type 类型，则优先展示表单集合 | -| columns[x].columnClassName | `int` | | 配置列的 `className` | -| columns[x].xs | `int` | | 宽度占比： 1 - 12 | -| columns[x].xsHidden | `boolean` | | 是否隐藏 | -| columns[x].xsOffset | `int` | | 偏移量 1 - 12 | -| columns[x].xsPull | `int` | | 靠左的距离占比：1 - 12 | -| columns[x].xsPush | `int` | | 靠右的距离占比： 1 - 12 | -| columns[x].sm | `int` | | 宽度占比： 1 - 12 | -| columns[x].smHidden | `boolean` | | 是否隐藏 | -| columns[x].smOffset | `int` | | 偏移量 1 - 12 | -| columns[x].smPull | `int` | | 靠左的距离占比：1 - 12 | -| columns[x].smPush | `int` | | 靠右的距离占比： 1 - 12 | -| columns[x].md | `int` | | 宽度占比： 1 - 12 | -| columns[x].mdHidden | `boolean` | | 是否隐藏 | -| columns[x].mdOffset | `int` | | 偏移量 1 - 12 | -| columns[x].mdPull | `int` | | 靠左的距离占比：1 - 12 | -| columns[x].mdPush | `int` | | 靠右的距离占比： 1 - 12 | -| columns[x].lg | `int` | | 宽度占比： 1 - 12 | -| columns[x].lgHidden | `boolean` | | 是否隐藏 | -| columns[x].lgOffset | `int` | | 偏移量 1 - 12 | -| columns[x].lgPull | `int` | | 靠左的距离占比：1 - 12 | -| columns[x].lgPush | `int` | | 靠右的距离占比： 1 - 12 | +| 属性名 | 类型 | 默认值 | 说明 | +| -------------------------- | ----------------------------------------- | -------- | -------------------------------------------------------------- | +| type | `string` | `"grid"` | 指定为 Grid 渲染器 | +| className | `string` | | 外层 Dom 的类名 | +| columns | `Array` | | 列集合 | +| columns[x] | [SchemaNode](../../docs/types/schemanode) | | 成员可以是其他渲染器 | +| columns[x].controls | Array<[表单项](./formitem)> | | 如果配置了表单集合，同时没有指定 type 类型，则优先展示表单集合 | +| columns[x].columnClassName | `int` | | 配置列的 `className` | +| columns[x].xs | `int` | | 宽度占比： 1 - 12 | +| columns[x].xsHidden | `boolean` | | 是否隐藏 | +| columns[x].xsOffset | `int` | | 偏移量 1 - 12 | +| columns[x].xsPull | `int` | | 靠左的距离占比：1 - 12 | +| columns[x].xsPush | `int` | | 靠右的距离占比： 1 - 12 | +| columns[x].sm | `int` | | 宽度占比： 1 - 12 | +| columns[x].smHidden | `boolean` | | 是否隐藏 | +| columns[x].smOffset | `int` | | 偏移量 1 - 12 | +| columns[x].smPull | `int` | | 靠左的距离占比：1 - 12 | +| columns[x].smPush | `int` | | 靠右的距离占比： 1 - 12 | +| columns[x].md | `int` | | 宽度占比： 1 - 12 | +| columns[x].mdHidden | `boolean` | | 是否隐藏 | +| columns[x].mdOffset | `int` | | 偏移量 1 - 12 | +| columns[x].mdPull | `int` | | 靠左的距离占比：1 - 12 | +| columns[x].mdPush | `int` | | 靠右的距离占比： 1 - 12 | +| columns[x].lg | `int` | | 宽度占比： 1 - 12 | +| columns[x].lgHidden | `boolean` | | 是否隐藏 | +| columns[x].lgOffset | `int` | | 偏移量 1 - 12 | +| columns[x].lgPull | `int` | | 靠左的距离占比：1 - 12 | +| columns[x].lgPush | `int` | | 靠右的距离占比： 1 - 12 | 更多使用说明，请参看 [Grid Props](https://react-bootstrap.github.io/layout/grid/#col-props) diff --git a/docs/zh-CN/components/form/hbox.md b/docs/zh-CN/components/form/hbox.md index d734afa6b..f363ed21b 100755 --- a/docs/zh-CN/components/form/hbox.md +++ b/docs/zh-CN/components/form/hbox.md @@ -48,7 +48,7 @@ order: 25 ### Column 属性 -除了 [SchemaNode](../../types/schemanode) 支持属性以外，还支持以下几种属性 +除了 [SchemaNode](../../../docs/types/schemanode) 支持属性以外，还支持以下几种属性 | 属性名 | 类型 | 默认值 | 说明 | | --------------- | --------------------------- | ------ | ---------------------------------------------------------------------------- | diff --git a/docs/zh-CN/components/form/hidden.md b/docs/zh-CN/components/form/hidden.md index 0a38b39fe..1ed25359c 100755 --- a/docs/zh-CN/components/form/hidden.md +++ b/docs/zh-CN/components/form/hidden.md @@ -10,7 +10,7 @@ order: 26 ## 基本用法 -默认表单提交，在没有 [自定义 API 请求数据](../../types/api#%E9%85%8D%E7%BD%AE%E8%AF%B7%E6%B1%82%E6%95%B0%E6%8D%AE) 的情况下，只会发送 `controls` 里面的这些成员，对于隐藏的字段同时又希望提交表单的时候带过去，可以使用 `hidden` 组件 +默认表单提交，在没有 [自定义 API 请求数据](../../../docs/types/api#%E9%85%8D%E7%BD%AE%E8%AF%B7%E6%B1%82%E6%95%B0%E6%8D%AE) 的情况下，只会发送 `controls` 里面的这些成员，对于隐藏的字段同时又希望提交表单的时候带过去，可以使用 `hidden` 组件 ```schema: scope="body" { diff --git a/docs/zh-CN/components/form/image.md b/docs/zh-CN/components/form/image.md index c588854bd..e7b8c62f3 100755 --- a/docs/zh-CN/components/form/image.md +++ b/docs/zh-CN/components/form/image.md @@ -162,7 +162,7 @@ order: 27 | 属性名 | 类型 | 默认值 | 说明 | | ---------------- | ------------------------------- | ---------------------- | -------------------------------------------------------------------------------------------------- | -| receiver | [API](../../types/api) | | 上传文件接口 | +| receiver | [API](../../../docs/types/api) | | 上传文件接口 | | accept | `string` | `.jpeg,.jpg,.png,.gif` | 支持的图片类型格式，请配置此属性为图片后缀，例如`.jpg,.png` | | maxSize | `number` | | 默认没有限制，当设置后，文件大小大于此值将不允许上传。单位为`B` | | maxLength | `number` | | 默认没有限制，当设置后，一次只允许上传指定数量文件。 | diff --git a/docs/zh-CN/components/form/index.md b/docs/zh-CN/components/form/index.md index 0bd6a8a68..c21ff81b3 100755 --- a/docs/zh-CN/components/form/index.md +++ b/docs/zh-CN/components/form/index.md @@ -545,7 +545,7 @@ Form 支持轮询初始化接口，步骤如下： 当你需要配置特定的请求方式，请求体，`header`时，使用对象类型 api 配置，并使用 数据映射 进行数据配置。 -下面示例我们更改了请求方法为`PUT`，并在原提交数据的基础上添加一个字段`"_from"`。更多用法查看 [API 文档](../../types/api) 和 [数据映射](../../concepts/data-mapping)文档 +下面示例我们更改了请求方法为`PUT`，并在原提交数据的基础上添加一个字段`"_from"`。更多用法查看 [API 文档](../../../docs/types/api) 和 [数据映射](../../../docs/concepts/data-mapping)文档 ```schema: scope="body" { @@ -638,7 +638,7 @@ Form 支持轮询初始化接口，步骤如下： } ``` -> `rule` 编写使用 [表达式](../../concepts/expression) +> `rule` 编写使用 [表达式](../../../docs/concepts/expression) ## 重置表单 @@ -798,7 +798,7 @@ Form 支持轮询初始化接口，步骤如下： 上例中`form`提交成功后，会触发`name`为`my_service`的`Service`组件重新请求初始化接口 -上面示例是一种[组件间联动](../concepts/linkage#%E7%BB%84%E4%BB%B6%E9%97%B4%E8%81%94%E5%8A%A8) +上面示例是一种[组件间联动](../../docs/concepts/linkage#%E7%BB%84%E4%BB%B6%E9%97%B4%E8%81%94%E5%8A%A8) ### 将数据域发送给目标组件 @@ -850,7 +850,7 @@ Form 支持轮询初始化接口，步骤如下： 第一个表单在提交时，会将它的表单数据域数据发送给`detailForm`表单，触发`detailForm`的初始化接口联动，重新请求接口更新数据域，并更新关键字表单项。 -上面示例组合使用了 [组件间联动](../concepts/linkage#%E7%BB%84%E4%BB%B6%E9%97%B4%E8%81%94%E5%8A%A8) 和 [接口联动](../concepts/linkage#%E6%8E%A5%E5%8F%A3%E8%81%94%E5%8A%A8) +上面示例组合使用了 [组件间联动](../../docs/concepts/linkage#%E7%BB%84%E4%BB%B6%E9%97%B4%E8%81%94%E5%8A%A8) 和 [接口联动](../../docs/concepts/linkage#%E6%8E%A5%E5%8F%A3%E8%81%94%E5%8A%A8) ## 持久化保存表单项数据 @@ -878,18 +878,18 @@ Form 支持轮询初始化接口，步骤如下： | messages.saveFailed | `string` | | 保存失败时提示 | | wrapWithPanel | `boolean` | `true` | 是否让 Form 用 panel 包起来，设置为 false 后，actions 将无效。 | | panelClassName | `string` | | 外层 panel 的类名 | -| api | [API](../../types/api) | | Form 用来保存数据的 api。 | -| initApi | [API](../../types/api) | | Form 用来获取初始数据的 api。 | +| api | [API](../../../docs/types/api) | | Form 用来保存数据的 api。 | +| initApi | [API](../../../docs/types/api) | | Form 用来获取初始数据的 api。 | | rules | Array<{rule:string;message:string}> | | 表单组合校验规则 | | interval | `number` | `3000` | 刷新时间(最低 3000) | | silentPolling | `boolean` | `false` | 配置刷新时是否显示加载动画 | | stopAutoRefreshWhen | `string` | `""` | 通过[表达式](./Types.md#表达式) 来配置停止刷新的条件 | -| initAsyncApi | [API](../../types/api) | | Form 用来获取初始数据的 api,与 initApi 不同的是，会一直轮询请求该接口，直到返回 finished 属性为 true 才 结束。 | +| initAsyncApi | [API](../../../docs/types/api) | | Form 用来获取初始数据的 api,与 initApi 不同的是，会一直轮询请求该接口，直到返回 finished 属性为 true 才 结束。 | | initFetch | `boolean` | `true` | 设置了 initApi 或者 initAsyncApi 后，默认会开始就发请求，设置为 false 后就不会起始就请求接口 | | initFetchOn | `string` | | 用表达式来配置 | | initFinishedField | `string` | `finished` | 设置了 initAsyncApi 后，默认会从返回数据的 data.finished 来判断是否完成，也可以设置成其他的 xxx，就会从 data.xxx 中获取 | | initCheckInterval | `number` | `3000` | 设置了 initAsyncApi 以后，默认拉取的时间间隔 | -| asyncApi | [API](../../types/api) | | 设置此属性后，表单提交发送保存接口后，还会继续轮询请求该接口，直到返回 `finished` 属性为 `true` 才 结束。 | +| asyncApi | [API](../../../docs/types/api) | | 设置此属性后，表单提交发送保存接口后，还会继续轮询请求该接口，直到返回 `finished` 属性为 `true` 才 结束。 | | checkInterval | `number` | 3000 | 轮询请求的时间间隔，默认为 3 秒。设置 `asyncApi` 才有效 | | finishedField | `string` | `"finished"` | 如果决定结束的字段名不是 `finished` 请设置此属性，比如 `is_success` | | submitOnChange | `boolean` | `false` | 表单修改即提交 | diff --git a/docs/zh-CN/components/form/list.md b/docs/zh-CN/components/form/list.md index 10649d3d5..89108e611 100755 --- a/docs/zh-CN/components/form/list.md +++ b/docs/zh-CN/components/form/list.md @@ -79,13 +79,13 @@ List 一般用来实现选择，可以单选也可以多选，和 Radio/Checkbox 当做选择器表单项使用时，除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------ | --------------------------------- | --------- | ------------------------------------------------------------------------------------------- | -| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | -| source | `string`或 [API](../../types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | -| multiple | `boolean` | `false` | [多选](./options#%E5%A4%9A%E9%80%89-multiple) | -| labelField | `boolean` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | -| valueField | `boolean` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | -| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | -| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | -| autoFill | `object` | | [自动填充](./options#%E8%87%AA%E5%8A%A8%E5%A1%AB%E5%85%85-autofill) | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------ | ----------------------------------------- | --------- | ------------------------------------------------------------------------------------------- | +| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | +| source | `string`或 [API](../../../docs/types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | +| multiple | `boolean` | `false` | [多选](./options#%E5%A4%9A%E9%80%89-multiple) | +| labelField | `boolean` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | +| valueField | `boolean` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | +| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | +| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | +| autoFill | `object` | | [自动填充](./options#%E8%87%AA%E5%8A%A8%E5%A1%AB%E5%85%85-autofill) | diff --git a/docs/zh-CN/components/form/matrix.md b/docs/zh-CN/components/form/matrix.md index 7e9766886..fd8c2ff8a 100755 --- a/docs/zh-CN/components/form/matrix.md +++ b/docs/zh-CN/components/form/matrix.md @@ -273,11 +273,11 @@ row 模式，每行只能单选某个单元格 除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置 -| 属性名 | 类型 | 默认值 | 说明 | -| ---------------- | ---------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -| columns | `Array` | | 列信息，数组中 `label` 字段是必须给出的 | -| rows | `Array` | | 行信息， 数组中 `label` 字段是必须给出的 | -| rowLabel | `string` | | 行标题说明 | -| source | [API](../../types/api) | | Api 地址，如果选项组不固定，可以通过配置 `source` 动态拉取。 | -| multiple | `boolean` | `true` | 是否多选 | -| singleSelectMode | `string` | `"column"` | 设置单选模式，`multiple`为`false`时有效，可设置为`cell`, `row`, `column` 分别为全部选项中只能单选某个单元格、每行只能单选某个单元格，每列只能单选某个单元格 | +| 属性名 | 类型 | 默认值 | 说明 | +| ---------------- | ------------------------------ | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | +| columns | `Array` | | 列信息，数组中 `label` 字段是必须给出的 | +| rows | `Array` | | 行信息， 数组中 `label` 字段是必须给出的 | +| rowLabel | `string` | | 行标题说明 | +| source | [API](../../../docs/types/api) | | Api 地址，如果选项组不固定，可以通过配置 `source` 动态拉取。 | +| multiple | `boolean` | `true` | 是否多选 | +| singleSelectMode | `string` | `"column"` | 设置单选模式，`multiple`为`false`时有效，可设置为`cell`, `row`, `column` 分别为全部选项中只能单选某个单元格、每行只能单选某个单元格，每列只能单选某个单元格 | diff --git a/docs/zh-CN/components/form/nestedselect.md b/docs/zh-CN/components/form/nestedselect.md index f3419faef..7ee295fd4 100755 --- a/docs/zh-CN/components/form/nestedselect.md +++ b/docs/zh-CN/components/form/nestedselect.md @@ -228,18 +228,18 @@ order: 31 当做选择器表单项使用时，除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置 -| 属性名 | 类型 | 默认值 | 说明 | -| ---------------- | --------------------------------- | -------------------- | ------------------------------------------------------------------------------------------- | -| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | -| source | `string`或 [API](../../types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | -| delimeter | `boolean` | `false` | [拼接符](./options#%E6%8B%BC%E6%8E%A5%E7%AC%A6-delimiter) | -| labelField | `boolean` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | -| valueField | `boolean` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | -| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | -| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | -| autoFill | `object` | | [自动填充](./options#%E8%87%AA%E5%8A%A8%E5%A1%AB%E5%85%85-autofill) | -| cascade | `boolean` | `false` | 设置 `true`时，当选中父节点时不自动选择子节点。 | -| withChildren | `boolean` | `false` | 设置 `true`时，选中父节点时，值里面将包含子节点的值，否则只会保留父节点的值。 | -| searchable | `boolean` | `false` | 可否搜索 | -| searchPromptText | `string` | `"输入内容进行检索"` | 搜索框占位文本 | -| multiple | `boolean` | `false` | 可否多选 | +| 属性名 | 类型 | 默认值 | 说明 | +| ---------------- | ----------------------------------------- | -------------------- | ------------------------------------------------------------------------------------------- | +| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | +| source | `string`或 [API](../../../docs/types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | +| delimeter | `boolean` | `false` | [拼接符](./options#%E6%8B%BC%E6%8E%A5%E7%AC%A6-delimiter) | +| labelField | `boolean` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | +| valueField | `boolean` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | +| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | +| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | +| autoFill | `object` | | [自动填充](./options#%E8%87%AA%E5%8A%A8%E5%A1%AB%E5%85%85-autofill) | +| cascade | `boolean` | `false` | 设置 `true`时，当选中父节点时不自动选择子节点。 | +| withChildren | `boolean` | `false` | 设置 `true`时，选中父节点时，值里面将包含子节点的值，否则只会保留父节点的值。 | +| searchable | `boolean` | `false` | 可否搜索 | +| searchPromptText | `string` | `"输入内容进行检索"` | 搜索框占位文本 | +| multiple | `boolean` | `false` | 可否多选 | diff --git a/docs/zh-CN/components/form/number.md b/docs/zh-CN/components/form/number.md index c4f28e2b0..b84855559 100755 --- a/docs/zh-CN/components/form/number.md +++ b/docs/zh-CN/components/form/number.md @@ -28,10 +28,10 @@ order: 32 当做选择器表单项使用时，除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置 -| 属性名 | 类型 | 默认值 | 说明 | -| --------- | ------------------------------- | ------ | -------------------- | -| min | [模板](../../concepts/template) | | 最小值 | -| max | [模板](../../concepts/template) | | 最大值 | -| step | `number` | | 步长 | -| precision | `number` | | 精度，即小数点后几位 | -| showSteps | `boolean` | | 是否显示上下点击按钮 | +| 属性名 | 类型 | 默认值 | 说明 | +| --------- | --------------------------------------- | ------ | -------------------- | +| min | [模板](../../../docs/concepts/template) | | 最小值 | +| max | [模板](../../../docs/concepts/template) | | 最大值 | +| step | `number` | | 步长 | +| precision | `number` | | 精度，即小数点后几位 | +| showSteps | `boolean` | | 是否显示上下点击按钮 | diff --git a/docs/zh-CN/components/form/options.md b/docs/zh-CN/components/form/options.md index 8c06c6f11..cfc5097e3 100755 --- a/docs/zh-CN/components/form/options.md +++ b/docs/zh-CN/components/form/options.md @@ -156,7 +156,7 @@ order: 2 ### 通过数据域中变量配置 -你也可以配置`source`属性，利用 [数据映射](../../concepts/data-mapping)，获取当前数据链中的变量 +你也可以配置`source`属性，利用 [数据映射](../../../docs/concepts/data-mapping)，获取当前数据链中的变量 ```schema: scope="body" { @@ -192,7 +192,7 @@ order: 2 ### 远程拉取 -除了可以通过数据映射获取当前数据域中的变量以外，`source`还支持配置接口，格式为 [API](../../types/api)，用于动态返回选项组。 +除了可以通过数据映射获取当前数据域中的变量以外，`source`还支持配置接口，格式为 [API](../../../docs/types/api)，用于动态返回选项组。 ```schema: scope="body" { @@ -208,7 +208,7 @@ order: 2 } ``` -远程拉取接口时，返回的数据结构除了需要满足 [amis 接口要求的基本数据结构](../../types/api#%E6%8E%A5%E5%8F%A3%E8%BF%94%E5%9B%9E%E6%A0%BC%E5%BC%8F-%E9%87%8D%E8%A6%81-) 以外，必须用`"options"`作为选项组的`key`值，如下 +远程拉取接口时，返回的数据结构除了需要满足 [amis 接口要求的基本数据结构](../../../docs/types/api#%E6%8E%A5%E5%8F%A3%E8%BF%94%E5%9B%9E%E6%A0%BC%E5%BC%8F-%E9%87%8D%E8%A6%81-) 以外，必须用`"options"`作为选项组的`key`值，如下 ```json { @@ -1265,7 +1265,7 @@ order: 2 ## 自动填充 autoFill -一些选择器组件，支持配置`autoFill`，将当前已选中的选项的某个字段的值，自动填充到表单中某个表单项中，**只在单选时有效**，支持[数据映射](../../concepts/data-mapping) +一些选择器组件，支持配置`autoFill`，将当前已选中的选项的某个字段的值，自动填充到表单中某个表单项中，**只在单选时有效**，支持[数据映射](../../../docs/concepts/data-mapping) ```schema: scope="body" { @@ -1307,12 +1307,12 @@ order: 2 除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------ | ----------------------------------------------------------------- | --------- | ---------------------------------------------------------------------- | -| options | `Array`或`Array` | | 选项组，供用户选择 | -| source | [API](../../types/api) 或 [数据映射](../../concepts/data-mapping) | | 选项组源，可通过数据映射获取当前数据域变量、或者配置 API 对象 | -| multiple | `boolean` | `false` | 是否支持多选 | -| labelField | `boolean` | `"label"` | 标识选项中哪个字段是`label`值 | -| valueField | `boolean` | `"value"` | 标识选项中哪个字段是`value`值 | -| joinValues | `boolean` | `true` | 是否拼接`value`值 | -| extractValue | `boolean` | `false` | 是否将`value`值抽取出来组成新的数组，只有在`joinValues`是`false`是生效 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------ | --------------------------------------------------------------------------------- | --------- | ---------------------------------------------------------------------- | +| options | `Array`或`Array` | | 选项组，供用户选择 | +| source | [API](../../../docs/types/api) 或 [数据映射](../../../docs/concepts/data-mapping) | | 选项组源，可通过数据映射获取当前数据域变量、或者配置 API 对象 | +| multiple | `boolean` | `false` | 是否支持多选 | +| labelField | `boolean` | `"label"` | 标识选项中哪个字段是`label`值 | +| valueField | `boolean` | `"value"` | 标识选项中哪个字段是`value`值 | +| joinValues | `boolean` | `true` | 是否拼接`value`值 | +| extractValue | `boolean` | `false` | 是否将`value`值抽取出来组成新的数组，只有在`joinValues`是`false`是生效 | diff --git a/docs/zh-CN/components/form/panel.md b/docs/zh-CN/components/form/panel.md index 8f96f4073..5a6466bb7 100755 --- a/docs/zh-CN/components/form/panel.md +++ b/docs/zh-CN/components/form/panel.md @@ -39,18 +39,18 @@ order: 34 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| --------------- | ------------------------------------ | ------ | ------------------------------------------------------------------- | -| title | `string` | | panel 标题 | -| body | [SchemaNode](../../types/schemanode) | | 内容区 | -| bodyClassName | `string` | | body 的 className | -| footer | [SchemaNode](../../types/schemanode) | | 底部区 | -| footerClassName | `string` | | footer 的 className | -| controls | Array<表单项> | | `controls` 跟 `body` 二选一，如果设置了 controls 优先显示表单集合。 | +| 属性名 | 类型 | 默认值 | 说明 | +| --------------- | -------------------------------------------- | ------ | ------------------------------------------------------------------- | +| title | `string` | | panel 标题 | +| body | [SchemaNode](../../../docs/types/schemanode) | | 内容区 | +| bodyClassName | `string` | | body 的 className | +| footer | [SchemaNode](../../../docs/types/schemanode) | | 底部区 | +| footerClassName | `string` | | footer 的 className | +| controls | Array<表单项> | | `controls` 跟 `body` 二选一，如果设置了 controls 优先显示表单集合。 | - `title` panel 标题 -- `body` [SchemaNode](../../types/schemanode) 可以是其他渲染模型。 +- `body` [SchemaNode](../../../docs/types/schemanode) 可以是其他渲染模型。 - `bodyClassName` body 的 className. -- `footer` [SchemaNode](../../types/schemanode) 可以是其他渲染模型。 +- `footer` [SchemaNode](../../../docs/types/schemanode) 可以是其他渲染模型。 - `footerClassName` footer 的 className. - `controls` 跟 `body` 二选一，如果设置了 controls 优先显示表单集合。 diff --git a/docs/zh-CN/components/form/picker.md b/docs/zh-CN/components/form/picker.md index 6fea4ff4c..19b2c475a 100755 --- a/docs/zh-CN/components/form/picker.md +++ b/docs/zh-CN/components/form/picker.md @@ -496,17 +496,17 @@ order: 35 当做选择器表单项使用时，除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------ | --------------------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------- | -| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | -| source | `string`或 [API](../../types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | -| multiple | `boolean` | | 是否为多选。 | -| delimeter | `boolean` | `false` | [拼接符](./options#%E6%8B%BC%E6%8E%A5%E7%AC%A6-delimiter) | -| labelField | `boolean` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | -| valueField | `boolean` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | -| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | -| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | -| autoFill | `object` | | [自动填充](./options#%E8%87%AA%E5%8A%A8%E5%A1%AB%E5%85%85-autofill) | -| modalMode | `string` | `"dialog"` | 设置 `dialog` 或者 `drawer`，用来配置弹出方式。 | -| pickerSchema | `string` | `{mode: 'list', listItem: {title: '${label}'}}` | 即用 List 类型的渲染，来展示列表信息。更多配置参考 [CRUD](../crud) | -| embed | `boolean` | `false` | 是否使用内嵌模式 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------ | ----------------------------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------- | +| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | +| source | `string`或 [API](../../../docs/types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | +| multiple | `boolean` | | 是否为多选。 | +| delimeter | `boolean` | `false` | [拼接符](./options#%E6%8B%BC%E6%8E%A5%E7%AC%A6-delimiter) | +| labelField | `boolean` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | +| valueField | `boolean` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | +| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | +| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | +| autoFill | `object` | | [自动填充](./options#%E8%87%AA%E5%8A%A8%E5%A1%AB%E5%85%85-autofill) | +| modalMode | `string` | `"dialog"` | 设置 `dialog` 或者 `drawer`，用来配置弹出方式。 | +| pickerSchema | `string` | `{mode: 'list', listItem: {title: '${label}'}}` | 即用 List 类型的渲染，来展示列表信息。更多配置参考 [CRUD](../crud) | +| embed | `boolean` | `false` | 是否使用内嵌模式 | diff --git a/docs/zh-CN/components/form/radios.md b/docs/zh-CN/components/form/radios.md index b8bd27202..be5063548 100644 --- a/docs/zh-CN/components/form/radios.md +++ b/docs/zh-CN/components/form/radios.md @@ -47,11 +47,11 @@ order: 36 当做选择器表单项使用时，除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------ | --------------------------------- | --------- | ------------------------------------------------------------------------------------------- | -| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | -| source | `string`或 [API](../../types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | -| labelField | `boolean` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | -| valueField | `boolean` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | -| columnsCount | `number` | `1` | 选项按几列显示，默认为一列 | -| autoFill | `object` | | [自动填充](./options#%E8%87%AA%E5%8A%A8%E5%A1%AB%E5%85%85-autofill) | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------ | ----------------------------------------- | --------- | ------------------------------------------------------------------------------------------- | +| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | +| source | `string`或 [API](../../../docs/types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | +| labelField | `boolean` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | +| valueField | `boolean` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | +| columnsCount | `number` | `1` | 选项按几列显示，默认为一列 | +| autoFill | `object` | | [自动填充](./options#%E8%87%AA%E5%8A%A8%E5%A1%AB%E5%85%85-autofill) | diff --git a/docs/zh-CN/components/form/rich-text.md b/docs/zh-CN/components/form/rich-text.md index 09b7a7dbb..45d85a9eb 100755 --- a/docs/zh-CN/components/form/rich-text.md +++ b/docs/zh-CN/components/form/rich-text.md @@ -107,11 +107,11 @@ froala 可以通过设置 buttons 参数来控制显示哪些按钮，默认是 当做选择器表单项使用时，除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------- | ---------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| saveAsUbb | `boolean` | | 是否保存为 ubb 格式 | -| receiver | [API](../../types/api) | | 默认的图片保存 API | -| videoReceiver | [API](../../types/api) | | 默认的视频保存 API | -| size | `string` | | 框的大小，可设置为 `md` 或者 `lg` | -| options | `object` | | 需要参考 [tinymce](https://www.tiny.cloud/docs/configure/integration-and-setup/) 或 [froala](https://www.froala.com/wysiwyg-editor/docs/options) 的文档 | -| buttons | `Array` | | froala 专用，配置显示的按钮，tinymce 可以通过前面的 options 设置 [toolbar](https://www.tiny.cloud/docs/demo/custom-toolbar-button/) 字符串 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------- | ------------------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | +| saveAsUbb | `boolean` | | 是否保存为 ubb 格式 | +| receiver | [API](../../../docs/types/api) | | 默认的图片保存 API | +| videoReceiver | [API](../../../docs/types/api) | | 默认的视频保存 API | +| size | `string` | | 框的大小，可设置为 `md` 或者 `lg` | +| options | `object` | | 需要参考 [tinymce](https://www.tiny.cloud/docs/configure/integration-and-setup/) 或 [froala](https://www.froala.com/wysiwyg-editor/docs/options) 的文档 | +| buttons | `Array` | | froala 专用，配置显示的按钮，tinymce 可以通过前面的 options 设置 [toolbar](https://www.tiny.cloud/docs/demo/custom-toolbar-button/) 字符串 | diff --git a/docs/zh-CN/components/form/select.md b/docs/zh-CN/components/form/select.md index 934e6fac8..e228caf32 100755 --- a/docs/zh-CN/components/form/select.md +++ b/docs/zh-CN/components/form/select.md @@ -16,28 +16,28 @@ order: 48 除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置 -| 属性名 | 类型 | 默认值 | 说明 | -| --------------- | ----------------------------------------------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------- | -| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | -| source | [API](../../types/api) 或 [数据映射](../../concepts/data-mapping) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | -| autoComplete | [API](../../types/api) | | [自动提示补全](./options#%E8%87%AA%E5%8A%A8%E8%A1%A5%E5%85%A8-autocomplete) | -| delimeter | `string` | `false` | [拼接符](./options#%E6%8B%BC%E6%8E%A5%E7%AC%A6-delimiter) | -| labelField | `string` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | -| valueField | `string` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | -| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | -| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | -| checkAll | `boolean` | `false` | 是否支持全选 | -| checkAllLabel | `string` | `全选` | 全选的文字 | -| defaultCheckAll | `boolean` | `false` | 默认是否全选 | -| creatable | `boolean` | `false` | [新增选项](./options#%E5%89%8D%E7%AB%AF%E6%96%B0%E5%A2%9E-creatable) | -| multiple | `boolean` | `false` | [多选](./options#多选-multiple) | -| searchable | `boolean` | `false` | [检索](./options#检索-searchable) | -| createBtnLabel | `string` | `"新增选项"` | [新增选项](./options#%E6%96%B0%E5%A2%9E%E9%80%89%E9%A1%B9) | -| addControls | Array<[表单项](./formitem)> | | [自定义新增表单项](./options#%E8%87%AA%E5%AE%9A%E4%B9%89%E6%96%B0%E5%A2%9E%E8%A1%A8%E5%8D%95%E9%A1%B9-addcontrols) | -| addApi | [API](../types/api) | | [配置新增选项接口](./options#%E9%85%8D%E7%BD%AE%E6%96%B0%E5%A2%9E%E6%8E%A5%E5%8F%A3-addapi) | -| editable | `boolean` | `false` | [编辑选项](./options#%E5%89%8D%E7%AB%AF%E7%BC%96%E8%BE%91-editable) | -| editControls | Array<[表单项](./formitem)> | | [自定义编辑表单项](./options#%E8%87%AA%E5%AE%9A%E4%B9%89%E7%BC%96%E8%BE%91%E8%A1%A8%E5%8D%95%E9%A1%B9-editcontrols) | -| editApi | [API](../types/api) | | [配置编辑选项接口](./options#%E9%85%8D%E7%BD%AE%E7%BC%96%E8%BE%91%E6%8E%A5%E5%8F%A3-editapi) | -| removable | `boolean` | `false` | [删除选项](./options#%E5%88%A0%E9%99%A4%E9%80%89%E9%A1%B9) | -| deleteApi | [API](../types/api) | | [配置删除选项接口](./options#%E9%85%8D%E7%BD%AE%E5%88%A0%E9%99%A4%E6%8E%A5%E5%8F%A3-deleteapi) | -| autoFill | `object` | | [自动填充](./options#%E8%87%AA%E5%8A%A8%E5%A1%AB%E5%85%85-autofill) | +| 属性名 | 类型 | 默认值 | 说明 | +| --------------- | --------------------------------------------------------------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------- | +| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | +| source | [API](../../../docs/types/api) 或 [数据映射](../../../docs/concepts/data-mapping) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | +| autoComplete | [API](../../../docs/types/api) | | [自动提示补全](./options#%E8%87%AA%E5%8A%A8%E8%A1%A5%E5%85%A8-autocomplete) | +| delimeter | `string` | `false` | [拼接符](./options#%E6%8B%BC%E6%8E%A5%E7%AC%A6-delimiter) | +| labelField | `string` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | +| valueField | `string` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | +| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | +| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | +| checkAll | `boolean` | `false` | 是否支持全选 | +| checkAllLabel | `string` | `全选` | 全选的文字 | +| defaultCheckAll | `boolean` | `false` | 默认是否全选 | +| creatable | `boolean` | `false` | [新增选项](./options#%E5%89%8D%E7%AB%AF%E6%96%B0%E5%A2%9E-creatable) | +| multiple | `boolean` | `false` | [多选](./options#多选-multiple) | +| searchable | `boolean` | `false` | [检索](./options#检索-searchable) | +| createBtnLabel | `string` | `"新增选项"` | [新增选项](./options#%E6%96%B0%E5%A2%9E%E9%80%89%E9%A1%B9) | +| addControls | Array<[表单项](./formitem)> | | [自定义新增表单项](./options#%E8%87%AA%E5%AE%9A%E4%B9%89%E6%96%B0%E5%A2%9E%E8%A1%A8%E5%8D%95%E9%A1%B9-addcontrols) | +| addApi | [API](../../docs/types/api) | | [配置新增选项接口](./options#%E9%85%8D%E7%BD%AE%E6%96%B0%E5%A2%9E%E6%8E%A5%E5%8F%A3-addapi) | +| editable | `boolean` | `false` | [编辑选项](./options#%E5%89%8D%E7%AB%AF%E7%BC%96%E8%BE%91-editable) | +| editControls | Array<[表单项](./formitem)> | | [自定义编辑表单项](./options#%E8%87%AA%E5%AE%9A%E4%B9%89%E7%BC%96%E8%BE%91%E8%A1%A8%E5%8D%95%E9%A1%B9-editcontrols) | +| editApi | [API](../../docs/types/api) | | [配置编辑选项接口](./options#%E9%85%8D%E7%BD%AE%E7%BC%96%E8%BE%91%E6%8E%A5%E5%8F%A3-editapi) | +| removable | `boolean` | `false` | [删除选项](./options#%E5%88%A0%E9%99%A4%E9%80%89%E9%A1%B9) | +| deleteApi | [API](../../docs/types/api) | | [配置删除选项接口](./options#%E9%85%8D%E7%BD%AE%E5%88%A0%E9%99%A4%E6%8E%A5%E5%8F%A3-deleteapi) | +| autoFill | `object` | | [自动填充](./options#%E8%87%AA%E5%8A%A8%E5%A1%AB%E5%85%85-autofill) | diff --git a/docs/zh-CN/components/form/service.md b/docs/zh-CN/components/form/service.md index 14cbe57ac..9a57e504c 100755 --- a/docs/zh-CN/components/form/service.md +++ b/docs/zh-CN/components/form/service.md @@ -82,7 +82,7 @@ order: 49 Service 中的`api`和`schemaApi`都支持**接口联动**。 -下面例子中，`数据模板`下拉框的值变化后，会触发 service 重新拉取 api 接口，从而更新数据源，变化表单项的值，更多用法查看 [接口联动](../../concepts/linkage#%E6%8E%A5%E5%8F%A3%E8%81%94%E5%8A%A8)。 +下面例子中，`数据模板`下拉框的值变化后，会触发 service 重新拉取 api 接口，从而更新数据源，变化表单项的值，更多用法查看 [接口联动](../../../docs/concepts/linkage#%E6%8E%A5%E5%8F%A3%E8%81%94%E5%8A%A8)。 ```schema: scope="body" { diff --git a/docs/zh-CN/components/form/table.md b/docs/zh-CN/components/form/table.md index 0a6cf0971..de41fa1f1 100755 --- a/docs/zh-CN/components/form/table.md +++ b/docs/zh-CN/components/form/table.md @@ -363,29 +363,29 @@ order: 54 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| ---------------------------- | ----------------------- | ---------------- | ---------------------------------------------------------------------------------------------------- | -| type | `string` | `"table"` | 指定为 Table 渲染器 | -| addable | `boolean` | `false` | 是否可增加一行 | -| editable | `boolean` | `false` | 是否可编辑 | -| removable | `boolean` | `false` | 是否可删除 | -| showAddBtn | `boolean` | `true` | 是否显示添加按钮 | -| addApi | [API](../../types/api) | - | 新增时提交的 API | -| updateApi | [API](../../types/api) | - | 修改时提交的 API | -| deleteApi | [API](../../types/api) | - | 删除时提交的 API | -| addBtnLabel | `string` | | 增加按钮名称 | -| addBtnIcon | `string` | `"fa fa-plus"` | 增加按钮图标 | -| updateBtnLabel | `string` | `""` | 更新按钮名称 | -| updateBtnIcon | `string` | `"fa fa-pencil"` | 更新按钮图标 | -| deleteBtnLabel | `string` | `""` | 删除按钮名称 | -| deleteBtnIcon | `string` | `"fa fa-minus"` | 删除按钮图标 | -| confirmBtnLabel | `string` | `""` | 确认编辑按钮名称 | -| confirmBtnIcon | `string` | `"fa fa-check"` | 确认编辑按钮图标 | -| cancelBtnLabel | `string` | `""` | 取消编辑按钮名称 | -| cancelBtnIcon | `string` | `"fa fa-times"` | 取消编辑按钮图标 | -| needConfirm | `boolean` | `true` | 是否需要确认操作，，可用来控控制表格的操作交互 | -| canAccessSuperData | `boolean` | `false` | 是否可以访问父级数据，也就是表单中的同级数据，通常需要跟 strictMode 搭配使用 | -| strictMode | `boolean` | `true` | 为了性能，默认其他表单项项值变化不会让当前表格更新，有时候为了同步获取其他表单项字段，需要开启这个。 | -| columns | `array` | [] | 列信息 | -| columns[x].quickEdit | `boolean` 或者 `object` | - | 配合 editable 为 true 一起使用 | -| columns[x].quickEditOnUpdate | `boolean` 或者 `object` | - | 可以用来区分新建模式和更新模式的编辑配置 | +| 属性名 | 类型 | 默认值 | 说明 | +| ---------------------------- | ------------------------------ | ---------------- | ---------------------------------------------------------------------------------------------------- | +| type | `string` | `"table"` | 指定为 Table 渲染器 | +| addable | `boolean` | `false` | 是否可增加一行 | +| editable | `boolean` | `false` | 是否可编辑 | +| removable | `boolean` | `false` | 是否可删除 | +| showAddBtn | `boolean` | `true` | 是否显示添加按钮 | +| addApi | [API](../../../docs/types/api) | - | 新增时提交的 API | +| updateApi | [API](../../../docs/types/api) | - | 修改时提交的 API | +| deleteApi | [API](../../../docs/types/api) | - | 删除时提交的 API | +| addBtnLabel | `string` | | 增加按钮名称 | +| addBtnIcon | `string` | `"fa fa-plus"` | 增加按钮图标 | +| updateBtnLabel | `string` | `""` | 更新按钮名称 | +| updateBtnIcon | `string` | `"fa fa-pencil"` | 更新按钮图标 | +| deleteBtnLabel | `string` | `""` | 删除按钮名称 | +| deleteBtnIcon | `string` | `"fa fa-minus"` | 删除按钮图标 | +| confirmBtnLabel | `string` | `""` | 确认编辑按钮名称 | +| confirmBtnIcon | `string` | `"fa fa-check"` | 确认编辑按钮图标 | +| cancelBtnLabel | `string` | `""` | 取消编辑按钮名称 | +| cancelBtnIcon | `string` | `"fa fa-times"` | 取消编辑按钮图标 | +| needConfirm | `boolean` | `true` | 是否需要确认操作，，可用来控控制表格的操作交互 | +| canAccessSuperData | `boolean` | `false` | 是否可以访问父级数据，也就是表单中的同级数据，通常需要跟 strictMode 搭配使用 | +| strictMode | `boolean` | `true` | 为了性能，默认其他表单项项值变化不会让当前表格更新，有时候为了同步获取其他表单项字段，需要开启这个。 | +| columns | `array` | [] | 列信息 | +| columns[x].quickEdit | `boolean` 或者 `object` | - | 配合 editable 为 true 一起使用 | +| columns[x].quickEditOnUpdate | `boolean` 或者 `object` | - | 可以用来区分新建模式和更新模式的编辑配置 | diff --git a/docs/zh-CN/components/form/tag.md b/docs/zh-CN/components/form/tag.md index b112fc82d..f25fb78b3 100755 --- a/docs/zh-CN/components/form/tag.md +++ b/docs/zh-CN/components/form/tag.md @@ -33,15 +33,15 @@ order: 55 除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------ | --------------------------------- | -------------------- | ------------------------------------------------------------------------------------------- | -| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | -| optionsTip | `Array`或`Array` | `"最近您使用的标签"` | 选项提示 | -| source | `string`或 [API](../../types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | -| delimeter | `string` | `false` | [拼接符](./options#%E6%8B%BC%E6%8E%A5%E7%AC%A6-delimiter) | -| labelField | `string` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | -| valueField | `string` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | -| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | -| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | -| clearable | `boolean` | `false` | 在有值的时候是否显示一个删除图标在右侧。 | -| resetValue | `string` | `""` | 删除后设置此配置项给定的值。 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------ | ----------------------------------------- | -------------------- | ------------------------------------------------------------------------------------------- | +| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | +| optionsTip | `Array`或`Array` | `"最近您使用的标签"` | 选项提示 | +| source | `string`或 [API](../../../docs/types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | +| delimeter | `string` | `false` | [拼接符](./options#%E6%8B%BC%E6%8E%A5%E7%AC%A6-delimiter) | +| labelField | `string` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | +| valueField | `string` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | +| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | +| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | +| clearable | `boolean` | `false` | 在有值的时候是否显示一个删除图标在右侧。 | +| resetValue | `string` | `""` | 删除后设置此配置项给定的值。 | diff --git a/docs/zh-CN/components/form/text.md b/docs/zh-CN/components/form/text.md index ff6c15394..8cecbb1a3 100755 --- a/docs/zh-CN/components/form/text.md +++ b/docs/zh-CN/components/form/text.md @@ -132,21 +132,21 @@ order: 56 当做选择器表单项使用时，除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------ | --------------------------------- | --------- | ------------------------------------------------------------------------------------------- | -| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | -| source | `string`或 [API](../../types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | -| autoComplete | `string`或 [API](../../types/api) | | [自动补全](./options#%E8%87%AA%E5%8A%A8%E8%A1%A5%E5%85%A8-autocomplete) | -| multiple | `boolean` | | [是否多选](./options#%E5%A4%9A%E9%80%89-multiple) | -| delimeter | `string` | `,` | [拼接符](./options#%E6%8B%BC%E6%8E%A5%E7%AC%A6-delimiter) | -| labelField | `string` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | -| valueField | `string` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | -| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | -| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | -| addOn | `addOn` | | 输入框附加组件，比如附带一个提示文字，或者附带一个提交按钮。 | -| addOn.type | `string` | | 请选择 `text` 、`button` 或者 `submit`。 | -| addOn.label | `string` | | 文字说明 | -| addOn.xxx | `string` | | 其他参数请参考按钮文档 | -| trimContents | `boolean` | | 是否去除首尾空白文本。 | -| clearable | `boolean` | | 是否可清除 | -| resetValue | `string` | `""` | 清除后设置此配置项给定的值。 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------ | ----------------------------------------- | --------- | ------------------------------------------------------------------------------------------- | +| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | +| source | `string`或 [API](../../../docs/types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | +| autoComplete | `string`或 [API](../../../docs/types/api) | | [自动补全](./options#%E8%87%AA%E5%8A%A8%E8%A1%A5%E5%85%A8-autocomplete) | +| multiple | `boolean` | | [是否多选](./options#%E5%A4%9A%E9%80%89-multiple) | +| delimeter | `string` | `,` | [拼接符](./options#%E6%8B%BC%E6%8E%A5%E7%AC%A6-delimiter) | +| labelField | `string` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | +| valueField | `string` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | +| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | +| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | +| addOn | `addOn` | | 输入框附加组件，比如附带一个提示文字，或者附带一个提交按钮。 | +| addOn.type | `string` | | 请选择 `text` 、`button` 或者 `submit`。 | +| addOn.label | `string` | | 文字说明 | +| addOn.xxx | `string` | | 其他参数请参考按钮文档 | +| trimContents | `boolean` | | 是否去除首尾空白文本。 | +| clearable | `boolean` | | 是否可清除 | +| resetValue | `string` | `""` | 清除后设置此配置项给定的值。 | diff --git a/docs/zh-CN/components/form/transfer.md b/docs/zh-CN/components/form/transfer.md index 6ed5cee11..5df1ba61c 100644 --- a/docs/zh-CN/components/form/transfer.md +++ b/docs/zh-CN/components/form/transfer.md @@ -545,22 +545,22 @@ icon: 除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置 -| 属性名 | 类型 | 默认值 | 说明 | -| ---------------- | --------------------------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | -| source | `string`或 [API](../../types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | -| delimeter | `string` | `false` | [拼接符](./options#%E6%8B%BC%E6%8E%A5%E7%AC%A6-delimiter) | -| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | -| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | -| searchable | `boolean` | `false` | 当设置为 `true` 时表示可以通过输入部分内容检索出选项。 | -| searchApi | [API](../../types/api) | | 如果想通过接口检索，可以设置个 api。 | -| statistics | `boolean` | `true` | 是否显示统计数据 | -| selectTitle | `string` | `"请选择"` | 左侧的标题文字 | -| resultTitle | `string` | `"当前选择"` | 右侧结果的标题文字 | -| sortable | `boolean` | `false` | 结果可以进行拖拽排序 | -| selectMode | `string` | `list` | 可选：`list`、`table`、`tree`、`chained`、`associated`。分别为：列表形式、表格形式、树形选择形式、级联选择形式，关联选择形式（与级联选择的区别在于，级联是无限极，而关联只有一级，关联左边可以是个 tree）。 | -| searchResultMode | `string` | | 如果不设置将采用 `selectMode` 的值，可以单独配置，参考 `selectMode`，决定搜索结果的展示形式。 | -| columns | `Array` | | 当展示形式为 `table` 可以用来配置展示哪些列，跟 table 中的 columns 配置相似，只是只有展示功能。 | -| leftOptions | `Array` | | 当展示形式为 `associated` 时用来配置左边的选项集。 | -| leftMode | `string` | | 当展示形式为 `associated` 时用来配置左边的选择形式，支持 `list` 或者 `tree`。默认为 `list`。 | -| rightMode | `string` | | 当展示形式为 `associated` 时用来配置右边的选择形式，可选：`list`、`table`、`tree`、`chained`。 | +| 属性名 | 类型 | 默认值 | 说明 | +| ---------------- | ----------------------------------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | +| source | `string`或 [API](../../../docs/types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | +| delimeter | `string` | `false` | [拼接符](./options#%E6%8B%BC%E6%8E%A5%E7%AC%A6-delimiter) | +| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | +| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | +| searchable | `boolean` | `false` | 当设置为 `true` 时表示可以通过输入部分内容检索出选项。 | +| searchApi | [API](../../../docs/types/api) | | 如果想通过接口检索，可以设置个 api。 | +| statistics | `boolean` | `true` | 是否显示统计数据 | +| selectTitle | `string` | `"请选择"` | 左侧的标题文字 | +| resultTitle | `string` | `"当前选择"` | 右侧结果的标题文字 | +| sortable | `boolean` | `false` | 结果可以进行拖拽排序 | +| selectMode | `string` | `list` | 可选：`list`、`table`、`tree`、`chained`、`associated`。分别为：列表形式、表格形式、树形选择形式、级联选择形式，关联选择形式（与级联选择的区别在于，级联是无限极，而关联只有一级，关联左边可以是个 tree）。 | +| searchResultMode | `string` | | 如果不设置将采用 `selectMode` 的值，可以单独配置，参考 `selectMode`，决定搜索结果的展示形式。 | +| columns | `Array` | | 当展示形式为 `table` 可以用来配置展示哪些列，跟 table 中的 columns 配置相似，只是只有展示功能。 | +| leftOptions | `Array` | | 当展示形式为 `associated` 时用来配置左边的选项集。 | +| leftMode | `string` | | 当展示形式为 `associated` 时用来配置左边的选择形式，支持 `list` 或者 `tree`。默认为 `list`。 | +| rightMode | `string` | | 当展示形式为 `associated` 时用来配置右边的选择形式，可选：`list`、`table`、`tree`、`chained`。 | diff --git a/docs/zh-CN/components/form/tree.md b/docs/zh-CN/components/form/tree.md index e88f00e80..579420444 100755 --- a/docs/zh-CN/components/form/tree.md +++ b/docs/zh-CN/components/form/tree.md @@ -508,36 +508,36 @@ order: 59 当做选择器表单项使用时，除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------- | ------------------------------------ | ---------------- | ------------------------------------------------------------------------------------------------------------------- | -| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | -| source | `string`或 [API](../../../types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | -| autoComplete | [API](../../../types/api) | | [自动提示补全](./options#%E8%87%AA%E5%8A%A8%E8%A1%A5%E5%85%A8-autocomplete) | -| multiple | `boolean` | `false` | 是否多选 | -| delimeter | `string` | `false` | [拼接符](./options#%E6%8B%BC%E6%8E%A5%E7%AC%A6-delimiter) | -| labelField | `string` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | -| valueField | `string` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | -| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | -| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | -| creatable | `boolean` | `false` | [新增选项](./options#%E5%89%8D%E7%AB%AF%E6%96%B0%E5%A2%9E-creatable) | -| addControls | Array<[表单项](./formitem)> | | [自定义新增表单项](./options#%E8%87%AA%E5%AE%9A%E4%B9%89%E6%96%B0%E5%A2%9E%E8%A1%A8%E5%8D%95%E9%A1%B9-addcontrols) | -| addApi | [API](../../types/api) | | [配置新增选项接口](./options#%E9%85%8D%E7%BD%AE%E6%96%B0%E5%A2%9E%E6%8E%A5%E5%8F%A3-addapi) | -| editable | `boolean` | `false` | [编辑选项](./options#%E5%89%8D%E7%AB%AF%E7%BC%96%E8%BE%91-editable) | -| editControls | Array<[表单项](./formitem)> | | [自定义编辑表单项](./options#%E8%87%AA%E5%AE%9A%E4%B9%89%E7%BC%96%E8%BE%91%E8%A1%A8%E5%8D%95%E9%A1%B9-editcontrols) | -| editApi | [API](../../types/api) | | [配置编辑选项接口](./options#%E9%85%8D%E7%BD%AE%E7%BC%96%E8%BE%91%E6%8E%A5%E5%8F%A3-editapi) | -| removable | `boolean` | `false` | [删除选项](./options#%E5%88%A0%E9%99%A4%E9%80%89%E9%A1%B9) | -| deleteApi | [API](../../types/api) | | [配置删除选项接口](./options#%E9%85%8D%E7%BD%AE%E5%88%A0%E9%99%A4%E6%8E%A5%E5%8F%A3-deleteapi) | -| searchable | `boolean` | `false` | 是否可检索，仅在 type 为 `tree-select` 的时候生效 | -| hideRoot | `boolean` | `true` | 如果想要显示个顶级节点，请设置为 `false` | -| rootLabel | `boolean` | `"顶级"` | 当 `hideRoot` 不为 `false` 时有用，用来设置顶级节点的文字。 | -| showIcon | `boolean` | `true` | 是否显示图标 | -| showRadio | `boolean` | `false` | 是否显示单选按钮，`multiple` 为 `false` 是有效。 | -| initiallyOpen | `boolean` | `true` | 设置是否默认展开所有层级。 | -| unfoldedLevel | `number` | `0` | 设置默认展开的级数，只有`initiallyOpen`不是`true`时生效。 | -| cascade | `boolean` | `false` | 当选中父节点时不自动选择子节点。 | -| withChildren | `boolean` | `false` | 选中父节点时，值里面将包含子节点的值，否则只会保留父节点的值。 | -| onlyChildren | `boolean` | `false` | 多选时，选中父节点时，是否只将其子节点加入到值中。 | -| rootCreatable | `boolean` | `false` | 是否可以创建顶级节点 | -| rootCreateTip | `string` | `"添加一级节点"` | 创建顶级节点的悬浮提示 | -| minLength | `number` | | 最少选中的节点数 | -| maxLength | `number` | | 最多选中的节点数 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------- | -------------------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------- | +| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | +| source | `string`或 [API](../../../../docs/types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | +| autoComplete | [API](../../../../docs/types/api) | | [自动提示补全](./options#%E8%87%AA%E5%8A%A8%E8%A1%A5%E5%85%A8-autocomplete) | +| multiple | `boolean` | `false` | 是否多选 | +| delimeter | `string` | `false` | [拼接符](./options#%E6%8B%BC%E6%8E%A5%E7%AC%A6-delimiter) | +| labelField | `string` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | +| valueField | `string` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | +| joinValues | `boolean` | `true` | [拼接值](./options#%E6%8B%BC%E6%8E%A5%E5%80%BC-joinvalues) | +| extractValue | `boolean` | `false` | [提取值](./options#%E6%8F%90%E5%8F%96%E5%A4%9A%E9%80%89%E5%80%BC-extractvalue) | +| creatable | `boolean` | `false` | [新增选项](./options#%E5%89%8D%E7%AB%AF%E6%96%B0%E5%A2%9E-creatable) | +| addControls | Array<[表单项](./formitem)> | | [自定义新增表单项](./options#%E8%87%AA%E5%AE%9A%E4%B9%89%E6%96%B0%E5%A2%9E%E8%A1%A8%E5%8D%95%E9%A1%B9-addcontrols) | +| addApi | [API](../../../docs/types/api) | | [配置新增选项接口](./options#%E9%85%8D%E7%BD%AE%E6%96%B0%E5%A2%9E%E6%8E%A5%E5%8F%A3-addapi) | +| editable | `boolean` | `false` | [编辑选项](./options#%E5%89%8D%E7%AB%AF%E7%BC%96%E8%BE%91-editable) | +| editControls | Array<[表单项](./formitem)> | | [自定义编辑表单项](./options#%E8%87%AA%E5%AE%9A%E4%B9%89%E7%BC%96%E8%BE%91%E8%A1%A8%E5%8D%95%E9%A1%B9-editcontrols) | +| editApi | [API](../../../docs/types/api) | | [配置编辑选项接口](./options#%E9%85%8D%E7%BD%AE%E7%BC%96%E8%BE%91%E6%8E%A5%E5%8F%A3-editapi) | +| removable | `boolean` | `false` | [删除选项](./options#%E5%88%A0%E9%99%A4%E9%80%89%E9%A1%B9) | +| deleteApi | [API](../../../docs/types/api) | | [配置删除选项接口](./options#%E9%85%8D%E7%BD%AE%E5%88%A0%E9%99%A4%E6%8E%A5%E5%8F%A3-deleteapi) | +| searchable | `boolean` | `false` | 是否可检索，仅在 type 为 `tree-select` 的时候生效 | +| hideRoot | `boolean` | `true` | 如果想要显示个顶级节点，请设置为 `false` | +| rootLabel | `boolean` | `"顶级"` | 当 `hideRoot` 不为 `false` 时有用，用来设置顶级节点的文字。 | +| showIcon | `boolean` | `true` | 是否显示图标 | +| showRadio | `boolean` | `false` | 是否显示单选按钮，`multiple` 为 `false` 是有效。 | +| initiallyOpen | `boolean` | `true` | 设置是否默认展开所有层级。 | +| unfoldedLevel | `number` | `0` | 设置默认展开的级数，只有`initiallyOpen`不是`true`时生效。 | +| cascade | `boolean` | `false` | 当选中父节点时不自动选择子节点。 | +| withChildren | `boolean` | `false` | 选中父节点时，值里面将包含子节点的值，否则只会保留父节点的值。 | +| onlyChildren | `boolean` | `false` | 多选时，选中父节点时，是否只将其子节点加入到值中。 | +| rootCreatable | `boolean` | `false` | 是否可以创建顶级节点 | +| rootCreateTip | `string` | `"添加一级节点"` | 创建顶级节点的悬浮提示 | +| minLength | `number` | | 最少选中的节点数 | +| maxLength | `number` | | 最多选中的节点数 | diff --git a/docs/zh-CN/components/grid-2d.md b/docs/zh-CN/components/grid-2d.md index 64d51e74a..d35d1e792 100644 --- a/docs/zh-CN/components/grid-2d.md +++ b/docs/zh-CN/components/grid-2d.md @@ -257,21 +257,21 @@ Grid 2D 是一种二维布局方式，它可以更直观设置组件位置。 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| --------------- | --------------------------------- | --------- | ------------------------------- | -| type | `string` | `grid-2d` | 指定为 Grid 2D 渲染器 | -| gridClassName | `string` | | 外层 Dom 的类名 | -| gap | `int`/`string` | 0 | 格子间距，包括水平和垂直 | -| cols | `int` | 12 | 格子水平划分为几个区域 | -| rowHeight | `int` | 50 | 每个格子默认垂直高度 | -| rowGap | `int`/`string` | | 格子垂直间距 | -| grids | `Array` | | 格子集合 | -| grids[x] | [SchemaNode](../types/schemanode) | | 格子可以是其他渲染器 | -| grids[x].x | `int` | | 格子起始位置的横坐标 | -| grids[x].y | `int` | | 格子起始位置的纵坐标 | -| grids[x].w | `int` | | 格子横跨几个宽度 | -| grids[x].h | `int` | | 格子横跨几个高度 | -| grids[x].width | `int`/`string`/`auto` | | 格子所在列的宽度 | -| grids[x].height | `int`/`string`/`auto` | | 格子所在行的高度，可以设置 auto | -| grids[x].align | `left`/`center`/`right`/`auto` | `auto` | 格子内容水平布局 | -| grids[x].valign | `top`/`bottom`/`middle`/`auto` | `auto` | 格子内容垂直布局 | +| 属性名 | 类型 | 默认值 | 说明 | +| --------------- | ----------------------------------------- | --------- | ------------------------------- | +| type | `string` | `grid-2d` | 指定为 Grid 2D 渲染器 | +| gridClassName | `string` | | 外层 Dom 的类名 | +| gap | `int`/`string` | 0 | 格子间距，包括水平和垂直 | +| cols | `int` | 12 | 格子水平划分为几个区域 | +| rowHeight | `int` | 50 | 每个格子默认垂直高度 | +| rowGap | `int`/`string` | | 格子垂直间距 | +| grids | `Array` | | 格子集合 | +| grids[x] | [SchemaNode](../../docs/types/schemanode) | | 格子可以是其他渲染器 | +| grids[x].x | `int` | | 格子起始位置的横坐标 | +| grids[x].y | `int` | | 格子起始位置的纵坐标 | +| grids[x].w | `int` | | 格子横跨几个宽度 | +| grids[x].h | `int` | | 格子横跨几个高度 | +| grids[x].width | `int`/`string`/`auto` | | 格子所在列的宽度 | +| grids[x].height | `int`/`string`/`auto` | | 格子所在行的高度，可以设置 auto | +| grids[x].align | `left`/`center`/`right`/`auto` | `auto` | 格子内容水平布局 | +| grids[x].valign | `top`/`bottom`/`middle`/`auto` | `auto` | 格子内容垂直布局 | diff --git a/docs/zh-CN/components/grid.md b/docs/zh-CN/components/grid.md index 229df2cce..2f6c40c44 100755 --- a/docs/zh-CN/components/grid.md +++ b/docs/zh-CN/components/grid.md @@ -47,31 +47,31 @@ order: 46 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------------- | --------------------------------- | -------- | ----------------------- | -| type | `string` | `"grid"` | 指定为 Grid 渲染器 | -| className | `string` | | 外层 Dom 的类名 | -| columns | `Array` | | 列集合 | -| columns[x] | [SchemaNode](../types/schemanode) | | 成员可以是其他渲染器 | -| columns[x].xs | `int` | | 宽度占比： 1 - 12 | -| columns[x].xsHidden | `boolean` | | 是否隐藏 | -| columns[x].xsOffset | `int` | | 偏移量 1 - 12 | -| columns[x].xsPull | `int` | | 靠左的距离占比：1 - 12 | -| columns[x].xsPush | `int` | | 靠右的距离占比： 1 - 12 | -| columns[x].sm | `int` | | 宽度占比： 1 - 12 | -| columns[x].smHidden | `boolean` | | 是否隐藏 | -| columns[x].smOffset | `int` | | 偏移量 1 - 12 | -| columns[x].smPull | `int` | | 靠左的距离占比：1 - 12 | -| columns[x].smPush | `int` | | 靠右的距离占比： 1 - 12 | -| columns[x].md | `int` | | 宽度占比： 1 - 12 | -| columns[x].mdHidden | `boolean` | | 是否隐藏 | -| columns[x].mdOffset | `int` | | 偏移量 1 - 12 | -| columns[x].mdPull | `int` | | 靠左的距离占比：1 - 12 | -| columns[x].mdPush | `int` | | 靠右的距离占比： 1 - 12 | -| columns[x].lg | `int` | | 宽度占比： 1 - 12 | -| columns[x].lgHidden | `boolean` | | 是否隐藏 | -| columns[x].lgOffset | `int` | | 偏移量 1 - 12 | -| columns[x].lgPull | `int` | | 靠左的距离占比：1 - 12 | -| columns[x].lgPush | `int` | | 靠右的距离占比： 1 - 12 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------------- | ----------------------------------------- | -------- | ----------------------- | +| type | `string` | `"grid"` | 指定为 Grid 渲染器 | +| className | `string` | | 外层 Dom 的类名 | +| columns | `Array` | | 列集合 | +| columns[x] | [SchemaNode](../../docs/types/schemanode) | | 成员可以是其他渲染器 | +| columns[x].xs | `int` | | 宽度占比： 1 - 12 | +| columns[x].xsHidden | `boolean` | | 是否隐藏 | +| columns[x].xsOffset | `int` | | 偏移量 1 - 12 | +| columns[x].xsPull | `int` | | 靠左的距离占比：1 - 12 | +| columns[x].xsPush | `int` | | 靠右的距离占比： 1 - 12 | +| columns[x].sm | `int` | | 宽度占比： 1 - 12 | +| columns[x].smHidden | `boolean` | | 是否隐藏 | +| columns[x].smOffset | `int` | | 偏移量 1 - 12 | +| columns[x].smPull | `int` | | 靠左的距离占比：1 - 12 | +| columns[x].smPush | `int` | | 靠右的距离占比： 1 - 12 | +| columns[x].md | `int` | | 宽度占比： 1 - 12 | +| columns[x].mdHidden | `boolean` | | 是否隐藏 | +| columns[x].mdOffset | `int` | | 偏移量 1 - 12 | +| columns[x].mdPull | `int` | | 靠左的距离占比：1 - 12 | +| columns[x].mdPush | `int` | | 靠右的距离占比： 1 - 12 | +| columns[x].lg | `int` | | 宽度占比： 1 - 12 | +| columns[x].lgHidden | `boolean` | | 是否隐藏 | +| columns[x].lgOffset | `int` | | 偏移量 1 - 12 | +| columns[x].lgPull | `int` | | 靠左的距离占比：1 - 12 | +| columns[x].lgPush | `int` | | 靠右的距离占比： 1 - 12 | 更多使用说明，请参看 [Grid Props](https://react-bootstrap.github.io/layout/grid/#col-props) diff --git a/docs/zh-CN/components/hbox.md b/docs/zh-CN/components/hbox.md index 8e5fe8969..42b2c57af 100755 --- a/docs/zh-CN/components/hbox.md +++ b/docs/zh-CN/components/hbox.md @@ -43,10 +43,10 @@ order: 48 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| -------------------------- | --------------------------------- | -------------- | -------------------- | -| type | `string` | `"hbox"` | 指定为 HBox 渲染器 | -| className | `string` | | 外层 Dom 的类名 | -| columns | `Array` | | 列集合 | -| columns[x] | [SchemaNode](../types/schemanode) | | 成员可以是其他渲染器 | -| columns[x].columnClassName | `string` | `"wrapper-xs"` | 列上类名 | +| 属性名 | 类型 | 默认值 | 说明 | +| -------------------------- | ----------------------------------------- | -------------- | -------------------- | +| type | `string` | `"hbox"` | 指定为 HBox 渲染器 | +| className | `string` | | 外层 Dom 的类名 | +| columns | `Array` | | 列集合 | +| columns[x] | [SchemaNode](../../docs/types/schemanode) | | 成员可以是其他渲染器 | +| columns[x].columnClassName | `string` | `"wrapper-xs"` | 列上类名 | diff --git a/docs/zh-CN/components/component.md b/docs/zh-CN/components/index.md similarity index 88% rename from docs/zh-CN/components/component.md rename to docs/zh-CN/components/index.md index c9f6c1b94..df5c1792e 100755 --- a/docs/zh-CN/components/component.md +++ b/docs/zh-CN/components/index.md @@ -1,14 +1,11 @@ --- title: 组件介绍 -description: +description: type: 0 group: ⚙ 组件 menuName: 组件介绍 -icon: +icon: order: 21 --- + 从这个章节开始，我们将会介绍 amis 中内置的所有组件的使用方法 - - - - diff --git a/docs/zh-CN/components/list.md b/docs/zh-CN/components/list.md index 736e5063e..7fec8060d 100755 --- a/docs/zh-CN/components/list.md +++ b/docs/zh-CN/components/list.md @@ -77,21 +77,21 @@ order: 56 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------------------ | ---------------------------- | --------------------- | -------------------------------------------------------------------- | -| type | `string` | | `"list"` 指定为列表展示。 | -| title | `string` | | 标题 | -| source | `string` | `${items}` | 数据源, 获取当前数据域变量，支持[数据映射](../concepts/data-mapping) | -| placeholder | `string` | ‘暂无数据’ | 当没数据的时候的文字提示 | -| className | `string` | | 外层 CSS 类名 | -| headerClassName | `string` | `amis-list-header` | 顶部外层 CSS 类名 | -| footerClassName | `string` | `amis-list-footer` | 底部外层 CSS 类名 | -| listItem | `Array` | | 配置单条信息 | -| listItem.title | [模板](../concepts/template) | | 标题 | -| listItem.titleClassName | `string` | `h5` | 标题 CSS 类名 | -| listItem.subTitle | [模板](../concepts/template) | | 副标题 | -| listItem.avatar | [模板](../concepts/template) | | 图片地址 | -| listItem.avatarClassName | `string` | `thumb-sm avatar m-r` | 图片 CSS 类名 | -| listItem.desc | [模板](../concepts/template) | | 描述 | -| listItem.body | `Array` | | 内容容器，主要用来放置非表单项组件 | -| listItem.actions | Array<[Action](./action)> | | 按钮区域 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------------------ | ------------------------------------ | --------------------- | ---------------------------------------------------------------------------- | +| type | `string` | | `"list"` 指定为列表展示。 | +| title | `string` | | 标题 | +| source | `string` | `${items}` | 数据源, 获取当前数据域变量，支持[数据映射](../../docs/concepts/data-mapping) | +| placeholder | `string` | ‘暂无数据’ | 当没数据的时候的文字提示 | +| className | `string` | | 外层 CSS 类名 | +| headerClassName | `string` | `amis-list-header` | 顶部外层 CSS 类名 | +| footerClassName | `string` | `amis-list-footer` | 底部外层 CSS 类名 | +| listItem | `Array` | | 配置单条信息 | +| listItem.title | [模板](../../docs/concepts/template) | | 标题 | +| listItem.titleClassName | `string` | `h5` | 标题 CSS 类名 | +| listItem.subTitle | [模板](../../docs/concepts/template) | | 副标题 | +| listItem.avatar | [模板](../../docs/concepts/template) | | 图片地址 | +| listItem.avatarClassName | `string` | `thumb-sm avatar m-r` | 图片 CSS 类名 | +| listItem.desc | [模板](../../docs/concepts/template) | | 描述 | +| listItem.body | `Array` | | 内容容器，主要用来放置非表单项组件 | +| listItem.actions | Array<[Action](./action)> | | 按钮区域 | diff --git a/docs/zh-CN/components/nav.md b/docs/zh-CN/components/nav.md index 112b44e91..5953a0e56 100755 --- a/docs/zh-CN/components/nav.md +++ b/docs/zh-CN/components/nav.md @@ -103,16 +103,16 @@ order: 58 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| ----------------- | -------------------------------- | ------- | -------------------------------------- | -| type | `string` | `"nav"` | 指定为 Nav 渲染器 | -| className | `string` | | 外层 Dom 的类名 | -| stacked | `boolean` | `true` | 设置成 false 可以以 tabs 的形式展示 | -| links | `Array` | | 链接集合 | -| links[x].label | `string` | | 名称 | -| links[x].to | [模板](../concepts/template) | | 链接地址 | -| links[x].icon | `string` | | 图标 | -| links[x].children | `Array` | | 子链接 | -| links[x].unfolded | `boolean` | | 初始是否展开 | -| links[x].active | `boolean` | | 是否高亮 | -| links[x].activeOn | [表达式](../concepts/expression) | | 是否高亮的条件，留空将自动分析链接地址 | +| 属性名 | 类型 | 默认值 | 说明 | +| ----------------- | ---------------------------------------- | ------- | -------------------------------------- | +| type | `string` | `"nav"` | 指定为 Nav 渲染器 | +| className | `string` | | 外层 Dom 的类名 | +| stacked | `boolean` | `true` | 设置成 false 可以以 tabs 的形式展示 | +| links | `Array` | | 链接集合 | +| links[x].label | `string` | | 名称 | +| links[x].to | [模板](../../docs/concepts/template) | | 链接地址 | +| links[x].icon | `string` | | 图标 | +| links[x].children | `Array` | | 子链接 | +| links[x].unfolded | `boolean` | | 初始是否展开 | +| links[x].active | `boolean` | | 是否高亮 | +| links[x].activeOn | [表达式](../../docs/concepts/expression) | | 是否高亮的条件，留空将自动分析链接地址 | diff --git a/docs/zh-CN/components/page.md b/docs/zh-CN/components/page.md index bcd487fb0..b86018d9f 100755 --- a/docs/zh-CN/components/page.md +++ b/docs/zh-CN/components/page.md @@ -8,7 +8,7 @@ icon: order: 23 --- -Page 组件是 amis 页面 JSON 配置中，**唯一的** 顶级容器组件，是整个页面配置的入口组件。 +Page 组件是 amis 页面 JSON 配置中顶级容器组件，是整个页面配置的入口组件。 ## 基本用法 @@ -86,7 +86,7 @@ Page 默认将页面分为几个区域，分别是**内容区（`body`）**、** } ``` -具体 API 规范查看 [API 文档](../types/api)。 +具体 API 规范查看 [API 文档](../../docs/types/api)。 ## 轮询初始化接口 @@ -151,24 +151,24 @@ Page 默认将页面分为几个区域，分别是**内容区（`body`）**、** ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------------- | --------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------- | -| type | `string` | `"page"` | 指定为 Page 组件 | -| title | [SchemaNode](../types/schemanode) | | 页面标题 | -| subTitle | [SchemaNode](../types/schemanode) | | 页面副标题 | -| remark | [Remark](./remark) | | 标题附近会出现一个提示图标，鼠标放上去会提示该内容。 | -| aside | [SchemaNode](../types/schemanode) | | 往页面的边栏区域加内容 | -| toolbar | [SchemaNode](../types/schemanode) | | 往页面的右上角加内容，需要注意的是，当有 title 时，该区域在右上角，没有时该区域在顶部 | -| body | [SchemaNode](../types/schemanode) | | 往页面的内容区域加内容 | -| className | `string` | | 外层 dom 类名 | -| cssVars | `object` | | 自定义 CSS 变量，请参考[样式](../../../style) | -| toolbarClassName | `string` | `v-middle wrapper text-right bg-light b-b` | Toolbar dom 类名 | -| bodyClassName | `string` | `wrapper` | Body dom 类名 | -| asideClassName | `string` | `w page-aside-region bg-auto` | Aside dom 类名 | -| headerClassName | `string` | `bg-light b-b wrapper` | Header 区域 dom 类名 | -| initApi | [API](../types/api) | | Page 用来获取初始数据的 api。返回的数据可以整个 page 级别使用。 | -| initFetch | `boolean` | `true` | 是否起始拉取 initApi | -| initFetchOn | [表达式](../concepts/expression) | | 是否起始拉取 initApi, 通过表达式配置 | -| interval | `number` | `3000` | 刷新时间(最小 1000) | -| silentPolling | `boolean` | `false` | 配置刷新时是否显示加载动画 | -| stopAutoRefreshWhen | [表达式](../concepts/expression) | `""` | 通过表达式来配置停止刷新的条件 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------------- | ----------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------- | +| type | `string` | `"page"` | 指定为 Page 组件 | +| title | [SchemaNode](../../docs/types/schemanode) | | 页面标题 | +| subTitle | [SchemaNode](../../docs/types/schemanode) | | 页面副标题 | +| remark | [Remark](./remark) | | 标题附近会出现一个提示图标，鼠标放上去会提示该内容。 | +| aside | [SchemaNode](../../docs/types/schemanode) | | 往页面的边栏区域加内容 | +| toolbar | [SchemaNode](../../docs/types/schemanode) | | 往页面的右上角加内容，需要注意的是，当有 title 时，该区域在右上角，没有时该区域在顶部 | +| body | [SchemaNode](../../docs/types/schemanode) | | 往页面的内容区域加内容 | +| className | `string` | | 外层 dom 类名 | +| cssVars | `object` | | 自定义 CSS 变量，请参考[样式](../../../style) | +| toolbarClassName | `string` | `v-middle wrapper text-right bg-light b-b` | Toolbar dom 类名 | +| bodyClassName | `string` | `wrapper` | Body dom 类名 | +| asideClassName | `string` | `w page-aside-region bg-auto` | Aside dom 类名 | +| headerClassName | `string` | `bg-light b-b wrapper` | Header 区域 dom 类名 | +| initApi | [API](../../docs/types/api) | | Page 用来获取初始数据的 api。返回的数据可以整个 page 级别使用。 | +| initFetch | `boolean` | `true` | 是否起始拉取 initApi | +| initFetchOn | [表达式](../../docs/concepts/expression) | | 是否起始拉取 initApi, 通过表达式配置 | +| interval | `number` | `3000` | 刷新时间(最小 1000) | +| silentPolling | `boolean` | `false` | 配置刷新时是否显示加载动画 | +| stopAutoRefreshWhen | [表达式](../../docs/concepts/expression) | `""` | 通过表达式来配置停止刷新的条件 | diff --git a/docs/zh-CN/components/pagination-wrapper.md b/docs/zh-CN/components/pagination-wrapper.md index 1d0d8e2b4..f5443835e 100644 --- a/docs/zh-CN/components/pagination-wrapper.md +++ b/docs/zh-CN/components/pagination-wrapper.md @@ -8,7 +8,7 @@ icon: order: 59 --- -功能性组件，分页容器，可以用来对已有列表数据做分页处理。 +分页容器组件，可以用来对已有列表数据做分页处理。 - 输入：默认读取作用域中的 items 变量，如果是其他变量名请配置 `inputName`。 - 输出：经过分页处理后会把分页后的数据下发给 `outputName` （默认也是 items）对应的数据。 diff --git a/docs/zh-CN/components/panel.md b/docs/zh-CN/components/panel.md index 76170157a..f3c13cb57 100755 --- a/docs/zh-CN/components/panel.md +++ b/docs/zh-CN/components/panel.md @@ -89,17 +89,17 @@ order: 59 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| ---------------- | --------------------------------- | -------------------------------------- | ------------------- | -| type | `string` | `"panel"` | 指定为 Panel 渲染器 | -| className | `string` | `"panel-default"` | 外层 Dom 的类名 | -| headerClassName | `string` | `"panel-heading"` | header 区域的类名 | -| footerClassName | `string` | `"panel-footer bg-light lter wrapper"` | footer 区域的类名 | -| actionsClassName | `string` | `"panel-footer"` | actions 区域的类名 | -| bodyClassName | `string` | `"panel-body"` | body 区域的类名 | -| title | [SchemaNode](../types/schemanode) | | 标题 | -| header | [SchemaNode](../types/schemanode) | | 头部容器 | -| body | [SchemaNode](../types/schemanode) | | 内容容器 | -| footer | [SchemaNode](../types/schemanode) | | 底部容器 | -| affixFooter | `boolean` | | 是否固定底部容器 | -| actions | Array<[Action](./action)> | | 按钮区域 | +| 属性名 | 类型 | 默认值 | 说明 | +| ---------------- | ----------------------------------------- | -------------------------------------- | ------------------- | +| type | `string` | `"panel"` | 指定为 Panel 渲染器 | +| className | `string` | `"panel-default"` | 外层 Dom 的类名 | +| headerClassName | `string` | `"panel-heading"` | header 区域的类名 | +| footerClassName | `string` | `"panel-footer bg-light lter wrapper"` | footer 区域的类名 | +| actionsClassName | `string` | `"panel-footer"` | actions 区域的类名 | +| bodyClassName | `string` | `"panel-body"` | body 区域的类名 | +| title | [SchemaNode](../../docs/types/schemanode) | | 标题 | +| header | [SchemaNode](../../docs/types/schemanode) | | 头部容器 | +| body | [SchemaNode](../../docs/types/schemanode) | | 内容容器 | +| footer | [SchemaNode](../../docs/types/schemanode) | | 底部容器 | +| affixFooter | `boolean` | | 是否固定底部容器 | +| actions | Array<[Action](./action)> | | 按钮区域 | diff --git a/docs/zh-CN/components/qrcode.md b/docs/zh-CN/components/qrcode.md index af6d0e139..45446bdf7 100755 --- a/docs/zh-CN/components/qrcode.md +++ b/docs/zh-CN/components/qrcode.md @@ -85,13 +85,13 @@ order: 61 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| --------------- | ---------------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| type | `string` | `"qr-code"` | 指定为 QRCode 渲染器 | -| className | `string` | | 外层 Dom 的类名 | -| qrcodeClassName | `string` | | 二维码 SVG 的类名 | -| codeSize | `number` | `128` | 二维码的宽高大小 | -| backgroundColor | `string` | `"#fff"` | 二维码背景色 | -| foregroundColor | `string` | `"#000"` | 二维码前景色 | -| level | `string` | `"L"` | 二维码复杂级别，有（'L' 'M' 'Q' 'H'）四种 | -| value | [模板](../concepts/template) | `"https://www.baidu.com"` | 扫描二维码后显示的文本，如果要显示某个页面请输入完整 url（`"http://..."`或`"https://..."`开头），支持使用 [模板](./concepts/template) | +| 属性名 | 类型 | 默认值 | 说明 | +| --------------- | ------------------------------------ | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| type | `string` | `"qr-code"` | 指定为 QRCode 渲染器 | +| className | `string` | | 外层 Dom 的类名 | +| qrcodeClassName | `string` | | 二维码 SVG 的类名 | +| codeSize | `number` | `128` | 二维码的宽高大小 | +| backgroundColor | `string` | `"#fff"` | 二维码背景色 | +| foregroundColor | `string` | `"#000"` | 二维码前景色 | +| level | `string` | `"L"` | 二维码复杂级别，有（'L' 'M' 'Q' 'H'）四种 | +| value | [模板](../../docs/concepts/template) | `"https://www.baidu.com"` | 扫描二维码后显示的文本，如果要显示某个页面请输入完整 url（`"http://..."`或`"https://..."`开头），支持使用 [模板](./concepts/template) | diff --git a/docs/zh-CN/components/radios.md b/docs/zh-CN/components/radios.md index 1c6604e78..de189a0d7 100644 --- a/docs/zh-CN/components/radios.md +++ b/docs/zh-CN/components/radios.md @@ -45,11 +45,11 @@ order: 36 当做选择器表单项使用时，除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外，还支持下面一些配置 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------ | --------------------------------- | --------- | ------------------------------------------------------------------------------------------- | -| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | -| source | `string`或 [API](../../types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | -| labelField | `boolean` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | -| valueField | `boolean` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | -| columnsCount | `number` | `1` | 选项按几列显示，默认为一列 | -| autoFill | `object` | | [自动填充](./options#%E8%87%AA%E5%8A%A8%E5%A1%AB%E5%85%85-autofill) | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------ | ----------------------------------------- | --------- | ------------------------------------------------------------------------------------------- | +| options | `Array`或`Array` | | [选项组](./options#%E9%9D%99%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-options) | +| source | `string`或 [API](../../../docs/types/api) | | [动态选项组](./options#%E5%8A%A8%E6%80%81%E9%80%89%E9%A1%B9%E7%BB%84-source) | +| labelField | `boolean` | `"label"` | [选项标签字段](./options#%E9%80%89%E9%A1%B9%E6%A0%87%E7%AD%BE%E5%AD%97%E6%AE%B5-labelfield) | +| valueField | `boolean` | `"value"` | [选项值字段](./options#%E9%80%89%E9%A1%B9%E5%80%BC%E5%AD%97%E6%AE%B5-valuefield) | +| columnsCount | `number` | `1` | 选项按几列显示，默认为一列 | +| autoFill | `object` | | [自动填充](./options#%E8%87%AA%E5%8A%A8%E5%A1%AB%E5%85%85-autofill) | diff --git a/docs/zh-CN/components/service.md b/docs/zh-CN/components/service.md index 79c9f4c6a..51a42661e 100755 --- a/docs/zh-CN/components/service.md +++ b/docs/zh-CN/components/service.md @@ -8,13 +8,13 @@ icon: order: 63 --- -amis 中部分组件，作为展示组件，自身没有**使用接口初始化数据域的能力**，例如：[Table](./table)、[Cards](./cards)、[List](./list)等，他们需要使用某些配置项，例如`source`，通过[数据映射](../concepts/data-mapping)功能，在当前的 **数据链** 中获取数据，并进行数据展示。 +amis 中部分组件，作为展示组件，自身没有**使用接口初始化数据域的能力**，例如：[Table](./table)、[Cards](./cards)、[List](./list)等，他们需要使用某些配置项，例如`source`，通过[数据映射](../../docs/concepts/data-mapping)功能，在当前的 **数据链** 中获取数据，并进行数据展示。 而`Service`组件就是专门为该类组件而生，它的功能是：：**配置初始化接口，进行数据域的初始化，然后在`Service`内容器中配置子组件，这些子组件通过数据链的方法，获取`Service`所拉取到的数据** ## 基本使用 -最基本的使用，是配置初始化接口`api`，将接口返回的数据添加到自身的数据域中，以供子组件通过[数据链](../concepts/datascope-and-datachain#%E6%95%B0%E6%8D%AE%E9%93%BE)进行获取使用。 +最基本的使用，是配置初始化接口`api`，将接口返回的数据添加到自身的数据域中，以供子组件通过[数据链](../../docs/concepts/datascope-and-datachain#%E6%95%B0%E6%8D%AE%E9%93%BE)进行获取使用。 ```schema: scope="body" { @@ -218,7 +218,7 @@ amis 中部分组件，作为展示组件，自身没有**使用接口初始化 ## 接口联动 -`api`和`schemaApi`都支持[接口联动](../concepts/linkage#%E6%8E%A5%E5%8F%A3%E8%81%94%E5%8A%A8) +`api`和`schemaApi`都支持[接口联动](../../docs/concepts/linkage#%E6%8E%A5%E5%8F%A3%E8%81%94%E5%8A%A8) ```schema: scope="body" { @@ -277,7 +277,7 @@ amis 中部分组件，作为展示组件，自身没有**使用接口初始化 上例可看到，变更**数据模板**的值，会触发 service 重新请求，并更新当前数据域中的数据 -更多相关见[接口联动](../concepts/linkage#%E6%8E%A5%E5%8F%A3%E8%81%94%E5%8A%A8) +更多相关见[接口联动](../../docs/concepts/linkage#%E6%8E%A5%E5%8F%A3%E8%81%94%E5%8A%A8) ## 定时轮询刷新 @@ -349,19 +349,19 @@ wsFetcher(ws, onMessage, onError) { ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| --------------------- | --------------------------------- | -------------- | ----------------------------------------------------------------------------- | -| type | `string` | `"service"` | 指定为 service 渲染器 | -| className | `string` | | 外层 Dom 的类名 | -| body | [SchemaNode](../types/schemanode) | | 内容容器 | -| api | [api](../types/api) | | 初始化数据域接口地址 | -| ws | `string` | | WebScocket 地址 | -| initFetch | `boolean` | | 是否默认拉取 | -| schemaApi | [api](../types/api) | | 用来获取远程 Schema 接口地址 | -| initFetchSchema | `boolean` | | 是否默认拉取 Schema | -| messages | `Object` | | 消息提示覆写，默认消息读取的是接口返回的 toast 提示文字，但是在此可以覆写它。 | -| messages.fetchSuccess | `string` | | 接口请求成功时的 toast 提示文字 | -| messages.fetchFailed | `string` | `"初始化失败"` | 接口请求失败时 toast 提示文字 | -| interval | `number` | | 轮询时间间隔(最低 3000) | -| silentPolling | `boolean` | `false` | 配置轮询时是否显示加载动画 | -| stopAutoRefreshWhen | [表达式](../concepts/expression) | | 配置停止轮询的条件 | +| 属性名 | 类型 | 默认值 | 说明 | +| --------------------- | ----------------------------------------- | -------------- | ----------------------------------------------------------------------------- | +| type | `string` | `"service"` | 指定为 service 渲染器 | +| className | `string` | | 外层 Dom 的类名 | +| body | [SchemaNode](../../docs/types/schemanode) | | 内容容器 | +| api | [api](../../docs/types/api) | | 初始化数据域接口地址 | +| ws | `string` | | WebScocket 地址 | +| initFetch | `boolean` | | 是否默认拉取 | +| schemaApi | [api](../../docs/types/api) | | 用来获取远程 Schema 接口地址 | +| initFetchSchema | `boolean` | | 是否默认拉取 Schema | +| messages | `Object` | | 消息提示覆写，默认消息读取的是接口返回的 toast 提示文字，但是在此可以覆写它。 | +| messages.fetchSuccess | `string` | | 接口请求成功时的 toast 提示文字 | +| messages.fetchFailed | `string` | `"初始化失败"` | 接口请求失败时 toast 提示文字 | +| interval | `number` | | 轮询时间间隔(最低 3000) | +| silentPolling | `boolean` | `false` | 配置轮询时是否显示加载动画 | +| stopAutoRefreshWhen | [表达式](../../docs/concepts/expression) | | 配置停止轮询的条件 | diff --git a/docs/zh-CN/components/table.md b/docs/zh-CN/components/table.md index 67dfcc770..09922aefc 100755 --- a/docs/zh-CN/components/table.md +++ b/docs/zh-CN/components/table.md @@ -1079,7 +1079,7 @@ order: 67 ## 高亮行 -可以通过配置`rowClassNameExpr`来为行添加 CSS 类，支持 [模板](../concepts/template) 语法。 +可以通过配置`rowClassNameExpr`来为行添加 CSS 类，支持 [模板](../../docs/concepts/template) 语法。 例如下例，`"<%= data.id % 2 ? "bg-success" : "" %>"` 表示当行数据的 `id` 变量为 不能被 `2` 整除时，给当前行添加`bg-success` CSS 类名，即绿色背景色 @@ -1264,26 +1264,26 @@ order: 67 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| ---------------- | --------------------------------------------- | ------------------------- | ----------------------------------------------------------------- | -| type | `string` | | `"type"` 指定为 table 渲染器 | -| title | `string` | | 标题 | -| source | `string` | `${items}` | 数据源, 绑定当前环境变量 | -| affixHeader | `boolean` | `true` | 是否固定表头 | -| columnsTogglable | `auto` 或者 `boolean` | `auto` | 展示列显示开关, 自动即：列数量大于或等于 5 个时自动开启 | -| placeholder | string | `暂无数据` | 当没数据的时候的文字提示 | -| className | `string` | `panel-default` | 外层 CSS 类名 | -| tableClassName | `string` | `table-db table-striped` | 表格 CSS 类名 | -| headerClassName | `string` | `Action.md-table-header` | 顶部外层 CSS 类名 | -| footerClassName | `string` | `Action.md-table-footer` | 底部外层 CSS 类名 | -| toolbarClassName | `string` | `Action.md-table-toolbar` | 工具栏 CSS 类名 | -| columns | Array<[Column](#%E5%88%97%E9%85%8D%E7%BD%AE)> | | 用来设置列信息 | -| combineNum | `number` | | 自动合并单元格 | -| itemActions | Array<[Action](./action-button)> | | 悬浮行操作按钮组 | -| itemCheckableOn | [表达式](../concepts/expression) | | 配置当前行是否可勾选的条件，要用 [表达式](../concepts/expression) | -| itemDraggableOn | [表达式](../concepts/expression) | | 配置当前行是否可拖拽的条件，要用 [表达式](../concepts/expression) | -| checkOnItemClick | `boolean` | `false` | 点击数据行是否可以勾选当前行 | -| rowClassName | `string` | | 给行添加 CSS 类名 | -| rowClassNameExpr | [模板](../concepts/template) | | 通过模板给行添加 CSS 类名 | -| prefixRow | `Array` | | 顶部总结行 | -| affixRow | `Array` | | 底部总结行 | +| 属性名 | 类型 | 默认值 | 说明 | +| ---------------- | --------------------------------------------- | ------------------------- | ------------------------------------------------------------------------- | +| type | `string` | | `"type"` 指定为 table 渲染器 | +| title | `string` | | 标题 | +| source | `string` | `${items}` | 数据源, 绑定当前环境变量 | +| affixHeader | `boolean` | `true` | 是否固定表头 | +| columnsTogglable | `auto` 或者 `boolean` | `auto` | 展示列显示开关, 自动即：列数量大于或等于 5 个时自动开启 | +| placeholder | string | `暂无数据` | 当没数据的时候的文字提示 | +| className | `string` | `panel-default` | 外层 CSS 类名 | +| tableClassName | `string` | `table-db table-striped` | 表格 CSS 类名 | +| headerClassName | `string` | `Action.md-table-header` | 顶部外层 CSS 类名 | +| footerClassName | `string` | `Action.md-table-footer` | 底部外层 CSS 类名 | +| toolbarClassName | `string` | `Action.md-table-toolbar` | 工具栏 CSS 类名 | +| columns | Array<[Column](#%E5%88%97%E9%85%8D%E7%BD%AE)> | | 用来设置列信息 | +| combineNum | `number` | | 自动合并单元格 | +| itemActions | Array<[Action](./action-button)> | | 悬浮行操作按钮组 | +| itemCheckableOn | [表达式](../../docs/concepts/expression) | | 配置当前行是否可勾选的条件，要用 [表达式](../../docs/concepts/expression) | +| itemDraggableOn | [表达式](../../docs/concepts/expression) | | 配置当前行是否可拖拽的条件，要用 [表达式](../../docs/concepts/expression) | +| checkOnItemClick | `boolean` | `false` | 点击数据行是否可以勾选当前行 | +| rowClassName | `string` | | 给行添加 CSS 类名 | +| rowClassNameExpr | [模板](../../docs/concepts/template) | | 通过模板给行添加 CSS 类名 | +| prefixRow | `Array` | | 顶部总结行 | +| affixRow | `Array` | | 底部总结行 | diff --git a/docs/zh-CN/components/tabs.md b/docs/zh-CN/components/tabs.md index 67163e617..a6ca128b2 100755 --- a/docs/zh-CN/components/tabs.md +++ b/docs/zh-CN/components/tabs.md @@ -8,6 +8,8 @@ icon: order: 68 --- +选项卡容器组件。 + ## 基本用法 ```schema: scope="body" diff --git a/docs/zh-CN/components/tasks.md b/docs/zh-CN/components/tasks.md index 0645d2761..f8cfce9c7 100755 --- a/docs/zh-CN/components/tasks.md +++ b/docs/zh-CN/components/tasks.md @@ -39,30 +39,30 @@ order: 69 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| ----------------- | ------------------- | --------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| type | `string` | `"tasks"` | 指定为 Tasks 渲染器 | -| className | `string` | | 外层 Dom 的类名 | -| tableClassName | `string` | | table Dom 的类名 | -| items | `Array` | | 任务列表 | -| items[x].label | `string` | | 任务名称 | -| items[x].key | `string` | | 任务键值，请唯一区分 | -| items[x].remark | `string` | | 当前任务状态，支持 html | -| items[x].status | `string` | | 任务状态： 0: 初始状态，不可操作。1: 就绪，可操作状态。2: 进行中，还没有结束。3：有错误，不可重试。4: 已正常结束。5：有错误，且可以重试。 | -| checkApi | [API](../types/api) | | 返回任务列表，返回的数据请参考 items。 | -| submitApi | [API](../types/api) | | 提交任务使用的 API | -| reSubmitApi | [API](../types/api) | | 如果任务失败，且可以重试，提交的时候会使用此 API | -| interval | `number` | `3000` | 当有任务进行中，会每隔一段时间再次检测，而时间间隔就是通过此项配置，默认 3s。 | -| taskNameLabel | `string` | 任务名称 | 任务名称列说明 | -| operationLabel | `string` | 操作 | 操作列说明 | -| statusLabel | `string` | 状态 | 状态列说明 | -| remarkLabel | `string` | 备注 | 备注列说明 | -| btnText | `string` | 上线 | 操作按钮文字 | -| retryBtnText | `string` | 重试 | 重试操作按钮文字 | -| btnClassName | `string` | `btn-sm btn-default` | 配置容器按钮 className | -| retryBtnClassName | `string` | `btn-sm btn-danger` | 配置容器重试按钮 className | -| statusLabelMap | `array` | `["label-warning", "label-info", "label-success", "label-danger", "label-default", "label-danger"]` | 状态显示对应的类名配置 | -| statusTextMap | `array` | `["未开始", "就绪", "进行中", "出错", "已完成", "出错"]` | 状态显示对应的文字显示配置 | +| 属性名 | 类型 | 默认值 | 说明 | +| ----------------- | --------------------------- | --------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| type | `string` | `"tasks"` | 指定为 Tasks 渲染器 | +| className | `string` | | 外层 Dom 的类名 | +| tableClassName | `string` | | table Dom 的类名 | +| items | `Array` | | 任务列表 | +| items[x].label | `string` | | 任务名称 | +| items[x].key | `string` | | 任务键值，请唯一区分 | +| items[x].remark | `string` | | 当前任务状态，支持 html | +| items[x].status | `string` | | 任务状态： 0: 初始状态，不可操作。1: 就绪，可操作状态。2: 进行中，还没有结束。3：有错误，不可重试。4: 已正常结束。5：有错误，且可以重试。 | +| checkApi | [API](../../docs/types/api) | | 返回任务列表，返回的数据请参考 items。 | +| submitApi | [API](../../docs/types/api) | | 提交任务使用的 API | +| reSubmitApi | [API](../../docs/types/api) | | 如果任务失败，且可以重试，提交的时候会使用此 API | +| interval | `number` | `3000` | 当有任务进行中，会每隔一段时间再次检测，而时间间隔就是通过此项配置，默认 3s。 | +| taskNameLabel | `string` | 任务名称 | 任务名称列说明 | +| operationLabel | `string` | 操作 | 操作列说明 | +| statusLabel | `string` | 状态 | 状态列说明 | +| remarkLabel | `string` | 备注 | 备注列说明 | +| btnText | `string` | 上线 | 操作按钮文字 | +| retryBtnText | `string` | 重试 | 重试操作按钮文字 | +| btnClassName | `string` | `btn-sm btn-default` | 配置容器按钮 className | +| retryBtnClassName | `string` | `btn-sm btn-danger` | 配置容器重试按钮 className | +| statusLabelMap | `array` | `["label-warning", "label-info", "label-success", "label-danger", "label-default", "label-danger"]` | 状态显示对应的类名配置 | +| statusTextMap | `array` | `["未开始", "就绪", "进行中", "出错", "已完成", "出错"]` | 状态显示对应的文字显示配置 | ```schema: scope="body" [ diff --git a/docs/zh-CN/components/tpl.md b/docs/zh-CN/components/tpl.md index ae8e9e220..68240f101 100755 --- a/docs/zh-CN/components/tpl.md +++ b/docs/zh-CN/components/tpl.md @@ -8,7 +8,7 @@ icon: order: 70 --- -输出 [模板](../concepts/template) 的常用组件 +输出 [模板](../../docs/concepts/template) 的常用组件 ## 基本用法 @@ -25,12 +25,12 @@ order: 70 } ``` -更多模板相关配置请看[模板文档](../concepts/template) +更多模板相关配置请看[模板文档](../../docs/concepts/template) ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| --------- | ---------------------------- | ------- | --------------- | -| type | `string` | `"tpl"` | 指定为 Tpl 组件 | -| className | `string` | | 外层 Dom 的类名 | -| tpl | [模板](../concepts/template) | | 配置模板 | +| 属性名 | 类型 | 默认值 | 说明 | +| --------- | ------------------------------------ | ------- | --------------- | +| type | `string` | `"tpl"` | 指定为 Tpl 组件 | +| className | `string` | | 外层 Dom 的类名 | +| tpl | [模板](../../docs/concepts/template) | | 配置模板 | diff --git a/docs/zh-CN/components/wizard.md b/docs/zh-CN/components/wizard.md index 973aacdf4..06c2c246f 100755 --- a/docs/zh-CN/components/wizard.md +++ b/docs/zh-CN/components/wizard.md @@ -58,37 +58,37 @@ order: 73 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------------- | -------------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| type | `string` | `"wizard"` | 指定为 `Wizard` 组件 | -| mode | `string` | `"horizontal"` | 展示模式，选择：`horizontal` 或者 `vertical` | -| api | [API](../types/api) | | 最后一步保存的接口。 | -| initApi | [API](../types/api) | | 初始化数据接口 | -| initFetch | [API](../types/api) | | 初始是否拉取数据。 | -| initFetchOn | [表达式](../concepts/expression) | | 初始是否拉取数据，通过表达式来配置 | -| actionPrevLabel | `string` | `上一步` | 上一步按钮文本 | -| actionNextLabel | `string` | `下一步` | 下一步按钮文本 | -| actionNextSaveLabel | `string` | `保存并下一步` | 保存并下一步按钮文本 | -| actionFinishLabel | `string` | `完成` | 完成按钮文本 | -| className | `string` | | 外层 CSS 类名 | -| actionClassName | `string` | `btn-sm btn-default` | 按钮 CSS 类名 | -| reload | `string` | | 操作完后刷新目标对象。请填写目标组件设置的 name 值，如果填写为 `window` 则让当前页面整体刷新。 | -| redirect | [模板](../concepts/template) | `3000` | 操作完后跳转。 | -| target | `string` | `false` | 可以把数据提交给别的组件而不是自己保存。请填写目标组件设置的 name 值，如果填写为 `window` 则把数据同步到地址栏上，同时依赖这些数据的组件会自动重新刷新。 | -| steps | Array<[step](#step)> | | 数组，配置步骤信息 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------------- | ---------------------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| type | `string` | `"wizard"` | 指定为 `Wizard` 组件 | +| mode | `string` | `"horizontal"` | 展示模式，选择：`horizontal` 或者 `vertical` | +| api | [API](../../docs/types/api) | | 最后一步保存的接口。 | +| initApi | [API](../../docs/types/api) | | 初始化数据接口 | +| initFetch | [API](../../docs/types/api) | | 初始是否拉取数据。 | +| initFetchOn | [表达式](../../docs/concepts/expression) | | 初始是否拉取数据，通过表达式来配置 | +| actionPrevLabel | `string` | `上一步` | 上一步按钮文本 | +| actionNextLabel | `string` | `下一步` | 下一步按钮文本 | +| actionNextSaveLabel | `string` | `保存并下一步` | 保存并下一步按钮文本 | +| actionFinishLabel | `string` | `完成` | 完成按钮文本 | +| className | `string` | | 外层 CSS 类名 | +| actionClassName | `string` | `btn-sm btn-default` | 按钮 CSS 类名 | +| reload | `string` | | 操作完后刷新目标对象。请填写目标组件设置的 name 值，如果填写为 `window` 则让当前页面整体刷新。 | +| redirect | [模板](../../docs/concepts/template) | `3000` | 操作完后跳转。 | +| target | `string` | `false` | 可以把数据提交给别的组件而不是自己保存。请填写目标组件设置的 name 值，如果填写为 `window` 则把数据同步到地址栏上，同时依赖这些数据的组件会自动重新刷新。 | +| steps | Array<[step](#step)> | | 数组，配置步骤信息 | ### step -| 属性名 | 类型 | 默认值 | 说明 | -| ----------------- | ---------------------------------- | ------ | --------------------------------------------------------------------------------------------- | -| title | `string` | | 步骤标题 | -| mode | `string` | | 展示默认，跟 [Form](./Form/Form.md) 中的模式一样，选择： `normal`、`horizontal`或者`inline`。 | -| horizontal | `Object` | | 当为水平模式时，用来控制左右占比 | -| horizontal.label | `number` | | 左边 label 的宽度占比 | -| horizontal.right | `number` | | 右边控制器的宽度占比。 | -| horizontal.offset | `number` | | 当没有设置 label 时，右边控制器的偏移量 | -| api | [API](../types/api) | | 当前步骤保存接口，可以不配置。 | -| initApi | [API](../types/api) | | 当前步骤数据初始化接口。 | -| initFetch | `boolean` | | 当前步骤数据初始化接口是否初始拉取。 | -| initFetchOn | [表达式](../concepts/expression) | | 当前步骤数据初始化接口是否初始拉取，用表达式来决定。 | -| controls | Array<[FormItem](./form/formItem)> | | 当前步骤的表单项集合，请参考 [FormItem](./form/formItem)。 | +| 属性名 | 类型 | 默认值 | 说明 | +| ----------------- | ---------------------------------------- | ------ | --------------------------------------------------------------------------------------------- | +| title | `string` | | 步骤标题 | +| mode | `string` | | 展示默认，跟 [Form](./Form/Form.md) 中的模式一样，选择： `normal`、`horizontal`或者`inline`。 | +| horizontal | `Object` | | 当为水平模式时，用来控制左右占比 | +| horizontal.label | `number` | | 左边 label 的宽度占比 | +| horizontal.right | `number` | | 右边控制器的宽度占比。 | +| horizontal.offset | `number` | | 当没有设置 label 时，右边控制器的偏移量 | +| api | [API](../../docs/types/api) | | 当前步骤保存接口，可以不配置。 | +| initApi | [API](../../docs/types/api) | | 当前步骤数据初始化接口。 | +| initFetch | `boolean` | | 当前步骤数据初始化接口是否初始拉取。 | +| initFetchOn | [表达式](../../docs/concepts/expression) | | 当前步骤数据初始化接口是否初始拉取，用表达式来决定。 | +| controls | Array<[FormItem](./form/formItem)> | | 当前步骤的表单项集合，请参考 [FormItem](./form/formItem)。 | diff --git a/docs/zh-CN/components/wrapper.md b/docs/zh-CN/components/wrapper.md index 12f544a7d..b1490cfcb 100755 --- a/docs/zh-CN/components/wrapper.md +++ b/docs/zh-CN/components/wrapper.md @@ -83,9 +83,9 @@ order: 72 ## 属性表 -| 属性名 | 类型 | 默认值 | 说明 | -| --------- | --------------------------------- | ----------- | ---------------------------- | -| type | `string` | `"wrapper"` | 指定为 Wrapper 渲染器 | -| className | `string` | | 外层 Dom 的类名 | -| size | `string` | | 支持: `xs`、`sm`、`md`和`lg` | -| body | [SchemaNode](../types/schemanode) | | 内容容器 | +| 属性名 | 类型 | 默认值 | 说明 | +| --------- | ----------------------------------------- | ----------- | ---------------------------- | +| type | `string` | `"wrapper"` | 指定为 Wrapper 渲染器 | +| className | `string` | | 外层 Dom 的类名 | +| size | `string` | | 支持: `xs`、`sm`、`md`和`lg` | +| body | [SchemaNode](../../docs/types/schemanode) | | 内容容器 | diff --git a/docs/zh-CN/index.md b/docs/zh-CN/index.md index 360dc2e3f..466655f01 100644 --- a/docs/zh-CN/index.md +++ b/docs/zh-CN/index.md @@ -221,7 +221,7 @@ amis 是一个低代码前端框架，它使用 JSON 配置来生成页面，可 ## 阅读建议 - 如果你是第一次接触 amis，那么请 **务必认真阅读完概念部分**，它会让你对 amis 有个整体的认识 -- 如果你已经掌握 amis 基本概念，且有一定的开发经验，需要参考 amis 组件相关文档的同学，那么请移步 [组件文档](./components/component) +- 如果你已经掌握 amis 基本概念，且有一定的开发经验，需要参考 amis 组件相关文档的同学，那么请移步 [组件文档](./components/page) ## 让我们马上开始吧 diff --git a/examples/components/App.tsx b/examples/components/App.tsx index ff16ce4a7..c67e61e57 100644 --- a/examples/components/App.tsx +++ b/examples/components/App.tsx @@ -26,18 +26,14 @@ import DocSearch from './DocSearch'; import Doc from './Doc'; import DocNavCN from './DocNavCN'; import Example, {examples} from './Example'; -import CssDocs, {cssDocs} from './CssDocs'; -import CSSDocs from './CssDocs'; +import CSSDocs, {cssDocs} from './CssDocs'; +import Components, {components} from './Components'; declare const _hmt: any; -let ExamplePathPrefix = '/examples'; -let DocPathPrefix = '/docs'; let ContextPath = ''; if (process.env.NODE_ENV === 'production') { - ExamplePathPrefix = ''; - DocPathPrefix = ''; ContextPath = '/amis'; } @@ -260,6 +256,13 @@ export class App extends React.PureComponent<{ 文档 + + + 组件 + 样式 @@ -550,7 +553,7 @@ function isActive(link: any, location: any) { return !!(link.path && getPath(link.path) === location.pathname); } -function navigations2route(pathPrefix = DocPathPrefix, navigations) { +function navigations2route(navigations) { let routes = []; navigations.forEach(root => { @@ -597,6 +600,8 @@ export default function entry({pathPrefix}) { from={`${ContextPath}/`} to={`${ContextPath}/${locate}/docs/index`} /> + + {/* docs */} + + {/* components */} + + + + + + {/* expamles */} - - {navigations2route(DocPathPrefix, DocNavCN)} + {navigations2route(DocNavCN)} + + + {navigations2route(components)} - {navigations2route(ExamplePathPrefix, examples)} + {navigations2route(examples)} - {navigations2route(ExamplePathPrefix, cssDocs)} + {navigations2route(cssDocs)} diff --git a/examples/components/Components.tsx b/examples/components/Components.tsx new file mode 100644 index 000000000..ff4c856d7 --- /dev/null +++ b/examples/components/Components.tsx @@ -0,0 +1,1092 @@ +import React from 'react'; +import makeMarkdownRenderer from './MdRenderer'; + +export const components = [ + { + label: '布局', + children: [ + { + label: 'Page 页面', + path: '/zh-CN/components/page', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/page.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Container 容器', + path: '/zh-CN/components/container', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/container.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Collapse 折叠器', + path: '/zh-CN/components/collapse', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/collapse.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Divider 分割线', + path: '/zh-CN/components/divider', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/divider.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Grid 水平布局', + path: '/zh-CN/components/grid', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/grid.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Grid 2D 布局', + path: '/zh-CN/components/grid-2d', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/grid-2d.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'HBox 布局', + path: '/zh-CN/components/hbox', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/hbox.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'PaginationWrapper 分页容器', + path: '/zh-CN/components/pagination-wrapper', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/pagination-wrapper.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Panel 面板', + path: '/zh-CN/components/panel', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/panel.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Tabs 选项卡', + path: '/zh-CN/components/tabs', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/tabs.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Wrapper 包裹容器', + path: '/zh-CN/components/wrapper', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/wrapper.md').then( + makeMarkdownRenderer + ) + } + ] + }, + + { + label: '功能', + children: [ + { + label: 'Action 行为按钮', + path: '/zh-CN/components/action', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/action.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'App 多页应用', + path: '/zh-CN/components/app', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/app.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Button 按钮', + path: '/zh-CN/components/button', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/button.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'ButtonGroup 按钮组', + path: '/zh-CN/components/button-group', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/button-group.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Custom 自定义组件', + path: '/zh-CN/components/custom', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/custom.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'DropDownButton 下拉按钮', + path: '/zh-CN/components/dropdown-button', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/dropdown-button.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Service 功能型容器', + path: '/zh-CN/components/service', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/service.md').then( + makeMarkdownRenderer + ) + }, + + { + label: 'Nav 导航', + path: '/zh-CN/components/nav', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/nav.md').then( + makeMarkdownRenderer + ) + } + ] + }, + + { + label: '数据输入', + children: [ + { + label: 'Form 表单', + path: '/zh-CN/components/form/index', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/index.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'FormItem 表单项', + path: '/zh-CN/components/form/formitem', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/formitem.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Options 选择器表单项', + path: '/zh-CN/components/form/options', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/options.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Array 数组输入框', + path: '/zh-CN/components/form/array', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/array.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Button 按钮', + path: '/zh-CN/components/form/button', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/button.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Button-Toolbar 按钮工具栏', + path: '/zh-CN/components/form/button-toolbar', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/button-toolbar.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Button-Group 按钮集合', + path: '/zh-CN/components/form/button-group', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/button-group.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Chain-Select 链式下拉框', + path: '/zh-CN/components/form/chain-select', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/chain-select.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Checkbox 勾选框', + path: '/zh-CN/components/form/checkbox', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/checkbox.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Checkboxes 复选框', + path: '/zh-CN/components/form/checkboxes', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/checkboxes.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'City 城市选择器', + path: '/zh-CN/components/form/city', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/city.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Color 颜色选择器', + path: '/zh-CN/components/form/color', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/color.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Combo 组合', + path: '/zh-CN/components/form/combo', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/combo.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Date 日期选择器', + path: '/zh-CN/components/form/date', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/date.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Datetime 日期时间选择器', + path: '/zh-CN/components/form/datetime', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/datetime.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Month 月份选择器', + path: '/zh-CN/components/form/month', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/month.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Date-Range 日期范围选择器', + path: '/zh-CN/components/form/date-range', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/date-range.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Datetime-Range 日期时间范围', + path: '/zh-CN/components/form/datetime-range', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/datetime-range.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Month-Range 月份范围', + path: '/zh-CN/components/form/month-range', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/month-range.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'DiffEditor 对比编辑器', + path: '/zh-CN/components/form/diff-editor', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/diff-editor.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Editor 代码编辑器', + path: '/zh-CN/components/form/editor', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/editor.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'FieldSet 表单项集合', + path: '/zh-CN/components/form/fieldset', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/fieldset.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'File 文件上传', + path: '/zh-CN/components/form/file', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/file.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Formula 公式', + path: '/zh-CN/components/form/formula', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/formula.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Grid 水平布局', + path: '/zh-CN/components/form/grid', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/grid.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Group 表单项组', + path: '/zh-CN/components/form/group', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/group.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'HBox', + path: '/zh-CN/components/form/hbox', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/hbox.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Hidden 隐藏字段', + path: '/zh-CN/components/form/hidden', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/hidden.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Image 图片', + path: '/zh-CN/components/form/image', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/image.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Input-Group 输入框组合', + path: '/zh-CN/components/form/input-group', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/input-group.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'List 选择器', + path: '/zh-CN/components/form/list', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/list.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Location 地理位置', + path: '/zh-CN/components/form/location', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/location.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'UUID 随机 ID', + path: '/zh-CN/components/form/uuid', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/uuid.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Matrix 矩阵', + path: '/zh-CN/components/form/matrix', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/matrix.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'NestedSelect 级联选择器', + path: '/zh-CN/components/form/nestedselect', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/nestedselect.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Number 数字输入框', + path: '/zh-CN/components/form/number', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/number.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Panel 面板', + path: '/zh-CN/components/form/panel', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/panel.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Picker 列表选择器', + path: '/zh-CN/components/form/picker', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/picker.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Quarter 季度', + path: '/zh-CN/components/form/quarter', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/quarter.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Radios 单选框', + path: '/zh-CN/components/form/radios', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/radios.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Rating 评分', + path: '/zh-CN/components/form/rating', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/rating.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Range 滑块', + path: '/zh-CN/components/form/range', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/range.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Repeat 重复频率选择器', + path: '/zh-CN/components/form/repeat', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/repeat.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Rich-Text 富文本编辑器', + path: '/zh-CN/components/form/rich-text', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/rich-text.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Select 下拉框', + path: '/zh-CN/components/form/select', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/select.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Service 功能容器', + path: '/zh-CN/components/form/service', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/service.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'SubForm 子表单', + path: '/zh-CN/components/form/subform', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/subform.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Switch 开关', + path: '/zh-CN/components/form/switch', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/switch.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Static 静态展示', + path: '/zh-CN/components/form/static', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/static.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Tabs 选项卡', + path: '/zh-CN/components/form/tabs', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/tabs.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Table 表格', + path: '/zh-CN/components/form/table', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/table.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Tag 标签选择器', + path: '/zh-CN/components/form/tag', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/tag.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Text 输入框', + path: '/zh-CN/components/form/text', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/text.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Textarea 多行输入框', + path: '/zh-CN/components/form/textarea', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/textarea.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Time 时间', + path: '/zh-CN/components/form/time', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/time.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Transfer 穿梭器', + path: '/zh-CN/components/form/transfer', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/transfer.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'TabsTransfer 组合穿梭器', + path: '/zh-CN/components/form/tabs-transfer', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/tabs-transfer.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Tree 树形选择框', + path: '/zh-CN/components/form/tree', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/tree.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'TreeSelect 树形选择器', + path: '/zh-CN/components/form/treeselect', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/treeselect.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Year 年', + path: '/zh-CN/components/form/year', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/form/year.md').then( + makeMarkdownRenderer + ) + } + ] + }, + + { + label: '数据展示', + children: [ + { + label: 'CRUD 增删改查', + path: '/zh-CN/components/crud', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/crud.md').then( + makeMarkdownRenderer + ) + }, + + { + label: 'Table 表格', + path: '/zh-CN/components/table', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/table.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Card 卡片', + path: '/zh-CN/components/card', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/card.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Cards 卡片组', + path: '/zh-CN/components/cards', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/cards.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Carousel 轮播图', + path: '/zh-CN/components/carousel', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/carousel.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Chart 图表', + path: '/zh-CN/components/chart', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/chart.md').then( + makeMarkdownRenderer + ) + }, + + { + label: 'Color 颜色', + path: '/zh-CN/components/color', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/color.md').then( + makeMarkdownRenderer + ) + }, + + { + label: 'Date 日期时间', + path: '/zh-CN/components/date', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/date.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Each 循环渲染器', + path: '/zh-CN/components/each', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/each.md').then( + makeMarkdownRenderer + ) + }, + + { + label: 'Html', + path: '/zh-CN/components/html', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/html.md').then( + makeMarkdownRenderer + ) + }, + + { + label: 'Icon 图标', + path: '/zh-CN/components/icon', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/icon.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'iFrame', + path: '/zh-CN/components/iframe', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/iframe.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Image 图片', + path: '/zh-CN/components/image', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/image.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Images 图片集', + path: '/zh-CN/components/images', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/images.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Json', + path: '/zh-CN/components/json', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/json.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Link 链接', + path: '/zh-CN/components/link', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/link.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'List 列表', + path: '/zh-CN/components/list', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/list.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Log 实时日志', + path: '/zh-CN/components/log', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/log.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Mapping 映射', + path: '/zh-CN/components/mapping', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/mapping.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Progress 进度条', + path: '/zh-CN/components/progress', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/progress.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'QRCode 二维码', + path: '/zh-CN/components/qrcode', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/qrcode.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Remark 标记', + path: '/zh-CN/components/remark', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/remark.md').then( + makeMarkdownRenderer + ) + }, + + { + label: 'Sparkline 走势图', + path: '/zh-CN/components/sparkline', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/sparkline.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Status 状态', + path: '/zh-CN/components/status', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/status.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Switch 开关', + path: '/zh-CN/components/switch', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/switch.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Tpl 模板', + path: '/zh-CN/components/tpl', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/tpl.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Video 视频', + path: '/zh-CN/components/video', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/video.md').then( + makeMarkdownRenderer + ) + } + ] + }, + + { + label: '反馈', + children: [ + { + label: 'Alert 提示', + path: '/zh-CN/components/alert', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/alert.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Dialog 对话框', + path: '/zh-CN/components/dialog', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/dialog.md').then( + makeMarkdownRenderer + ) + }, + + { + label: 'Drawer 抽屉', + path: '/zh-CN/components/drawer', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/drawer.md').then( + makeMarkdownRenderer + ) + }, + { + label: 'Spinner 加载中', + path: '/zh-CN/components/spinner', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/spinner.md').then( + makeMarkdownRenderer + ) + } + ] + }, + + { + label: '其他', + children: [ + { + label: 'Audio 音频', + path: '/zh-CN/components/audio', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/audio.md').then( + makeMarkdownRenderer + ) + }, + + { + label: 'Tasks 任务操作集合', + path: '/zh-CN/components/tasks', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/tasks.md').then( + makeMarkdownRenderer + ) + }, + + { + label: 'Wizard 向导', + path: '/zh-CN/components/wizard', + getComponent: () => + // @ts-ignore + import('../../docs/zh-CN/components/wizard.md').then( + makeMarkdownRenderer + ) + } + ] + } +]; + +export default class Components extends React.PureComponent { + componentDidMount() { + this.props.setNavigations(components); + } + + componentDidUpdate() { + this.props.setNavigations(components); + } + + render() { + return ( + <> + {React.cloneElement(this.props.children as any, { + ...(this.props.children as any).props, + theme: this.props.theme, + classPrefix: this.props.classPrefix, + locale: this.props.locale, + viewMode: this.props.viewMode, + offScreen: this.props.offScreen + })} + + ); + } +} diff --git a/examples/components/DocNavCN.ts b/examples/components/DocNavCN.ts index 675ecbfd1..23bee8c78 100644 --- a/examples/components/DocNavCN.ts +++ b/examples/components/DocNavCN.ts @@ -16,7 +16,6 @@ export default [ { label: '快速开始', path: '/zh-CN/docs/start/getting-started', - getComponent: () => // @ts-ignore import('../../docs/zh-CN/start/getting-started.md').then( @@ -113,7 +112,7 @@ export default [ }, { - label: '🎼 类型', + label: '类型', children: [ { label: 'SchemaNode', @@ -143,1040 +142,6 @@ export default [ ] }, - { - label: '⚙ 组件', - children: [ - { - label: '组件介绍', - path: '/zh-CN/docs/components/component', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/component.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Page 页面', - path: '/zh-CN/docs/components/page', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/page.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Form 表单', - path: '/zh-CN/docs/components/form/index', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/index.md').then( - makeMarkdownRenderer - ), - children: [ - { - label: 'FormItem 表单项', - path: '/zh-CN/docs/components/form/formitem', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/formitem.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Options 选择器表单项', - path: '/zh-CN/docs/components/form/options', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/options.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Array 数组输入框', - path: '/zh-CN/docs/components/form/array', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/array.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Button 按钮', - path: '/zh-CN/docs/components/form/button', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/button.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Button-Toolbar 按钮工具栏', - path: '/zh-CN/docs/components/form/button-toolbar', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/button-toolbar.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Button-Group 按钮集合', - path: '/zh-CN/docs/components/form/button-group', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/button-group.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Chain-Select 链式下拉框', - path: '/zh-CN/docs/components/form/chain-select', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/chain-select.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Checkbox 勾选框', - path: '/zh-CN/docs/components/form/checkbox', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/checkbox.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Checkboxes 复选框', - path: '/zh-CN/docs/components/form/checkboxes', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/checkboxes.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'City 城市选择器', - path: '/zh-CN/docs/components/form/city', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/city.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Color 颜色选择器', - path: '/zh-CN/docs/components/form/color', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/color.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Combo 组合', - path: '/zh-CN/docs/components/form/combo', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/combo.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Date 日期选择器', - path: '/zh-CN/docs/components/form/date', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/date.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Datetime 日期时间选择器', - path: '/zh-CN/docs/components/form/datetime', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/datetime.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Month 月份选择器', - path: '/zh-CN/docs/components/form/month', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/month.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Date-Range 日期范围选择器', - path: '/zh-CN/docs/components/form/date-range', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/date-range.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Datetime-Range 日期时间范围', - path: '/zh-CN/docs/components/form/datetime-range', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/datetime-range.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Month-Range 月份范围', - path: '/zh-CN/docs/components/form/month-range', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/month-range.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'DiffEditor 对比编辑器', - path: '/zh-CN/docs/components/form/diff-editor', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/diff-editor.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Editor 代码编辑器', - path: '/zh-CN/docs/components/form/editor', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/editor.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'FieldSet 表单项集合', - path: '/zh-CN/docs/components/form/fieldset', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/fieldset.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'File 文件上传', - path: '/zh-CN/docs/components/form/file', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/file.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Formula 公式', - path: '/zh-CN/docs/components/form/formula', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/formula.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Grid 水平布局', - path: '/zh-CN/docs/components/form/grid', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/grid.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Group 表单项组', - path: '/zh-CN/docs/components/form/group', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/group.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'HBox', - path: '/zh-CN/docs/components/form/hbox', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/hbox.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Hidden 隐藏字段', - path: '/zh-CN/docs/components/form/hidden', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/hidden.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Image 图片', - path: '/zh-CN/docs/components/form/image', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/image.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Input-Group 输入框组合', - path: '/zh-CN/docs/components/form/input-group', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/input-group.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'List 列表', - path: '/zh-CN/docs/components/form/list', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/list.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Location 地理位置', - path: '/zh-CN/docs/components/form/location', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/location.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'UUID 随机 ID', - path: '/zh-CN/docs/components/form/uuid', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/uuid.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Matrix 矩阵', - path: '/zh-CN/docs/components/form/matrix', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/matrix.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'NestedSelect 级联选择器', - path: '/zh-CN/docs/components/form/nestedselect', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/nestedselect.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Number 数字输入框', - path: '/zh-CN/docs/components/form/number', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/number.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Panel 面板', - path: '/zh-CN/docs/components/form/panel', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/panel.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Picker 列表选择器', - path: '/zh-CN/docs/components/form/picker', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/picker.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Quarter 季度', - path: '/zh-CN/docs/components/form/quarter', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/quarter.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Radios 单选框', - path: '/zh-CN/docs/components/form/radios', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/radios.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Rating 评分', - path: '/zh-CN/docs/components/form/rating', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/rating.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Range 滑块', - path: '/zh-CN/docs/components/form/range', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/range.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Repeat 重复频率选择器', - path: '/zh-CN/docs/components/form/repeat', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/repeat.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Rich-Text 富文本编辑器', - path: '/zh-CN/docs/components/form/rich-text', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/rich-text.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Select 选择器', - path: '/zh-CN/docs/components/form/select', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/select.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Service 功能容器', - path: '/zh-CN/docs/components/form/service', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/service.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'SubForm 子表单', - path: '/zh-CN/docs/components/form/subform', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/subform.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Switch 开关', - path: '/zh-CN/docs/components/form/switch', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/switch.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Static 静态展示', - path: '/zh-CN/docs/components/form/static', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/static.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Tabs 选项卡', - path: '/zh-CN/docs/components/form/tabs', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/tabs.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Table 表格', - path: '/zh-CN/docs/components/form/table', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/table.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Tag 标签选择器', - path: '/zh-CN/docs/components/form/tag', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/tag.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Text 输入框', - path: '/zh-CN/docs/components/form/text', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/text.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Textarea 多行输入框', - path: '/zh-CN/docs/components/form/textarea', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/textarea.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Time 时间', - path: '/zh-CN/docs/components/form/time', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/time.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Transfer 穿梭器', - path: '/zh-CN/docs/components/form/transfer', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/transfer.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'TabsTransfer 组合穿梭器', - path: '/zh-CN/docs/components/form/tabs-transfer', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/tabs-transfer.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Tree 树形选择框', - path: '/zh-CN/docs/components/form/tree', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/tree.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'TreeSelect 树形选择器', - path: '/zh-CN/docs/components/form/treeselect', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/treeselect.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Year 年', - path: '/zh-CN/docs/components/form/year', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/form/year.md').then( - makeMarkdownRenderer - ) - } - ] - }, - { - label: 'CRUD 增删改查', - path: '/zh-CN/docs/components/crud', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/crud.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Custom 自定义组件', - path: '/zh-CN/docs/components/custom', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/custom.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Table 表格', - path: '/zh-CN/docs/components/table', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/table.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Action 行为按钮', - path: '/zh-CN/docs/components/action', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/action.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Alert 提示', - path: '/zh-CN/docs/components/alert', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/alert.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Audio 音频', - path: '/zh-CN/docs/components/audio', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/audio.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Button 按钮', - path: '/zh-CN/docs/components/button', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/button.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'ButtonGroup 按钮组', - path: '/zh-CN/docs/components/button-group', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/button-group.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Card 卡片', - path: '/zh-CN/docs/components/card', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/card.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Cards 卡片组', - path: '/zh-CN/docs/components/cards', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/cards.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Carousel 轮播图', - path: '/zh-CN/docs/components/carousel', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/carousel.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Chart 图表', - path: '/zh-CN/docs/components/chart', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/chart.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Collapse 折叠器', - path: '/zh-CN/docs/components/collapse', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/collapse.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Color 颜色', - path: '/zh-CN/docs/components/color', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/color.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Container 容器', - path: '/zh-CN/docs/components/container', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/container.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Date 日期时间', - path: '/zh-CN/docs/components/date', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/date.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Dialog 对话框', - path: '/zh-CN/docs/components/dialog', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/dialog.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Divider 分割线', - path: '/zh-CN/docs/components/divider', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/divider.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Drawer 抽屉', - path: '/zh-CN/docs/components/drawer', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/drawer.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'DropDownButton', - path: '/zh-CN/docs/components/dropdown-button', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/dropdown-button.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Each 循环渲染器', - path: '/zh-CN/docs/components/each', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/each.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Grid 水平布局', - path: '/zh-CN/docs/components/grid', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/grid.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Grid 2D 布局', - path: '/zh-CN/docs/components/grid-2d', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/grid-2d.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'HBox 布局', - path: '/zh-CN/docs/components/hbox', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/hbox.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Html', - path: '/zh-CN/docs/components/html', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/html.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Icon 图标', - path: '/zh-CN/docs/components/icon', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/icon.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'iFrame', - path: '/zh-CN/docs/components/iframe', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/iframe.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Image 图片', - path: '/zh-CN/docs/components/image', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/image.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Images 图片集', - path: '/zh-CN/docs/components/images', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/images.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Json', - path: '/zh-CN/docs/components/json', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/json.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Link 链接', - path: '/zh-CN/docs/components/link', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/link.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'List 列表', - path: '/zh-CN/docs/components/list', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/list.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Log 实时日志', - path: '/zh-CN/docs/components/log', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/log.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Mapping 映射', - path: '/zh-CN/docs/components/mapping', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/mapping.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Nav 导航', - path: '/zh-CN/docs/components/nav', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/nav.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Panel 面板', - path: '/zh-CN/docs/components/panel', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/panel.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'PaginationWrapper', - path: '/zh-CN/docs/components/pagination-wrapper', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/pagination-wrapper.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Progress 进度条', - path: '/zh-CN/docs/components/progress', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/progress.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'QRCode 二维码', - path: '/zh-CN/docs/components/qrcode', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/qrcode.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Remark 标记', - path: '/zh-CN/docs/components/remark', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/remark.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Service 功能型容器', - path: '/zh-CN/docs/components/service', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/service.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Sparkline 走势图', - path: '/zh-CN/docs/components/sparkline', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/sparkline.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Spinner 加载中', - path: '/zh-CN/docs/components/spinner', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/spinner.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Status 状态', - path: '/zh-CN/docs/components/status', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/status.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Switch 开关', - path: '/zh-CN/docs/components/switch', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/switch.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Tabs 选项卡', - path: '/zh-CN/docs/components/tabs', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/tabs.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Tasks 任务操作集合', - path: '/zh-CN/docs/components/tasks', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/tasks.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Tpl 模板', - path: '/zh-CN/docs/components/tpl', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/tpl.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Video 视频', - path: '/zh-CN/docs/components/video', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/video.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Wrapper 包裹容器', - path: '/zh-CN/docs/components/wrapper', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/wrapper.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'Wizard 向导', - path: '/zh-CN/docs/components/wizard', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/wizard.md').then( - makeMarkdownRenderer - ) - }, - { - label: 'App 多页应用', - path: '/zh-CN/docs/components/app', - getComponent: () => - // @ts-ignore - import('../../docs/zh-CN/components/app.md').then( - makeMarkdownRenderer - ) - } - ] - }, - { label: '💎 高级', children: [ diff --git a/mock/server.conf b/mock/server.conf index 3ad371c33..1ad140e48 100644 --- a/mock/server.conf +++ b/mock/server.conf @@ -1,4 +1,4 @@ -rewrite ^\/(?:zh-CN|en-US)?\/?(?:examples|docs|style)(?:\/[a-z0-9\-_\/]+)?$ /examples/index.html +rewrite ^\/(?:zh-CN|en-US)?\/?(?:examples|docs|components|style)(?:\/[a-z0-9\-_\/]+)?$ /examples/index.html rewrite ^\/play$ /examples/index.html rewrite ^\/edit$ /examples/index.html