diff --git a/docs/renderers/Field.md b/docs/renderers/Field.md index b18801fe5..4945d0355 100644 --- a/docs/renderers/Field.md +++ b/docs/renderers/Field.md @@ -1,6 +1,6 @@ ## Field -主要用在 [Table](#table) 的列配置 Column、[List](#list) 的内容、[Card](#card) 卡片的内容和表单的[Static-XXX](#static-xxx) 中。它主要用来展示数据。 +主要用在 [Table](./Table.md) 的列配置 Column、[List](./list.md) 的内容、[Card](./Card.md) 卡片的内容和表单的[Static-XXX](./Static.md#static-xxx) 中。它主要用来展示数据。 ```schema:height="450" scope="body" { @@ -80,10 +80,10 @@ - `placeholder` 当没有值时的展示内容。 - `popOver` 配置后在内容区增加一个放大按钮，点击后弹出一个详情弹框。 `boolean` 简单的开启或者关闭 - `Object` 弹出的内容配置。请参考 [Dialog](#dialog) 配置说明。 + `Object` 弹出的内容配置。请参考 [Dialog](./Dialog.md) 配置说明。 - `quickEdit` 配置后在内容区增加一个编辑按钮，点击后弹出一个编辑框。 `boolean` 简单的开启或者关闭 - `Object` 快速编辑详情，请参考 [FormItem](#formitem) 配置。 + `Object` 快速编辑详情，请参考 [FormItem](./FormItem.md) 配置。 `.mode` 模式如果设置为 `inline` 模式，则直接展示输入框，而不需要点击按钮后展示。 `.saveImmediately` 开启后，直接保存，而不是等全部操作完后批量保存。 - `copyable` 配置后会在内容区增加一个复制按钮，点击后把内容复制到剪切板。 @@ -91,11 +91,11 @@ ### Tpl(Field) -请参考[tpl](#tpl) +请参考[tpl](./Tpl.md) ### Plain(Field) -请参考[Plain](#plain) +请参考[Plain](./Plain.md) ### Json(Field) @@ -185,18 +185,18 @@ todo ## Tabs -| 属性名 | 类型 | 默认值 | 说明 | -| ----------------- | ----------------------- | ----------------------------------- | -------------------------------------------------------- | -| type | `string` | `"tabs"` | 指定为 Tabs 渲染器 | -| className | `string` | | 外层 Dom 的类名 | -| tabsClassName | `string` | | Tabs Dom 的类名 | -| tabs | `Array` | | tabs 内容 | -| tabs[x].title | `string` | | Tab 标题 | -| tabs[x].icon | `icon` | | Tab 的图标 | -| tabs[x].tab | [Container](#container) | | 内容区 | -| tabs[x].hash | `string` | | 设置以后将跟 url 的 hash 对应 | -| tabs[x].reload | `boolean` | | 设置以后内容每次都会重新渲染，对于 crud 的重新拉取很有用 | -| tabs[x].className | `string` | `"bg-white b-l b-r b-b wrapper-md"` | Tab 区域样式 | +| 属性名 | 类型 | 默认值 | 说明 | +| ----------------- | --------------------------------- | ----------------------------------- | -------------------------------------------------------- | +| type | `string` | `"tabs"` | 指定为 Tabs 渲染器 | +| className | `string` | | 外层 Dom 的类名 | +| tabsClassName | `string` | | Tabs Dom 的类名 | +| tabs | `Array` | | tabs 内容 | +| tabs[x].title | `string` | | Tab 标题 | +| tabs[x].icon | `icon` | | Tab 的图标 | +| tabs[x].tab | [Container](./Types.md#Container) | | 内容区 | +| tabs[x].hash | `string` | | 设置以后将跟 url 的 hash 对应 | +| tabs[x].reload | `boolean` | | 设置以后内容每次都会重新渲染，对于 crud 的重新拉取很有用 | +| tabs[x].className | `string` | `"bg-white b-l b-r b-b wrapper-md"` | Tab 区域样式 | ```schema:height="300" scope="body" { diff --git a/docs/renderers/Tasks.md b/docs/renderers/Tasks.md index 3c6344a70..4cd0df375 100644 --- a/docs/renderers/Tasks.md +++ b/docs/renderers/Tasks.md @@ -27,30 +27,30 @@ } ``` -| 属性名 | 类型 | 默认值 | 说明 | -| ----------------- | ----------- | --------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| 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](#api) | | 返回任务列表，返回的数据请参考 items。 | -| submitApi | [api](#api) | | 提交任务使用的 API | -| reSubmitApi | [api](#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](./Types.md#api) | | 返回任务列表，返回的数据请参考 items。 | +| submitApi | [api](./Types.md#api) | | 提交任务使用的 API | +| reSubmitApi | [api](./Types.md#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:height="300" scope="body" [