From 23fdd5cb2bce64fdc1da5fe48f887aeff581a799 Mon Sep 17 00:00:00 2001 From: rickcole Date: Thu, 4 Jun 2020 16:33:48 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=87=E6=A1=A3=E5=92=8C=E7=89=88=E6=9C=AC?= =?UTF-8?q?=E5=8F=B7?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers/CRUD.md | 2 +- docs/renderers/Chart.md | 6 +-- docs/renderers/Form/Form.md | 90 ++++++++++++++++++------------------- docs/renderers/Page.md | 6 +-- docs/renderers/Service.md | 5 +-- docs/renderers/Tasks.md | 2 +- package.json | 2 +- 7 files changed, 54 insertions(+), 59 deletions(-) diff --git a/docs/renderers/CRUD.md b/docs/renderers/CRUD.md index e3c9140bc..699d773c5 100644 --- a/docs/renderers/CRUD.md +++ b/docs/renderers/CRUD.md @@ -18,7 +18,7 @@ CRUD 支持三种模式：`table`、`cards`、`list`，默认为 `table`。 | filterTogglable | `boolean` | `false` | 是否可显隐过滤器 | | filterDefaultVisible | `boolean` | `true` | 设置过滤器默认是否可见。 | | initFetch | `boolean` | `true` | 是否初始化的时候拉取数据, 只针对有 filter 的情况, 没有 filter 初始都会拉取数据 | -| interval | `number` | `3000` | 刷新时间(最低 3000) | +| interval | `number` | `3000` | 刷新时间(最低 3000)，单位是毫秒 | | silentPolling | `boolean` | `false` | 配置刷新时是否隐藏加载动画 | | stopAutoRefreshWhen | `string` | `""` | 通过[表达式](./Types.md#表达式)来配置停止刷新的条件 | | stopAutoRefreshWhenModalIsOpen | `boolean` | `false` | 当有弹框时关闭自动刷新，关闭弹框又恢复 | diff --git a/docs/renderers/Chart.md b/docs/renderers/Chart.md index b93a0f555..1160c4f91 100644 --- a/docs/renderers/Chart.md +++ b/docs/renderers/Chart.md @@ -1,15 +1,15 @@ ## Chart -图表渲染器，采用 echarts 渲染，配置格式跟 echarts 相同，[echarts配置文档](http://echarts.baidu.com/option.html#title) +图表渲染器，采用 echarts 渲染，配置格式跟 echarts 相同，[echarts 配置文档](http://echarts.baidu.com/option.html#title) | 属性名 | 类型 | 默认值 | 说明 | -|--------------------|-----------------------------------|-----------|--------------------------------------------------------------------| +| ------------------ | --------------------------------- | --------- | ------------------------------------------------------------------ | | type | `string` | `"chart"` | 指定为 chart 渲染器 | | className | `string` | | 外层 Dom 的类名 | | body | [Container](./Types.md#container) | | 内容容器 | | api | [api](./Types.md#Api) | | 配置项远程地址 | | initFetch | `boolean` | | 是否默认拉取 | -| interval | `number` | | 刷新时间(最低 3000) | +| interval | `number` | | 刷新时间(最低 3000) ，单位是毫秒 | | config | `object/string` | | 设置 eschars 的配置项,当为`string`的时候可以设置 function 等配置项 | | style | `object` | | 设置根元素的 style | | width | `string` | | 设置根元素的宽度 | diff --git a/docs/renderers/Form/Form.md b/docs/renderers/Form/Form.md index ee0b5cf29..d32350f66 100644 --- a/docs/renderers/Form/Form.md +++ b/docs/renderers/Form/Form.md @@ -27,7 +27,7 @@ ``` | 属性名 | 类型 | 默认值 | 说明 | -|-------------------------------|--------------------------------------|------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ----------------------------- | ------------------------------------ | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | type | `string` | | `"form"` 指定为 Form 渲染器 | | mode | `string` | `normal` | 表单展示方式，可以是：`normal`、`horizontal` 或者 `inline` | | horizontal | `Object` | `{"left":"col-sm-2", "right":"col-sm-10", "offset":"col-sm-offset-2"}` | 当 mode 为 `horizontal` 时有用，用来控制 label | @@ -39,13 +39,13 @@ | messages | `Object` | | 消息提示覆写，默认消息读取的是 API 返回的消息，但是在此可以覆写它。 | | messages.fetchSuccess | `string` | | 获取成功时提示 | | messages.fetchFailed | `string` | | 获取失败时提示 | -| messages.saveSuccess | `string` | | 保存成功时提示 | -| messages.saveFailed | `string` | | 保存失败时提示 | +| messages.saveSuccess | `string` | | 保存成功时提示 | +| messages.saveFailed | `string` | | 保存失败时提示 | | wrapWithPanel | `boolean` | `true` | 是否让 Form 用 panel 包起来，设置为 false 后，actions 将无效。 | -| panelClassName | `boolean` | `true` | panel的类名。 | +| panelClassName | `boolean` | `true` | panel 的类名。 | | [api](#api) | [Api](../Types.md#api) | | Form 用来保存数据的 api。 | | [initApi](#initApi) | [Api](../Types.md#api) | | Form 用来获取初始数据的 api。 | -| interval | `number` | `3000` | 刷新时间(最低 3000) | +| interval | `number` | `3000` | 刷新时间(最低 3000)，单位是毫秒 | | silentPolling | `boolean` | `false` | 配置刷新时是否显示加载动画 | | stopAutoRefreshWhen | `string` | `""` | 通过[表达式](./Types.md#表达式) 来配置停止刷新的条件 | | [initAsyncApi](#initAsyncApi) | [Api](../Types.md#api) | | Form 用来获取初始数据的 api,与 initApi 不同的是，会一直轮训请求该接口，直到返回 finished 属性为 true 才 结束。 | @@ -55,7 +55,7 @@ | initCheckInterval | `number` | `3000` | 设置了 initAsyncApi 以后，默认拉取的时间间隔 | | schemaApi | [Api](../Types.md#api) | | `已不支持`，请改用 controls 里面放置 Service 渲染器实现 | | [asyncApi](#asyncApi) | [Api](../Types.md#api) | | 设置此属性后，表单提交发送保存接口后，还会继续轮训请求该接口，直到返回 `finished` 属性为 `true` 才 结束。 | -| checkInterval | `number` | 3000 | 轮训请求的时间间隔，默认为 3 秒。设置 `asyncApi` 才有效 | +| checkInterval | `number` | 3000 | 轮训请求的时间间隔，默认为 3000 毫秒。设置 `asyncApi` 才有效 | | finishedField | `string` | `"finished"` | 如果决定结束的字段名不是 `finished` 请设置此属性，比如 `is_success` | | submitOnChange | `boolean` | `false` | 表单修改即提交 | | submitOnInit | `boolean` | `false` | 初始就提交一次 | @@ -201,7 +201,6 @@ } ``` - ### 接口说明 开始之前请你先阅读[整体要求](../api.md)。 @@ -216,58 +215,57 @@ **响应** - 要求返回的数据 data 是对象，不要返回其他格式，且注意层级问题，data 中返回的数据正好跟 form 中的变量一一对应。 +要求返回的数据 data 是对象，不要返回其他格式，且注意层级问题，data 中返回的数据正好跟 form 中的变量一一对应。 - ``` - { - status: 0, - msg: '', - data: { - a: '123' - } - } - ``` +``` +{ + status: 0, + msg: '', + data: { + a: '123' + } +} +``` - 如果有个表单项的 name 配置成 a，initApi 返回后会自动填充 '123'。 +如果有个表单项的 name 配置成 a，initApi 返回后会自动填充 '123'。 - #### api +#### api - 用来保存表单结果。 +用来保存表单结果。 - **发送** +**发送** - 默认为 `POST` 方式，会将所有表单项整理成一个对象发送过过去。除此之外你开可以主动的获取以下信息。 +默认为 `POST` 方式，会将所有表单项整理成一个对象发送过过去。除此之外你开可以主动的获取以下信息。 - * `diff` 只会包含diff 结果 - * `prinstine` 原始数据。 +- `diff` 只会包含 diff 结果 +- `prinstine` 原始数据。 - 如: - +如: - ```json - { - "api": { - "method": "post", - "url": "/api/xxx/save", - "data": { - "modified": "$$", - "diff": "${diff}", - "origin": "${prinstine}" - } - } - } - ``` +```json +{ + "api": { + "method": "post", + "url": "/api/xxx/save", + "data": { + "modified": "$$", + "diff": "${diff}", + "origin": "${prinstine}" + } + } +} +``` - **响应** +**响应** - 如果 返回了 data 对象，且是对象，会把结果 merge 到表单数据里面。 +如果 返回了 data 对象，且是对象，会把结果 merge 到表单数据里面。 - #### initAsyncApi +#### initAsyncApi - 这个接口的作用在于解决接口耗时比较长导致超时问题的情况，当配置此接口后，初始化接口的时候先请求 initApi 如果 initApi 接口返回了 data.finished 为 true，则初始化完成。如果返回为 false 则之后每隔 3s 请求 initAsyncApi，直到接口返回了 data.finished 为 true 才结束。 用这种机制的话，业务 api 不需要完全等待操作完成才输出结果，而是直接检测状态，没完成也直接返回，后续还会发起请求检测。 +这个接口的作用在于解决接口耗时比较长导致超时问题的情况，当配置此接口后，初始化接口的时候先请求 initApi 如果 initApi 接口返回了 data.finished 为 true，则初始化完成。如果返回为 false 则之后每隔 3s 请求 initAsyncApi，直到接口返回了 data.finished 为 true 才结束。 用这种机制的话，业务 api 不需要完全等待操作完成才输出结果，而是直接检测状态，没完成也直接返回，后续还会发起请求检测。 - 格式要求就是 data 是对象，且 有 finished 这个字段。返回的其他字段会被 merge 到表单数据里面。 +格式要求就是 data 是对象，且 有 finished 这个字段。返回的其他字段会被 merge 到表单数据里面。 - ##### asyncApi +##### asyncApi - 保存同样也可以采用异步模式，具体请参考 initAsyncApi。 \ No newline at end of file +保存同样也可以采用异步模式，具体请参考 initAsyncApi。 diff --git a/docs/renderers/Page.md b/docs/renderers/Page.md index c81a9854e..777ea6a2c 100644 --- a/docs/renderers/Page.md +++ b/docs/renderers/Page.md @@ -36,11 +36,10 @@ | initApi | [Api](./Types.md#Api) | | Page 用来获取初始数据的 api。返回的数据可以整个 page 级别使用。 | | initFetch | `boolean` | `true` | 是否起始拉取 initApi | | initFetchOn | `string` | | 是否起始拉取 initApi, 通过表达式配置 | -| interval | `number` | `3000` | 刷新时间(最低 3000) | +| interval | `number` | `3000` | 刷新时间(最低 3000)，单位是毫秒 | | silentPolling | `boolean` | `false` | 配置刷新时是否显示加载动画 | | stopAutoRefreshWhen | `string` | `""` | 通过[表达式](./Types.md#表达式)来配置停止刷新的条件 | - ### 接口说明 开始之前请你先阅读[整体要求](../api.md)。 @@ -75,11 +74,10 @@ data 返回是对象即可。 当配置了 initApi 且返回如上数据后，当前 page 渲染器，以及所有孩子渲染器都能取到这个这个变量了如： - ```json { "type": "page", "initApi": "/api/xxx", "body": "${a}" } -``` \ No newline at end of file +``` diff --git a/docs/renderers/Service.md b/docs/renderers/Service.md index c4950cd71..56296944c 100644 --- a/docs/renderers/Service.md +++ b/docs/renderers/Service.md @@ -16,7 +16,7 @@ | messages | `Object` | | 消息提示覆写，默认消息读取的是 API 返回的消息，但是在此可以覆写它。 | | messages.fetchSuccess | `string` | | 获取成功时提示 | | messages.fetchFailed | `string` | `"初始化失败"` | 获取失败时提示 | -| interval | `number` | `3000` | 刷新时间(最低 3000) | +| interval | `number` | `3000` | 刷新时间(最低 3000)，单位是毫秒 | | silentPolling | `boolean` | `false` | 配置刷新时是否显示加载动画 | | stopAutoRefreshWhen | `string` | `""` | 通过[表达式](./Types.md#表达式)来配置停止刷新的条件 | @@ -32,7 +32,6 @@ } ``` - ### 动态配置 Service 还有个重要的功能就是支持配置 `schemaApi`，通过它可以实现动态渲染。 @@ -44,4 +43,4 @@ Service 还有个重要的功能就是支持配置 `schemaApi`，通过它可以 "className": "m-t", "schemaApi": "/api/mock2/service/schema?type=tabs" } -``` \ No newline at end of file +``` diff --git a/docs/renderers/Tasks.md b/docs/renderers/Tasks.md index 4cd0df375..85faf6641 100644 --- a/docs/renderers/Tasks.md +++ b/docs/renderers/Tasks.md @@ -40,7 +40,7 @@ | checkApi | [api](./Types.md#api) | | 返回任务列表，返回的数据请参考 items。 | | submitApi | [api](./Types.md#api) | | 提交任务使用的 API | | reSubmitApi | [api](./Types.md#api) | | 如果任务失败，且可以重试，提交的时候会使用此 API | -| interval | `number` | `3000` | 当有任务进行中，会每隔一段时间再次检测，而时间间隔就是通过此项配置，默认 3s。 | +| interval | `number` | `3000` | 当有任务进行中，会每隔一段时间再次检测，而时间间隔就是通过此项配置，默认 3000，单位是毫秒 | | taskNameLabel | `string` | 任务名称 | 任务名称列说明 | | operationLabel | `string` | 操作 | 操作列说明 | | statusLabel | `string` | 状态 | 状态列说明 | diff --git a/package.json b/package.json index f7b86436b..e3d293b62 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "amis", - "version": "1.0.11", + "version": "1.0.12", "description": "一种MIS页面生成工具", "main": "lib/index.js", "scripts": {