From 2d4905eebfc1198ab3bc8d9e3d8e2462dd8e54ba Mon Sep 17 00:00:00 2001 From: liaoxuezhi Date: Thu, 9 May 2019 19:30:08 +0800 Subject: [PATCH 0001/1953] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=20gh-pages?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 1 + .npmignore | 3 +- examples/components/App.jsx | 9 ++- fis-conf.js | 125 ++++++++++++++++++++++++++++++++++++ 4 files changed, 135 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 233eb3c8c..5aeb92b32 100644 --- a/.gitignore +++ b/.gitignore @@ -13,6 +13,7 @@ node_modules /dist /lib /public +/gh-pages /.vscode /output /toolkit/amis-renderer diff --git a/.npmignore b/.npmignore index 66876c4c9..5f8f41688 100644 --- a/.npmignore +++ b/.npmignore @@ -14,4 +14,5 @@ fis-conf.js /__tests__ /__mocks__ /coverage -/publish.sh \ No newline at end of file +/publish.sh +/gh-pages \ No newline at end of file diff --git a/examples/components/App.jsx b/examples/components/App.jsx index 416498a29..c3fadda03 100644 --- a/examples/components/App.jsx +++ b/examples/components/App.jsx @@ -6,7 +6,7 @@ import {AlertComponent, ToastComponent} from '../../src/components/index'; import { mapTree } from '../../src/utils/helper'; -import { Router, Route, IndexRoute, browserHistory, Link, Redirect } from 'react-router'; +import { Router, Route, IndexRoute, browserHistory, hashHistory, Link, Redirect } from 'react-router'; import makeSchemaRenderer from './SchemaRender'; @@ -712,9 +712,14 @@ export class App extends React.PureComponent { export default function entry({pathPrefix}) { PathPrefix = pathPrefix || '/examples'; + let history = browserHistory; + + if (process.env.NODE_ENV === 'production') { + history = hashHistory; + } return ( - + {navigations2route(PathPrefix)} diff --git a/fis-conf.js b/fis-conf.js index e3d55498c..a1a17fe30 100644 --- a/fis-conf.js +++ b/fis-conf.js @@ -5,6 +5,7 @@ const path = require('path'); const parserMarkdown = require('./build/md-parser'); fis.get('project.ignore').push( 'public/**', + 'gh-pages/**', '.*/**' ); @@ -225,4 +226,128 @@ if (fis.project.currentMedia() === 'publish') { }); // publishEnv.unhook('node_modules'); publishEnv.hook('relative'); +} else if (fis.project.currentMedia() === 'gh-pages') { + const ghPages = fis.media('gh-pages'); + + ghPages.match('/node_modules/(**)', { + release: '/n/$1' + }); + + ghPages.match('/examples/(**)', { + release: '/$1' + }); + + ghPages.match('/{examples,docs}/**', { + preprocessor: function(contents, file) { + if (!file.isText() || typeof contents !== 'string') { + return contents; + } + + return contents.replace(/(\\?(?:'|"))\/api\/mock2?\//g, function(_, qutoa) { + return qutoa + 'https://houtai.baidu.com/api/mock2/'; + }); + } + }) + + ghPages.match('mock/**.{json,js,conf}', { + release: false + }); + + ghPages.match('::package', { + packager: fis.plugin('deps-pack', { + 'pkg/npm.js': [ + '/mod.js', + 'node_modules/**.js', + '!monaco-editor/**', + '!flv.js/**', + '!hls.js/**', + '!amis/lib/editor/**', + '!froala-editor/**', + '!amis/lib/components/RichText.js', + '!jquery/**', + '!zrender/**', + '!echarts/**', + ], + 'pkg/rich-text.js': [ + 'amis/lib/components/RichText.js', + 'froala-editor/**', + 'jquery/**' + ], + 'pkg/echarts.js': [ + 'zrender/**', + 'echarts/**' + ], + 'pkg/api-mock.js': [ + 'mock/*.ts' + ], + 'pkg/app.js': [ + '/app.tsx', + '/app.tsx:deps' + ], + 'pkg/rest.js': [ + '**.{js,jsx,ts,tsx}', + '!static/mod.js', + '!monaco-editor/**', + '!echarts/**', + '!flv.js/**', + '!hls.js/**', + '!froala-editor/**', + '!jquery/**', + '!amis/lib/components/RichText.js', + '!zrender/**', + '!echarts/**', + ], + // css 打包 + 'pkg/style.css': [ + 'node_modules/*/**.css', + '*.scss', + '!/scss/*.scss', + '/scss/*.scss' + ] + }) + }); + + ghPages.match('*.{css,less,scss}', { + optimizer: fis.plugin('clean-css'), + useHash: true + }); + + ghPages.match('::image', { + useHash: true + }); + + ghPages.match('*.{js,ts,tsx}', { + optimizer: fis.plugin('uglify-js'), + useHash: true + }); + + ghPages.match('*.map', { + release: false, + url: 'null', + useHash: false + }); + ghPages.match('{*.jsx,*.tsx,*.ts}', { + moduleId: function (m, path) { + return fis.util.md5('amis' + path); + }, + parser: fis.plugin('typescript', { + sourceMap: false, + importHelpers: true + }) + }); + ghPages.match('*', { + domain: '/amis', + deploy: [ + fis.plugin('skip-packed'), + fis.plugin('local-deliver', { + to: './gh-pages' + }) + ] + }); + ghPages.match('{*.min.js,monaco-editor/**.js}', { + optimizer: null + }); + ghPages.match('monaco-editor/**.js', { + useHash: false + }); } From 3ce5bff1e256e64b84314cb9a4ed2bc3a571cc2c Mon Sep 17 00:00:00 2001 From: liaoxuezhi Date: Thu, 9 May 2019 19:40:59 +0800 Subject: [PATCH 0002/1953] =?UTF-8?q?gh-pages=20=E8=B0=83=E6=95=B4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- examples/components/App.jsx | 9 +++++++-- fis-conf.js | 6 +++--- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/examples/components/App.jsx b/examples/components/App.jsx index c3fadda03..148751d34 100644 --- a/examples/components/App.jsx +++ b/examples/components/App.jsx @@ -82,6 +82,10 @@ import Button from '../../src/components/Button'; let PathPrefix = '/examples'; +if (process.env.NODE_ENV === 'production') { + PathPrefix = '' +} + const navigations = [ { label: '示例', @@ -690,7 +694,7 @@ export class App extends React.PureComponent { } } - function navigations2route(pathPrefix = '/examples') { + function navigations2route(pathPrefix = PathPrefix) { let routes = []; navigations.forEach(root => { @@ -711,7 +715,7 @@ export class App extends React.PureComponent { } export default function entry({pathPrefix}) { - PathPrefix = pathPrefix || '/examples'; + PathPrefix = pathPrefix || PathPrefix; let history = browserHistory; if (process.env.NODE_ENV === 'production') { @@ -721,6 +725,7 @@ export class App extends React.PureComponent { return ( + {navigations2route(PathPrefix)} diff --git a/fis-conf.js b/fis-conf.js index a1a17fe30..c6bcdf7a6 100644 --- a/fis-conf.js +++ b/fis-conf.js @@ -256,7 +256,7 @@ if (fis.project.currentMedia() === 'publish') { ghPages.match('::package', { packager: fis.plugin('deps-pack', { 'pkg/npm.js': [ - '/mod.js', + '/examples/mod.js', 'node_modules/**.js', '!monaco-editor/**', '!flv.js/**', @@ -281,8 +281,8 @@ if (fis.project.currentMedia() === 'publish') { 'mock/*.ts' ], 'pkg/app.js': [ - '/app.tsx', - '/app.tsx:deps' + '/examples/components/App.jsx', + '/examples/components/App.jsx:deps' ], 'pkg/rest.js': [ '**.{js,jsx,ts,tsx}', From 2736c5cb60fb3248dd9954daa887aef829103f4c Mon Sep 17 00:00:00 2001 From: SIMDD Date: Thu, 9 May 2019 20:43:12 +0800 Subject: [PATCH 0005/1953] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20?= =?UTF-8?q?=E4=BF=AE=E6=94=B9=20=E7=B1=BB=E5=9E=8B=E8=AF=B4=E6=98=8E=20?= =?UTF-8?q?=E4=B8=BA=20Types?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers/Form.md | 12 ++++++------ docs/renderers/FormItem.md | 8 ++++---- docs/renderers/Page.md | 40 +++++++++++++++++++------------------- 3 files changed, 30 insertions(+), 30 deletions(-) diff --git a/docs/renderers/Form.md b/docs/renderers/Form.md index bde6a505a..920f083d2 100644 --- a/docs/renderers/Form.md +++ b/docs/renderers/Form.md @@ -42,18 +42,18 @@ | messages.saveFailed | `string` | | 保存成功时提示 | | messages.saveSuccess | `string` | | 保存失败时提示 | | wrapWithPanel | `boolean` | `true` | 是否让 Form 用 panel 包起来，设置为 false 后，actions 将无效。 | -| api | [Api](./类型说明.md#api) | | Form 用来保存数据的 api。 | -| initApi | [Api](./类型说明.md#api) | | Form 用来获取初始数据的 api。 | +| api | [Api](./Types.md#api) | | Form 用来保存数据的 api。 | +| initApi | [Api](./Types.md#api) | | Form 用来获取初始数据的 api。 | | interval | `number` | `3000` | 刷新时间(最低 3000) | | silentPolling | `boolean` | `false` | 配置刷新时是否显示加载动画 | -| stopAutoRefreshWhen | `string` | `""` | 通过[表达式](./类型说明.md#表达式) 来配置停止刷新的条件 | -| initAsyncApi | [Api](./类型说明.md#api) | | Form 用来获取初始数据的 api,与 initApi 不同的是，会一直轮训请求该接口，直到返回 finished 属性为 true 才 结束。 | +| stopAutoRefreshWhen | `string` | `""` | 通过[表达式](./Types.md#表达式) 来配置停止刷新的条件 | +| initAsyncApi | [Api](./Types.md#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 以后，默认拉取的时间间隔 | -| schemaApi | [Api](./类型说明.md#api) | | `已不支持`，请改用 controls 里面放置 Service 渲染器实现 | -| asyncApi | [Api](./类型说明.md#api) | | 设置此属性后，表单提交发送保存接口后，还会继续轮训请求该接口，直到返回 `finished` 属性为 `true` 才 结束。 | +| schemaApi | [Api](./Types.md#api) | | `已不支持`，请改用 controls 里面放置 Service 渲染器实现 | +| asyncApi | [Api](./Types.md#api) | | 设置此属性后，表单提交发送保存接口后，还会继续轮训请求该接口，直到返回 `finished` 属性为 `true` 才 结束。 | | checkInterval | `number` | 3000 | 轮训请求的时间间隔，默认为 3 秒。设置 `asyncApi` 才有效 | | finishedField | `string` | `"finished"` | 如果决定结束的字段名不是 `finished` 请设置此属性，比如 `is_success` | | submitOnChange | `boolean` | `false` | 表单修改即提交 | diff --git a/docs/renderers/FormItem.md b/docs/renderers/FormItem.md index ce22d7f38..f19340ce6 100644 --- a/docs/renderers/FormItem.md +++ b/docs/renderers/FormItem.md @@ -12,15 +12,15 @@ Form 中主要是由各种 FormItem 组成。FormItem 中主要包含这些字 - `submitOnChange` 是否该表单项值发生变化时就提交当前表单。 - `className` 表单最外层类名。 - `disabled` 当前表单项是否是禁用状态。 -- `disabledOn` 通过[表达式](./类型说明.md#表达式)来配置当前表单项的禁用状态。 +- `disabledOn` 通过[表达式](./Types.md#表达式)来配置当前表单项的禁用状态。 - `visible` 是否可见。 -- `visibleOn` 通过[表达式](./类型说明.md#表达式)来配置当前表单项是否显示。 +- `visibleOn` 通过[表达式](./Types.md#表达式)来配置当前表单项是否显示。 - `hidden` 是否隐藏，不要跟 `visible` `visibleOn` 同时配置 -- `hiddenOn` 通过[表达式](./类型说明.md#表达式)来配置当前表单项是否隐藏。 +- `hiddenOn` 通过[表达式](./Types.md#表达式)来配置当前表单项是否隐藏。 - `inputClassName` 表单控制器类名。 - `labelClassName` label 的类名。 - `required` 是否为必填。 -- `requiredOn` 通过[表达式](./类型说明.md#表达式)来配置当前表单项是否为必填。 +- `requiredOn` 通过[表达式](./Types.md#表达式)来配置当前表单项是否为必填。 - `validations` 格式验证，支持设置多个，多个规则用英文逗号隔开。 - `isEmptyString` 必须是空白字符。 diff --git a/docs/renderers/Page.md b/docs/renderers/Page.md index fc8d096e5..bae43e841 100644 --- a/docs/renderers/Page.md +++ b/docs/renderers/Page.md @@ -16,23 +16,23 @@ Json 配置最外层是一个 `Page` 渲染器。他主要包含标题，副标 > PS: 代码支持及时编辑预览 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------------- | ------------------------------------ | ------------------------------------------ | ----------------------------------------------------------------------------------- | -| type | `string` | `"page"` | 指定为 Page 渲染器。 | -| title | `string` | | 页面标题 | -| subTitle | `string` | | 页面副标题 | -| remark | `string` | | 标题附近会出现一个提示图标，鼠标放上去会提示该内容。 | -| aside | [Container](./类型说明.md#Container) | | 往页面的边栏区域加内容 | -| toolbar | [Container](./类型说明.md#Container) | | 往页面的右上角加内容，需要注意的是，当有 Title 是，区域在右上角，没有时区域就在顶部 | -| body | [Container](./类型说明.md#Container) | | 往页面的内容区域加内容 | -| className | `string` | | 外层 dom 类名 | -| 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](./类型说明.md#Api) | | Page 用来获取初始数据的 api。返回的数据可以整个 page 级别使用。 | -| initFetch | `boolean` | `true` | 是否起始拉取 initApi | -| initFetchOn | `string` | | 是否起始拉取 initApi, 通过表达式配置 | -| interval | `number` | `3000` | 刷新时间(最低 3000) | -| silentPolling | `boolean` | `false` | 配置刷新时是否显示加载动画 | -| stopAutoRefreshWhen | `string` | `""` | 通过[表达式](./类型说明.md#表达式)来配置停止刷新的条件 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------------- | --------------------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------- | +| type | `string` | `"page"` | 指定为 Page 渲染器。 | +| title | `string` | | 页面标题 | +| subTitle | `string` | | 页面副标题 | +| remark | `string` | | 标题附近会出现一个提示图标，鼠标放上去会提示该内容。 | +| aside | [Container](./Types.md#Container) | | 往页面的边栏区域加内容 | +| toolbar | [Container](./Types.md#Container) | | 往页面的右上角加内容，需要注意的是，当有 Title 是，区域在右上角，没有时区域就在顶部 | +| body | [Container](./Types.md#Container) | | 往页面的内容区域加内容 | +| className | `string` | | 外层 dom 类名 | +| 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.md#Api) | | Page 用来获取初始数据的 api。返回的数据可以整个 page 级别使用。 | +| initFetch | `boolean` | `true` | 是否起始拉取 initApi | +| initFetchOn | `string` | | 是否起始拉取 initApi, 通过表达式配置 | +| interval | `number` | `3000` | 刷新时间(最低 3000) | +| silentPolling | `boolean` | `false` | 配置刷新时是否显示加载动画 | +| stopAutoRefreshWhen | `string` | `""` | 通过[表达式](./Types.md#表达式)来配置停止刷新的条件 | From f9ec2de1ccd51332c5062a07ad9ec3b8ae7b2e93 Mon Sep 17 00:00:00 2001 From: SIMDD Date: Thu, 9 May 2019 20:50:49 +0800 Subject: [PATCH 0006/1953] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20fix=20#F?= =?UTF-8?q?ormItem?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers/Array.md | 2 +- docs/renderers/Chained-Select.md | 6 +++--- docs/renderers/Checkbox.md | 2 +- docs/renderers/Checkboxes.md | 2 +- docs/renderers/Combo.md | 4 ++-- docs/renderers/Date-Range.md | 2 +- docs/renderers/Date.md | 2 +- docs/renderers/Datetime.md | 2 +- docs/renderers/Editor.md | 4 ++-- docs/renderers/File.md | 2 +- docs/renderers/FormItem-Button-Group.md | 2 +- docs/renderers/FormItem-List.md | 2 +- docs/renderers/FormItem-Table.md | 2 +- docs/renderers/Image.md | 2 +- docs/renderers/Matrix.md | 2 +- docs/renderers/NestedSelect.md | 2 +- docs/renderers/Picker.md | 2 +- docs/renderers/Radios.md | 2 +- docs/renderers/Repeat.md | 2 +- docs/renderers/Rich-Text.md | 2 +- docs/renderers/Select.md | 4 ++-- docs/renderers/SubForm.md | 2 +- docs/renderers/Switch.md | 2 +- docs/renderers/Time.md | 2 +- docs/renderers/Tree.md | 2 +- docs/renderers/TreeSelect.md | 2 +- docs/renderers/Types.md | 2 +- 27 files changed, 32 insertions(+), 32 deletions(-) diff --git a/docs/renderers/Array.md b/docs/renderers/Array.md index 87d1758f4..fdc2fd113 100644 --- a/docs/renderers/Array.md +++ b/docs/renderers/Array.md @@ -13,7 +13,7 @@ - `addButtonText` 新增按钮文字，默认为 `"新增"`。 - `minLength` 限制最小长度。 - `maxLength` 限制最大长度。 -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="450" scope="form" [ diff --git a/docs/renderers/Chained-Select.md b/docs/renderers/Chained-Select.md index bcbad4546..c78e95290 100644 --- a/docs/renderers/Chained-Select.md +++ b/docs/renderers/Chained-Select.md @@ -6,9 +6,9 @@ - `options` 选项配置，类型为数组，成员格式如下。 - `label` 文字 - `value` 值 -- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。[详情](/docs/api#select) 另外也可以用 `$xxxx` 来获取当前作用域中的变量。 - 更多配置请参考 [FormItem](#FormItem)。 -- 更多配置请参考 [FormItem](#FormItem) +- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。另外也可以用 `$xxxx` 来获取当前作用域中的变量。 + 更多配置请参考 [FormItem](./FormItem.md)。 +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="300" scope="form-item" { diff --git a/docs/renderers/Checkbox.md b/docs/renderers/Checkbox.md index a1331fe53..e0947b5db 100644 --- a/docs/renderers/Checkbox.md +++ b/docs/renderers/Checkbox.md @@ -6,7 +6,7 @@ - `option` 选项说明 - `trueValue` 默认 `true` - `falseValue` 默认 `false` -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="200" scope="form-item" { diff --git a/docs/renderers/Checkboxes.md b/docs/renderers/Checkboxes.md index 3bcddb328..c4075dd65 100644 --- a/docs/renderers/Checkboxes.md +++ b/docs/renderers/Checkboxes.md @@ -11,7 +11,7 @@ - `extractValue` 默认为 `false`, `joinValues`设置为`false`时生效, 开启后将选中的选项 value 的值封装为数组，作为当前表单项的值。 - `delimiter` 默认为 `,` - `columnsCount` 默认为 `1` 可以配置成一行显示多个。 -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="330" scope="form" [ diff --git a/docs/renderers/Combo.md b/docs/renderers/Combo.md index 8938fd884..bcf5ad35a 100644 --- a/docs/renderers/Combo.md +++ b/docs/renderers/Combo.md @@ -4,7 +4,7 @@ - `type` 请设置成 `combo` - `multiple` 默认为 `false` 配置是否为多选模式 -- `controls` 配置组合成员，所有成员都是横向展示，可以是任意 [FormItem](#FormItem) +- `controls` 配置组合成员，所有成员都是横向展示，可以是任意 [FormItem](./FormItem.md) - `controls[x].columnClassName` 列的类名，可以用它配置列宽度。默认平均分配。 - `controls[x].unique` 设置当前列值是否唯一，即不允许重复选择。 - `maxLength` 当 multiple 为 true 的时候启用，设置可以最大项数。 @@ -22,7 +22,7 @@ - `minLength` 限制最小长度。 - `maxLength` 限制最大长度。 - `scaffold` 单条初始值。默认为 `{}`。 -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="450" scope="form" [ diff --git a/docs/renderers/Date-Range.md b/docs/renderers/Date-Range.md index 7b0a1dcb9..813f8c300 100644 --- a/docs/renderers/Date-Range.md +++ b/docs/renderers/Date-Range.md @@ -7,7 +7,7 @@ - `inputFormat` 默认 `HH:mm` 用来配置显示的时间格式。 - `minDate` 限制最小日期，可用 `${xxx}` 取值，或者输入相对时间，或者时间戳。如：`${start}`、`+3days`、`+3days+2hours`或者 `${start|default:-2days}+3days` - `maxDate` 限制最小日期，可用 `${xxx}` 取值，或者输入相对时间，或者时间戳。如：`${start}`、`+3days`、`+3days+2hours`或者 `${start|default:-2days}+3days` -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="250" scope="form" [ diff --git a/docs/renderers/Date.md b/docs/renderers/Date.md index d0e528041..5213bc23d 100644 --- a/docs/renderers/Date.md +++ b/docs/renderers/Date.md @@ -15,7 +15,7 @@ 可用单位： `min`、`hour`、`day`、`week`、`month`、`year`。所有单位支持复数形式。 -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="250" scope="form" [ diff --git a/docs/renderers/Datetime.md b/docs/renderers/Datetime.md index e570ae8b4..86e7d2142 100644 --- a/docs/renderers/Datetime.md +++ b/docs/renderers/Datetime.md @@ -18,7 +18,7 @@ 可用单位： `min`、`hour`、`day`、`week`、`month`、`year`。所有单位支持复数形式。 -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="250" scope="form" [ diff --git a/docs/renderers/Editor.md b/docs/renderers/Editor.md index f7add2fb3..bc3adb40b 100644 --- a/docs/renderers/Editor.md +++ b/docs/renderers/Editor.md @@ -4,7 +4,7 @@ - `type` 请设置成 `editor` 或者 `bat-editor`、`c-editor`、`coffeescript-editor`、`cpp-editor`、`csharp-editor`、`css-editor`、`dockerfile-editor`、`fsharp-editor`、`go-editor`、`handlebars-editor`、`html-editor`、`ini-editor`、`java-editor`、`javascript-editor`、`json-editor`、`less-editor`、`lua-editor`、`markdown-editor`、`msdax-editor`、`objective-c-editor`、`php-editor`、`plaintext-editor`、`postiats-editor`、`powershell-editor`、`pug-editor`、`python-editor`、`r-editor`、`razor-editor`、`ruby-editor`、`sb-editor`、`scss-editor`、`sol-editor`、`sql-editor`、`swift-editor`、`typescript-editor`、`vb-editor`、`xml-editor`、`yaml-editor`。 - `language` 默认为 `javascript` 当 `type` 为 `editor` 的时候有用。 -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="350" scope="form-item" { @@ -20,7 +20,7 @@ - `language` 默认为 `javascript` 当 `type` 为 `diff-editor` 的时候有用 - `diffValue` 设置左侧编辑器的值，支持`${xxx}`获取变量 - `disabled` 配置 **右侧编辑器** 是否可编辑，**左侧编辑器**始终不可编辑 -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) PS: 当用作纯展示时，可以通过`value`配置项，设置右侧编辑器的值 diff --git a/docs/renderers/File.md b/docs/renderers/File.md index 15736d066..9c2fb590f 100644 --- a/docs/renderers/File.md +++ b/docs/renderers/File.md @@ -19,7 +19,7 @@ - `startChunkApi` 默认 `/api/upload/startChunk` 想自己存储时才需要关注。 - `chunkApi` 默认 `/api/upload/chunk` 想自己存储时才需要关注。 - `finishChunkApi` 默认 `/api/upload/finishChunk` 想自己存储时才需要关注。 -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="250" scope="form-item" { diff --git a/docs/renderers/FormItem-Button-Group.md b/docs/renderers/FormItem-Button-Group.md index ecdc0ba36..0df61d95a 100644 --- a/docs/renderers/FormItem-Button-Group.md +++ b/docs/renderers/FormItem-Button-Group.md @@ -71,7 +71,7 @@ button-group 有两种模式，除了能让按钮组合在一起，还能做类 - 多选模式：选中的多个选项的 `value` 会通过 `delimiter` 连接起来，否则直接将以数组的形式提交值。 - `delimiter` 默认为 `,` - `clearable` 默认为 `true`, 表示可以取消选中。 -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="250" scope="form" [ diff --git a/docs/renderers/FormItem-List.md b/docs/renderers/FormItem-List.md index f49660cec..6731da361 100644 --- a/docs/renderers/FormItem-List.md +++ b/docs/renderers/FormItem-List.md @@ -14,7 +14,7 @@ - 多选模式：选中的多个选项的 `value` 会通过 `delimiter` 连接起来，否则直接将以数组的形式提交值。 - `delimiter` 默认为 `,` - `clearable` 默认为 `true`, 表示可以取消选中。 -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) 单选 diff --git a/docs/renderers/FormItem-Table.md b/docs/renderers/FormItem-Table.md index 24cc8ba5b..26e3dda56 100644 --- a/docs/renderers/FormItem-Table.md +++ b/docs/renderers/FormItem-Table.md @@ -71,7 +71,7 @@ | columns[x].quickEdit | `boolean` 或者 `object` | - | 配合 editable 为 true 一起使用 | | columns[x].quickEditOnUpdate | `boolean` 或者 `object` | - | 可以用来区分新建模式和更新模式的编辑配置 | -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) - 更多 Demo 详情请参考 [表格编辑](/docs/examples/form/table) ```schema:height="250" scope="form-item" diff --git a/docs/renderers/Image.md b/docs/renderers/Image.md index 5748dbc84..179cf2f28 100644 --- a/docs/renderers/Image.md +++ b/docs/renderers/Image.md @@ -25,7 +25,7 @@ - `minHeight` 限制图片最小高度。 - `maxWidth` 限制图片最大宽度。 - `maxHeight` 限制图片最大高度。 -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="250" scope="form-item" { diff --git a/docs/renderers/Matrix.md b/docs/renderers/Matrix.md index bb04b2865..ada3f6618 100644 --- a/docs/renderers/Matrix.md +++ b/docs/renderers/Matrix.md @@ -7,7 +7,7 @@ - `rows` 行信息， 数组中 `label` 字段是必须给出的 - `rowLabel` 行标题说明 - `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。[详情](/docs/api#matrix) -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="250" scope="form-item" { diff --git a/docs/renderers/NestedSelect.md b/docs/renderers/NestedSelect.md index fd179e450..4fec0c9b5 100644 --- a/docs/renderers/NestedSelect.md +++ b/docs/renderers/NestedSelect.md @@ -11,7 +11,7 @@ - 多选模式：选中的多个选项的 `value` 会通过 `delimiter` 连接起来，否则直接将以数组的形式提交值。 - `extractValue` 默认为 `false`, `joinValues`设置为`false`时生效, 开启后将选中的选项 value 的值封装为数组，作为当前表单项的值。 - `delimiter` 默认为 `,` -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="300" scope="form-item" { diff --git a/docs/renderers/Picker.md b/docs/renderers/Picker.md index 4470e2c14..78593025d 100644 --- a/docs/renderers/Picker.md +++ b/docs/renderers/Picker.md @@ -15,7 +15,7 @@ - `delimiter` 默认为 `,` - `modalMode` 设置 `dialog` 或者 `drawer`，用来配置弹出方式。 - `pickerSchema` 默认为 `{mode: 'list', listItem: {title: '${label}'}}`, 即用 List 类型的渲染，来展示列表信息。更多的玩法请参考 [CRUD](#crud) 的配置。 -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="300" scope="form-item" { diff --git a/docs/renderers/Radios.md b/docs/renderers/Radios.md index 820f83699..c6bf9ddaf 100644 --- a/docs/renderers/Radios.md +++ b/docs/renderers/Radios.md @@ -8,7 +8,7 @@ - `value` 值 - `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。[详情](/docs/api#select) - `columnsCount` 默认为 `1` 可以配置成一行显示多个。 -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="330" scope="form" [ diff --git a/docs/renderers/Repeat.md b/docs/renderers/Repeat.md index 36a43c93d..a2c4c40ad 100644 --- a/docs/renderers/Repeat.md +++ b/docs/renderers/Repeat.md @@ -5,7 +5,7 @@ - `type` 请设置成 `repeat` - `options` 默认: `hourly,daily,weekly,monthly`， 可用配置 `secondly,minutely,hourly,daily,weekdays,weekly,monthly,yearly` - `placeholder` 默认为 `不重复`, 当不指定值时的说明。 -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="300" scope="form-item" { diff --git a/docs/renderers/Rich-Text.md b/docs/renderers/Rich-Text.md index 0b8f9816e..01b61d5a7 100644 --- a/docs/renderers/Rich-Text.md +++ b/docs/renderers/Rich-Text.md @@ -34,7 +34,7 @@ ``` - `options` Object 类型，给富文本的配置信息。请参考 https://www.froala.com/wysiwyg-editor/docs/options -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="350" scope="form-item" { diff --git a/docs/renderers/Select.md b/docs/renderers/Select.md index ddc87cd3d..b3465bcb0 100644 --- a/docs/renderers/Select.md +++ b/docs/renderers/Select.md @@ -6,7 +6,7 @@ - `options` 选项配置，类型为数组，成员格式如下。 - `label` 文字 - `value` 值 -- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。[详情](/docs/api#select) 另外也可以用 `$xxxx` 来获取当前作用域中的变量。 +- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。另外也可以用 `$xxxx` 来获取当前作用域中的变量。 - `autoComplete` 跟 source 不同的是，每次用户输入都会去接口获取提示。 - `multiple` 默认为 `false`, 设置成 `true` 表示可多选。 - `joinValues` 默认为 `true` @@ -16,7 +16,7 @@ - `delimiter` 默认为 `,` - `clearable` 默认为 `false`, 当设置为 `true` 时，已选中的选项右侧会有个小 `X` 用来取消设置。 - `searchable` 默认为 `false`，表示可以通过输入部分内容检索出选项。 -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) 单选 diff --git a/docs/renderers/SubForm.md b/docs/renderers/SubForm.md index 72030f87b..88cc31e67 100644 --- a/docs/renderers/SubForm.md +++ b/docs/renderers/SubForm.md @@ -13,7 +13,7 @@ formItem 还可以是子表单类型。 - `form` 字表单的配置 `title` 标题 `controls` 请参考 [Form](#/form) 中的配置说明。 -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="400" scope="form" [ diff --git a/docs/renderers/Switch.md b/docs/renderers/Switch.md index 126681c52..a9cb78bee 100644 --- a/docs/renderers/Switch.md +++ b/docs/renderers/Switch.md @@ -6,7 +6,7 @@ - `option` 选项说明 - `trueValue` 默认 `true` - `falseValue` 默认 `false` -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="200" scope="form-item" { diff --git a/docs/renderers/Time.md b/docs/renderers/Time.md index 16c49b539..9798cde3b 100644 --- a/docs/renderers/Time.md +++ b/docs/renderers/Time.md @@ -16,7 +16,7 @@ 可用单位： `min`、`hour`、`day`、`week`、`month`、`year`。所有单位支持复数形式。 -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="250" scope="form" [ diff --git a/docs/renderers/Tree.md b/docs/renderers/Tree.md index 8327494ad..c6701ef7e 100644 --- a/docs/renderers/Tree.md +++ b/docs/renderers/Tree.md @@ -17,7 +17,7 @@ - 多选模式：选中的多个选项的 `value` 会通过 `delimiter` 连接起来，否则直接将以数组的形式提交值。 - `extractValue` 默认为 `false`, `joinValues`设置为`false`时生效, 开启后将选中的选项 value 的值封装为数组，作为当前表单项的值。 - `delimiter` 默认为 `,` -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="300" scope="form-item" { diff --git a/docs/renderers/TreeSelect.md b/docs/renderers/TreeSelect.md index 99e62a5ff..454ddd1bd 100644 --- a/docs/renderers/TreeSelect.md +++ b/docs/renderers/TreeSelect.md @@ -17,7 +17,7 @@ - 多选模式：选中的多个选项的 `value` 会通过 `delimiter` 连接起来，否则直接将以数组的形式提交值。 - `extractValue` 默认为 `false`, `joinValues`设置为`false`时生效, 开启后将选中的选项 value 的值封装为数组，作为当前表单项的值。 - `delimiter` 默认为 `,` -- 更多配置请参考 [FormItem](#FormItem) +- 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="300" scope="form-item" { diff --git a/docs/renderers/Types.md b/docs/renderers/Types.md index 27084ca10..bfe8aa74f 100644 --- a/docs/renderers/Types.md +++ b/docs/renderers/Types.md @@ -128,7 +128,7 @@ AMis 所有值为 url 的如： `"http://www.baidu.com"` 都会被替换成 prox ### 表达式 配置项中，所有 `boolean` 类型的配置，都可以用 JS 表达式来配置。所有`boolean` 配置项，后面加个 `On` 则是表达式配置方式，可以用 js 语法来根据当前模型中的数据来决定是否启用。 -如：[FormItem](#FormItem) 中的 `disabledOn`、`hiddenOn`、`visibleOn`、[CRUD](#CRUD) 中的 `itemDraggableOn` 等等。 +如：[FormItem](./FormItem.md) 中的 `disabledOn`、`hiddenOn`、`visibleOn`、[CRUD](#CRUD) 中的 `itemDraggableOn` 等等。 ```schema:height="300" scope="form" [ From f82f32fafedb1c12f271345d3a76e0306d8657f9 Mon Sep 17 00:00:00 2001 From: SIMDD Date: Thu, 9 May 2019 20:54:32 +0800 Subject: [PATCH 0007/1953] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20?= =?UTF-8?q?=E5=88=A0=E9=99=A4=E6=97=A0=E7=94=A8=E7=9A=84=20=E8=AF=A6?= =?UTF-8?q?=E6=83=85=20=E9=93=BE=E6=8E=A5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers/CRUD.md | 8 ++++---- docs/renderers/Checkboxes.md | 2 +- docs/renderers/FormItem-Button-Group.md | 2 +- docs/renderers/FormItem-List.md | 2 +- docs/renderers/Matrix.md | 2 +- docs/renderers/NestedSelect.md | 2 +- docs/renderers/Picker.md | 2 +- docs/renderers/Radios.md | 2 +- docs/renderers/Tree.md | 2 +- docs/renderers/TreeSelect.md | 2 +- 10 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/renderers/CRUD.md b/docs/renderers/CRUD.md index da4772aac..0b267eec0 100644 --- a/docs/renderers/CRUD.md +++ b/docs/renderers/CRUD.md @@ -10,7 +10,7 @@ CRUD 支持三种模式：`table`、`cards`、`list`，默认为 `table`。 | mode | `string` | `"table"` | `"table" 、 "cards" 或者 "list"` | | title | `string` | `""` | 可设置成空，当设置成空时，没有标题栏 | | className | `string` | | 表格外层 Dom 的类名 | -| api | [Api](#api) | | CRUD 用来获取列表数据的 api。[详情](/docs/api#crud) | +| api | [Api](#api) | | CRUD 用来获取列表数据的 api。 | | filter | [Form](#form) | | 设置过滤器，当该表单提交后，会把数据带给当前 crud 刷新列表。 | | initFetch | `boolean` | `true` | 是否初始化的时候拉取数据, 只针对有 filter 的情况, 没有 filter 初始都会拉取数据 | | interval | `number` | `3000` | 刷新时间(最低 3000) | @@ -19,9 +19,9 @@ CRUD 支持三种模式：`table`、`cards`、`list`，默认为 `table`。 | syncLocation | `boolean` | `true` | 是否将过滤条件的参数同步到地址栏 | | draggable | `boolean` | `false` | 是否可通过拖拽排序 | | itemDraggableOn | `boolean` | | 用[表达式](#表达式)来配置是否可拖拽排序 | -| saveOrderApi | [Api](#api) | | 保存排序的 api。[详情](/docs/api#crud) | -| quickSaveApi | [Api](#api) | | 快速编辑后用来批量保存的 API。[详情](/docs/api#crud) | -| quickSaveItemApi | [Api](#api) | | 快速编辑配置成及时保存时使用的 API。[详情](/docs/api#crud) | +| saveOrderApi | [Api](#api) | | 保存排序的 api。 | +| quickSaveApi | [Api](#api) | | 快速编辑后用来批量保存的 API。 | +| quickSaveItemApi | [Api](#api) | | 快速编辑配置成及时保存时使用的 API。 | | bulkActions | Array Of [Action](#action) | | 批量操作列表，配置后，表格可进行选中操作。 | | defaultChecked | `boolean` | `false` | 当可批量操作时，默认是否全部勾选。 | | messages | `Object` | | 覆盖消息提示，如果不指定，将采用 api 返回的 message | diff --git a/docs/renderers/Checkboxes.md b/docs/renderers/Checkboxes.md index c4075dd65..12312039d 100644 --- a/docs/renderers/Checkboxes.md +++ b/docs/renderers/Checkboxes.md @@ -6,7 +6,7 @@ - `options` 选项配置，类型为数组，成员格式如下。 - `label` 文字 - `value` 值 -- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。[详情](/docs/api#select) +- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。 - `joinValues` 默认为 `true` 选中的多个选项的 `value` 会通过 `delimiter` 连接起来，否则直接将以数组的形式提交值。 - `extractValue` 默认为 `false`, `joinValues`设置为`false`时生效, 开启后将选中的选项 value 的值封装为数组，作为当前表单项的值。 - `delimiter` 默认为 `,` diff --git a/docs/renderers/FormItem-Button-Group.md b/docs/renderers/FormItem-Button-Group.md index 0df61d95a..e63269ada 100644 --- a/docs/renderers/FormItem-Button-Group.md +++ b/docs/renderers/FormItem-Button-Group.md @@ -64,7 +64,7 @@ button-group 有两种模式，除了能让按钮组合在一起，还能做类 - `label` 文字 - `value` 值 - `image` 图片的 http 地址。 -- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。[详情](/docs/api#select) +- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。 - `multiple` 默认为 `false`, 设置成 `true` 表示可多选。 - `joinValues` 默认为 `true` - 单选模式：当用户选中某个选项时，选项中的 value 将被作为该表单项的值提交，否则，整个选项对象都会作为该表单项的值提交。 diff --git a/docs/renderers/FormItem-List.md b/docs/renderers/FormItem-List.md index 6731da361..5a424f94a 100644 --- a/docs/renderers/FormItem-List.md +++ b/docs/renderers/FormItem-List.md @@ -7,7 +7,7 @@ - `label` 文字 - `value` 值 - `image` 图片的 http 地址。 -- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。[详情](/docs/api#select) +- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。 - `multiple` 默认为 `false`, 设置成 `true` 表示可多选。 - `joinValues` 默认为 `true` - 单选模式：当用户选中某个选项时，选项中的 value 将被作为该表单项的值提交，否则，整个选项对象都会作为该表单项的值提交。 diff --git a/docs/renderers/Matrix.md b/docs/renderers/Matrix.md index ada3f6618..21fcfb779 100644 --- a/docs/renderers/Matrix.md +++ b/docs/renderers/Matrix.md @@ -6,7 +6,7 @@ - `columns` 列信息， 数组中 `label` 字段是必须给出的 - `rows` 行信息， 数组中 `label` 字段是必须给出的 - `rowLabel` 行标题说明 -- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。[详情](/docs/api#matrix) +- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。 - 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="250" scope="form-item" diff --git a/docs/renderers/NestedSelect.md b/docs/renderers/NestedSelect.md index 4fec0c9b5..8a1191bbd 100644 --- a/docs/renderers/NestedSelect.md +++ b/docs/renderers/NestedSelect.md @@ -4,7 +4,7 @@ - `type` 请设置成 `nested-select` - `options` 类似于 [select](#select) 中 `options`, 并且支持通过 `children` 无限嵌套。 -- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。[详情](/docs/api#tree) +- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。 - `multiple` 默认为 `false`, 设置成 `true` 表示可多选。 - `joinValues` 默认为 `true` - 单选模式：当用户选中某个选项时，选项中的 value 将被作为该表单项的值提交，否则，整个选项对象都会作为该表单项的值提交。 diff --git a/docs/renderers/Picker.md b/docs/renderers/Picker.md index 78593025d..8248485d0 100644 --- a/docs/renderers/Picker.md +++ b/docs/renderers/Picker.md @@ -7,7 +7,7 @@ - `options` 选项配置，类型为数组，成员格式如下。 - `label` 文字 - `value` 值 -- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。[详情](/docs/api#select) 另外也可以用 `$xxxx` 来获取当前作用域中的变量。 +- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。 另外也可以用 `$xxxx` 来获取当前作用域中的变量。 - `joinValues` 默认为 `true` - 单选模式：当用户选中某个选项时，选项中的 value 将被作为该表单项的值提交，否则，整个选项对象都会作为该表单项的值提交。 - 多选模式：选中的多个选项的 `value` 会通过 `delimiter` 连接起来，否则直接将以数组的形式提交值。 diff --git a/docs/renderers/Radios.md b/docs/renderers/Radios.md index c6bf9ddaf..37f478c34 100644 --- a/docs/renderers/Radios.md +++ b/docs/renderers/Radios.md @@ -6,7 +6,7 @@ - `options` 选项配置，类型为数组，成员格式如下。 - `label` 文字 - `value` 值 -- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。[详情](/docs/api#select) +- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。 - `columnsCount` 默认为 `1` 可以配置成一行显示多个。 - 更多配置请参考 [FormItem](./FormItem.md) diff --git a/docs/renderers/Tree.md b/docs/renderers/Tree.md index c6701ef7e..dc7d1037e 100644 --- a/docs/renderers/Tree.md +++ b/docs/renderers/Tree.md @@ -4,7 +4,7 @@ - `type` 请设置成 `tree` - `options` 类似于 [select](#select) 中 `options`, 并且支持通过 `children` 无限嵌套。 -- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。[详情](/docs/api#tree) +- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。 - `hideRoot` 默认是会显示一个顶级，如果不想显示，请设置 `false` - `rootLabel` 默认为 `顶级`，当 hideRoot 不为 `false` 时有用，用来设置顶级节点的文字。 - `showIcon` 是否显示投标，默认为 `true`。 diff --git a/docs/renderers/TreeSelect.md b/docs/renderers/TreeSelect.md index 454ddd1bd..e65ab6ff6 100644 --- a/docs/renderers/TreeSelect.md +++ b/docs/renderers/TreeSelect.md @@ -4,7 +4,7 @@ - `type` 请设置成 `tree-select` - `options` 类似于 [select](#select) 中 `options`, 并且支持通过 `children` 无限嵌套。 -- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。[详情](/docs/api#tree) +- `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。 - `hideRoot` 默认是会显示一个顶级，如果不想显示，请设置 `false` - `rootLabel` 默认为 `顶级`，当 hideRoot 不为 `false` 时有用，用来设置顶级节点的文字。 - `showIcon` 是否显示投标，默认为 `true`。 From 4a206cd436bafcaec8e9c206e64a26a824bb5d05 Mon Sep 17 00:00:00 2001 From: SIMDD Date: Thu, 9 May 2019 20:56:59 +0800 Subject: [PATCH 0008/1953] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20renderer?= =?UTF-8?q?s=20=E6=A0=BC=E5=BC=8F=E4=BF=AE=E6=94=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/renderers.md b/docs/renderers.md index 42c87e741..46428aaf9 100644 --- a/docs/renderers.md +++ b/docs/renderers.md @@ -4,19 +4,18 @@ title: AMis 渲染器手册 AMis 页面是通过 Json 配置出来的，是由一个一个渲染模型组成的，掌握他们规则，就能灵活配置出各种页面。 - - [Page](./renderers/Page.md): JSON 配置最外层的 Page 渲染器 - [Form](./renderers/Form.md): 表单渲染器 - [FormItem](./renderers/FormItem.md): Form 中主要是由各种 FormItem 组成 - - [FormItem-List](./renderers/FormItem-List.md): 简单的列表选择框 - - [FormItem-Button-Group](./renderers/FormItem-Button-Group.md): 按钮集合 - - [FormItem-Service](./renderers/FormItem-Service.md): 动态配置，配置项由接口决定 - - [FormItem-Tabs](./renderers/FormItem-Tabs.md): 多个输入框通过选项卡来分组 - - [FormItem-Table](./renderers/FormItem-Table.md): 可以用来展示数组类型的数据 - - [FormItem-HBox](./renderers/FormItem-HBox.md): 支持 form 内部再用 HBox 布局 - - [FormItem-Grid](./renderers/FormItem-Grid.md): 支持 form 内部再用 grid 布局 - - [FormItem-Panel](./renderers/FormItem-Panel.md): 还是为了布局，可以把一部分 FormItem 合并到一个 panel 里面单独展示 + - [FormItem-List](./renderers/FormItem-List.md): 简单的列表选择框 + - [FormItem-Button-Group](./renderers/FormItem-Button-Group.md): 按钮集合 + - [FormItem-Service](./renderers/FormItem-Service.md): 动态配置，配置项由接口决定 + - [FormItem-Tabs](./renderers/FormItem-Tabs.md): 多个输入框通过选项卡来分组 + - [FormItem-Table](./renderers/FormItem-Table.md): 可以用来展示数组类型的数据 + - [FormItem-HBox](./renderers/FormItem-HBox.md): 支持 form 内部再用 HBox 布局 + - [FormItem-Grid](./renderers/FormItem-Grid.md): 支持 form 内部再用 grid 布局 + - [FormItem-Panel](./renderers/FormItem-Panel.md): 还是为了布局，可以把一部分 FormItem 合并到一个 panel 里面单独展示 - [Hidden](./renderers/Hidden.md): 隐藏字段类型 - [Text](./renderers/Text.md): 普通的文本输入框 - [Textarea](./renderers/Textarea.md): 多行文本输入框 @@ -89,4 +88,4 @@ AMis 页面是通过 Json 配置出来的，是由一个一个渲染模型组成 - [Nav](./renderers/Nav.md): 菜单栏 - [Tasks](./renderers/Tasks.md): 任务操作集合，类似于 orp 上线 - [QRCode](./renderers/QRCode.md): 二维码显示组件 -- [类型说明](./renderers/Types.md): 类型说明文档 +- [Types](./renderers/Types.md): 类型说明文档 From 984e7c30e97f8ba32c2b052b679bdbae99044f5c Mon Sep 17 00:00:00 2001 From: SIMDD Date: Thu, 9 May 2019 20:59:48 +0800 Subject: [PATCH 0009/1953] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20?= =?UTF-8?q?=E6=B8=B2=E6=9F=93=E5=99=A8=E6=89=8B=E5=86=8C=E6=A0=BC=E5=BC=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/docs/renderers.md b/docs/renderers.md index 46428aaf9..a89e81f39 100644 --- a/docs/renderers.md +++ b/docs/renderers.md @@ -1,12 +1,9 @@ ---- -title: AMis 渲染器手册 ---- +### AMis 渲染器手册 AMis 页面是通过 Json 配置出来的，是由一个一个渲染模型组成的，掌握他们规则，就能灵活配置出各种页面。 - [Page](./renderers/Page.md): JSON 配置最外层的 Page 渲染器 - [Form](./renderers/Form.md): 表单渲染器 - - [FormItem](./renderers/FormItem.md): Form 中主要是由各种 FormItem 组成 - [FormItem-List](./renderers/FormItem-List.md): 简单的列表选择框 - [FormItem-Button-Group](./renderers/FormItem-Button-Group.md): 按钮集合 @@ -55,7 +52,6 @@ AMis 页面是通过 Json 配置出来的，是由一个一个渲染模型组成 - [Rich-Text](./renderers/Rich-Text.md): 富文本编辑器 - [Editor](./renderers/Editor.md): 编辑器 - [Static](./renderers/Static.md): 纯用来展现数据的 - - [Wizard](./renderers/Wizard.md): 表单向导 - [Tpl](./renderers/Tpl.md): 支持用 JS 模板引擎来组织输出 - [Plain](./renderers/Plain.md): 单纯的文字输出 From 65f8f1ef619d82d81c8c8fbe38f3313828321b50 Mon Sep 17 00:00:00 2001 From: SIMDD Date: Thu, 9 May 2019 21:00:19 +0800 Subject: [PATCH 0010/1953] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20?= =?UTF-8?q?=E6=B8=B2=E6=9F=93=E5=99=A8=E6=89=8B=E5=86=8C?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/renderers.md b/docs/renderers.md index a89e81f39..de43c7ba7 100644 --- a/docs/renderers.md +++ b/docs/renderers.md @@ -1,6 +1,6 @@ -### AMis 渲染器手册 +### 渲染器手册 -AMis 页面是通过 Json 配置出来的，是由一个一个渲染模型组成的，掌握他们规则，就能灵活配置出各种页面。 +AMis 页面是通过 JSON 配置出来的，是由一个一个渲染模型组成的，掌握他们规则，就能灵活配置出各种页面。 - [Page](./renderers/Page.md): JSON 配置最外层的 Page 渲染器 - [Form](./renderers/Form.md): 表单渲染器 From 1f8d4c8db18d867373e61798a77122ed2682edb4 Mon Sep 17 00:00:00 2001 From: SIMDD Date: Thu, 9 May 2019 21:33:28 +0800 Subject: [PATCH 0011/1953] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20fix=20[C?= =?UTF-8?q?ontainer](#Container)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers/Field.md | 34 ++++++++++++++--------------- docs/renderers/Tasks.md | 48 ++++++++++++++++++++--------------------- 2 files changed, 41 insertions(+), 41 deletions(-) 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" [ From 0ba9e3b0f44f98b585e779c585e578569e2440ca Mon Sep 17 00:00:00 2001 From: SIMDD Date: Thu, 9 May 2019 21:37:23 +0800 Subject: [PATCH 0012/1953] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20[Column]?= =?UTF-8?q?(#column)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers/Card.md | 30 ++++++++++----------- docs/renderers/Cards.md | 22 ++++++++-------- docs/renderers/Column.md | 2 +- docs/renderers/Dialog.md | 20 +++++++------- docs/renderers/Drawer.md | 22 ++++++++-------- docs/renderers/Grid.md | 52 ++++++++++++++++++------------------- docs/renderers/HBox.md | 14 +++++----- docs/renderers/List.md | 36 ++++++++++++------------- docs/renderers/Operation.md | 2 +- docs/renderers/Panel.md | 26 +++++++++---------- docs/renderers/Static.md | 2 +- docs/renderers/Table.md | 28 ++++++++++---------- 12 files changed, 128 insertions(+), 128 deletions(-) diff --git a/docs/renderers/Card.md b/docs/renderers/Card.md index ece1bb6b1..863679bac 100644 --- a/docs/renderers/Card.md +++ b/docs/renderers/Card.md @@ -2,21 +2,21 @@ 卡片的展示形式。 -| 属性名 | 类型 | 默认值 | 说明 | -| ---------------------- | ---------------------------- | ----------------------------------- | -------------------------------------- | -| type | `string` | `"card"` | 指定为 Card 渲染器 | -| className | `string` | `"panel-default"` | 外层 Dom 的类名 | -| header | `Object` | | Card 头部内容设置 | -| header.className | `string` | | 头部类名 | -| header.title | `string` | | 标题 | -| header.subTitle | `string` | | 副标题 | -| header.desc | `string` | | 描述 | -| header.avatar | `string` | | 图片 | -| header.highlight | `boolean` | | 是否点亮 | -| header.avatarClassName | `string` | `"pull-left thumb avatar b-3x m-r"` | 图片类名 | -| body | `Array` 或者 [Field](#field) | | 内容容器，主要用来放置 [Field](#field) | -| bodyClassName | `string` | `"padder m-t-sm m-b-sm"` | 内容区域类名 | -| actions | Array Of [Button](#button) | | 按钮区域 | +| 属性名 | 类型 | 默认值 | 说明 | +| ---------------------- | -------------------------------- | ----------------------------------- | ------------------------------------------ | +| type | `string` | `"card"` | 指定为 Card 渲染器 | +| className | `string` | `"panel-default"` | 外层 Dom 的类名 | +| header | `Object` | | Card 头部内容设置 | +| header.className | `string` | | 头部类名 | +| header.title | `string` | | 标题 | +| header.subTitle | `string` | | 副标题 | +| header.desc | `string` | | 描述 | +| header.avatar | `string` | | 图片 | +| header.highlight | `boolean` | | 是否点亮 | +| header.avatarClassName | `string` | `"pull-left thumb avatar b-3x m-r"` | 图片类名 | +| body | `Array` 或者 [Field](./Field.md) | | 内容容器，主要用来放置 [Field](./Field.md) | +| bodyClassName | `string` | `"padder m-t-sm m-b-sm"` | 内容区域类名 | +| actions | Array Of [Button](./Button.md) | | 按钮区域 | ```schema:height="300" scope="body" { diff --git a/docs/renderers/Cards.md b/docs/renderers/Cards.md index d5ec9c714..59dfea527 100644 --- a/docs/renderers/Cards.md +++ b/docs/renderers/Cards.md @@ -2,17 +2,17 @@ 卡片集合。 -| 属性名 | 类型 | 默认值 | 说明 | -| --------------- | ------------- | ------------------- | -------------------------- | -| type | `string` | | `"cards"` 指定为卡片集合。 | -| title | `string` | | 标题 | -| source | `string` | `${items}` | 数据源, 绑定当前环境变量 | -| placeholder | string | ‘暂无数据’ | 当没数据的时候的文字提示 | -| 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 | `string` | | 标题 | +| source | `string` | `${items}` | 数据源, 绑定当前环境变量 | +| placeholder | string | ‘暂无数据’ | 当没数据的时候的文字提示 | +| 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.md) | | 配置卡片信息 | ```schema:height="450" scope="body" { diff --git a/docs/renderers/Column.md b/docs/renderers/Column.md index e318a6efb..b0c56dcb0 100644 --- a/docs/renderers/Column.md +++ b/docs/renderers/Column.md @@ -2,7 +2,7 @@ 表格中的列配置 -- `type` 默认为 `text`，支持： `text`、`html`、`tpl`、`image`、`progress`、`status`、`date`、`datetime`、`time`、`json`、`mapping`参考 [Field 说明](#field)和[Operation](#operation)。 +- `type` 默认为 `text`，支持： `text`、`html`、`tpl`、`image`、`progress`、`status`、`date`、`datetime`、`time`、`json`、`mapping`参考 [Field 说明](./Field.md)和[Operation](./Operation.md)。 - `name` 用来关联列表数据中的变量 `key`。 - `label` 列标题。 - `copyable` 开启后，会支持内容点击复制。 diff --git a/docs/renderers/Dialog.md b/docs/renderers/Dialog.md index bdb166d8a..806f9afaa 100644 --- a/docs/renderers/Dialog.md +++ b/docs/renderers/Dialog.md @@ -2,16 +2,16 @@ Dialog 由 [Action](#action) 触发。他是一个类似于 [Page](#page) 的容器模型。 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------- | ------------------------------------- | ------------ | ------------------------------------------------ | -| type | `string` | | `"dialog"` 指定为 Dialog 渲染器 | -| title | `string` 或者 [Container](#Container) | | 弹出层标题 | -| body | [Container](#Container) | | 往 Dialog 内容区加内容 | -| size | `string` | | 指定 dialog 大小，支持: `xs`、`sm`、`md`、`lg` | -| bodyClassName | `string` | `modal-body` | Dialog body 区域的样式类名 | -| closeOnEsc | `boolean` | `false` | 是否支持按 `Esc` 关闭 Dialog | -| disabled | `boolean` | `false` | 如果设置此属性，则该 Dialog 只读没有提交操作。 | -| actions | Array Of [Action](#action) | | 可以不设置，默认只有【确认】和【取消】两个按钮。 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------- | ----------------------------------------------- | ------------ | ------------------------------------------------ | +| type | `string` | | `"dialog"` 指定为 Dialog 渲染器 | +| title | `string` 或者 [Container](./Types.md#Container) | | 弹出层标题 | +| body | [Container](./Types.md#Container) | | 往 Dialog 内容区加内容 | +| size | `string` | | 指定 dialog 大小，支持: `xs`、`sm`、`md`、`lg` | +| bodyClassName | `string` | `modal-body` | Dialog body 区域的样式类名 | +| closeOnEsc | `boolean` | `false` | 是否支持按 `Esc` 关闭 Dialog | +| disabled | `boolean` | `false` | 如果设置此属性，则该 Dialog 只读没有提交操作。 | +| actions | Array Of [Action](#action) | | 可以不设置，默认只有【确认】和【取消】两个按钮。 | ```schema:height="200" { diff --git a/docs/renderers/Drawer.md b/docs/renderers/Drawer.md index bf7ee5d66..96f758494 100644 --- a/docs/renderers/Drawer.md +++ b/docs/renderers/Drawer.md @@ -2,17 +2,17 @@ Drawer 由 [Action](#action) 触发。 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------- | ------------------------------------- | ------------ | ------------------------------------------------ | -| type | `string` | | `"drawer"` 指定为 Drawer 渲染器 | -| title | `string` 或者 [Container](#Container) | | 弹出层标题 | -| body | [Container](#Container) | | 往 Dialog 内容区加内容 | -| size | `string` | | 指定 dialog 大小，支持: `xs`、`sm`、`md`、`lg` | -| bodyClassName | `string` | `modal-body` | Dialog body 区域的样式类名 | -| closeOnEsc | `boolean` | `false` | 是否支持按 `Esc` 关闭 Dialog | -| overlay | `boolean` | `true` | 是否显示蒙层 | -| resizable | `boolean` | `false` | 是否可通过拖拽改变 Drawer 大小 | -| actions | Array Of [Action](#action) | | 可以不设置，默认只有【确认】和【取消】两个按钮。 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------- | ----------------------------------------------- | ------------ | ------------------------------------------------ | +| type | `string` | | `"drawer"` 指定为 Drawer 渲染器 | +| title | `string` 或者 [Container](./Types.md#Container) | | 弹出层标题 | +| body | [Container](./Types.md#Container) | | 往 Dialog 内容区加内容 | +| size | `string` | | 指定 dialog 大小，支持: `xs`、`sm`、`md`、`lg` | +| bodyClassName | `string` | `modal-body` | Dialog body 区域的样式类名 | +| closeOnEsc | `boolean` | `false` | 是否支持按 `Esc` 关闭 Dialog | +| overlay | `boolean` | `true` | 是否显示蒙层 | +| resizable | `boolean` | `false` | 是否可通过拖拽改变 Drawer 大小 | +| actions | Array Of [Action](#action) | | 可以不设置，默认只有【确认】和【取消】两个按钮。 | ```schema:height="200" { diff --git a/docs/renderers/Grid.md b/docs/renderers/Grid.md index 10fe17fe9..6c1de0c55 100644 --- a/docs/renderers/Grid.md +++ b/docs/renderers/Grid.md @@ -1,31 +1,31 @@ ## Grid -| 属性名 | 类型 | 默认值 | 说明 | -| ------------------- | ----------------------- | -------- | ----------------------- | -| type | `string` | `"grid"` | 指定为 Grid 渲染器 | -| className | `string` | | 外层 Dom 的类名 | -| columns | `Array` | | 列集合 | -| columns[x] | [Container](#Container) | | 成员可以是其他渲染器 | -| 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] | [Container](./Types.md#Container) | | 成员可以是其他渲染器 | +| 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/components.html#grid-props-col) diff --git a/docs/renderers/HBox.md b/docs/renderers/HBox.md index f4cd89bb1..4d37c5f4b 100644 --- a/docs/renderers/HBox.md +++ b/docs/renderers/HBox.md @@ -1,12 +1,12 @@ ## HBox -| 属性名 | 类型 | 默认值 | 说明 | -| -------------------------- | ----------------------- | -------------- | -------------------- | -| type | `string` | `"hbox"` | 指定为 HBox 渲染器 | -| className | `string` | | 外层 Dom 的类名 | -| columns | `Array` | | 列集合 | -| columns[x] | [Container](#Container) | | 成员可以是其他渲染器 | -| columns[x].columnClassName | `string` | `"wrapper-xs"` | 列上类名 | +| 属性名 | 类型 | 默认值 | 说明 | +| -------------------------- | --------------------------------- | -------------- | -------------------- | +| type | `string` | `"hbox"` | 指定为 HBox 渲染器 | +| className | `string` | | 外层 Dom 的类名 | +| columns | `Array` | | 列集合 | +| columns[x] | [Container](./Types.md#Container) | | 成员可以是其他渲染器 | +| columns[x].columnClassName | `string` | `"wrapper-xs"` | 列上类名 | ```schema:height="300" scope="body" [ diff --git a/docs/renderers/List.md b/docs/renderers/List.md index 4881a2508..c6b3706e5 100644 --- a/docs/renderers/List.md +++ b/docs/renderers/List.md @@ -2,24 +2,24 @@ 列表展示。 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------------------ | ---------------------------- | --------------------- | -------------------------------------- | -| type | `string` | | `"list"` 指定为列表展示。 | -| title | `string` | | 标题 | -| source | `string` | `${items}` | 数据源, 绑定当前环境变量 | -| placeholder | string | ‘暂无数据’ | 当没数据的时候的文字提示 | -| className | `string` | | 外层 CSS 类名 | -| headerClassName | `string` | `amis-list-header` | 顶部外层 CSS 类名 | -| footerClassName | `string` | `amis-list-footer` | 底部外层 CSS 类名 | -| listItem | `Array` | | 配置单条信息 | -| listItem.title | `string` | | 标题，支持模板语法如： \${xxx} | -| listItem.titleClassName | `string` | `h5` | 标题 CSS 类名 | -| listItem.subTitle | `string` | | 副标题，支持模板语法如： \${xxx} | -| listItem.avatar | `string` | | 图片地址，支持模板语法如： \${xxx} | -| listItem.avatarClassName | `string` | `thumb-sm avatar m-r` | 图片 CSS 类名 | -| listItem.desc | `string` | | 描述，支持模板语法如： \${xxx} | -| listItem.body | `Array` 或者 [Field](#field) | | 内容容器，主要用来放置 [Field](#field) | -| listItem.actions | Array Of [Button](#button) | | 按钮区域 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------------------ | -------------------------------- | --------------------- | ------------------------------------------ | +| type | `string` | | `"list"` 指定为列表展示。 | +| title | `string` | | 标题 | +| source | `string` | `${items}` | 数据源, 绑定当前环境变量 | +| placeholder | string | ‘暂无数据’ | 当没数据的时候的文字提示 | +| className | `string` | | 外层 CSS 类名 | +| headerClassName | `string` | `amis-list-header` | 顶部外层 CSS 类名 | +| footerClassName | `string` | `amis-list-footer` | 底部外层 CSS 类名 | +| listItem | `Array` | | 配置单条信息 | +| listItem.title | `string` | | 标题，支持模板语法如： \${xxx} | +| listItem.titleClassName | `string` | `h5` | 标题 CSS 类名 | +| listItem.subTitle | `string` | | 副标题，支持模板语法如： \${xxx} | +| listItem.avatar | `string` | | 图片地址，支持模板语法如： \${xxx} | +| listItem.avatarClassName | `string` | `thumb-sm avatar m-r` | 图片 CSS 类名 | +| listItem.desc | `string` | | 描述，支持模板语法如： \${xxx} | +| listItem.body | `Array` 或者 [Field](./Field.md) | | 内容容器，主要用来放置 [Field](./Field.md) | +| listItem.actions | Array Of [Button](./Button.md) | | 按钮区域 | ```schema:height="400" scope="body" { diff --git a/docs/renderers/Operation.md b/docs/renderers/Operation.md index 63d64dae4..480ea6e47 100644 --- a/docs/renderers/Operation.md +++ b/docs/renderers/Operation.md @@ -4,4 +4,4 @@ - `type` 请设置成 `operation`。 - `label` 列标题。 -- `buttons` 按钮集合，请参考[Button](#button) 按钮配置说明。 +- `buttons` 按钮集合，请参考[Button](./Button.md) 按钮配置说明。 diff --git a/docs/renderers/Panel.md b/docs/renderers/Panel.md index 07869fb6a..bb0848097 100644 --- a/docs/renderers/Panel.md +++ b/docs/renderers/Panel.md @@ -2,19 +2,19 @@ 可以把相关信息以盒子的形式展示到一块。 -| 属性名 | 类型 | 默认值 | 说明 | -| ---------------- | -------------------------- | -------------------------------------- | ------------------- | -| 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 | `string` | | 标题 | -| header | [Container](#container) | | 顶部容器 | -| body | [Container](#container) | | 内容容器 | -| footer | [Container](#container) | | 底部容器 | -| actions | Array Of [Button](#button) | | 按钮区域 | +| 属性名 | 类型 | 默认值 | 说明 | +| ---------------- | ------------------------------ | -------------------------------------- | ------------------- | +| 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 | `string` | | 标题 | +| header | [Container](#container) | | 顶部容器 | +| body | [Container](#container) | | 内容容器 | +| footer | [Container](#container) | | 底部容器 | +| actions | Array Of [Button](./Button.md) | | 按钮区域 | ```schema:height="300" scope="body" { diff --git a/docs/renderers/Static.md b/docs/renderers/Static.md index 8aef7fc82..6f7de4bee 100644 --- a/docs/renderers/Static.md +++ b/docs/renderers/Static.md @@ -31,7 +31,7 @@ - `type` 请设置成 `static-tpl`、`static-plain`、`static-json`、`static-date`、`static-datetime`、`static-time`、`static-mapping`、`static-image`、`static-progress`、`static-status`或者`static-switch` -纯用来展示数据的，用法跟 crud 里面的[Column](#column)一样, 且支持 quickEdit 和 popOver 功能。 +纯用来展示数据的，用法跟 crud 里面的[Column](.Column.md)一样, 且支持 quickEdit 和 popOver 功能。 ```schema:height="250" scope="form-item" { diff --git a/docs/renderers/Table.md b/docs/renderers/Table.md index 7add1a20b..f0617090d 100644 --- a/docs/renderers/Table.md +++ b/docs/renderers/Table.md @@ -2,20 +2,20 @@ 表格展示。 -| 属性名 | 类型 | 默认值 | 说明 | -| ---------------- | -------------------------- | ------------------------ | ------------------------------------------------------- | -| type | `string` | | `"table"` 指定为 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` | `crud-table-header` | 顶部外层 CSS 类名 | -| footerClassName | `string` | `crud-table-footer` | 底部外层 CSS 类名 | -| toolbarClassName | `string` | `crud-table-toolbar` | 工具栏 CSS 类名 | -| columns | Array of [Column](#column) | | 用来设置列信息 | +| 属性名 | 类型 | 默认值 | 说明 | +| ---------------- | ----------------------------- | ------------------------ | ------------------------------------------------------- | +| type | `string` | | `"table"` 指定为 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` | `crud-table-header` | 顶部外层 CSS 类名 | +| footerClassName | `string` | `crud-table-footer` | 底部外层 CSS 类名 | +| toolbarClassName | `string` | `crud-table-toolbar` | 工具栏 CSS 类名 | +| columns | Array of [Column](.Column.md) | | 用来设置列信息 | ```schema:height="700" scope="body" { From eac71b04e6b97b6948f3c5ecf272741f2fe32556 Mon Sep 17 00:00:00 2001 From: SIMDD Date: Thu, 9 May 2019 21:39:29 +0800 Subject: [PATCH 0013/1953] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20[Contain?= =?UTF-8?q?er](#container)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers/Chart.md | 20 ++++++++++---------- docs/renderers/FormItem-Panel.md | 4 ++-- docs/renderers/Panel.md | 26 +++++++++++++------------- docs/renderers/Service.md | 24 ++++++++++++------------ docs/renderers/Wrapper.md | 12 ++++++------ 5 files changed, 43 insertions(+), 43 deletions(-) diff --git a/docs/renderers/Chart.md b/docs/renderers/Chart.md index 91d8e6d3d..88b35bb0e 100644 --- a/docs/renderers/Chart.md +++ b/docs/renderers/Chart.md @@ -2,16 +2,16 @@ 图表渲染器，采用 echarts 渲染，配置格式跟 echarts 相同，配置文档[文档](http://echarts.baidu.com/option.html#title) -| 属性名 | 类型 | 默认值 | 说明 | -| --------- | ----------------------- | --------- | ------------------------------------------------------------------ | -| type | `string` | `"chart"` | 指定为 chart 渲染器 | -| className | `string` | | 外层 Dom 的类名 | -| body | [Container](#container) | | 内容容器 | -| api | [api](#api) | | 配置项远程地址 | -| initFetch | `boolean` | | 是否默认拉取 | -| interval | `number` | | 刷新时间(最低 3000) | -| config | `object/string` | | 设置 eschars 的配置项,当为`string`的时候可以设置 function 等配置项 | -| style | `object` | | 设置根元素的 style | +| 属性名 | 类型 | 默认值 | 说明 | +| --------- | --------------------------------- | --------- | ------------------------------------------------------------------ | +| type | `string` | `"chart"` | 指定为 chart 渲染器 | +| className | `string` | | 外层 Dom 的类名 | +| body | [Container](./Types.md#container) | | 内容容器 | +| api | [api](#api) | | 配置项远程地址 | +| initFetch | `boolean` | | 是否默认拉取 | +| interval | `number` | | 刷新时间(最低 3000) | +| config | `object/string` | | 设置 eschars 的配置项,当为`string`的时候可以设置 function 等配置项 | +| style | `object` | | 设置根元素的 style | ```schema:height="350" scope="body" { diff --git a/docs/renderers/FormItem-Panel.md b/docs/renderers/FormItem-Panel.md index b021dc648..e719b1ce6 100644 --- a/docs/renderers/FormItem-Panel.md +++ b/docs/renderers/FormItem-Panel.md @@ -3,9 +3,9 @@ 还是为了布局，可以把一部分 [FormItem](#formItem) 合并到一个 panel 里面单独展示。 - `title` panel 标题 -- `body` [Container](#container) 可以是其他渲染模型。 +- `body` [Container](./Types.md#container) 可以是其他渲染模型。 - `bodyClassName` body 的 className. -- `footer` [Container](#container) 可以是其他渲染模型。 +- `footer` [Container](./Types.md#container) 可以是其他渲染模型。 - `footerClassName` footer 的 className. - `controls` 跟 `body` 二选一，如果设置了 controls 优先显示表单集合。 diff --git a/docs/renderers/Panel.md b/docs/renderers/Panel.md index bb0848097..fdea918e6 100644 --- a/docs/renderers/Panel.md +++ b/docs/renderers/Panel.md @@ -2,19 +2,19 @@ 可以把相关信息以盒子的形式展示到一块。 -| 属性名 | 类型 | 默认值 | 说明 | -| ---------------- | ------------------------------ | -------------------------------------- | ------------------- | -| 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 | `string` | | 标题 | -| header | [Container](#container) | | 顶部容器 | -| body | [Container](#container) | | 内容容器 | -| footer | [Container](#container) | | 底部容器 | -| actions | Array Of [Button](./Button.md) | | 按钮区域 | +| 属性名 | 类型 | 默认值 | 说明 | +| ---------------- | --------------------------------- | -------------------------------------- | ------------------- | +| 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 | `string` | | 标题 | +| header | [Container](./Types.md#container) | | 顶部容器 | +| body | [Container](./Types.md#container) | | 内容容器 | +| footer | [Container](./Types.md#container) | | 底部容器 | +| actions | Array Of [Button](./Button.md) | | 按钮区域 | ```schema:height="300" scope="body" { diff --git a/docs/renderers/Service.md b/docs/renderers/Service.md index ba9718b77..2c06326e2 100644 --- a/docs/renderers/Service.md +++ b/docs/renderers/Service.md @@ -4,18 +4,18 @@ 该组件初始化时就会自动拉取一次数据，后续如果需要刷新，请结合 Action 实现，可以把 Action 的 actionType 设置为 reload, target 为该组件的 name 值。 同时该组件，还支持 api 数值自动监听，比如 `getData?type=$type` 只要当前环境 type 值发生变化，就会自动重新拉取。 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------------- | ----------------------- | ----------- | ----------------------------------------- | -| type | `string` | `"service"` | 指定为 service 渲染器 | -| className | `string` | | 外层 Dom 的类名 | -| body | [Container](#container) | | 内容容器 | -| api | [api](#api) | | 数据源 API 地址 | -| initFetch | `boolean` | | 是否默认拉取 | -| schemaApi | [api](#api) | | 用来获取远程 Schema 的 api | -| initFetchSchema | `boolean` | | 是否默认拉取 Schema | -| interval | `number` | `3000` | 刷新时间(最低 3000) | -| silentPolling | `boolean` | `false` | 配置刷新时是否显示加载动画 | -| stopAutoRefreshWhen | `string` | `""` | 通过[表达式](#表达式)来配置停止刷新的条件 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------------- | --------------------------------- | ----------- | ----------------------------------------- | +| type | `string` | `"service"` | 指定为 service 渲染器 | +| className | `string` | | 外层 Dom 的类名 | +| body | [Container](./Types.md#container) | | 内容容器 | +| api | [api](#api) | | 数据源 API 地址 | +| initFetch | `boolean` | | 是否默认拉取 | +| schemaApi | [api](#api) | | 用来获取远程 Schema 的 api | +| initFetchSchema | `boolean` | | 是否默认拉取 Schema | +| interval | `number` | `3000` | 刷新时间(最低 3000) | +| silentPolling | `boolean` | `false` | 配置刷新时是否显示加载动画 | +| stopAutoRefreshWhen | `string` | `""` | 通过[表达式](#表达式)来配置停止刷新的条件 | ```schema:height="200" scope="body" { diff --git a/docs/renderers/Wrapper.md b/docs/renderers/Wrapper.md index 01cce914f..f1dd53c47 100644 --- a/docs/renderers/Wrapper.md +++ b/docs/renderers/Wrapper.md @@ -2,12 +2,12 @@ 简单的一个容器。 -| 属性名 | 类型 | 默认值 | 说明 | -| --------- | ----------------------- | ----------- | ---------------------------- | -| type | `string` | `"wrapper"` | 指定为 Wrapper 渲染器 | -| className | `string` | | 外层 Dom 的类名 | -| size | `string` | | 支持: `xs`、`sm`、`md`和`lg` | -| body | [Container](#container) | | 内容容器 | +| 属性名 | 类型 | 默认值 | 说明 | +| --------- | --------------------------------- | ----------- | ---------------------------- | +| type | `string` | `"wrapper"` | 指定为 Wrapper 渲染器 | +| className | `string` | | 外层 Dom 的类名 | +| size | `string` | | 支持: `xs`、`sm`、`md`和`lg` | +| body | [Container](./Types.md#container) | | 内容容器 | ```schema:height="200" scope="body" { From b92855ecc6bb7e0821c287a3bebddb2687cd5034 Mon Sep 17 00:00:00 2001 From: SIMDD Date: Thu, 9 May 2019 21:42:07 +0800 Subject: [PATCH 0014/1953] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20[Form](#?= =?UTF-8?q?form)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers/CRUD.md | 2 +- docs/renderers/FieldSet.md | 2 +- docs/renderers/Group.md | 2 +- docs/renderers/Wizard.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/renderers/CRUD.md b/docs/renderers/CRUD.md index 0b267eec0..89fb91ac1 100644 --- a/docs/renderers/CRUD.md +++ b/docs/renderers/CRUD.md @@ -11,7 +11,7 @@ CRUD 支持三种模式：`table`、`cards`、`list`，默认为 `table`。 | title | `string` | `""` | 可设置成空，当设置成空时，没有标题栏 | | className | `string` | | 表格外层 Dom 的类名 | | api | [Api](#api) | | CRUD 用来获取列表数据的 api。 | -| filter | [Form](#form) | | 设置过滤器，当该表单提交后，会把数据带给当前 crud 刷新列表。 | +| filter | [Form](./Form.md) | | 设置过滤器，当该表单提交后，会把数据带给当前 crud 刷新列表。 | | initFetch | `boolean` | `true` | 是否初始化的时候拉取数据, 只针对有 filter 的情况, 没有 filter 初始都会拉取数据 | | interval | `number` | `3000` | 刷新时间(最低 3000) | | silentPolling | `boolean` | `false` | 配置刷新时是否显示加载动画 | diff --git a/docs/renderers/FieldSet.md b/docs/renderers/FieldSet.md index 9edd12c3a..88fa3bedc 100644 --- a/docs/renderers/FieldSet.md +++ b/docs/renderers/FieldSet.md @@ -5,7 +5,7 @@ - `type` 请设置成 `fieldSet` - `title` 标题 - `controls` 表单项集合。 -- `mode` 展示默认，跟 [Form](#form) 中的模式一样，选择： `normal`、`horizontal`或者`inline`。 +- `mode` 展示默认，跟 [Form](./Form.md) 中的模式一样，选择： `normal`、`horizontal`或者`inline`。 - `horizontal` 当为水平模式时，用来控制左右占比。 - `horizontal.label` 左边 label 的宽度占比。 - `horizontal.right` 右边控制器的宽度占比。 diff --git a/docs/renderers/Group.md b/docs/renderers/Group.md index 3af820856..b44be91fa 100644 --- a/docs/renderers/Group.md +++ b/docs/renderers/Group.md @@ -4,7 +4,7 @@ - `type` 请设置成 `group` - `controls` 表单项集合。 -- `mode` 展示默认，跟 [Form](#form) 中的模式一样，选择： `normal`、`horizontal`或者`inline`。 +- `mode` 展示默认，跟 [Form](./Form.md) 中的模式一样，选择： `normal`、`horizontal`或者`inline`。 - `horizontal` 当为水平模式时，用来控制左右占比。 - `horizontal.label` 左边 label 的宽度占比。 - `horizontal.right` 右边控制器的宽度占比。 diff --git a/docs/renderers/Wizard.md b/docs/renderers/Wizard.md index 9a254ade3..809fafa19 100644 --- a/docs/renderers/Wizard.md +++ b/docs/renderers/Wizard.md @@ -19,7 +19,7 @@ - `target` 可以把数据提交给别的组件而不是自己保存。请填写目标组件设置的 name 值，如果填写为 `window` 则把数据同步到地址栏上，同时依赖这些数据的组件会自动重新刷新。 - `steps` 数组，配置步骤信息。 - `steps[x].title` 步骤标题。 -- `steps[x].mode` 展示默认，跟 [Form](#form) 中的模式一样，选择： `normal`、`horizontal`或者`inline`。 +- `steps[x].mode` 展示默认，跟 [Form](./Form.md) 中的模式一样，选择： `normal`、`horizontal`或者`inline`。 - `steps[x].horizontal` 当为水平模式时，用来控制左右占比。 - `steps[x].horizontal.label` 左边 label 的宽度占比。 - `steps[x].horizontal.right` 右边控制器的宽度占比。 From 8ba359c7780394c6d8de9f89ef0ba3f9e6958af6 Mon Sep 17 00:00:00 2001 From: SIMDD Date: Thu, 9 May 2019 21:43:25 +0800 Subject: [PATCH 0015/1953] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20[Api](#a?= =?UTF-8?q?pi)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers/Action.md | 2 +- docs/renderers/Chart.md | 2 +- docs/renderers/FormItem-Table.md | 6 +++--- docs/renderers/Service.md | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/renderers/Action.md b/docs/renderers/Action.md index 01956e4ff..ecb75cb17 100644 --- a/docs/renderers/Action.md +++ b/docs/renderers/Action.md @@ -4,7 +4,7 @@ Action 是一种特殊的渲染器，它本身是一个按钮，同时它能触 - `type` 指定为 `button`。 - `actionType` 【必填】 选项：`ajax`、`link`、`url`、`dawer`、`dialog`、`confirm`、`cancel`、`prev`、`next`、`copy` 或者 `close`。 -- `api` 当 `actionType` 为 `ajax` 时，必须指定，参考 [api](#api) 格式说明。 +- `api` 当 `actionType` 为 `ajax` 时，必须指定，参考 [api](./Types.md#Api) 格式说明。 - `link` 当 `actionType` 为 `link` 时必须指定，用来指定跳转地址，跟 url 不同的是，这是单页跳转方式，不会渲染浏览器，请指定 AMis 平台内的页面。 - `url` 当 `actionType` 为 `url` 时必须指定，按钮点击后，会打开指定页面。 - `blank` 当 `actionType` 为 `url` 时可选，如果为 false 将在本页面打开。 diff --git a/docs/renderers/Chart.md b/docs/renderers/Chart.md index 88b35bb0e..ca38999da 100644 --- a/docs/renderers/Chart.md +++ b/docs/renderers/Chart.md @@ -7,7 +7,7 @@ | type | `string` | `"chart"` | 指定为 chart 渲染器 | | className | `string` | | 外层 Dom 的类名 | | body | [Container](./Types.md#container) | | 内容容器 | -| api | [api](#api) | | 配置项远程地址 | +| api | [api](./Types.md#Api) | | 配置项远程地址 | | initFetch | `boolean` | | 是否默认拉取 | | interval | `number` | | 刷新时间(最低 3000) | | config | `object/string` | | 设置 eschars 的配置项,当为`string`的时候可以设置 function 等配置项 | diff --git a/docs/renderers/FormItem-Table.md b/docs/renderers/FormItem-Table.md index 26e3dda56..9fb7e8467 100644 --- a/docs/renderers/FormItem-Table.md +++ b/docs/renderers/FormItem-Table.md @@ -54,9 +54,9 @@ | addable | `boolean` | false | 是否可增加一行 | | editable | `boolean` | false | 是否可编辑 | | removable | `boolean` | false | 是否可删除 | -| addApi | [api](#api) | - | 新增时提交的 API | -| updateApi | [api](#api) | - | 修改时提交的 API | -| deleteApi | [api](#api) | - | 删除时提交的 API | +| addApi | [api](./Types.md#Api) | - | 新增时提交的 API | +| updateApi | [api](./Types.md#Api) | - | 修改时提交的 API | +| deleteApi | [api](./Types.md#Api) | - | 删除时提交的 API | | addBtnLabel | `string` | | 增加按钮名称 | | addBtnIcon | `string` | `"fa fa-plus"` | 增加按钮图标 | | updateBtnLabel | `string` | `""` | 更新按钮名称 | diff --git a/docs/renderers/Service.md b/docs/renderers/Service.md index 2c06326e2..e2e9f3f7a 100644 --- a/docs/renderers/Service.md +++ b/docs/renderers/Service.md @@ -9,9 +9,9 @@ | type | `string` | `"service"` | 指定为 service 渲染器 | | className | `string` | | 外层 Dom 的类名 | | body | [Container](./Types.md#container) | | 内容容器 | -| api | [api](#api) | | 数据源 API 地址 | +| api | [api](./Types.md#Api) | | 数据源 API 地址 | | initFetch | `boolean` | | 是否默认拉取 | -| schemaApi | [api](#api) | | 用来获取远程 Schema 的 api | +| schemaApi | [api](./Types.md#Api) | | 用来获取远程 Schema 的 api | | initFetchSchema | `boolean` | | 是否默认拉取 Schema | | interval | `number` | `3000` | 刷新时间(最低 3000) | | silentPolling | `boolean` | `false` | 配置刷新时是否显示加载动画 | From da36626676486ce5f2a41860b0549434313a3717 Mon Sep 17 00:00:00 2001 From: SIMDD Date: Thu, 9 May 2019 21:45:28 +0800 Subject: [PATCH 0016/1953] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20[?= =?UTF-8?q?=E8=A1=A8=E8=BE=BE=E5=BC=8F](#=E8=A1=A8=E8=BE=BE=E5=BC=8F)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers/CRUD.md | 4 ++-- docs/renderers/Service.md | 24 ++++++++++++------------ docs/renderers/Static.md | 4 ++-- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/renderers/CRUD.md b/docs/renderers/CRUD.md index 89fb91ac1..021fa2621 100644 --- a/docs/renderers/CRUD.md +++ b/docs/renderers/CRUD.md @@ -15,10 +15,10 @@ CRUD 支持三种模式：`table`、`cards`、`list`，默认为 `table`。 | initFetch | `boolean` | `true` | 是否初始化的时候拉取数据, 只针对有 filter 的情况, 没有 filter 初始都会拉取数据 | | interval | `number` | `3000` | 刷新时间(最低 3000) | | silentPolling | `boolean` | `false` | 配置刷新时是否显示加载动画 | -| stopAutoRefreshWhen | `string` | `""` | 通过[表达式](#表达式)来配置停止刷新的条件 | +| stopAutoRefreshWhen | `string` | `""` | 通过[表达式](./Types.md#表达式)来配置停止刷新的条件 | | syncLocation | `boolean` | `true` | 是否将过滤条件的参数同步到地址栏 | | draggable | `boolean` | `false` | 是否可通过拖拽排序 | -| itemDraggableOn | `boolean` | | 用[表达式](#表达式)来配置是否可拖拽排序 | +| itemDraggableOn | `boolean` | | 用[表达式](./Types.md#表达式)来配置是否可拖拽排序 | | saveOrderApi | [Api](#api) | | 保存排序的 api。 | | quickSaveApi | [Api](#api) | | 快速编辑后用来批量保存的 API。 | | quickSaveItemApi | [Api](#api) | | 快速编辑配置成及时保存时使用的 API。 | diff --git a/docs/renderers/Service.md b/docs/renderers/Service.md index e2e9f3f7a..77e8baa51 100644 --- a/docs/renderers/Service.md +++ b/docs/renderers/Service.md @@ -4,18 +4,18 @@ 该组件初始化时就会自动拉取一次数据，后续如果需要刷新，请结合 Action 实现，可以把 Action 的 actionType 设置为 reload, target 为该组件的 name 值。 同时该组件，还支持 api 数值自动监听，比如 `getData?type=$type` 只要当前环境 type 值发生变化，就会自动重新拉取。 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------------- | --------------------------------- | ----------- | ----------------------------------------- | -| type | `string` | `"service"` | 指定为 service 渲染器 | -| className | `string` | | 外层 Dom 的类名 | -| body | [Container](./Types.md#container) | | 内容容器 | -| api | [api](./Types.md#Api) | | 数据源 API 地址 | -| initFetch | `boolean` | | 是否默认拉取 | -| schemaApi | [api](./Types.md#Api) | | 用来获取远程 Schema 的 api | -| initFetchSchema | `boolean` | | 是否默认拉取 Schema | -| interval | `number` | `3000` | 刷新时间(最低 3000) | -| silentPolling | `boolean` | `false` | 配置刷新时是否显示加载动画 | -| stopAutoRefreshWhen | `string` | `""` | 通过[表达式](#表达式)来配置停止刷新的条件 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------------- | --------------------------------- | ----------- | --------------------------------------------------- | +| type | `string` | `"service"` | 指定为 service 渲染器 | +| className | `string` | | 外层 Dom 的类名 | +| body | [Container](./Types.md#container) | | 内容容器 | +| api | [api](./Types.md#Api) | | 数据源 API 地址 | +| initFetch | `boolean` | | 是否默认拉取 | +| schemaApi | [api](./Types.md#Api) | | 用来获取远程 Schema 的 api | +| initFetchSchema | `boolean` | | 是否默认拉取 Schema | +| interval | `number` | `3000` | 刷新时间(最低 3000) | +| silentPolling | `boolean` | `false` | 配置刷新时是否显示加载动画 | +| stopAutoRefreshWhen | `string` | `""` | 通过[表达式](./Types.md#表达式)来配置停止刷新的条件 | ```schema:height="200" scope="body" { diff --git a/docs/renderers/Static.md b/docs/renderers/Static.md index 6f7de4bee..d83d314fe 100644 --- a/docs/renderers/Static.md +++ b/docs/renderers/Static.md @@ -11,9 +11,9 @@ - `inline` 是否为 inline 模式。 - `className` 表单最外层类名。 - `visible` 是否可见。 -- `visibleOn` 通过[表达式](#表达式)来配置当前表单项是否显示。 +- `visibleOn` 通过[表达式](./Types.md#表达式)来配置当前表单项是否显示。 - `hidden` 是否隐藏，不要跟 `visible` `visibleOn` 同时配置 -- `hiddenOn` 通过[表达式](#表达式)来配置当前表单项是否隐藏。 +- `hiddenOn` 通过[表达式](./Types.md#表达式)来配置当前表单项是否隐藏。 - `inputClassName` 表单控制器类名。 - `labelClassName` label 的类名。 - `tpl` 如果想一次展示多条数据，可以考虑用 `tpl`，模板引擎是 lodash template，同时你还可以简单用 `$` 取值。 具体请查看 [tpl](#tpl) From a3fd13d3e9fc9c3048046adc32d8c60947eeccfa Mon Sep 17 00:00:00 2001 From: SIMDD Date: Thu, 9 May 2019 21:47:03 +0800 Subject: [PATCH 0017/1953] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20[Api](#a?= =?UTF-8?q?pi)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers/CRUD.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/renderers/CRUD.md b/docs/renderers/CRUD.md index 021fa2621..157b882d9 100644 --- a/docs/renderers/CRUD.md +++ b/docs/renderers/CRUD.md @@ -10,7 +10,7 @@ CRUD 支持三种模式：`table`、`cards`、`list`，默认为 `table`。 | mode | `string` | `"table"` | `"table" 、 "cards" 或者 "list"` | | title | `string` | `""` | 可设置成空，当设置成空时，没有标题栏 | | className | `string` | | 表格外层 Dom 的类名 | -| api | [Api](#api) | | CRUD 用来获取列表数据的 api。 | +| api | [Api](./Types#Api) | | CRUD 用来获取列表数据的 api。 | | filter | [Form](./Form.md) | | 设置过滤器，当该表单提交后，会把数据带给当前 crud 刷新列表。 | | initFetch | `boolean` | `true` | 是否初始化的时候拉取数据, 只针对有 filter 的情况, 没有 filter 初始都会拉取数据 | | interval | `number` | `3000` | 刷新时间(最低 3000) | @@ -19,9 +19,9 @@ CRUD 支持三种模式：`table`、`cards`、`list`，默认为 `table`。 | syncLocation | `boolean` | `true` | 是否将过滤条件的参数同步到地址栏 | | draggable | `boolean` | `false` | 是否可通过拖拽排序 | | itemDraggableOn | `boolean` | | 用[表达式](./Types.md#表达式)来配置是否可拖拽排序 | -| saveOrderApi | [Api](#api) | | 保存排序的 api。 | -| quickSaveApi | [Api](#api) | | 快速编辑后用来批量保存的 API。 | -| quickSaveItemApi | [Api](#api) | | 快速编辑配置成及时保存时使用的 API。 | +| saveOrderApi | [Api](./Types#Api) | | 保存排序的 api。 | +| quickSaveApi | [Api](./Types#Api) | | 快速编辑后用来批量保存的 API。 | +| quickSaveItemApi | [Api](./Types#Api) | | 快速编辑配置成及时保存时使用的 API。 | | bulkActions | Array Of [Action](#action) | | 批量操作列表，配置后，表格可进行选中操作。 | | defaultChecked | `boolean` | `false` | 当可批量操作时，默认是否全部勾选。 | | messages | `Object` | | 覆盖消息提示，如果不指定，将采用 api 返回的 message | From f1b9e1c3ea9c2ba22070000d22b5f5dffe72ac42 Mon Sep 17 00:00:00 2001 From: SIMDD Date: Thu, 9 May 2019 21:50:34 +0800 Subject: [PATCH 0018/1953] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20?= =?UTF-8?q?=E5=89=A9=E4=BD=99=E7=9A=84=E5=AD=97=E6=AE=B5=E4=BF=AE=E6=94=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers/Action.md | 4 +- docs/renderers/Array.md | 2 +- docs/renderers/Button.md | 2 +- docs/renderers/CRUD-Cards.md | 2 +- docs/renderers/CRUD-List.md | 2 +- docs/renderers/CRUD-Table.md | 2 +- docs/renderers/CRUD.md | 66 ++++++++++++++++---------------- docs/renderers/Dialog.md | 4 +- docs/renderers/Drawer.md | 4 +- docs/renderers/FormItem-HBox.md | 2 +- docs/renderers/FormItem-Panel.md | 2 +- docs/renderers/FormItem-Table.md | 2 +- docs/renderers/NestedSelect.md | 2 +- docs/renderers/Picker.md | 2 +- docs/renderers/Static.md | 2 +- docs/renderers/SubForm.md | 2 +- docs/renderers/Tpl.md | 2 +- docs/renderers/Tree.md | 2 +- docs/renderers/TreeSelect.md | 2 +- docs/renderers/Types.md | 2 +- docs/renderers/Wizard.md | 2 +- 21 files changed, 56 insertions(+), 56 deletions(-) diff --git a/docs/renderers/Action.md b/docs/renderers/Action.md index ecb75cb17..986944cb7 100644 --- a/docs/renderers/Action.md +++ b/docs/renderers/Action.md @@ -69,7 +69,7 @@ Action 是一种特殊的渲染器，它本身是一个按钮，同时它能触 } ``` -- `dialog` 当按钮点击后，弹出一个对话框。 关于 dialog 配置，请查看 [Dialog 模型](#dialog)。 +- `dialog` 当按钮点击后，弹出一个对话框。 关于 dialog 配置，请查看 [Dialog 模型](./dialog.md)。 ```schema:height="200" { @@ -96,7 +96,7 @@ Action 是一种特殊的渲染器，它本身是一个按钮，同时它能触 } ``` -- `drawer` 当按钮点击后，弹出一个抽出式对话框。 关于 drawer 配置，请查看 [Drawer 模型](#drawer)。 +- `drawer` 当按钮点击后，弹出一个抽出式对话框。 关于 drawer 配置，请查看 [Drawer 模型](./drawer.md)。 ```schema:height="200" { diff --git a/docs/renderers/Array.md b/docs/renderers/Array.md index fdc2fd113..aad316871 100644 --- a/docs/renderers/Array.md +++ b/docs/renderers/Array.md @@ -2,7 +2,7 @@ 数组输入框配置 -其实就是 [Combo](#combo) 的一个 flat 用法。 +其实就是 [Combo](./combo.md) 的一个 flat 用法。 - `type` 请设置成 `array` - `items` 配置单项表单类型 diff --git a/docs/renderers/Button.md b/docs/renderers/Button.md index a93d88d93..b9108d985 100644 --- a/docs/renderers/Button.md +++ b/docs/renderers/Button.md @@ -9,7 +9,7 @@ - `size` 按钮大小。 包含： `xs`、`sm`、`md`和`lg` - `className` 按钮的类名。 -如果按钮是 `button` 类型，则还需要配置 [Action](#action) 中定义的属性，否则，AMis 不知道如何响应当前按钮点击。 +如果按钮是 `button` 类型，则还需要配置 [Action](./action.md) 中定义的属性，否则，AMis 不知道如何响应当前按钮点击。 ```schema:height="300" scope="form" [ diff --git a/docs/renderers/CRUD-Cards.md b/docs/renderers/CRUD-Cards.md index ecda150a5..e82fb8646 100644 --- a/docs/renderers/CRUD-Cards.md +++ b/docs/renderers/CRUD-Cards.md @@ -1,6 +1,6 @@ ### Cards(CRUD) -请参考[Cards](#cards) +请参考[Cards](./Cards.md) ```schema:height="800" scope="body" { diff --git a/docs/renderers/CRUD-List.md b/docs/renderers/CRUD-List.md index 11bca5f6d..48f71bd60 100644 --- a/docs/renderers/CRUD-List.md +++ b/docs/renderers/CRUD-List.md @@ -1,6 +1,6 @@ ### List(CRUD) -请参考[List](#list) +请参考[List](./list.md) ```schema:height="800" scope="body" { diff --git a/docs/renderers/CRUD-Table.md b/docs/renderers/CRUD-Table.md index f79bb0935..a55f7e0c4 100644 --- a/docs/renderers/CRUD-Table.md +++ b/docs/renderers/CRUD-Table.md @@ -1,6 +1,6 @@ ### Table(CRUD) -在 CRUD 中的 Table 主要增加了 Column 里面的以下配置功能，更多参数，请参考[Table](#table) +在 CRUD 中的 Table 主要增加了 Column 里面的以下配置功能，更多参数，请参考[Table](./Table.md) - `sortable` 开启后可以根据当前列排序(后端排序)。 diff --git a/docs/renderers/CRUD.md b/docs/renderers/CRUD.md index 157b882d9..abcceca9b 100644 --- a/docs/renderers/CRUD.md +++ b/docs/renderers/CRUD.md @@ -4,36 +4,36 @@ CRUD 支持三种模式：`table`、`cards`、`list`，默认为 `table`。 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------------------- | -------------------------- | ------------------------------- | ----------------------------------------------------------------------------------------- | -| type | `string` | | `"crud"` 指定为 CRUD 渲染器 | -| mode | `string` | `"table"` | `"table" 、 "cards" 或者 "list"` | -| title | `string` | `""` | 可设置成空，当设置成空时，没有标题栏 | -| className | `string` | | 表格外层 Dom 的类名 | -| api | [Api](./Types#Api) | | CRUD 用来获取列表数据的 api。 | -| filter | [Form](./Form.md) | | 设置过滤器，当该表单提交后，会把数据带给当前 crud 刷新列表。 | -| initFetch | `boolean` | `true` | 是否初始化的时候拉取数据, 只针对有 filter 的情况, 没有 filter 初始都会拉取数据 | -| interval | `number` | `3000` | 刷新时间(最低 3000) | -| silentPolling | `boolean` | `false` | 配置刷新时是否显示加载动画 | -| stopAutoRefreshWhen | `string` | `""` | 通过[表达式](./Types.md#表达式)来配置停止刷新的条件 | -| syncLocation | `boolean` | `true` | 是否将过滤条件的参数同步到地址栏 | -| draggable | `boolean` | `false` | 是否可通过拖拽排序 | -| itemDraggableOn | `boolean` | | 用[表达式](./Types.md#表达式)来配置是否可拖拽排序 | -| saveOrderApi | [Api](./Types#Api) | | 保存排序的 api。 | -| quickSaveApi | [Api](./Types#Api) | | 快速编辑后用来批量保存的 API。 | -| quickSaveItemApi | [Api](./Types#Api) | | 快速编辑配置成及时保存时使用的 API。 | -| bulkActions | Array Of [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 一起使用，请看下面例子。 | -| orderField | `string` | | 设置用来确定位置的字段名，设置后新的顺序将被赋值到该字段中。 | -| headerToolbar | Array | `['bulkActions', 'pagination']` | 顶部工具栏配置 | -| footerToolbar | Array | `['statistics', 'pagination']` | 顶部工具栏配置 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------------------- | ------------------------------ | ------------------------------- | ----------------------------------------------------------------------------------------- | +| type | `string` | | `"crud"` 指定为 CRUD 渲染器 | +| mode | `string` | `"table"` | `"table" 、 "cards" 或者 "list"` | +| title | `string` | `""` | 可设置成空，当设置成空时，没有标题栏 | +| className | `string` | | 表格外层 Dom 的类名 | +| api | [Api](./Types#Api) | | CRUD 用来获取列表数据的 api。 | +| filter | [Form](./Form.md) | | 设置过滤器，当该表单提交后，会把数据带给当前 crud 刷新列表。 | +| initFetch | `boolean` | `true` | 是否初始化的时候拉取数据, 只针对有 filter 的情况, 没有 filter 初始都会拉取数据 | +| interval | `number` | `3000` | 刷新时间(最低 3000) | +| silentPolling | `boolean` | `false` | 配置刷新时是否显示加载动画 | +| stopAutoRefreshWhen | `string` | `""` | 通过[表达式](./Types.md#表达式)来配置停止刷新的条件 | +| syncLocation | `boolean` | `true` | 是否将过滤条件的参数同步到地址栏 | +| draggable | `boolean` | `false` | 是否可通过拖拽排序 | +| itemDraggableOn | `boolean` | | 用[表达式](./Types.md#表达式)来配置是否可拖拽排序 | +| saveOrderApi | [Api](./Types#Api) | | 保存排序的 api。 | +| quickSaveApi | [Api](./Types#Api) | | 快速编辑后用来批量保存的 API。 | +| quickSaveItemApi | [Api](./Types#Api) | | 快速编辑配置成及时保存时使用的 API。 | +| bulkActions | Array Of [Action](./action.md) | | 批量操作列表，配置后，表格可进行选中操作。 | +| 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 一起使用，请看下面例子。 | +| orderField | `string` | | 设置用来确定位置的字段名，设置后新的顺序将被赋值到该字段中。 | +| headerToolbar | Array | `['bulkActions', 'pagination']` | 顶部工具栏配置 | +| footerToolbar | Array | `['statistics', 'pagination']` | 顶部工具栏配置 | diff --git a/docs/renderers/Dialog.md b/docs/renderers/Dialog.md index 806f9afaa..c1fea30ac 100644 --- a/docs/renderers/Dialog.md +++ b/docs/renderers/Dialog.md @@ -1,6 +1,6 @@ ### Dialog -Dialog 由 [Action](#action) 触发。他是一个类似于 [Page](#page) 的容器模型。 +Dialog 由 [Action](./action.md) 触发。他是一个类似于 [Page](./page.md) 的容器模型。 | 属性名 | 类型 | 默认值 | 说明 | | ------------- | ----------------------------------------------- | ------------ | ------------------------------------------------ | @@ -11,7 +11,7 @@ Dialog 由 [Action](#action) 触发。他是一个类似于 [Page](#page) 的容 | bodyClassName | `string` | `modal-body` | Dialog body 区域的样式类名 | | closeOnEsc | `boolean` | `false` | 是否支持按 `Esc` 关闭 Dialog | | disabled | `boolean` | `false` | 如果设置此属性，则该 Dialog 只读没有提交操作。 | -| actions | Array Of [Action](#action) | | 可以不设置，默认只有【确认】和【取消】两个按钮。 | +| actions | Array Of [Action](./action.md) | | 可以不设置，默认只有【确认】和【取消】两个按钮。 | ```schema:height="200" { diff --git a/docs/renderers/Drawer.md b/docs/renderers/Drawer.md index 96f758494..20a489137 100644 --- a/docs/renderers/Drawer.md +++ b/docs/renderers/Drawer.md @@ -1,6 +1,6 @@ ### Drawer -Drawer 由 [Action](#action) 触发。 +Drawer 由 [Action](./action.md) 触发。 | 属性名 | 类型 | 默认值 | 说明 | | ------------- | ----------------------------------------------- | ------------ | ------------------------------------------------ | @@ -12,7 +12,7 @@ Drawer 由 [Action](#action) 触发。 | closeOnEsc | `boolean` | `false` | 是否支持按 `Esc` 关闭 Dialog | | overlay | `boolean` | `true` | 是否显示蒙层 | | resizable | `boolean` | `false` | 是否可通过拖拽改变 Drawer 大小 | -| actions | Array Of [Action](#action) | | 可以不设置，默认只有【确认】和【取消】两个按钮。 | +| actions | Array Of [Action](./action.md) | | 可以不设置，默认只有【确认】和【取消】两个按钮。 | ```schema:height="200" { diff --git a/docs/renderers/FormItem-HBox.md b/docs/renderers/FormItem-HBox.md index 0046c6494..c999d60f5 100644 --- a/docs/renderers/FormItem-HBox.md +++ b/docs/renderers/FormItem-HBox.md @@ -1,6 +1,6 @@ ### HBox(FormItem) -支持 form 内部再用 HBox 布局，实现左右排列。没错用 [Group](#group) 也能实现，所以还是推荐用 [Group](#group)。 +支持 form 内部再用 HBox 布局，实现左右排列。没错用 [Group](./group.md) 也能实现，所以还是推荐用 [Group](./group.md)。 - `type` 请设置成 `hbox` - `columns` 数据，用来配置列内容。每个 column 又一个独立的渲染器。 diff --git a/docs/renderers/FormItem-Panel.md b/docs/renderers/FormItem-Panel.md index e719b1ce6..d0382f8fb 100644 --- a/docs/renderers/FormItem-Panel.md +++ b/docs/renderers/FormItem-Panel.md @@ -1,6 +1,6 @@ ### Panel(FormItem) -还是为了布局，可以把一部分 [FormItem](#formItem) 合并到一个 panel 里面单独展示。 +还是为了布局，可以把一部分 [FormItem](./formItem.md) 合并到一个 panel 里面单独展示。 - `title` panel 标题 - `body` [Container](./Types.md#container) 可以是其他渲染模型。 diff --git a/docs/renderers/FormItem-Table.md b/docs/renderers/FormItem-Table.md index 9fb7e8467..bdb488e85 100644 --- a/docs/renderers/FormItem-Table.md +++ b/docs/renderers/FormItem-Table.md @@ -1,6 +1,6 @@ ### Table(FormItem) -可以用来展现数据的,可以用来展示数组类型的数据，比如 multiple 的[子 form](#SubForm)。 +可以用来展现数据的,可以用来展示数组类型的数据，比如 multiple 的[子 form](./SubForm.md)。 - `type` 请设置成 `table` - `columns` 数组类型，用来定义列信息。 diff --git a/docs/renderers/NestedSelect.md b/docs/renderers/NestedSelect.md index 8a1191bbd..5b4777cc7 100644 --- a/docs/renderers/NestedSelect.md +++ b/docs/renderers/NestedSelect.md @@ -3,7 +3,7 @@ 树形结构选择框。 - `type` 请设置成 `nested-select` -- `options` 类似于 [select](#select) 中 `options`, 并且支持通过 `children` 无限嵌套。 +- `options` 类似于 [select](./select.md) 中 `options`, 并且支持通过 `children` 无限嵌套。 - `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。 - `multiple` 默认为 `false`, 设置成 `true` 表示可多选。 - `joinValues` 默认为 `true` diff --git a/docs/renderers/Picker.md b/docs/renderers/Picker.md index 8248485d0..0e2243562 100644 --- a/docs/renderers/Picker.md +++ b/docs/renderers/Picker.md @@ -14,7 +14,7 @@ - `extractValue` 默认为 `false`, `joinValues`设置为`false`时生效, 开启后将选中的选项 value 的值封装为数组，作为当前表单项的值。 - `delimiter` 默认为 `,` - `modalMode` 设置 `dialog` 或者 `drawer`，用来配置弹出方式。 -- `pickerSchema` 默认为 `{mode: 'list', listItem: {title: '${label}'}}`, 即用 List 类型的渲染，来展示列表信息。更多的玩法请参考 [CRUD](#crud) 的配置。 +- `pickerSchema` 默认为 `{mode: 'list', listItem: {title: '${label}'}}`, 即用 List 类型的渲染，来展示列表信息。更多的玩法请参考 [CRUD](./crud.md) 的配置。 - 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="300" scope="form-item" diff --git a/docs/renderers/Static.md b/docs/renderers/Static.md index d83d314fe..be3a64965 100644 --- a/docs/renderers/Static.md +++ b/docs/renderers/Static.md @@ -16,7 +16,7 @@ - `hiddenOn` 通过[表达式](./Types.md#表达式)来配置当前表单项是否隐藏。 - `inputClassName` 表单控制器类名。 - `labelClassName` label 的类名。 -- `tpl` 如果想一次展示多条数据，可以考虑用 `tpl`，模板引擎是 lodash template，同时你还可以简单用 `$` 取值。 具体请查看 [tpl](#tpl) +- `tpl` 如果想一次展示多条数据，可以考虑用 `tpl`，模板引擎是 lodash template，同时你还可以简单用 `$` 取值。 具体请查看 [tpl](./tpl.md) ```schema:height="250" scope="form-item" { diff --git a/docs/renderers/SubForm.md b/docs/renderers/SubForm.md index 88cc31e67..6d472f1d6 100644 --- a/docs/renderers/SubForm.md +++ b/docs/renderers/SubForm.md @@ -12,7 +12,7 @@ formItem 还可以是子表单类型。 - `editButtonClassName` 修改按钮 CSS 类名 默认：`btn-info btn-addon btn-sm`。 - `form` 字表单的配置 `title` 标题 - `controls` 请参考 [Form](#/form) 中的配置说明。 + `controls` 请参考 [Form](./form.md) 中的配置说明。 - 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="400" scope="form" diff --git a/docs/renderers/Tpl.md b/docs/renderers/Tpl.md index 48aa93301..f8bfd9417 100644 --- a/docs/renderers/Tpl.md +++ b/docs/renderers/Tpl.md @@ -75,7 +75,7 @@ tpl 类型的渲染器支持用 JS 模板引擎来组织输出，采用的 lodas - `html2ubb` 我想你应该不需要，贴吧定制的 ubb 格式。 - `split` 可以将字符传通过分隔符分离成数组，默认分隔符为 `,` 如： `${ids|split|last}` 即取一段用逗号分割的数值中的最后一个。 - `nth` 取数组中的第 n 个成员。如： `${ids|split|nth:1}` -- `str2date` 请参考 [date](#date) 中日期默认值的设置格式。 +- `str2date` 请参考 [date](./date.md) 中日期默认值的设置格式。 - `duration` 格式化成时间端如：`2` -=> `2秒` `67` => `1分7秒` `1111111` => `13天21时39分31秒` - `asArray` 将数据包成数组如： `a` => `[a]` - `lowerCase` 转小写 diff --git a/docs/renderers/Tree.md b/docs/renderers/Tree.md index dc7d1037e..5abdef644 100644 --- a/docs/renderers/Tree.md +++ b/docs/renderers/Tree.md @@ -3,7 +3,7 @@ 树形结构输入框。 - `type` 请设置成 `tree` -- `options` 类似于 [select](#select) 中 `options`, 并且支持通过 `children` 无限嵌套。 +- `options` 类似于 [select](./select.md) 中 `options`, 并且支持通过 `children` 无限嵌套。 - `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。 - `hideRoot` 默认是会显示一个顶级，如果不想显示，请设置 `false` - `rootLabel` 默认为 `顶级`，当 hideRoot 不为 `false` 时有用，用来设置顶级节点的文字。 diff --git a/docs/renderers/TreeSelect.md b/docs/renderers/TreeSelect.md index e65ab6ff6..b45b72f3e 100644 --- a/docs/renderers/TreeSelect.md +++ b/docs/renderers/TreeSelect.md @@ -3,7 +3,7 @@ 树形结构选择框。 - `type` 请设置成 `tree-select` -- `options` 类似于 [select](#select) 中 `options`, 并且支持通过 `children` 无限嵌套。 +- `options` 类似于 [select](./select.md) 中 `options`, 并且支持通过 `children` 无限嵌套。 - `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。 - `hideRoot` 默认是会显示一个顶级，如果不想显示，请设置 `false` - `rootLabel` 默认为 `顶级`，当 hideRoot 不为 `false` 时有用，用来设置顶级节点的文字。 diff --git a/docs/renderers/Types.md b/docs/renderers/Types.md index bfe8aa74f..caeaacb82 100644 --- a/docs/renderers/Types.md +++ b/docs/renderers/Types.md @@ -128,7 +128,7 @@ AMis 所有值为 url 的如： `"http://www.baidu.com"` 都会被替换成 prox ### 表达式 配置项中，所有 `boolean` 类型的配置，都可以用 JS 表达式来配置。所有`boolean` 配置项，后面加个 `On` 则是表达式配置方式，可以用 js 语法来根据当前模型中的数据来决定是否启用。 -如：[FormItem](./FormItem.md) 中的 `disabledOn`、`hiddenOn`、`visibleOn`、[CRUD](#CRUD) 中的 `itemDraggableOn` 等等。 +如：[FormItem](./FormItem.md) 中的 `disabledOn`、`hiddenOn`、`visibleOn`、[CRUD](./CRUD.md) 中的 `itemDraggableOn` 等等。 ```schema:height="300" scope="form" [ diff --git a/docs/renderers/Wizard.md b/docs/renderers/Wizard.md index 809fafa19..a65eed3b7 100644 --- a/docs/renderers/Wizard.md +++ b/docs/renderers/Wizard.md @@ -28,7 +28,7 @@ - `steps[x].initApi` 当前步骤数据初始化接口。 - `steps[x].initFetch` 当前步骤数据初始化接口是否初始拉取。 - `steps[x].initFetchOn` 当前步骤数据初始化接口是否初始拉取，用表达式来决定。 -- `steps[x].controls` 当前步骤的表单项集合，请参考 [FormItem](#formitem)。 +- `steps[x].controls` 当前步骤的表单项集合，请参考 [FormItem](./formitem.md)。 ```schema:height="400" scope="body" { From 0128549f1f1098fa67378450382f90769facf7ed Mon Sep 17 00:00:00 2001 From: SIMDD Date: Thu, 9 May 2019 21:52:58 +0800 Subject: [PATCH 0019/1953] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20?= =?UTF-8?q?=E5=A4=A7=E5=B0=8F=E5=86=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers/Button.md | 2 +- docs/renderers/CRUD.md | 2 +- docs/renderers/Dialog.md | 4 ++-- docs/renderers/Drawer.md | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/renderers/Button.md b/docs/renderers/Button.md index b9108d985..97af17813 100644 --- a/docs/renderers/Button.md +++ b/docs/renderers/Button.md @@ -9,7 +9,7 @@ - `size` 按钮大小。 包含： `xs`、`sm`、`md`和`lg` - `className` 按钮的类名。 -如果按钮是 `button` 类型，则还需要配置 [Action](./action.md) 中定义的属性，否则，AMis 不知道如何响应当前按钮点击。 +如果按钮是 `button` 类型，则还需要配置 [Action](./Action.md) 中定义的属性，否则，AMis 不知道如何响应当前按钮点击。 ```schema:height="300" scope="form" [ diff --git a/docs/renderers/CRUD.md b/docs/renderers/CRUD.md index abcceca9b..baeec573d 100644 --- a/docs/renderers/CRUD.md +++ b/docs/renderers/CRUD.md @@ -22,7 +22,7 @@ CRUD 支持三种模式：`table`、`cards`、`list`，默认为 `table`。 | saveOrderApi | [Api](./Types#Api) | | 保存排序的 api。 | | quickSaveApi | [Api](./Types#Api) | | 快速编辑后用来批量保存的 API。 | | quickSaveItemApi | [Api](./Types#Api) | | 快速编辑配置成及时保存时使用的 API。 | -| bulkActions | Array Of [Action](./action.md) | | 批量操作列表，配置后，表格可进行选中操作。 | +| bulkActions | Array Of [Action](./Action.md) | | 批量操作列表，配置后，表格可进行选中操作。 | | defaultChecked | `boolean` | `false` | 当可批量操作时，默认是否全部勾选。 | | messages | `Object` | | 覆盖消息提示，如果不指定，将采用 api 返回的 message | | messages.fetchFailed | `string` | | 获取失败时提示 | diff --git a/docs/renderers/Dialog.md b/docs/renderers/Dialog.md index c1fea30ac..8f37aebcc 100644 --- a/docs/renderers/Dialog.md +++ b/docs/renderers/Dialog.md @@ -1,6 +1,6 @@ ### Dialog -Dialog 由 [Action](./action.md) 触发。他是一个类似于 [Page](./page.md) 的容器模型。 +Dialog 由 [Action](./Action.md) 触发。他是一个类似于 [Page](./page.md) 的容器模型。 | 属性名 | 类型 | 默认值 | 说明 | | ------------- | ----------------------------------------------- | ------------ | ------------------------------------------------ | @@ -11,7 +11,7 @@ Dialog 由 [Action](./action.md) 触发。他是一个类似于 [Page](./page.md | bodyClassName | `string` | `modal-body` | Dialog body 区域的样式类名 | | closeOnEsc | `boolean` | `false` | 是否支持按 `Esc` 关闭 Dialog | | disabled | `boolean` | `false` | 如果设置此属性，则该 Dialog 只读没有提交操作。 | -| actions | Array Of [Action](./action.md) | | 可以不设置，默认只有【确认】和【取消】两个按钮。 | +| actions | Array Of [Action](./Action.md) | | 可以不设置，默认只有【确认】和【取消】两个按钮。 | ```schema:height="200" { diff --git a/docs/renderers/Drawer.md b/docs/renderers/Drawer.md index 20a489137..4699447de 100644 --- a/docs/renderers/Drawer.md +++ b/docs/renderers/Drawer.md @@ -1,6 +1,6 @@ ### Drawer -Drawer 由 [Action](./action.md) 触发。 +Drawer 由 [Action](./Action.md) 触发。 | 属性名 | 类型 | 默认值 | 说明 | | ------------- | ----------------------------------------------- | ------------ | ------------------------------------------------ | @@ -12,7 +12,7 @@ Drawer 由 [Action](./action.md) 触发。 | closeOnEsc | `boolean` | `false` | 是否支持按 `Esc` 关闭 Dialog | | overlay | `boolean` | `true` | 是否显示蒙层 | | resizable | `boolean` | `false` | 是否可通过拖拽改变 Drawer 大小 | -| actions | Array Of [Action](./action.md) | | 可以不设置，默认只有【确认】和【取消】两个按钮。 | +| actions | Array Of [Action](./Action.md) | | 可以不设置，默认只有【确认】和【取消】两个按钮。 | ```schema:height="200" { From 816c59cc7febb4059c39f434b4f0d23a4fca67c5 Mon Sep 17 00:00:00 2001 From: SIMDD Date: Thu, 9 May 2019 21:55:20 +0800 Subject: [PATCH 0020/1953] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20?= =?UTF-8?q?=E6=B8=B2=E6=9F=93=E5=99=A8=E6=89=8B=E5=86=8C=E9=93=BE=E6=8E=A5?= =?UTF-8?q?=E4=BF=AE=E5=A4=8D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers/FormItem-Panel.md | 2 +- docs/renderers/SubForm.md | 2 +- docs/renderers/Wizard.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/renderers/FormItem-Panel.md b/docs/renderers/FormItem-Panel.md index d0382f8fb..c8fa8c217 100644 --- a/docs/renderers/FormItem-Panel.md +++ b/docs/renderers/FormItem-Panel.md @@ -1,6 +1,6 @@ ### Panel(FormItem) -还是为了布局，可以把一部分 [FormItem](./formItem.md) 合并到一个 panel 里面单独展示。 +还是为了布局，可以把一部分 [FormItem](./FormItem.md) 合并到一个 panel 里面单独展示。 - `title` panel 标题 - `body` [Container](./Types.md#container) 可以是其他渲染模型。 diff --git a/docs/renderers/SubForm.md b/docs/renderers/SubForm.md index 6d472f1d6..dc5d0951a 100644 --- a/docs/renderers/SubForm.md +++ b/docs/renderers/SubForm.md @@ -12,7 +12,7 @@ formItem 还可以是子表单类型。 - `editButtonClassName` 修改按钮 CSS 类名 默认：`btn-info btn-addon btn-sm`。 - `form` 字表单的配置 `title` 标题 - `controls` 请参考 [Form](./form.md) 中的配置说明。 + `controls` 请参考 [Form](./Form.md) 中的配置说明。 - 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="400" scope="form" diff --git a/docs/renderers/Wizard.md b/docs/renderers/Wizard.md index a65eed3b7..10e664ce7 100644 --- a/docs/renderers/Wizard.md +++ b/docs/renderers/Wizard.md @@ -28,7 +28,7 @@ - `steps[x].initApi` 当前步骤数据初始化接口。 - `steps[x].initFetch` 当前步骤数据初始化接口是否初始拉取。 - `steps[x].initFetchOn` 当前步骤数据初始化接口是否初始拉取，用表达式来决定。 -- `steps[x].controls` 当前步骤的表单项集合，请参考 [FormItem](./formitem.md)。 +- `steps[x].controls` 当前步骤的表单项集合，请参考 [FormItem](./FormItem.md)。 ```schema:height="400" scope="body" { From 0f10fef6b790725eeb5b37e84b3f935478d633a8 Mon Sep 17 00:00:00 2001 From: SIMDD Date: Thu, 9 May 2019 21:58:58 +0800 Subject: [PATCH 0021/1953] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20?= =?UTF-8?q?=E6=96=87=E4=BB=B6=E5=90=8D=E5=A4=A7=E5=86=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers/Action.md | 4 ++-- docs/renderers/Array.md | 2 +- docs/renderers/CRUD-List.md | 2 +- docs/renderers/Dialog.md | 2 +- docs/renderers/Field.md | 2 +- docs/renderers/FormItem-HBox.md | 2 +- docs/renderers/NestedSelect.md | 2 +- docs/renderers/Picker.md | 2 +- docs/renderers/Static.md | 2 +- docs/renderers/Tpl.md | 2 +- docs/renderers/Tree.md | 2 +- docs/renderers/TreeSelect.md | 2 +- 12 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/renderers/Action.md b/docs/renderers/Action.md index 986944cb7..d1dedefc5 100644 --- a/docs/renderers/Action.md +++ b/docs/renderers/Action.md @@ -69,7 +69,7 @@ Action 是一种特殊的渲染器，它本身是一个按钮，同时它能触 } ``` -- `dialog` 当按钮点击后，弹出一个对话框。 关于 dialog 配置，请查看 [Dialog 模型](./dialog.md)。 +- `dialog` 当按钮点击后，弹出一个对话框。 关于 dialog 配置，请查看 [Dialog 模型](./Dialog.md)。 ```schema:height="200" { @@ -96,7 +96,7 @@ Action 是一种特殊的渲染器，它本身是一个按钮，同时它能触 } ``` -- `drawer` 当按钮点击后，弹出一个抽出式对话框。 关于 drawer 配置，请查看 [Drawer 模型](./drawer.md)。 +- `drawer` 当按钮点击后，弹出一个抽出式对话框。 关于 drawer 配置，请查看 [Drawer 模型](./Drawer.md)。 ```schema:height="200" { diff --git a/docs/renderers/Array.md b/docs/renderers/Array.md index aad316871..f15fcfbc7 100644 --- a/docs/renderers/Array.md +++ b/docs/renderers/Array.md @@ -2,7 +2,7 @@ 数组输入框配置 -其实就是 [Combo](./combo.md) 的一个 flat 用法。 +其实就是 [Combo](./Combo.md) 的一个 flat 用法。 - `type` 请设置成 `array` - `items` 配置单项表单类型 diff --git a/docs/renderers/CRUD-List.md b/docs/renderers/CRUD-List.md index 48f71bd60..b05ed2f68 100644 --- a/docs/renderers/CRUD-List.md +++ b/docs/renderers/CRUD-List.md @@ -1,6 +1,6 @@ ### List(CRUD) -请参考[List](./list.md) +请参考[List](./List.md) ```schema:height="800" scope="body" { diff --git a/docs/renderers/Dialog.md b/docs/renderers/Dialog.md index 8f37aebcc..9895bf786 100644 --- a/docs/renderers/Dialog.md +++ b/docs/renderers/Dialog.md @@ -1,6 +1,6 @@ ### Dialog -Dialog 由 [Action](./Action.md) 触发。他是一个类似于 [Page](./page.md) 的容器模型。 +Dialog 由 [Action](./Action.md) 触发。他是一个类似于 [Page](./Page.md) 的容器模型。 | 属性名 | 类型 | 默认值 | 说明 | | ------------- | ----------------------------------------------- | ------------ | ------------------------------------------------ | diff --git a/docs/renderers/Field.md b/docs/renderers/Field.md index 4945d0355..e11262cfd 100644 --- a/docs/renderers/Field.md +++ b/docs/renderers/Field.md @@ -1,6 +1,6 @@ ## Field -主要用在 [Table](./Table.md) 的列配置 Column、[List](./list.md) 的内容、[Card](./Card.md) 卡片的内容和表单的[Static-XXX](./Static.md#static-xxx) 中。它主要用来展示数据。 +主要用在 [Table](./Table.md) 的列配置 Column、[List](./List.md) 的内容、[Card](./Card.md) 卡片的内容和表单的[Static-XXX](./Static.md#static-xxx) 中。它主要用来展示数据。 ```schema:height="450" scope="body" { diff --git a/docs/renderers/FormItem-HBox.md b/docs/renderers/FormItem-HBox.md index c999d60f5..95591c041 100644 --- a/docs/renderers/FormItem-HBox.md +++ b/docs/renderers/FormItem-HBox.md @@ -1,6 +1,6 @@ ### HBox(FormItem) -支持 form 内部再用 HBox 布局，实现左右排列。没错用 [Group](./group.md) 也能实现，所以还是推荐用 [Group](./group.md)。 +支持 form 内部再用 HBox 布局，实现左右排列。没错用 [Group](./Group.md) 也能实现，所以还是推荐用 [Group](./Group.md)。 - `type` 请设置成 `hbox` - `columns` 数据，用来配置列内容。每个 column 又一个独立的渲染器。 diff --git a/docs/renderers/NestedSelect.md b/docs/renderers/NestedSelect.md index 5b4777cc7..785fe3f2d 100644 --- a/docs/renderers/NestedSelect.md +++ b/docs/renderers/NestedSelect.md @@ -3,7 +3,7 @@ 树形结构选择框。 - `type` 请设置成 `nested-select` -- `options` 类似于 [select](./select.md) 中 `options`, 并且支持通过 `children` 无限嵌套。 +- `options` 类似于 [select](./Select.md) 中 `options`, 并且支持通过 `children` 无限嵌套。 - `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。 - `multiple` 默认为 `false`, 设置成 `true` 表示可多选。 - `joinValues` 默认为 `true` diff --git a/docs/renderers/Picker.md b/docs/renderers/Picker.md index 0e2243562..12d512058 100644 --- a/docs/renderers/Picker.md +++ b/docs/renderers/Picker.md @@ -14,7 +14,7 @@ - `extractValue` 默认为 `false`, `joinValues`设置为`false`时生效, 开启后将选中的选项 value 的值封装为数组，作为当前表单项的值。 - `delimiter` 默认为 `,` - `modalMode` 设置 `dialog` 或者 `drawer`，用来配置弹出方式。 -- `pickerSchema` 默认为 `{mode: 'list', listItem: {title: '${label}'}}`, 即用 List 类型的渲染，来展示列表信息。更多的玩法请参考 [CRUD](./crud.md) 的配置。 +- `pickerSchema` 默认为 `{mode: 'list', listItem: {title: '${label}'}}`, 即用 List 类型的渲染，来展示列表信息。更多的玩法请参考 [CRUD](./CRUD.md) 的配置。 - 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="300" scope="form-item" diff --git a/docs/renderers/Static.md b/docs/renderers/Static.md index be3a64965..90595efd4 100644 --- a/docs/renderers/Static.md +++ b/docs/renderers/Static.md @@ -16,7 +16,7 @@ - `hiddenOn` 通过[表达式](./Types.md#表达式)来配置当前表单项是否隐藏。 - `inputClassName` 表单控制器类名。 - `labelClassName` label 的类名。 -- `tpl` 如果想一次展示多条数据，可以考虑用 `tpl`，模板引擎是 lodash template，同时你还可以简单用 `$` 取值。 具体请查看 [tpl](./tpl.md) +- `tpl` 如果想一次展示多条数据，可以考虑用 `tpl`，模板引擎是 lodash template，同时你还可以简单用 `$` 取值。 具体请查看 [tpl](./Tpl.md) ```schema:height="250" scope="form-item" { diff --git a/docs/renderers/Tpl.md b/docs/renderers/Tpl.md index f8bfd9417..225ba4228 100644 --- a/docs/renderers/Tpl.md +++ b/docs/renderers/Tpl.md @@ -75,7 +75,7 @@ tpl 类型的渲染器支持用 JS 模板引擎来组织输出，采用的 lodas - `html2ubb` 我想你应该不需要，贴吧定制的 ubb 格式。 - `split` 可以将字符传通过分隔符分离成数组，默认分隔符为 `,` 如： `${ids|split|last}` 即取一段用逗号分割的数值中的最后一个。 - `nth` 取数组中的第 n 个成员。如： `${ids|split|nth:1}` -- `str2date` 请参考 [date](./date.md) 中日期默认值的设置格式。 +- `str2date` 请参考 [date](./Date.md) 中日期默认值的设置格式。 - `duration` 格式化成时间端如：`2` -=> `2秒` `67` => `1分7秒` `1111111` => `13天21时39分31秒` - `asArray` 将数据包成数组如： `a` => `[a]` - `lowerCase` 转小写 diff --git a/docs/renderers/Tree.md b/docs/renderers/Tree.md index 5abdef644..2a078c6a4 100644 --- a/docs/renderers/Tree.md +++ b/docs/renderers/Tree.md @@ -3,7 +3,7 @@ 树形结构输入框。 - `type` 请设置成 `tree` -- `options` 类似于 [select](./select.md) 中 `options`, 并且支持通过 `children` 无限嵌套。 +- `options` 类似于 [select](./Select.md) 中 `options`, 并且支持通过 `children` 无限嵌套。 - `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。 - `hideRoot` 默认是会显示一个顶级，如果不想显示，请设置 `false` - `rootLabel` 默认为 `顶级`，当 hideRoot 不为 `false` 时有用，用来设置顶级节点的文字。 diff --git a/docs/renderers/TreeSelect.md b/docs/renderers/TreeSelect.md index b45b72f3e..d612cb4b3 100644 --- a/docs/renderers/TreeSelect.md +++ b/docs/renderers/TreeSelect.md @@ -3,7 +3,7 @@ 树形结构选择框。 - `type` 请设置成 `tree-select` -- `options` 类似于 [select](./select.md) 中 `options`, 并且支持通过 `children` 无限嵌套。 +- `options` 类似于 [select](./Select.md) 中 `options`, 并且支持通过 `children` 无限嵌套。 - `source` Api 地址，如果选项不固定，可以通过配置 `source` 动态拉取。 - `hideRoot` 默认是会显示一个顶级，如果不想显示，请设置 `false` - `rootLabel` 默认为 `顶级`，当 hideRoot 不为 `false` 时有用，用来设置顶级节点的文字。 From 3054761868a38ed5b4891500e25b5dab1c2c0155 Mon Sep 17 00:00:00 2001 From: SIMDD Date: Thu, 9 May 2019 22:02:29 +0800 Subject: [PATCH 0022/1953] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20?= =?UTF-8?q?=E5=88=A0=E9=99=A4=E6=96=87=E6=A1=A3demo?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers/Action.md | 2 +- docs/renderers/CRUD-Cards.md | 4 ++-- docs/renderers/CRUD-List.md | 4 ++-- docs/renderers/CRUD-Table.md | 2 +- docs/renderers/CRUD.md | 6 +++--- docs/renderers/Field.md | 28 ++++++++++++++-------------- docs/renderers/Table.md | 28 ++++++++++++++-------------- 7 files changed, 37 insertions(+), 37 deletions(-) diff --git a/docs/renderers/Action.md b/docs/renderers/Action.md index d1dedefc5..906faa217 100644 --- a/docs/renderers/Action.md +++ b/docs/renderers/Action.md @@ -11,7 +11,7 @@ Action 是一种特殊的渲染器，它本身是一个按钮，同时它能触 - `dialog` 当 `actionType` 为 `dialog` 时用来指定弹框内容。 - `dawer` 当 `actionType` 为 `drawer` 时用来指定抽出式弹框内容。 - `copy` 当 `actionType` 为 `copy` 时用来指定复制的内容。 -- `nextCondition` 当 `actionType` 为 `dialog` 时可以用来设置下一条数据的条件，默认为 `true`。详情请见 [Demo](/docs/demo/crud/next)。 +- `nextCondition` 当 `actionType` 为 `dialog` 时可以用来设置下一条数据的条件，默认为 `true`。 - `confirmText` 当设置 `confirmText` 后，操作在开始前会询问用户。 - `reload` 指定此次操作完后，需要刷新的目标组件名字（组件的 name 指，自己配置的），多个请用 `,` 号隔开。 - `feedback` 如果 ajax 类型的，当 ajax 返回正常后，还能接着弹出一个 dialog 做其他交互。返回的数据可用于这个 dialog 中。 diff --git a/docs/renderers/CRUD-Cards.md b/docs/renderers/CRUD-Cards.md index e82fb8646..9bd50e525 100644 --- a/docs/renderers/CRUD-Cards.md +++ b/docs/renderers/CRUD-Cards.md @@ -4,8 +4,8 @@ ```schema:height="800" scope="body" { -"type": "crud", -"api": "/api/mock2/crud/users", +"type": "Action.md", +"api": "/api/mock2/Action.md/users", "syncLocation": false, "mode": "cards", "defaultParams": { diff --git a/docs/renderers/CRUD-List.md b/docs/renderers/CRUD-List.md index b05ed2f68..65dd95bc3 100644 --- a/docs/renderers/CRUD-List.md +++ b/docs/renderers/CRUD-List.md @@ -4,8 +4,8 @@ ```schema:height="800" scope="body" { -"type": "crud", -"api": "/api/mock2/crud/permissions", +"type": "Action.md", +"api": "/api/mock2/Action.md/permissions", "mode": "list", "placeholder": "当前组内, 还没有配置任何权限.", "syncLocation": false, diff --git a/docs/renderers/CRUD-Table.md b/docs/renderers/CRUD-Table.md index a55f7e0c4..2e688faca 100644 --- a/docs/renderers/CRUD-Table.md +++ b/docs/renderers/CRUD-Table.md @@ -6,7 +6,7 @@ ```schema:height="800" scope="body" { - "type": "crud", + "type": "Action.md", "api": "/api/sample", "syncLocation": false, "title": null, diff --git a/docs/renderers/CRUD.md b/docs/renderers/CRUD.md index baeec573d..1ac47ad1f 100644 --- a/docs/renderers/CRUD.md +++ b/docs/renderers/CRUD.md @@ -1,17 +1,17 @@ ### CRUD -增删改查模型，主要用来展现列表，并支持各类【增】【删】【改】【查】的操作。复杂示例请前往 [Demo](/docs/demo/crud/table)。 +增删改查模型，主要用来展现列表，并支持各类【增】【删】【改】【查】的操作。 CRUD 支持三种模式：`table`、`cards`、`list`，默认为 `table`。 | 属性名 | 类型 | 默认值 | 说明 | | ------------------------- | ------------------------------ | ------------------------------- | ----------------------------------------------------------------------------------------- | -| type | `string` | | `"crud"` 指定为 CRUD 渲染器 | +| type | `string` | | `"Action.md"` 指定为 CRUD 渲染器 | | mode | `string` | `"table"` | `"table" 、 "cards" 或者 "list"` | | title | `string` | `""` | 可设置成空，当设置成空时，没有标题栏 | | className | `string` | | 表格外层 Dom 的类名 | | api | [Api](./Types#Api) | | CRUD 用来获取列表数据的 api。 | -| filter | [Form](./Form.md) | | 设置过滤器，当该表单提交后，会把数据带给当前 crud 刷新列表。 | +| filter | [Form](./Form.md) | | 设置过滤器，当该表单提交后，会把数据带给当前 Action.md 刷新列表。 | | initFetch | `boolean` | `true` | 是否初始化的时候拉取数据, 只针对有 filter 的情况, 没有 filter 初始都会拉取数据 | | interval | `number` | `3000` | 刷新时间(最低 3000) | | silentPolling | `boolean` | `false` | 配置刷新时是否显示加载动画 | diff --git a/docs/renderers/Field.md b/docs/renderers/Field.md index e11262cfd..1d455c1fb 100644 --- a/docs/renderers/Field.md +++ b/docs/renderers/Field.md @@ -4,8 +4,8 @@ ```schema:height="450" scope="body" { - "type": "crud", - "api": "/api/mock2/crud/list", + "type": "Action.md", + "api": "/api/mock2/Action.md/list", "affixHeader": false, "syncLocation": false, "columns": [ @@ -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](./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 区域样式 | +| 属性名 | 类型 | 默认值 | 说明 | +| ----------------- | --------------------------------- | ----------------------------------- | ------------------------------------------------------------- | +| 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` | | 设置以后内容每次都会重新渲染，对于 Action.md 的重新拉取很有用 | +| 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/Table.md b/docs/renderers/Table.md index f0617090d..68f984ae2 100644 --- a/docs/renderers/Table.md +++ b/docs/renderers/Table.md @@ -2,20 +2,20 @@ 表格展示。 -| 属性名 | 类型 | 默认值 | 说明 | -| ---------------- | ----------------------------- | ------------------------ | ------------------------------------------------------- | -| type | `string` | | `"table"` 指定为 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` | `crud-table-header` | 顶部外层 CSS 类名 | -| footerClassName | `string` | `crud-table-footer` | 底部外层 CSS 类名 | -| toolbarClassName | `string` | `crud-table-toolbar` | 工具栏 CSS 类名 | -| columns | Array of [Column](.Column.md) | | 用来设置列信息 | +| 属性名 | 类型 | 默认值 | 说明 | +| ---------------- | ----------------------------- | ------------------------- | ------------------------------------------------------- | +| type | `string` | | `"table"` 指定为 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 of [Column](.Column.md) | | 用来设置列信息 | ```schema:height="700" scope="body" { From 099ee383ff314e90a855b44387f34a6d5ea7a076 Mon Sep 17 00:00:00 2001 From: SIMDD Date: Thu, 9 May 2019 22:04:21 +0800 Subject: [PATCH 0023/1953] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20fix=20?= =?UTF-8?q?=E9=93=BE=E6=8E=A5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers/CRUD.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/renderers/CRUD.md b/docs/renderers/CRUD.md index 1ac47ad1f..55fb785c6 100644 --- a/docs/renderers/CRUD.md +++ b/docs/renderers/CRUD.md @@ -10,7 +10,7 @@ CRUD 支持三种模式：`table`、`cards`、`list`，默认为 `table`。 | mode | `string` | `"table"` | `"table" 、 "cards" 或者 "list"` | | title | `string` | `""` | 可设置成空，当设置成空时，没有标题栏 | | className | `string` | | 表格外层 Dom 的类名 | -| api | [Api](./Types#Api) | | CRUD 用来获取列表数据的 api。 | +| api | [Api](./Types.md#Api) | | CRUD 用来获取列表数据的 api。 | | filter | [Form](./Form.md) | | 设置过滤器，当该表单提交后，会把数据带给当前 Action.md 刷新列表。 | | initFetch | `boolean` | `true` | 是否初始化的时候拉取数据, 只针对有 filter 的情况, 没有 filter 初始都会拉取数据 | | interval | `number` | `3000` | 刷新时间(最低 3000) | @@ -19,9 +19,9 @@ CRUD 支持三种模式：`table`、`cards`、`list`，默认为 `table`。 | syncLocation | `boolean` | `true` | 是否将过滤条件的参数同步到地址栏 | | draggable | `boolean` | `false` | 是否可通过拖拽排序 | | itemDraggableOn | `boolean` | | 用[表达式](./Types.md#表达式)来配置是否可拖拽排序 | -| saveOrderApi | [Api](./Types#Api) | | 保存排序的 api。 | -| quickSaveApi | [Api](./Types#Api) | | 快速编辑后用来批量保存的 API。 | -| quickSaveItemApi | [Api](./Types#Api) | | 快速编辑配置成及时保存时使用的 API。 | +| saveOrderApi | [Api](./Types.md#Api) | | 保存排序的 api。 | +| quickSaveApi | [Api](./Types.md#Api) | | 快速编辑后用来批量保存的 API。 | +| quickSaveItemApi | [Api](./Types.md#Api) | | 快速编辑配置成及时保存时使用的 API。 | | bulkActions | Array Of [Action](./Action.md) | | 批量操作列表，配置后，表格可进行选中操作。 | | defaultChecked | `boolean` | `false` | 当可批量操作时，默认是否全部勾选。 | | messages | `Object` | | 覆盖消息提示，如果不指定，将采用 api 返回的 message | From 8d9335747915debaada1936b76b3c0075103cfaa Mon Sep 17 00:00:00 2001 From: liaoxuezhi Date: Fri, 10 May 2019 09:54:42 +0800 Subject: [PATCH 0024/1953] =?UTF-8?q?gh-pages=20=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- fis-conf.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/fis-conf.js b/fis-conf.js index c6bcdf7a6..6e756ef32 100644 --- a/fis-conf.js +++ b/fis-conf.js @@ -316,7 +316,7 @@ if (fis.project.currentMedia() === 'publish') { useHash: true }); - ghPages.match('*.{js,ts,tsx}', { + ghPages.match('*.{js,ts,tsx,jsx}', { optimizer: fis.plugin('uglify-js'), useHash: true }); @@ -347,7 +347,7 @@ if (fis.project.currentMedia() === 'publish') { ghPages.match('{*.min.js,monaco-editor/**.js}', { optimizer: null }); - ghPages.match('monaco-editor/**.js', { + ghPages.match('monaco-editor/**', { useHash: false }); } From a57a05763a0f028dd7237000600efb644d4c03ac Mon Sep 17 00:00:00 2001 From: liaoxuezhi Date: Fri, 10 May 2019 10:04:37 +0800 Subject: [PATCH 0025/1953] =?UTF-8?q?gh-pages=20=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- fis-conf.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/fis-conf.js b/fis-conf.js index 6e756ef32..4fff57549 100644 --- a/fis-conf.js +++ b/fis-conf.js @@ -302,7 +302,8 @@ if (fis.project.currentMedia() === 'publish') { 'node_modules/*/**.css', '*.scss', '!/scss/*.scss', - '/scss/*.scss' + '/scss/*.scss', + '!monaco-editor/**', ] }) }); From adafefc3eb58cb3f3411423e6a1a8385217f488b Mon Sep 17 00:00:00 2001 From: liaoxuezhi Date: Fri, 10 May 2019 10:25:02 +0800 Subject: [PATCH 0026/1953] =?UTF-8?q?=E6=9A=B4=E9=9C=B2=20Scoped=20?= =?UTF-8?q?=E5=92=8C=20ScopedContext=20=E6=96=B9=E4=BE=BF=E5=B0=86?= =?UTF-8?q?=E8=87=AA=E5=AE=9A=E4=B9=89=E7=BB=84=E4=BB=B6=E5=8F=82=E4=B8=8E?= =?UTF-8?q?=E7=BB=84=E4=BB=B6=E9=97=B4=E9=80=9A=E4=BF=A1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/index.tsx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/index.tsx b/src/index.tsx index 9b84e2157..6aee2df09 100644 --- a/src/index.tsx +++ b/src/index.tsx @@ -149,6 +149,7 @@ import './renderers/Wrapper'; import './renderers/IFrame'; import './renderers/QRCode'; import './renderers/Icon'; +import Scoped, {ScopedContext} from './Scoped'; import { FormItem @@ -228,6 +229,8 @@ export { relativeValueRe, resolveVariable, setIconVendor, + Scoped, + ScopedContext, classPrefix, classnames From 11f216bfff6cf4a0c44cae5871803e72c77496c2 Mon Sep 17 00:00:00 2001 From: liaoxuezhi Date: Fri, 10 May 2019 12:13:30 +0800 Subject: [PATCH 0029/1953] =?UTF-8?q?=E4=BF=AE=E5=A4=8D=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E9=94=99=E8=AF=AF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers/CRUD-Cards.md | 4 ++-- docs/renderers/CRUD-List.md | 4 ++-- docs/renderers/CRUD-Table.md | 2 +- docs/renderers/Tabs.md | 31 +++++++++++++++++++++++++++++++ 4 files changed, 36 insertions(+), 5 deletions(-) create mode 100644 docs/renderers/Tabs.md diff --git a/docs/renderers/CRUD-Cards.md b/docs/renderers/CRUD-Cards.md index 9bd50e525..e82fb8646 100644 --- a/docs/renderers/CRUD-Cards.md +++ b/docs/renderers/CRUD-Cards.md @@ -4,8 +4,8 @@ ```schema:height="800" scope="body" { -"type": "Action.md", -"api": "/api/mock2/Action.md/users", +"type": "crud", +"api": "/api/mock2/crud/users", "syncLocation": false, "mode": "cards", "defaultParams": { diff --git a/docs/renderers/CRUD-List.md b/docs/renderers/CRUD-List.md index 65dd95bc3..b05ed2f68 100644 --- a/docs/renderers/CRUD-List.md +++ b/docs/renderers/CRUD-List.md @@ -4,8 +4,8 @@ ```schema:height="800" scope="body" { -"type": "Action.md", -"api": "/api/mock2/Action.md/permissions", +"type": "crud", +"api": "/api/mock2/crud/permissions", "mode": "list", "placeholder": "当前组内, 还没有配置任何权限.", "syncLocation": false, diff --git a/docs/renderers/CRUD-Table.md b/docs/renderers/CRUD-Table.md index 2e688faca..a55f7e0c4 100644 --- a/docs/renderers/CRUD-Table.md +++ b/docs/renderers/CRUD-Table.md @@ -6,7 +6,7 @@ ```schema:height="800" scope="body" { - "type": "Action.md", + "type": "crud", "api": "/api/sample", "syncLocation": false, "title": null, diff --git a/docs/renderers/Tabs.md b/docs/renderers/Tabs.md new file mode 100644 index 000000000..af08cec12 --- /dev/null +++ b/docs/renderers/Tabs.md @@ -0,0 +1,31 @@ +## 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 区域样式 | + +```schema:height="300" scope="body" +{ + "type": "tabs", + "tabs": [ + { + "title": "Tab 1", + "tab": "Content 1" + }, + + { + "title": "Tab 2", + "tab": "Content 2" + } + ] +} +``` From eb41e847b5d9c6ad8def6904c2f87d166cc031ee Mon Sep 17 00:00:00 2001 From: liaoxuezhi Date: Fri, 10 May 2019 12:14:02 +0800 Subject: [PATCH 0030/1953] =?UTF-8?q?=E5=85=88=E5=8E=BB=E6=8E=89=20prettie?= =?UTF-8?q?r?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 2eb6902b5..03ccc1c3a 100644 --- a/package.json +++ b/package.json @@ -154,7 +154,7 @@ } } }, - "husky": { + "_husky": { "hooks": { "pre-commit": "lint-staged" } From b6b1e094e6f35c5ac54c23cb15b30b6507283d0f Mon Sep 17 00:00:00 2001 From: liaoxuezhi Date: Fri, 10 May 2019 14:12:15 +0800 Subject: [PATCH 0032/1953] rebuild pages --- fis-conf.js | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/fis-conf.js b/fis-conf.js index 4fff57549..8bb27c1b8 100644 --- a/fis-conf.js +++ b/fis-conf.js @@ -243,9 +243,13 @@ if (fis.project.currentMedia() === 'publish') { return contents; } - return contents.replace(/(\\?(?:'|"))\/api\/mock2?\//g, function(_, qutoa) { - return qutoa + 'https://houtai.baidu.com/api/mock2/'; - }); + return contents + .replace(/(\\?(?:'|"))((?:get|post|delete|put)\:)?\/api\/mock2?/ig, function(_, qutoa, method) { + return qutoa + (method || '') + 'https://houtai.baidu.com/api/mock2'; + }) + .replace(/(\\?(?:'|"))((?:get|post|delete|put)\:)?\/api\/sample/ig, function(_, qutoa, method) { + return qutoa + (method || '') + 'https://houtai.baidu.com/api/sample'; + }); } }) From 054ae63f7538065960e40b3a5d4d61047e9a7c74 Mon Sep 17 00:00:00 2001 From: rickcole Date: Sun, 12 May 2019 19:50:50 +0800 Subject: [PATCH 0034/1953] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E4=BA=86=E4=B8=80?= =?UTF-8?q?=E4=BA=9B=E6=96=87=E6=A1=A3=E9=85=8D=E7=BD=AE=E9=A1=B9=EF=BC=8C?= =?UTF-8?q?=E4=BB=A5=E5=8F=8A=E4=B8=80=E7=82=B9=E5=B0=8F=E9=97=AE=E9=A2=98?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers/Action.md | 86 ++++++++++++++++++++++++++++++++-------- docs/renderers/CRUD.md | 75 ++++++++++++++++++++--------------- docs/renderers/Combo.md | 1 + docs/renderers/Form.md | 4 ++ docs/renderers/Nav.md | 20 +++++----- docs/renderers/Panel.md | 1 + src/renderers/Action.tsx | 1 - src/renderers/CRUD.tsx | 8 ++-- 8 files changed, 133 insertions(+), 63 deletions(-) diff --git a/docs/renderers/Action.md b/docs/renderers/Action.md index 906faa217..742868ee9 100644 --- a/docs/renderers/Action.md +++ b/docs/renderers/Action.md @@ -2,22 +2,76 @@ Action 是一种特殊的渲染器，它本身是一个按钮，同时它能触发事件。 -- `type` 指定为 `button`。 -- `actionType` 【必填】 选项：`ajax`、`link`、`url`、`dawer`、`dialog`、`confirm`、`cancel`、`prev`、`next`、`copy` 或者 `close`。 -- `api` 当 `actionType` 为 `ajax` 时，必须指定，参考 [api](./Types.md#Api) 格式说明。 -- `link` 当 `actionType` 为 `link` 时必须指定，用来指定跳转地址，跟 url 不同的是，这是单页跳转方式，不会渲染浏览器，请指定 AMis 平台内的页面。 -- `url` 当 `actionType` 为 `url` 时必须指定，按钮点击后，会打开指定页面。 -- `blank` 当 `actionType` 为 `url` 时可选，如果为 false 将在本页面打开。 -- `dialog` 当 `actionType` 为 `dialog` 时用来指定弹框内容。 -- `dawer` 当 `actionType` 为 `drawer` 时用来指定抽出式弹框内容。 -- `copy` 当 `actionType` 为 `copy` 时用来指定复制的内容。 -- `nextCondition` 当 `actionType` 为 `dialog` 时可以用来设置下一条数据的条件，默认为 `true`。 -- `confirmText` 当设置 `confirmText` 后，操作在开始前会询问用户。 -- `reload` 指定此次操作完后，需要刷新的目标组件名字（组件的 name 指，自己配置的），多个请用 `,` 号隔开。 -- `feedback` 如果 ajax 类型的，当 ajax 返回正常后，还能接着弹出一个 dialog 做其他交互。返回的数据可用于这个 dialog 中。 -- `messages`，actionType 为 `ajax` 时才有用。 - - `success` ajax 操作成功后提示，可以不指定，不指定时以 api 返回为准。 - - `failed` ajax 操作失败提示。 +#### 通用配置项 +所有`actionType`都支持的通用配置项 + +| 属性名 | 类型 | 默认值 | 说明 | +| ---------------- | --------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| type | `string` | `action` | 指定为 Page 渲染器。 | +| actionType | `string` | - | 【必填】这是action最核心的配置，来指定该action的作用类型，支持：`ajax`、`link`、`url`、`dawer`、`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 | `string` | - | 当设置后，操作在开始前会询问用户。可用 `${xxx}` 取值。 | +| reload | `string` | - | 指定此次操作完后，需要刷新的目标组件名字（组件的 name 指，自己配置的），多个请用 `,` 号隔开。 | +| tooltip | `string` | - | 鼠标停留时弹出该段文字，也可以配置对象类型：字段为`title`和`content`。可用 `${xxx}` 取值。 | +| disabledTip | `string` | - | 被禁用后鼠标停留时弹出该段文字，也可以配置对象类型：字段为`title`和`content`。可用 `${xxx}` 取值。 | +| tooltipPlacement | `string` | `top` | 如果配置了`tooltip`或者`disabledTip`，指定提示信息位置，可配置`top`、`bottom`、`left`、`right`。 | + +下面会分别介绍每种类型的Action配置项 + +#### ajax +| 属性名 | 类型 | 默认值 | 说明 | +| ---------- | ----------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------- | +| actionType | `string` | `ajax` | 发送请求 | +| api | `string` 或 `ApiObject` | - | 请求地址，参考 [api](./Types.md#api) 格式说明。 | +| redirect | `string` | - | 指定当前请求结束后跳转的路径，可用 `${xxx}` 取值。 | +| feedback | `DialogObject` | - | 如果 ajax 类型的，当 ajax 返回正常后，还能接着弹出一个 dialog 做其他交互。返回的数据可用于这个 dialog 中。格式可参考[Dialog](./Dialog.md) | +| messages | `object` | - | `success`：ajax 操作成功后提示，可以不指定，不指定时以 api 返回为准。`failed`：ajax 操作失败提示。 | + +#### link +| 属性名 | 类型 | 默认值 | 说明 | +| ---------- | -------- | ------ | ------------------------------------------------------------------------------------------------------------------- | +| actionType | `string` | `link` | 单页跳转 | +| link | `string` | `link` | 用来指定跳转地址，跟 url 不同的是，这是单页跳转方式，不会渲染浏览器，请指定 AMis 平台内的页面。可用 `${xxx}` 取值。 | + +#### url +| 属性名 | 类型 | 默认值 | 说明 | +| ---------- | --------- | ------- | ------------------------------------------------ | +| actionType | `string` | `url` | 页面跳转 | +| url | `string` | - | 按钮点击后，会打开指定页面。可用 `${xxx}` 取值。 | +| blank | `boolean` | `false` | 如果为 `true` 将在新tab页面打开。 | + +#### dialog +| 属性名 | 类型 | 默认值 | 说明 | +| ------------- | -------------------------- | -------- | --------------------------------------------- | +| actionType | `string` | `dialog` | 点击后显示一个弹出框 | +| dialog | `string` 或 `DialogObject` | - | 指定弹框内容，格式可参考[Dialog](./Dialog.md) | +| nextCondition | `boolean` | - | 可以用来设置下一条数据的条件，默认为 `true`。 | + +#### drawer +| 属性名 | 类型 | 默认值 | 说明 | +| ---------- | -------------------------- | -------- | --------------------------------------------- | +| actionType | `string` | `drawer` | 点击后显示一个侧边栏 | +| drawer | `string` 或 `DrawerObject` | - | 指定弹框内容，格式可参考[Drawer](./Drawer.md) | + +#### copy +| 属性名 | 类型 | 默认值 | 说明 | +| ---------- | -------- | ------ | ------------------------------------ | +| actionType | `string` | `copy` | 复制一段内容到粘贴板 | +| content | `string` | - | 指定复制的内容。可用 `${xxx}` 取值。 | + +#### 其他配置项 +| 属性名 | 类型 | 默认值 | 说明 | +| -------- | --------------- | ------- | ----------------------------------------------------------------------------------------------------------- | +| close | `boolean` | `false` | 当`action`配置在`dialog`或`drawer`的`actions`中时，配置为`true`指定此次操作完后关闭当前`dialog`或`drawer`。 | +| required | `Array` | - | 配置字符串数组，指定在`form`中进行操作之前，需验证必填的表单项字段 | 示例： diff --git a/docs/renderers/CRUD.md b/docs/renderers/CRUD.md index 55fb785c6..b2ec20957 100644 --- a/docs/renderers/CRUD.md +++ b/docs/renderers/CRUD.md @@ -4,36 +4,45 @@ CRUD 支持三种模式：`table`、`cards`、`list`，默认为 `table`。 -| 属性名 | 类型 | 默认值 | 说明 | -| ------------------------- | ------------------------------ | ------------------------------- | ----------------------------------------------------------------------------------------- | -| type | `string` | | `"Action.md"` 指定为 CRUD 渲染器 | -| mode | `string` | `"table"` | `"table" 、 "cards" 或者 "list"` | -| title | `string` | `""` | 可设置成空，当设置成空时，没有标题栏 | -| className | `string` | | 表格外层 Dom 的类名 | -| api | [Api](./Types.md#Api) | | CRUD 用来获取列表数据的 api。 | -| filter | [Form](./Form.md) | | 设置过滤器，当该表单提交后，会把数据带给当前 Action.md 刷新列表。 | -| initFetch | `boolean` | `true` | 是否初始化的时候拉取数据, 只针对有 filter 的情况, 没有 filter 初始都会拉取数据 | -| interval | `number` | `3000` | 刷新时间(最低 3000) | -| silentPolling | `boolean` | `false` | 配置刷新时是否显示加载动画 | -| stopAutoRefreshWhen | `string` | `""` | 通过[表达式](./Types.md#表达式)来配置停止刷新的条件 | -| syncLocation | `boolean` | `true` | 是否将过滤条件的参数同步到地址栏 | -| draggable | `boolean` | `false` | 是否可通过拖拽排序 | -| itemDraggableOn | `boolean` | | 用[表达式](./Types.md#表达式)来配置是否可拖拽排序 | -| saveOrderApi | [Api](./Types.md#Api) | | 保存排序的 api。 | -| quickSaveApi | [Api](./Types.md#Api) | | 快速编辑后用来批量保存的 API。 | -| quickSaveItemApi | [Api](./Types.md#Api) | | 快速编辑配置成及时保存时使用的 API。 | -| bulkActions | Array Of [Action](./Action.md) | | 批量操作列表，配置后，表格可进行选中操作。 | -| 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 一起使用，请看下面例子。 | -| orderField | `string` | | 设置用来确定位置的字段名，设置后新的顺序将被赋值到该字段中。 | -| headerToolbar | Array | `['bulkActions', 'pagination']` | 顶部工具栏配置 | -| footerToolbar | Array | `['statistics', 'pagination']` | 顶部工具栏配置 | +| 属性名 | 类型 | 默认值 | 说明 | +| ------------------------------ | ------------------------------ | ------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| type | `string` | | `"Action.md"` 指定为 CRUD 渲染器 | +| mode | `string` | `"table"` | `"table" 、 "cards" 或者 "list"` | +| title | `string` | `""` | 可设置成空，当设置成空时，没有标题栏 | +| className | `string` | | 表格外层 Dom 的类名 | +| api | [Api](./Types.md#Api) | | CRUD 用来获取列表数据的 api。 | +| filter | [Form](./Form.md) | | 设置过滤器，当该表单提交后，会把数据带给当前 Action.md 刷新列表。 | +| filterTogglable | `boolean` | `false` | 是否可显隐过滤器 | +| filterDefaultVisible | `boolean` | `true` | 设置过滤器默认是否可见。 | +| initFetch | `boolean` | `true` | 是否初始化的时候拉取数据, 只针对有 filter 的情况, 没有 filter 初始都会拉取数据 | +| interval | `number` | `3000` | 刷新时间(最低 3000) | +| silentPolling | `boolean` | `false` | 配置刷新时是否隐藏加载动画 | +| stopAutoRefreshWhen | `string` | `""` | 通过[表达式](./Types.md#表达式)来配置停止刷新的条件 | +| stopAutoRefreshWhenModalIsOpen | `boolean` | `false` | 当有弹框时关闭自动刷新，关闭弹框又恢复 | +| syncLocation | `boolean` | `true` | 是否将过滤条件的参数同步到地址栏 | +| draggable | `boolean` | `false` | 是否可通过拖拽排序 | +| itemDraggableOn | `boolean` | | 用[表达式](./Types.md#表达式)来配置是否可拖拽排序 | +| saveOrderApi | [Api](./Types.md#Api) | | 保存排序的 api。 | +| quickSaveApi | [Api](./Types.md#Api) | | 快速编辑后用来批量保存的 API。 | +| quickSaveItemApi | [Api](./Types.md#Api) | | 快速编辑配置成及时保存时使用的 API。 | +| bulkActions | Array Of [Action](./Action.md) | | 批量操作列表，配置后，表格可进行选中操作。 | +| 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/renderers/Combo.md b/docs/renderers/Combo.md index bcf5ad35a..1a9252379 100644 --- a/docs/renderers/Combo.md +++ b/docs/renderers/Combo.md @@ -22,6 +22,7 @@ - `minLength` 限制最小长度。 - `maxLength` 限制最大长度。 - `scaffold` 单条初始值。默认为 `{}`。 +- `canAccessSuperData` 指定是否可以自动获取上层的数据并映射到表单项上，默认是`true`。 - 更多配置请参考 [FormItem](./FormItem.md) ```schema:height="450" scope="form" diff --git a/docs/renderers/Form.md b/docs/renderers/Form.md index 920f083d2..32181d347 100644 --- a/docs/renderers/Form.md +++ b/docs/renderers/Form.md @@ -42,6 +42,7 @@ | messages.saveFailed | `string` | | 保存成功时提示 | | messages.saveSuccess | `string` | | 保存失败时提示 | | wrapWithPanel | `boolean` | `true` | 是否让 Form 用 panel 包起来，设置为 false 后，actions 将无效。 | +| panelClassName | `boolean` | `true` | 是否让 Form 用 panel 包起来，设置为 false 后，actions 将无效。 | | api | [Api](./Types.md#api) | | Form 用来保存数据的 api。 | | initApi | [Api](./Types.md#api) | | Form 用来获取初始数据的 api。 | | interval | `number` | `3000` | 刷新时间(最低 3000) | @@ -57,11 +58,14 @@ | checkInterval | `number` | 3000 | 轮训请求的时间间隔，默认为 3 秒。设置 `asyncApi` 才有效 | | finishedField | `string` | `"finished"` | 如果决定结束的字段名不是 `finished` 请设置此属性，比如 `is_success` | | submitOnChange | `boolean` | `false` | 表单修改即提交 | +| submitOnInit | `boolean` | `false` | 初始就提交一次 | +| resetAfterSubmit | `boolean` | `false` | 提交后是否重置表单 | | primaryField | `string` | `"id"` | 设置主键 id, 当设置后，检测表单是否完成时（asyncApi），只会携带此数据。 | | target | `string` | | 默认表单提交自己会通过发送 api 保存数据，但是也可以设定另外一个 form 的 name 值，或者另外一个 `CRUD` 模型的 name 值。 如果 target 目标是一个 `Form` ，则目标 `Form` 会重新触发 `initApi`，api 可以拿到当前 form 数据。如果目标是一个 `CRUD` 模型，则目标模型会重新触发搜索，参数为当前 Form 数据。当目标是 `window` 时，会把当前表单的数据附带到页面地址上。 | | redirect | `string` | | 设置此属性后，Form 保存成功后，自动跳转到指定页面。支持相对地址，和绝对地址（相对于组内的）。 | | reload | `string` | | 操作完后刷新目标对象。请填写目标组件设置的 name 值，如果填写为 `window` 则让当前页面整体刷新。 | | autoFocus | `boolean` | `false` | 是否自动聚焦。 | +| canAccessSuperData | `boolean` | `true` | 指定是否可以自动获取上层的数据并映射到表单项上 | | name | `string` | | 设置一个名字后，方便其他组件与其通信 | 表单项都是通过 controls 设置的，类型是数组，成员主要是[FormItem](./FormItem.md)，默认一行一个（当然 form 是 inline 模式时例外），如果想一行多个，可以将多个[FormItem](./FormItem.md)放在一个 [Group](./Group.md) 里面。 diff --git a/docs/renderers/Nav.md b/docs/renderers/Nav.md index ea82e026b..2f5813231 100644 --- a/docs/renderers/Nav.md +++ b/docs/renderers/Nav.md @@ -1,14 +1,16 @@ ## Nav -| 属性名 | 类型 | 默认值 | 说明 | -| -------------- | --------- | -------- | ----------------------------------- | -| type | `string` | `"tabs"` | 指定为 Nav 渲染器 | -| className | `string` | | 外层 Dom 的类名 | -| stacked | `boolean` | `true` | 设置成 false 可以以 tabs 的形式展示 | -| links | `Array` | | 链接集合 | -| links[x].label | `string` | | 名称 | -| links[x].to | `string` | | 链接地址 | -| links[x].icon | `string` | | 图标 | +| 属性名 | 类型 | 默认值 | 说明 | +| ----------------- | --------- | -------- | -------------------------------------- | +| type | `string` | `"tabs"` | 指定为 Nav 渲染器 | +| className | `string` | | 外层 Dom 的类名 | +| stacked | `boolean` | `true` | 设置成 false 可以以 tabs 的形式展示 | +| links | `Array` | | 链接集合 | +| links[x].label | `string` | | 名称 | +| links[x].to | `string` | | 链接地址 | +| links[x].icon | `string` | | 图标 | +| links[x].active | `boolean` | | 是否高亮 | +| links[x].activeOn | `表达式` | | 是否高亮的条件，留空将自动分析链接地址 | 链接集合。 diff --git a/docs/renderers/Panel.md b/docs/renderers/Panel.md index fdea918e6..19fe98716 100644 --- a/docs/renderers/Panel.md +++ b/docs/renderers/Panel.md @@ -14,6 +14,7 @@ | header | [Container](./Types.md#container) | | 顶部容器 | | body | [Container](./Types.md#container) | | 内容容器 | | footer | [Container](./Types.md#container) | | 底部容器 | +| affixFooter | `boolean` | | 是否固定底部容器 | | actions | Array Of [Button](./Button.md) | | 按钮区域 | ```schema:height="300" scope="body" diff --git a/src/renderers/Action.tsx b/src/renderers/Action.tsx index 35554dde1..ac6d14f65 100644 --- a/src/renderers/Action.tsx +++ b/src/renderers/Action.tsx @@ -35,7 +35,6 @@ const ActionProps = [ 'mergeData', 'index', 'copy', - 'content', ]; import {filterContents} from './Remark'; import {ClassNamesFn, themeable} from '../theme'; diff --git a/src/renderers/CRUD.tsx b/src/renderers/CRUD.tsx index f25681c18..8b53bbf7c 100644 --- a/src/renderers/CRUD.tsx +++ b/src/renderers/CRUD.tsx @@ -45,7 +45,7 @@ interface CRUDProps extends RendererProps { quickSaveApi?: Api; quickSaveItemApi?: Api; initFetch?: boolean; - pagePageAvailable?: Array; + perPageAvailable?: Array; messages: { fetchFailed?: string; fetchSuccess?: string; @@ -83,7 +83,7 @@ export default class CRUD extends React.Component { 'valueField', 'defaultParams', 'bodyClassName', - 'pagePageAvailable', + 'perPageAvailable', 'pageField', 'perPageField', 'hideQuickSaveBtn', @@ -1037,7 +1037,7 @@ export default class CRUD extends React.Component { } renderSwitchPerPage(childProps: any) { - const {store, pagePageAvailable, classnames: cx, classPrefix: ns} = this.props; + const {store, perPageAvailable, classnames: cx, classPrefix: ns} = this.props; const items = childProps.items; @@ -1045,7 +1045,7 @@ export default class CRUD extends React.Component { return null; } - const perPages = (pagePageAvailable || [5, 10, 20, 50, 100]).map((item: any) => ({ + const perPages = (perPageAvailable || [5, 10, 20, 50, 100]).map((item: any) => ({ label: item, value: item + '', })); From c28aad6bc22b67a4a65ca1b6927afb88a96b2867 Mon Sep 17 00:00:00 2001 From: liaoxuezhi Date: Mon, 13 May 2019 13:08:24 +0800 Subject: [PATCH 0035/1953] =?UTF-8?q?Pagination=20=E8=B0=83=E6=95=B4,=20?= =?UTF-8?q?=E5=8E=BB=E6=8E=89=20pageNum=20changePageNum=20=E5=B1=9E?= =?UTF-8?q?=E6=80=A7?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/renderers/CRUD.tsx | 4 +-- src/renderers/Pagination.tsx | 60 +++++++++++++++++------------------- 2 files changed, 30 insertions(+), 34 deletions(-) diff --git a/src/renderers/CRUD.tsx b/src/renderers/CRUD.tsx index 8b53bbf7c..7be3dc47c 100644 --- a/src/renderers/CRUD.tsx +++ b/src/renderers/CRUD.tsx @@ -1015,9 +1015,7 @@ export default class CRUD extends React.Component { items: lastPage, hasNext: store.hasNext, mode: store.mode, - onPageChange: this.handleChangePage, - pageNum: store.pageNum, - changePageNum: store.changePageNum, + onPageChange: this.handleChangePage } )} diff --git a/src/renderers/Pagination.tsx b/src/renderers/Pagination.tsx index 62ff9b621..49350bca6 100644 --- a/src/renderers/Pagination.tsx +++ b/src/renderers/Pagination.tsx @@ -1,31 +1,23 @@ import * as React from 'react'; import {Renderer, RendererProps} from '../factory'; +import { autobind } from '../utils/helper'; export interface PaginationProps extends RendererProps { - activePage?: number; - items?: number; - maxButtons?: number; - hasNext?: boolean; - mode?: string; - onPageChange: (page: number, perPage?: number) => void; - pageNum?: number; - changePageNum: (value: number) => void; - showPageInput: boolean; -} - -export interface DefaultProps { activePage: number; items: number; maxButtons: number; - mode: string; hasNext: boolean; + mode: string; + onPageChange: (page: number, perPage?: number) => void; showPageInput: boolean; } -type PropsWithDefault = PaginationProps & DefaultProps; +export interface PaginationState { + pageNum: string; +}; -export default class Pagination extends React.PureComponent { - static defaultProps: DefaultProps = { +export default class Pagination extends React.Component { + static defaultProps = { activePage: 1, items: 1, maxButtons: 5, @@ -34,13 +26,20 @@ export default class Pagination extends React.PureComponent @@ -68,22 +67,21 @@ export default class Pagination extends React.PureComponent) { - const {changePageNum, items} = this.props; + const {items} = this.props; let value = e.currentTarget.value; - if (((typeof value === 'number' || /^\d+$/.test(value)) && value > 0) || value === '') { - if (value !== '') { - value = parseInt(value, 10); - value = (value > (items as number) ? items : value) as number; - } - changePageNum(value); + if (/^\d+$/.test(value) && parseInt(value, 10) > items) { + value = String(items); } + + this.setState({pageNum: value}); } renderNormal() { - let {activePage, items, maxButtons, onPageChange, pageNum, classnames: cx, showPageInput} = this - .props as PropsWithDefault; + let {activePage, items, maxButtons, onPageChange, classnames: cx, showPageInput} = this.props; + const pageNum = this.state.pageNum; let pageButtons: any = []; let startPage: number; @@ -195,7 +193,7 @@ export default class Pagination extends React.PureComponent -
    onPageChange(value)}> +
      {pageButtons}
    @@ -214,7 +212,7 @@ export default class Pagination extends React.PureComponent