From e8500986715db289bbfd1242e5ce1af0e22be825 Mon Sep 17 00:00:00 2001 From: liaoxuezhi Date: Tue, 4 Jun 2019 16:24:09 +0800 Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=20docsearch?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers/Action.md | 22 ++++----- docs/renderers/Audio.md | 2 +- docs/renderers/Button-Group.md | 2 +- docs/renderers/CRUD-Cards.md | 2 +- docs/renderers/CRUD-List.md | 2 +- docs/renderers/CRUD-Table.md | 2 +- docs/renderers/CRUD.md | 2 +- docs/renderers/Card.md | 2 +- docs/renderers/Cards.md | 2 +- docs/renderers/Carousel.md | 2 +- docs/renderers/Chart.md | 2 +- docs/renderers/Collapse.md | 2 +- docs/renderers/Column.md | 2 +- docs/renderers/Dialog.md | 2 +- docs/renderers/Divider.md | 2 +- docs/renderers/Drawer.md | 2 +- docs/renderers/Field.md | 22 ++++----- docs/renderers/Form/Datetime.md | 2 +- docs/renderers/Form/Editor.md | 2 +- docs/renderers/Form/Email.md | 2 +- docs/renderers/Form/FieldSet.md | 2 +- docs/renderers/Form/File.md | 2 +- docs/renderers/Form/Form.md | 2 +- docs/renderers/Form/FormItem.md | 2 +- docs/renderers/Form/Formula.md | 2 +- docs/renderers/Form/Grid.md | 2 +- docs/renderers/Form/Group.md | 2 +- docs/renderers/Form/HBox.md | 2 +- docs/renderers/Form/Hidden.md | 2 +- docs/renderers/Form/Image.md | 2 +- docs/renderers/Form/List.md | 2 +- docs/renderers/Form/Matrix.md | 2 +- docs/renderers/Form/NestedSelect.md | 2 +- docs/renderers/Form/Number.md | 2 +- docs/renderers/Form/Panel.md | 2 +- docs/renderers/Form/Password.md | 2 +- docs/renderers/Form/Picker.md | 2 +- docs/renderers/Form/Radios.md | 2 +- docs/renderers/Form/Range.md | 2 +- docs/renderers/Form/Repeat.md | 2 +- docs/renderers/Form/Rich-Text.md | 2 +- docs/renderers/Form/Select.md | 2 +- docs/renderers/Form/Service.md | 2 +- docs/renderers/Form/SubForm.md | 2 +- docs/renderers/Form/Switch.md | 2 +- docs/renderers/Form/Table.md | 2 +- docs/renderers/Form/Tabs.md | 2 +- docs/renderers/Form/Text.md | 2 +- docs/renderers/Form/Textarea.md | 2 +- docs/renderers/Form/Time.md | 2 +- docs/renderers/Form/Tree.md | 2 +- docs/renderers/Form/TreeSelect.md | 2 +- docs/renderers/Form/Url.md | 2 +- docs/renderers/Grid.md | 2 +- docs/renderers/HBox.md | 2 +- docs/renderers/Html.md | 2 +- docs/renderers/List.md | 2 +- docs/renderers/Nav.md | 2 +- docs/renderers/Operation.md | 2 +- docs/renderers/Page.md | 2 +- docs/renderers/Panel.md | 2 +- docs/renderers/Plain.md | 2 +- docs/renderers/QRCode.md | 2 +- docs/renderers/Service.md | 2 +- docs/renderers/Static.md | 2 +- docs/renderers/Table.md | 2 +- docs/renderers/Tabs.md | 2 +- docs/renderers/Tasks.md | 2 +- docs/renderers/Tpl.md | 2 +- docs/renderers/Types.md | 8 ++-- docs/renderers/Video.md | 2 +- docs/renderers/Wizard.md | 2 +- docs/renderers/Wrapper.md | 2 +- docs/renderers/iFrame.md | 2 +- examples/components/App.jsx | 3 ++ examples/components/DocSearch.jsx | 47 +++++++++++++++++++ examples/components/SchemaRender.jsx | 29 +++++++----- examples/index.html | 4 ++ gh-pages/docs/renderers/Action.js | 38 +++++++-------- gh-pages/docs/renderers/Audio.js | 4 +- gh-pages/docs/renderers/Button-Group.js | 4 +- gh-pages/docs/renderers/CRUD-Cards.js | 4 +- gh-pages/docs/renderers/CRUD-List.js | 4 +- gh-pages/docs/renderers/CRUD-Table.js | 4 +- gh-pages/docs/renderers/CRUD.js | 4 +- gh-pages/docs/renderers/Card.js | 4 +- gh-pages/docs/renderers/Cards.js | 4 +- gh-pages/docs/renderers/Carousel.js | 4 +- gh-pages/docs/renderers/Chart.js | 4 +- gh-pages/docs/renderers/Collapse.js | 4 +- gh-pages/docs/renderers/Column.js | 4 +- gh-pages/docs/renderers/Dialog.js | 4 +- gh-pages/docs/renderers/Drawer.js | 4 +- gh-pages/docs/renderers/Field.js | 24 +++++----- gh-pages/docs/renderers/Form/Datetime.js | 4 +- gh-pages/docs/renderers/Form/Editor.js | 30 ++++++------ gh-pages/docs/renderers/Form/Email.js | 4 +- gh-pages/docs/renderers/Form/FieldSet.js | 4 +- gh-pages/docs/renderers/Form/File.js | 4 +- gh-pages/docs/renderers/Form/Form.js | 4 +- gh-pages/docs/renderers/Form/FormItem.js | 4 +- gh-pages/docs/renderers/Form/Formula.js | 4 +- gh-pages/docs/renderers/Form/Grid.js | 4 +- gh-pages/docs/renderers/Form/Group.js | 4 +- gh-pages/docs/renderers/Form/HBox.js | 4 +- gh-pages/docs/renderers/Form/Hidden.js | 4 +- gh-pages/docs/renderers/Form/Image.js | 4 +- gh-pages/docs/renderers/Form/List.js | 4 +- gh-pages/docs/renderers/Form/Matrix.js | 4 +- gh-pages/docs/renderers/Form/NestedSelect.js | 4 +- gh-pages/docs/renderers/Form/Number.js | 4 +- gh-pages/docs/renderers/Form/Panel.js | 4 +- gh-pages/docs/renderers/Form/Password.js | 4 +- gh-pages/docs/renderers/Form/Picker.js | 4 +- gh-pages/docs/renderers/Form/Radios.js | 4 +- gh-pages/docs/renderers/Form/Range.js | 4 +- gh-pages/docs/renderers/Form/Repeat.js | 4 +- gh-pages/docs/renderers/Form/Rich-Text.js | 4 +- gh-pages/docs/renderers/Form/Select.js | 4 +- gh-pages/docs/renderers/Form/Service.js | 4 +- gh-pages/docs/renderers/Form/SubForm.js | 4 +- gh-pages/docs/renderers/Form/Switch.js | 4 +- gh-pages/docs/renderers/Form/Table.js | 4 +- gh-pages/docs/renderers/Form/Tabs.js | 4 +- gh-pages/docs/renderers/Form/Text.js | 4 +- gh-pages/docs/renderers/Form/Textarea.js | 4 +- gh-pages/docs/renderers/Form/Time.js | 4 +- gh-pages/docs/renderers/Form/Tree.js | 4 +- gh-pages/docs/renderers/Form/TreeSelect.js | 4 +- gh-pages/docs/renderers/Form/Url.js | 4 +- gh-pages/docs/renderers/Grid.js | 4 +- gh-pages/docs/renderers/HBox.js | 4 +- gh-pages/docs/renderers/Html.js | 11 +---- gh-pages/docs/renderers/List.js | 4 +- gh-pages/docs/renderers/Nav.js | 4 +- gh-pages/docs/renderers/Page.js | 4 +- gh-pages/docs/renderers/Panel.js | 4 +- gh-pages/docs/renderers/Plain.js | 4 +- gh-pages/docs/renderers/QRCode.js | 4 +- gh-pages/docs/renderers/Service.js | 4 +- gh-pages/docs/renderers/Static.js | 18 +++---- gh-pages/docs/renderers/Table.js | 4 +- gh-pages/docs/renderers/Tabs.js | 4 +- gh-pages/docs/renderers/Tasks.js | 4 +- gh-pages/docs/renderers/Tpl.js | 4 +- gh-pages/docs/renderers/Types.js | 10 ++-- gh-pages/docs/renderers/Video.js | 4 +- gh-pages/docs/renderers/Wizard.js | 4 +- gh-pages/docs/renderers/Wrapper.js | 4 +- gh-pages/docs/renderers/iFrame.js | 4 +- gh-pages/index.html | 5 +- .../pkg/{app_0f244c5.js => app_08f28ee.js} | 6 ++- scraper-config.json | 4 +- 153 files changed, 373 insertions(+), 314 deletions(-) create mode 100644 examples/components/DocSearch.jsx rename gh-pages/pkg/{app_0f244c5.js => app_08f28ee.js} (98%) diff --git a/docs/renderers/Action.md b/docs/renderers/Action.md index d3be5474..78601d97 100644 --- a/docs/renderers/Action.md +++ b/docs/renderers/Action.md @@ -1,8 +1,8 @@ -### Action +# Action Action 是一种特殊的渲染器,它本身是一个按钮,同时它能触发事件。 -#### 通用配置项 +## 通用配置项 所有`actionType`都支持的通用配置项 | 属性名 | 类型 | 默认值 | 说明 | @@ -26,7 +26,7 @@ Action 是一种特殊的渲染器,它本身是一个按钮,同时它能触 下面会分别介绍每种类型的Action配置项 -#### ajax +## ajax | 属性名 | 类型 | 默认值 | 说明 | | ---------- | ----------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------- | | actionType | `string` | `ajax` | 发送请求 | @@ -35,45 +35,45 @@ Action 是一种特殊的渲染器,它本身是一个按钮,同时它能触 | feedback | `DialogObject` | - | 如果 ajax 类型的,当 ajax 返回正常后,还能接着弹出一个 dialog 做其他交互。返回的数据可用于这个 dialog 中。格式可参考[Dialog](./Dialog.md) | | messages | `object` | - | `success`:ajax 操作成功后提示,可以不指定,不指定时以 api 返回为准。`failed`:ajax 操作失败提示。 | -#### link +## link | 属性名 | 类型 | 默认值 | 说明 | | ---------- | -------- | ------ | ------------------------------------------------------------------------------------------------------------------- | | actionType | `string` | `link` | 单页跳转 | | link | `string` | `link` | 用来指定跳转地址,跟 url 不同的是,这是单页跳转方式,不会渲染浏览器,请指定 amis 平台内的页面。可用 `${xxx}` 取值。 | -#### url +## url | 属性名 | 类型 | 默认值 | 说明 | | ---------- | --------- | ------- | ------------------------------------------------ | | actionType | `string` | `url` | 页面跳转 | | url | `string` | - | 按钮点击后,会打开指定页面。可用 `${xxx}` 取值。 | | blank | `boolean` | `false` | 如果为 `true` 将在新tab页面打开。 | -#### dialog +## dialog | 属性名 | 类型 | 默认值 | 说明 | | ------------- | -------------------------- | -------- | --------------------------------------------- | | actionType | `string` | `dialog` | 点击后显示一个弹出框 | | dialog | `string` 或 `DialogObject` | - | 指定弹框内容,格式可参考[Dialog](./Dialog.md) | | nextCondition | `boolean` | - | 可以用来设置下一条数据的条件,默认为 `true`。 | -#### drawer +## drawer | 属性名 | 类型 | 默认值 | 说明 | | ---------- | -------------------------- | -------- | --------------------------------------------- | | actionType | `string` | `drawer` | 点击后显示一个侧边栏 | | drawer | `string` 或 `DrawerObject` | - | 指定弹框内容,格式可参考[Drawer](./Drawer.md) | -#### copy +## copy | 属性名 | 类型 | 默认值 | 说明 | | ---------- | -------- | ------ | ------------------------------------ | | actionType | `string` | `copy` | 复制一段内容到粘贴板 | | content | `string` | - | 指定复制的内容。可用 `${xxx}` 取值。 | -### reload +## reload | 属性名 | 类型 | 默认值 | 说明 | | ---------- | -------- | -------- | --------------------------------------------------------------------------- | | actionType | `string` | `reload` | 刷新目标组件 | | target | `string` | - | 需要刷新的目标组件名字(组件的`name`值,自己配置的),多个请用 `,` 号隔开。 | -#### add +## add 该actionType为[FormItem-Table](./FormItem-Table.md)专用 | 属性名 | 类型 | 默认值 | 说明 | @@ -81,7 +81,7 @@ Action 是一种特殊的渲染器,它本身是一个按钮,同时它能触 | actionType | `string` | `add` | 给指定`FormItem-Table`添加一条数据, | | target | `string` | - | 指定`FormItem-Table`的名字(`Table`的`name`值),多个请用 `,` 号隔开。 | -#### 其他配置项 +## 其他配置项 | 属性名 | 类型 | 默认值 | 说明 | | -------- | --------------- | ------- | ----------------------------------------------------------------------------------------------------------- | | close | `boolean` | `false` | 当`action`配置在`dialog`或`drawer`的`actions`中时,配置为`true`指定此次操作完后关闭当前`dialog`或`drawer`。 | diff --git a/docs/renderers/Audio.md b/docs/renderers/Audio.md index 7055f451..96b55ec3 100644 --- a/docs/renderers/Audio.md +++ b/docs/renderers/Audio.md @@ -1,4 +1,4 @@ -### Audio +# Audio 音频播放器 diff --git a/docs/renderers/Button-Group.md b/docs/renderers/Button-Group.md index 863b61e8..de90b558 100644 --- a/docs/renderers/Button-Group.md +++ b/docs/renderers/Button-Group.md @@ -1,4 +1,4 @@ -## Button-Group +# Button-Group 按钮集合。 diff --git a/docs/renderers/CRUD-Cards.md b/docs/renderers/CRUD-Cards.md index e82fb864..0e5836e1 100644 --- a/docs/renderers/CRUD-Cards.md +++ b/docs/renderers/CRUD-Cards.md @@ -1,4 +1,4 @@ -### Cards(CRUD) +## Cards(CRUD) 请参考[Cards](./Cards.md) diff --git a/docs/renderers/CRUD-List.md b/docs/renderers/CRUD-List.md index b05ed2f6..d45b3af4 100644 --- a/docs/renderers/CRUD-List.md +++ b/docs/renderers/CRUD-List.md @@ -1,4 +1,4 @@ -### List(CRUD) +## List(CRUD) 请参考[List](./List.md) diff --git a/docs/renderers/CRUD-Table.md b/docs/renderers/CRUD-Table.md index a55f7e0c..4c7b29d6 100644 --- a/docs/renderers/CRUD-Table.md +++ b/docs/renderers/CRUD-Table.md @@ -1,4 +1,4 @@ -### Table(CRUD) +## Table(CRUD) 在 CRUD 中的 Table 主要增加了 Column 里面的以下配置功能,更多参数,请参考[Table](./Table.md) diff --git a/docs/renderers/CRUD.md b/docs/renderers/CRUD.md index b2ec2095..9874684c 100644 --- a/docs/renderers/CRUD.md +++ b/docs/renderers/CRUD.md @@ -1,4 +1,4 @@ -### CRUD +# CRUD 增删改查模型,主要用来展现列表,并支持各类【增】【删】【改】【查】的操作。 diff --git a/docs/renderers/Card.md b/docs/renderers/Card.md index 863679ba..db0f3b72 100644 --- a/docs/renderers/Card.md +++ b/docs/renderers/Card.md @@ -1,4 +1,4 @@ -## Card +# Card 卡片的展示形式。 diff --git a/docs/renderers/Cards.md b/docs/renderers/Cards.md index 59dfea52..309ebca2 100644 --- a/docs/renderers/Cards.md +++ b/docs/renderers/Cards.md @@ -1,4 +1,4 @@ -## Cards +# Cards 卡片集合。 diff --git a/docs/renderers/Carousel.md b/docs/renderers/Carousel.md index d92323a2..588ec3d8 100644 --- a/docs/renderers/Carousel.md +++ b/docs/renderers/Carousel.md @@ -1,4 +1,4 @@ -### Carousel +# Carousel 轮播图 diff --git a/docs/renderers/Chart.md b/docs/renderers/Chart.md index ca38999d..b3b4b9c1 100644 --- a/docs/renderers/Chart.md +++ b/docs/renderers/Chart.md @@ -1,4 +1,4 @@ -### Chart +# Chart 图表渲染器,采用 echarts 渲染,配置格式跟 echarts 相同,配置文档[文档](http://echarts.baidu.com/option.html#title) diff --git a/docs/renderers/Collapse.md b/docs/renderers/Collapse.md index 1c145c8d..f566677a 100644 --- a/docs/renderers/Collapse.md +++ b/docs/renderers/Collapse.md @@ -1,4 +1,4 @@ -### Collapse +# Collapse 折叠器 diff --git a/docs/renderers/Column.md b/docs/renderers/Column.md index b896a51f..c5a38dd3 100644 --- a/docs/renderers/Column.md +++ b/docs/renderers/Column.md @@ -1,4 +1,4 @@ -### Column +# Column 表格中的列配置 diff --git a/docs/renderers/Dialog.md b/docs/renderers/Dialog.md index 9895bf78..45abb497 100644 --- a/docs/renderers/Dialog.md +++ b/docs/renderers/Dialog.md @@ -1,4 +1,4 @@ -### Dialog +# Dialog Dialog 由 [Action](./Action.md) 触发。他是一个类似于 [Page](./Page.md) 的容器模型。 diff --git a/docs/renderers/Divider.md b/docs/renderers/Divider.md index d9c93778..4ddd2af4 100644 --- a/docs/renderers/Divider.md +++ b/docs/renderers/Divider.md @@ -1,4 +1,4 @@ -### Divider +# Divider 分割线 diff --git a/docs/renderers/Drawer.md b/docs/renderers/Drawer.md index 4699447d..9d8690be 100644 --- a/docs/renderers/Drawer.md +++ b/docs/renderers/Drawer.md @@ -1,4 +1,4 @@ -### Drawer +# Drawer Drawer 由 [Action](./Action.md) 触发。 diff --git a/docs/renderers/Field.md b/docs/renderers/Field.md index 2b44a3df..4e864dab 100644 --- a/docs/renderers/Field.md +++ b/docs/renderers/Field.md @@ -1,4 +1,4 @@ -## Field +# Field 主要用在 [Table](./Table.md) 的列配置 Column、[List](./List.md) 的内容、[Card](./Card.md) 卡片的内容和表单的[Static-XXX](./Static.md#static-xxx) 中。它主要用来展示数据。 @@ -74,7 +74,7 @@ } ``` -### Field 通用配置 +## Field 通用配置 - `name` 绑定变量名。 - `placeholder` 当没有值时的展示内容。 @@ -89,19 +89,19 @@ - `copyable` 配置后会在内容区增加一个复制按钮,点击后把内容复制到剪切板。 todo -### Tpl(Field) +## Tpl(Field) 请参考[tpl](./Tpl.md) -### Plain(Field) +## Plain(Field) 请参考[Plain](./Plain.md) -### Json(Field) +## Json(Field) todo -### Date(Field) +## Date(Field) 用来显示日期。 @@ -109,7 +109,7 @@ todo - `format` 默认为 `YYYY-MM-DD`,时间格式,请参考 moment 中的格式用法。 - `valueFormat` 默认为 `X`,时间格式,请参考 moment 中的格式用法。 -### Mapping(Field) +## Mapping(Field) 用来对值做映射显示。 @@ -129,7 +129,7 @@ todo 当值为 1 时,显示 One, 当值为其他时会命中 `*` 所以显示 `其他 flag的值`。 -### Image(Field) +## Image(Field) 用来展示图片。 @@ -139,7 +139,7 @@ todo - `className` CSS 类名。 - `src` 图片地址,支持变量。如果想动态显示,请勿配置。 -### Progress(Field) +## Progress(Field) 用来展示进度条。 @@ -157,7 +157,7 @@ todo - `progressClassName` 进度外层 CSS 类名 默认为: `progress-xs progress-striped active m-t-xs m-b-none` - `progressBarClassName` 进度条 CSS 类名。 -### Status(Field) +## Status(Field) 用来显示状态,用图表展示。 @@ -174,7 +174,7 @@ todo 这个例子,当值为 0 、2、4 ... 时显示红 `X`, 当值为 1, 3, 5 ...  绿 `√` -### Switch(Field) +## Switch(Field) 用来占一个开关。 diff --git a/docs/renderers/Form/Datetime.md b/docs/renderers/Form/Datetime.md index 89f5d058..dda3337e 100644 --- a/docs/renderers/Form/Datetime.md +++ b/docs/renderers/Form/Datetime.md @@ -1,4 +1,4 @@ -### Datetime +## Datetime 日期时间类型。 diff --git a/docs/renderers/Form/Editor.md b/docs/renderers/Form/Editor.md index bc3adb40..9d4ad982 100644 --- a/docs/renderers/Form/Editor.md +++ b/docs/renderers/Form/Editor.md @@ -1,4 +1,4 @@ -### Editor +## Editor ### XXX-Editor diff --git a/docs/renderers/Form/Email.md b/docs/renderers/Form/Email.md index ed9d55b4..07bfb0c8 100644 --- a/docs/renderers/Form/Email.md +++ b/docs/renderers/Form/Email.md @@ -1,4 +1,4 @@ -### Email +## Email Email 输入框。 diff --git a/docs/renderers/Form/FieldSet.md b/docs/renderers/Form/FieldSet.md index 88fa3bed..cfcef088 100644 --- a/docs/renderers/Form/FieldSet.md +++ b/docs/renderers/Form/FieldSet.md @@ -1,4 +1,4 @@ -### FieldSet +## FieldSet 多个输入框可以通过 fieldSet 捆绑在一起。 diff --git a/docs/renderers/Form/File.md b/docs/renderers/Form/File.md index 45106563..a62298ea 100644 --- a/docs/renderers/Form/File.md +++ b/docs/renderers/Form/File.md @@ -1,4 +1,4 @@ -### File +## File 文件输入,amis 也默认处理了图片存储,提交给 API 的是文件的下载地址。 diff --git a/docs/renderers/Form/Form.md b/docs/renderers/Form/Form.md index 5bd8e97d..d89fe12b 100644 --- a/docs/renderers/Form/Form.md +++ b/docs/renderers/Form/Form.md @@ -1,4 +1,4 @@ -## Form +# Form 表单渲染器,主要用来展示或者接收用户输入后将数据提交给后端或者其他组件。 diff --git a/docs/renderers/Form/FormItem.md b/docs/renderers/Form/FormItem.md index e23a5ba9..3000371d 100644 --- a/docs/renderers/Form/FormItem.md +++ b/docs/renderers/Form/FormItem.md @@ -1,4 +1,4 @@ -### FormItem +## FormItem Form 中主要是由各种 FormItem 组成。FormItem 中主要包含这些字段。 diff --git a/docs/renderers/Form/Formula.md b/docs/renderers/Form/Formula.md index 65244f8d..31a0f6ef 100644 --- a/docs/renderers/Form/Formula.md +++ b/docs/renderers/Form/Formula.md @@ -1,4 +1,4 @@ -### Formula +## Formula 公式类型,可以设置公式,并将结果设置给目标值。 diff --git a/docs/renderers/Form/Grid.md b/docs/renderers/Form/Grid.md index b8599f6d..cf752c8c 100644 --- a/docs/renderers/Form/Grid.md +++ b/docs/renderers/Form/Grid.md @@ -1,4 +1,4 @@ -### Grid(FormItem) +## Grid(FormItem) 支持 form 内部再用 grid 布局。 diff --git a/docs/renderers/Form/Group.md b/docs/renderers/Form/Group.md index b44be91f..6a1cbab7 100644 --- a/docs/renderers/Form/Group.md +++ b/docs/renderers/Form/Group.md @@ -1,4 +1,4 @@ -### Group +## Group 表单项集合中,默认都是一行一个,如果想要一行多个,请用 Group 包裹起来。 diff --git a/docs/renderers/Form/HBox.md b/docs/renderers/Form/HBox.md index 95591c04..010aae5d 100644 --- a/docs/renderers/Form/HBox.md +++ b/docs/renderers/Form/HBox.md @@ -1,4 +1,4 @@ -### HBox(FormItem) +## HBox(FormItem) 支持 form 内部再用 HBox 布局,实现左右排列。没错用 [Group](./Group.md) 也能实现,所以还是推荐用 [Group](./Group.md)。 diff --git a/docs/renderers/Form/Hidden.md b/docs/renderers/Form/Hidden.md index babeeb61..dd61c35a 100644 --- a/docs/renderers/Form/Hidden.md +++ b/docs/renderers/Form/Hidden.md @@ -1,4 +1,4 @@ -### Hidden +## Hidden 隐藏字段类型,默认表单提交,只会发送 controls 里面的这些成员,对于隐藏的字段同时又希望提交表单的时候带过去,请把表单项配置成 `hidden` 类型。 diff --git a/docs/renderers/Form/Image.md b/docs/renderers/Form/Image.md index 4978c8ed..943bbc33 100644 --- a/docs/renderers/Form/Image.md +++ b/docs/renderers/Form/Image.md @@ -1,4 +1,4 @@ -### Image +## Image 图片格式输入,默认 amis 会直接存储在 FEX 的 hiphoto 里面,提交到 form 是直接的图片 url。 diff --git a/docs/renderers/Form/List.md b/docs/renderers/Form/List.md index 5a424f94..29f69af7 100644 --- a/docs/renderers/Form/List.md +++ b/docs/renderers/Form/List.md @@ -1,4 +1,4 @@ -### List(FormItem) +## List(FormItem) 简单的列表选择框。 diff --git a/docs/renderers/Form/Matrix.md b/docs/renderers/Form/Matrix.md index 21fcfb77..684cb7fe 100644 --- a/docs/renderers/Form/Matrix.md +++ b/docs/renderers/Form/Matrix.md @@ -1,4 +1,4 @@ -### Matrix +## Matrix 矩阵类型的输入框。 diff --git a/docs/renderers/Form/NestedSelect.md b/docs/renderers/Form/NestedSelect.md index 785fe3f2..277fa1ab 100644 --- a/docs/renderers/Form/NestedSelect.md +++ b/docs/renderers/Form/NestedSelect.md @@ -1,4 +1,4 @@ -### NestedSelect +## NestedSelect 树形结构选择框。 diff --git a/docs/renderers/Form/Number.md b/docs/renderers/Form/Number.md index 1aaf5b15..77108d3c 100644 --- a/docs/renderers/Form/Number.md +++ b/docs/renderers/Form/Number.md @@ -1,4 +1,4 @@ -### Number +## Number 数字输入框。 diff --git a/docs/renderers/Form/Panel.md b/docs/renderers/Form/Panel.md index a6adf12f..38326da1 100644 --- a/docs/renderers/Form/Panel.md +++ b/docs/renderers/Form/Panel.md @@ -1,4 +1,4 @@ -### Panel(FormItem) +## Panel(FormItem) 还是为了布局,可以把一部分 [FormItem](./FormItem.md) 合并到一个 panel 里面单独展示。 diff --git a/docs/renderers/Form/Password.md b/docs/renderers/Form/Password.md index 376bd322..b980a394 100644 --- a/docs/renderers/Form/Password.md +++ b/docs/renderers/Form/Password.md @@ -1,4 +1,4 @@ -### Password +## Password 密码输入框。 diff --git a/docs/renderers/Form/Picker.md b/docs/renderers/Form/Picker.md index 5eb58044..253cef3b 100644 --- a/docs/renderers/Form/Picker.md +++ b/docs/renderers/Form/Picker.md @@ -1,4 +1,4 @@ -### Picker +## Picker 列表选取。可以静态数据,或者通过接口拉取动态数据。 diff --git a/docs/renderers/Form/Radios.md b/docs/renderers/Form/Radios.md index 37f478c3..b8159c65 100644 --- a/docs/renderers/Form/Radios.md +++ b/docs/renderers/Form/Radios.md @@ -1,4 +1,4 @@ -### Radios +## Radios 单选框 diff --git a/docs/renderers/Form/Range.md b/docs/renderers/Form/Range.md index eceaadf7..8732fc39 100644 --- a/docs/renderers/Form/Range.md +++ b/docs/renderers/Form/Range.md @@ -1,4 +1,4 @@ -### Range +## Range 范围输入框。 diff --git a/docs/renderers/Form/Repeat.md b/docs/renderers/Form/Repeat.md index a2c4c40a..e78a016a 100644 --- a/docs/renderers/Form/Repeat.md +++ b/docs/renderers/Form/Repeat.md @@ -1,4 +1,4 @@ -### Repeat +## Repeat 可用来设置重复频率 diff --git a/docs/renderers/Form/Rich-Text.md b/docs/renderers/Form/Rich-Text.md index 01b61d5a..cad05897 100644 --- a/docs/renderers/Form/Rich-Text.md +++ b/docs/renderers/Form/Rich-Text.md @@ -1,4 +1,4 @@ -### Rich-Text +## Rich-Text 富文本编辑器 diff --git a/docs/renderers/Form/Select.md b/docs/renderers/Form/Select.md index 564c471d..e860607d 100644 --- a/docs/renderers/Form/Select.md +++ b/docs/renderers/Form/Select.md @@ -1,4 +1,4 @@ -### Select +## Select 选项表单。 diff --git a/docs/renderers/Form/Service.md b/docs/renderers/Form/Service.md index f266b0be..aaeddeac 100644 --- a/docs/renderers/Form/Service.md +++ b/docs/renderers/Form/Service.md @@ -1,4 +1,4 @@ -### Service(FormItem) +## Service(FormItem) 目前看到的配置方式都是静态配置,如果你想动态配置,即配置项由接口决定,那么就使用此渲染器。 diff --git a/docs/renderers/Form/SubForm.md b/docs/renderers/Form/SubForm.md index dc5d0951..c07d10f2 100644 --- a/docs/renderers/Form/SubForm.md +++ b/docs/renderers/Form/SubForm.md @@ -1,4 +1,4 @@ -### SubForm +## SubForm formItem 还可以是子表单类型。 diff --git a/docs/renderers/Form/Switch.md b/docs/renderers/Form/Switch.md index a9cb78be..79065744 100644 --- a/docs/renderers/Form/Switch.md +++ b/docs/renderers/Form/Switch.md @@ -1,4 +1,4 @@ -### Switch +## Switch 可选框,和 checkbox 完全等价。 diff --git a/docs/renderers/Form/Table.md b/docs/renderers/Form/Table.md index 3a8603fd..888627e6 100644 --- a/docs/renderers/Form/Table.md +++ b/docs/renderers/Form/Table.md @@ -1,4 +1,4 @@ -### Table(FormItem) +## Table(FormItem) 可以用来展现数据的,可以用来展示数组类型的数据,比如 multiple 的[子 form](./SubForm.md)。 diff --git a/docs/renderers/Form/Tabs.md b/docs/renderers/Form/Tabs.md index f6a46bd1..c4603bdd 100644 --- a/docs/renderers/Form/Tabs.md +++ b/docs/renderers/Form/Tabs.md @@ -1,4 +1,4 @@ -### Tabs(FormItem) +## Tabs(FormItem) 多个输入框也可以通过选项卡来分组。 diff --git a/docs/renderers/Form/Text.md b/docs/renderers/Form/Text.md index f3034cfd..25997a04 100644 --- a/docs/renderers/Form/Text.md +++ b/docs/renderers/Form/Text.md @@ -1,4 +1,4 @@ -### Text +## Text 普通的文本输入框。 diff --git a/docs/renderers/Form/Textarea.md b/docs/renderers/Form/Textarea.md index aeb2c0a8..00908aed 100644 --- a/docs/renderers/Form/Textarea.md +++ b/docs/renderers/Form/Textarea.md @@ -1,4 +1,4 @@ -### Textarea +## Textarea 多行文本输入框。 diff --git a/docs/renderers/Form/Time.md b/docs/renderers/Form/Time.md index 595eef04..869489c6 100644 --- a/docs/renderers/Form/Time.md +++ b/docs/renderers/Form/Time.md @@ -1,4 +1,4 @@ -### Time +## Time 时间类型。 diff --git a/docs/renderers/Form/Tree.md b/docs/renderers/Form/Tree.md index 2a078c6a..423beb37 100644 --- a/docs/renderers/Form/Tree.md +++ b/docs/renderers/Form/Tree.md @@ -1,4 +1,4 @@ -### Tree +## Tree 树形结构输入框。 diff --git a/docs/renderers/Form/TreeSelect.md b/docs/renderers/Form/TreeSelect.md index d612cb4b..f14bee10 100644 --- a/docs/renderers/Form/TreeSelect.md +++ b/docs/renderers/Form/TreeSelect.md @@ -1,4 +1,4 @@ -### TreeSelect +## TreeSelect 树形结构选择框。 diff --git a/docs/renderers/Form/Url.md b/docs/renderers/Form/Url.md index 6e0555a0..23553d76 100644 --- a/docs/renderers/Form/Url.md +++ b/docs/renderers/Form/Url.md @@ -1,4 +1,4 @@ -### Url +## Url URL 输入框。 diff --git a/docs/renderers/Grid.md b/docs/renderers/Grid.md index 6c1de0c5..79c39656 100644 --- a/docs/renderers/Grid.md +++ b/docs/renderers/Grid.md @@ -1,4 +1,4 @@ -## Grid +# Grid | 属性名 | 类型 | 默认值 | 说明 | | ------------------- | --------------------------------- | -------- | ----------------------- | diff --git a/docs/renderers/HBox.md b/docs/renderers/HBox.md index 4d37c5f4..77da4e59 100644 --- a/docs/renderers/HBox.md +++ b/docs/renderers/HBox.md @@ -1,4 +1,4 @@ -## HBox +# HBox | 属性名 | 类型 | 默认值 | 说明 | | -------------------------- | --------------------------------- | -------------- | -------------------- | diff --git a/docs/renderers/Html.md b/docs/renderers/Html.md index d90c3344..eb3b5787 100644 --- a/docs/renderers/Html.md +++ b/docs/renderers/Html.md @@ -1,4 +1,4 @@ -### Html +# Html html, 当需要用到变量时,请用 [Tpl](./Tpl.md) 代替。 diff --git a/docs/renderers/List.md b/docs/renderers/List.md index c9e7b235..33ff4d9c 100644 --- a/docs/renderers/List.md +++ b/docs/renderers/List.md @@ -1,4 +1,4 @@ -## List +# List 列表展示。 diff --git a/docs/renderers/Nav.md b/docs/renderers/Nav.md index 2f581323..960ef536 100644 --- a/docs/renderers/Nav.md +++ b/docs/renderers/Nav.md @@ -1,4 +1,4 @@ -## Nav +# Nav | 属性名 | 类型 | 默认值 | 说明 | | ----------------- | --------- | -------- | -------------------------------------- | diff --git a/docs/renderers/Operation.md b/docs/renderers/Operation.md index 480ea6e4..d8f54a86 100644 --- a/docs/renderers/Operation.md +++ b/docs/renderers/Operation.md @@ -1,4 +1,4 @@ -### Operation +## Operation 表格列中的操作栏,用来放置按钮集合,只能放在 table 的列配置中。 diff --git a/docs/renderers/Page.md b/docs/renderers/Page.md index bae43e84..67a1fa5a 100644 --- a/docs/renderers/Page.md +++ b/docs/renderers/Page.md @@ -1,4 +1,4 @@ -## Page +# Page Json 配置最外层是一个 `Page` 渲染器。他主要包含标题,副标题,提示信息等设置,需要注意的是,他有三个容器区域分别是:内容区、边栏区和工具条区,在容器里面放不同的渲染器,就能配置出不同的页面来。 diff --git a/docs/renderers/Panel.md b/docs/renderers/Panel.md index 19fe9871..8e4c66d1 100644 --- a/docs/renderers/Panel.md +++ b/docs/renderers/Panel.md @@ -1,4 +1,4 @@ -### Panel +# Panel 可以把相关信息以盒子的形式展示到一块。 diff --git a/docs/renderers/Plain.md b/docs/renderers/Plain.md index f398a4cf..0e58d298 100644 --- a/docs/renderers/Plain.md +++ b/docs/renderers/Plain.md @@ -1,4 +1,4 @@ -### Plain +# Plain plain, 单纯的文字输出来。 diff --git a/docs/renderers/QRCode.md b/docs/renderers/QRCode.md index d865ea37..789e553d 100644 --- a/docs/renderers/QRCode.md +++ b/docs/renderers/QRCode.md @@ -1,4 +1,4 @@ -## QRCode +# QRCode 二维码显示组件 diff --git a/docs/renderers/Service.md b/docs/renderers/Service.md index 74c05ae0..9af91465 100644 --- a/docs/renderers/Service.md +++ b/docs/renderers/Service.md @@ -1,4 +1,4 @@ -## Service +# Service 功能型容器,自身不负责展示内容,主要职责在于通过配置的 api 拉取数据,数据可用于子组件。 该组件初始化时就会自动拉取一次数据,后续如果需要刷新,请结合 Action 实现,可以把 Action 的 actionType 设置为 reload, target 为该组件的 name 值。 diff --git a/docs/renderers/Static.md b/docs/renderers/Static.md index 0411e856..0bd66aec 100644 --- a/docs/renderers/Static.md +++ b/docs/renderers/Static.md @@ -1,4 +1,4 @@ -### Static +## Static 纯用来展现数据的。 diff --git a/docs/renderers/Table.md b/docs/renderers/Table.md index 68f984ae..3f306283 100644 --- a/docs/renderers/Table.md +++ b/docs/renderers/Table.md @@ -1,4 +1,4 @@ -### Table +# Table 表格展示。 diff --git a/docs/renderers/Tabs.md b/docs/renderers/Tabs.md index af08cec1..bd77b460 100644 --- a/docs/renderers/Tabs.md +++ b/docs/renderers/Tabs.md @@ -1,4 +1,4 @@ -## Tabs +# Tabs | 属性名 | 类型 | 默认值 | 说明 | | ----------------- | ----------------------- | ----------------------------------- | -------------------------------------------------------- | diff --git a/docs/renderers/Tasks.md b/docs/renderers/Tasks.md index 4cd0df37..2a5488eb 100644 --- a/docs/renderers/Tasks.md +++ b/docs/renderers/Tasks.md @@ -1,4 +1,4 @@ -## Tasks +# Tasks 任务操作集合,类似于 orp 上线。 diff --git a/docs/renderers/Tpl.md b/docs/renderers/Tpl.md index 225ba422..bc266252 100644 --- a/docs/renderers/Tpl.md +++ b/docs/renderers/Tpl.md @@ -1,4 +1,4 @@ -### Tpl +# Tpl tpl 类型的渲染器支持用 JS 模板引擎来组织输出,采用的 lodash 的 [template](https://lodash.com/docs/4.15.0#template),关于语法部分,请前往 lodash 文档页面。 diff --git a/docs/renderers/Types.md b/docs/renderers/Types.md index aa897670..31aa1e9f 100644 --- a/docs/renderers/Types.md +++ b/docs/renderers/Types.md @@ -1,6 +1,6 @@ -## 类型说明 +# 类型说明 -### Container +## Container Container 不是一个特定的渲染器,而是 amis 中一个特殊类型,它是以下类型的任何一种。 @@ -40,7 +40,7 @@ Container 不是一个特定的渲染器,而是 amis 中一个特殊类型, } ``` -### API +## API Api 类型可以是字符串或者对象。API 中可以直接设置数据发送结构,注意看示例。 @@ -125,7 +125,7 @@ Api 类型可以是字符串或者对象。API 中可以直接设置数据发送 amis 所有值为 url 的如: `"http://www.baidu.com"` 都会被替换成 proxy 代理,如果不希望这么做,请明确指示如: `"raw:http://www.baidu.com"`。还有为了安全,amis 默认只能转发公司内部 API 接口,如果您的接口在外网环境,也请明确指示如:`"external:http://www.baidu.com"` -### 表达式 +## 表达式 配置项中,所有 `boolean` 类型的配置,都可以用 JS 表达式来配置。所有`boolean` 配置项,后面加个 `On` 则是表达式配置方式,可以用 js 语法来根据当前模型中的数据来决定是否启用。 如:[FormItem](./FormItem.md) 中的 `disabledOn`、`hiddenOn`、`visibleOn`、[CRUD](./CRUD.md) 中的 `itemDraggableOn` 等等。 diff --git a/docs/renderers/Video.md b/docs/renderers/Video.md index 4c324203..613dd7ee 100644 --- a/docs/renderers/Video.md +++ b/docs/renderers/Video.md @@ -1,4 +1,4 @@ -### Video +# Video 视频播放器。 diff --git a/docs/renderers/Wizard.md b/docs/renderers/Wizard.md index 3aa03f89..184b82fe 100644 --- a/docs/renderers/Wizard.md +++ b/docs/renderers/Wizard.md @@ -1,4 +1,4 @@ -### Wizard +# Wizard 表单向导,能够配置多个步骤引导用户一步一步完成表单提交。 diff --git a/docs/renderers/Wrapper.md b/docs/renderers/Wrapper.md index f1dd53c4..b73ad662 100644 --- a/docs/renderers/Wrapper.md +++ b/docs/renderers/Wrapper.md @@ -1,4 +1,4 @@ -### Wrapper +# Wrapper 简单的一个容器。 diff --git a/docs/renderers/iFrame.md b/docs/renderers/iFrame.md index 2bb43f4a..71c83b62 100644 --- a/docs/renderers/iFrame.md +++ b/docs/renderers/iFrame.md @@ -1,4 +1,4 @@ -## iFrame +# iFrame 如果需要内嵌外部站点,可用 iframe 来实现。 diff --git a/examples/components/App.jsx b/examples/components/App.jsx index 86103df0..6d91a616 100644 --- a/examples/components/App.jsx +++ b/examples/components/App.jsx @@ -82,6 +82,7 @@ import Tab3Schema from './Tabs/Tab3'; import TestComponent from './Test'; import Select from '../../src/components/Select'; import Button from '../../src/components/Button'; +import DocSearch from './DocSearch'; let PathPrefix = '/examples'; @@ -706,6 +707,8 @@ export class App extends React.PureComponent { /> )} + + ); diff --git a/examples/components/DocSearch.jsx b/examples/components/DocSearch.jsx new file mode 100644 index 00000000..01e0f49e --- /dev/null +++ b/examples/components/DocSearch.jsx @@ -0,0 +1,47 @@ +import * as React from 'react'; +import makeSchemaRenderer from './SchemaRender'; + +const FormComponent = makeSchemaRenderer({ + type: 'form', + mode: 'inline', + wrapWithPanel: false, + className: 'pull-right m-t-sm m-r', + controls: [{ + "type": "input-group", + "size": "sm", + "controls": [ + { + "type": "icon", + "addOnclassName": "no-bg", + "className": "text-sm", + "icon": "search", + "vendor": "iconfont" + }, + { + "type": "text", + "placeholder": "搜索文档", + "inputClassName": "b-l-none p-l-none", + "name": "docsearch" + } + ] + }] +}) + +export default class DocSearch extends React.Component { + componentDidMount() { + const inputSelector = 'input[name="docsearch"]'; + docsearch({ + appId: '3W0NHYOWPE', + apiKey: '469f5cf3d54f9b86127970f913dc0725', + indexName: 'gh_pages', + inputSelector, + debug: false, + }); + } + + render() { + return ( + + ); + } +} \ No newline at end of file diff --git a/examples/components/SchemaRender.jsx b/examples/components/SchemaRender.jsx index ee538ad3..15a0ce32 100644 --- a/examples/components/SchemaRender.jsx +++ b/examples/components/SchemaRender.jsx @@ -150,21 +150,26 @@ export default function(schema) { render() { const ns = this.props.classPrefix; + const showCode = this.props.showCode; return (
- - {this.state.open ? this.renderCode() : null} - + {showCode !== false ? ( + + {this.state.open ? this.renderCode() : null} + + ) : null } {this.renderSchema()} - document.querySelector('.navbar-nav')}> - - + {showCode !== false ? ( + document.querySelector('.navbar-nav')}> + + + ) : null}
); } diff --git a/examples/index.html b/examples/index.html index 8f08e9ee..5ddcc887 100644 --- a/examples/index.html +++ b/examples/index.html @@ -17,6 +17,9 @@ href="animate.css/animate.css"> + @@ -33,6 +36,7 @@
+ \n\n
  • link 当按钮点击后,无刷新进入 amis 内部某个页面。

    \n
    \n
  • \n
  • url 当按钮点击后,新窗口打开指定页面。

    \n
    \n
  • \n
  • dialog 当按钮点击后,弹出一个对话框。 关于 dialog 配置,请查看 Dialog 模型

    \n
    \n
  • \n
  • drawer 当按钮点击后,弹出一个抽出式对话框。 关于 drawer 配置,请查看 Drawer 模型

    \n
    \n
  • \n\n", + "html": "

    Action

    Action 是一种特殊的渲染器,它本身是一个按钮,同时它能触发事件。

    \n

    通用配置项

    所有actionType都支持的通用配置项

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestringaction指定为 Page 渲染器。
    actionTypestring-【必填】这是action最核心的配置,来指定该action的作用类型,支持:ajaxlinkurldrawerdialogconfirmcancelprevnextcopyclose
    labelstring-按钮文本。可用 ${xxx} 取值。
    levelstringdefault按钮样式,支持:linkprimarysecondaryinfosuccesswarningdangerlightdarkdefault
    sizestring-按钮大小,支持:xssmmdlg
    iconstring-设置图标,例如fa fa-plus
    iconClassNamestring-给图标上添加类名。
    activeboolean-按钮是否高亮。
    activeLevelstring-按钮高亮时的样式,配置支持同level
    activeClassNamestringis-active给按钮高亮添加类名。
    blockboolean-display:"block"来显示按钮。
    confirmTextstring-当设置后,操作在开始前会询问用户。可用 ${xxx} 取值。
    reloadstring-指定此次操作完后,需要刷新的目标组件名字(组件的name值,自己配置的),多个请用 , 号隔开。
    tooltipstring-鼠标停留时弹出该段文字,也可以配置对象类型:字段为titlecontent。可用 ${xxx} 取值。
    disabledTipstring-被禁用后鼠标停留时弹出该段文字,也可以配置对象类型:字段为titlecontent。可用 ${xxx} 取值。
    tooltipPlacementstringtop如果配置了tooltip或者disabledTip,指定提示信息位置,可配置topbottomleftright
    \n

    下面会分别介绍每种类型的Action配置项

    \n

    ajax

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    actionTypestringajax发送请求
    apistringApiObject-请求地址,参考 api 格式说明。
    redirectstring-指定当前请求结束后跳转的路径,可用 ${xxx} 取值。
    feedbackDialogObject-如果 ajax 类型的,当 ajax 返回正常后,还能接着弹出一个 dialog 做其他交互。返回的数据可用于这个 dialog 中。格式可参考Dialog
    messagesobject-success:ajax 操作成功后提示,可以不指定,不指定时以 api 返回为准。failed:ajax 操作失败提示。
    \n

    link

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    actionTypestringlink单页跳转
    linkstringlink用来指定跳转地址,跟 url 不同的是,这是单页跳转方式,不会渲染浏览器,请指定 amis 平台内的页面。可用 ${xxx} 取值。
    \n

    url

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    actionTypestringurl页面跳转
    urlstring-按钮点击后,会打开指定页面。可用 ${xxx} 取值。
    blankbooleanfalse如果为 true 将在新tab页面打开。
    \n

    dialog

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    actionTypestringdialog点击后显示一个弹出框
    dialogstringDialogObject-指定弹框内容,格式可参考Dialog
    nextConditionboolean-可以用来设置下一条数据的条件,默认为 true
    \n

    drawer

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    actionTypestringdrawer点击后显示一个侧边栏
    drawerstringDrawerObject-指定弹框内容,格式可参考Drawer
    \n

    copy

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    actionTypestringcopy复制一段内容到粘贴板
    contentstring-指定复制的内容。可用 ${xxx} 取值。
    \n

    reload

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    actionTypestringreload刷新目标组件
    targetstring-需要刷新的目标组件名字(组件的name值,自己配置的),多个请用 , 号隔开。
    \n

    add

    该actionType为FormItem-Table专用

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    actionTypestringadd给指定FormItem-Table添加一条数据,
    targetstring-指定FormItem-Table的名字(Tablename值),多个请用 , 号隔开。
    \n

    其他配置项

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    closebooleanfalseaction配置在dialogdraweractions中时,配置为true指定此次操作完后关闭当前dialogdrawer
    requiredArray<string>-配置字符串数组,指定在form中进行操作之前,需验证必填的表单项字段
    \n

    示例:

    \n
      \n
    • ajax 当按钮点击时,发送 ajax 请求,发送的数据取决于所在的容器里面。

      \n
      \n
    • \n
    • link 当按钮点击后,无刷新进入 amis 内部某个页面。

      \n
      \n
    • \n
    • url 当按钮点击后,新窗口打开指定页面。

      \n
      \n
    • \n
    • dialog 当按钮点击后,弹出一个对话框。 关于 dialog 配置,请查看 Dialog 模型

      \n
      \n
    • \n
    • drawer 当按钮点击后,弹出一个抽出式对话框。 关于 drawer 配置,请查看 Drawer 模型

      \n
      \n
    • \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,69 +10,67 @@ define('docs/renderers/Action.md', function(require, exports, module) { "label": "Action", "fragment": "action", "fullPath": "#action", - "level": 3, + "level": 1, "children": [ { "label": "通用配置项", "fragment": "%E9%80%9A%E7%94%A8%E9%85%8D%E7%BD%AE%E9%A1%B9", "fullPath": "#%E9%80%9A%E7%94%A8%E9%85%8D%E7%BD%AE%E9%A1%B9", - "level": 4 + "level": 2 }, { "label": "ajax", "fragment": "ajax", "fullPath": "#ajax", - "level": 4 + "level": 2 }, { "label": "link", "fragment": "link", "fullPath": "#link", - "level": 4 + "level": 2 }, { "label": "url", "fragment": "url", "fullPath": "#url", - "level": 4 + "level": 2 }, { "label": "dialog", "fragment": "dialog", "fullPath": "#dialog", - "level": 4 + "level": 2 }, { "label": "drawer", "fragment": "drawer", "fullPath": "#drawer", - "level": 4 + "level": 2 }, { "label": "copy", "fragment": "copy", "fullPath": "#copy", - "level": 4 - } - ] - }, - { - "label": "reload", - "fragment": "reload", - "fullPath": "#reload", - "level": 3, - "children": [ + "level": 2 + }, + { + "label": "reload", + "fragment": "reload", + "fullPath": "#reload", + "level": 2 + }, { "label": "add", "fragment": "add", "fullPath": "#add", - "level": 4 + "level": 2 }, { "label": "其他配置项", "fragment": "%E5%85%B6%E4%BB%96%E9%85%8D%E7%BD%AE%E9%A1%B9", "fullPath": "#%E5%85%B6%E4%BB%96%E9%85%8D%E7%BD%AE%E9%A1%B9", - "level": 4 + "level": 2 } ] } diff --git a/gh-pages/docs/renderers/Audio.js b/gh-pages/docs/renderers/Audio.js index e09e2c97..433e5f67 100644 --- a/gh-pages/docs/renderers/Audio.js +++ b/gh-pages/docs/renderers/Audio.js @@ -1,7 +1,7 @@ define('docs/renderers/Audio.md', function(require, exports, module) { module.exports = { - "html": "

    Audio

    音频播放器

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"audio"指定为 audio 渲染器
    classNamestring外层 Dom 的类名
    inlinebooleantrue是否是内联模式
    srcstring音频地址
    loopbooleanfalse是否循环播放
    autoPlaybooleanfalse是否自动播放
    ratesarray[]加速播放
    controlsarray['rates', 'play', 'time', 'process', 'volume']内部模块定制化
    \n
    \n", + "html": "

    Audio

    音频播放器

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"audio"指定为 audio 渲染器
    classNamestring外层 Dom 的类名
    inlinebooleantrue是否是内联模式
    srcstring音频地址
    loopbooleanfalse是否循环播放
    autoPlaybooleanfalse是否自动播放
    ratesarray[]加速播放
    controlsarray['rates', 'play', 'time', 'process', 'volume']内部模块定制化
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Audio.md', function(require, exports, module) { "label": "Audio", "fragment": "audio", "fullPath": "#audio", - "level": 3 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Button-Group.js b/gh-pages/docs/renderers/Button-Group.js index 0db02738..65de86e7 100644 --- a/gh-pages/docs/renderers/Button-Group.js +++ b/gh-pages/docs/renderers/Button-Group.js @@ -1,7 +1,7 @@ define('docs/renderers/Button-Group.md', function(require, exports, module) { module.exports = { - "html": "

    Button-Group

    按钮集合。

    \n
      \n
    • type 请设置成 button-group
    • \n
    • buttons 配置按钮集合。
    • \n
    \n
    \n", + "html": "

    Button-Group

    按钮集合。

    \n
      \n
    • type 请设置成 button-group
    • \n
    • buttons 配置按钮集合。
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Button-Group.md', function(require, exports, module) { "label": "Button-Group", "fragment": "button-group", "fullPath": "#button-group", - "level": 2 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/CRUD-Cards.js b/gh-pages/docs/renderers/CRUD-Cards.js index 5de0cdfa..100ea9e9 100644 --- a/gh-pages/docs/renderers/CRUD-Cards.js +++ b/gh-pages/docs/renderers/CRUD-Cards.js @@ -1,7 +1,7 @@ define('docs/renderers/CRUD-Cards.md', function(require, exports, module) { module.exports = { - "html": "

    Cards(CRUD)

    请参考Cards

    \n
    \n", + "html": "

    Cards(CRUD)

    请参考Cards

    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/CRUD-Cards.md', function(require, exports, module) { "label": "Cards(CRUD)", "fragment": "cards-crud-", "fullPath": "#cards-crud-", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/CRUD-List.js b/gh-pages/docs/renderers/CRUD-List.js index fcfa581b..40dc3a29 100644 --- a/gh-pages/docs/renderers/CRUD-List.js +++ b/gh-pages/docs/renderers/CRUD-List.js @@ -1,7 +1,7 @@ define('docs/renderers/CRUD-List.md', function(require, exports, module) { module.exports = { - "html": "

    List(CRUD)

    请参考List

    \n
    \n", + "html": "

    List(CRUD)

    请参考List

    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/CRUD-List.md', function(require, exports, module) { "label": "List(CRUD)", "fragment": "list-crud-", "fullPath": "#list-crud-", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/CRUD-Table.js b/gh-pages/docs/renderers/CRUD-Table.js index 725cf7db..e4a0cad2 100644 --- a/gh-pages/docs/renderers/CRUD-Table.js +++ b/gh-pages/docs/renderers/CRUD-Table.js @@ -1,7 +1,7 @@ define('docs/renderers/CRUD-Table.md', function(require, exports, module) { module.exports = { - "html": "

    Table(CRUD)

    在 CRUD 中的 Table 主要增加了 Column 里面的以下配置功能,更多参数,请参考Table

    \n
      \n
    • sortable 开启后可以根据当前列排序(后端排序)。
    • \n
    \n
    \n", + "html": "

    Table(CRUD)

    在 CRUD 中的 Table 主要增加了 Column 里面的以下配置功能,更多参数,请参考Table

    \n
      \n
    • sortable 开启后可以根据当前列排序(后端排序)。
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/CRUD-Table.md', function(require, exports, module) { "label": "Table(CRUD)", "fragment": "table-crud-", "fullPath": "#table-crud-", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/CRUD.js b/gh-pages/docs/renderers/CRUD.js index 42b92fa2..2e95fc5c 100644 --- a/gh-pages/docs/renderers/CRUD.js +++ b/gh-pages/docs/renderers/CRUD.js @@ -1,7 +1,7 @@ define('docs/renderers/CRUD.md', function(require, exports, module) { module.exports = { - "html": "

    CRUD

    增删改查模型,主要用来展现列表,并支持各类【增】【删】【改】【查】的操作。

    \n

    CRUD 支持三种模式:tablecardslist,默认为 table

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"Action.md" 指定为 CRUD 渲染器
    modestring"table""table" 、 "cards" 或者 "list"
    titlestring""可设置成空,当设置成空时,没有标题栏
    classNamestring表格外层 Dom 的类名
    apiApiCRUD 用来获取列表数据的 api。
    filterForm设置过滤器,当该表单提交后,会把数据带给当前 Action.md 刷新列表。
    filterTogglablebooleanfalse是否可显隐过滤器
    filterDefaultVisiblebooleantrue设置过滤器默认是否可见。
    initFetchbooleantrue是否初始化的时候拉取数据, 只针对有 filter 的情况, 没有 filter 初始都会拉取数据
    intervalnumber3000刷新时间(最低 3000)
    silentPollingbooleanfalse配置刷新时是否隐藏加载动画
    stopAutoRefreshWhenstring""通过表达式来配置停止刷新的条件
    stopAutoRefreshWhenModalIsOpenbooleanfalse当有弹框时关闭自动刷新,关闭弹框又恢复
    syncLocationbooleantrue是否将过滤条件的参数同步到地址栏
    draggablebooleanfalse是否可通过拖拽排序
    itemDraggableOnboolean表达式来配置是否可拖拽排序
    saveOrderApiApi保存排序的 api。
    quickSaveApiApi快速编辑后用来批量保存的 API。
    quickSaveItemApiApi快速编辑配置成及时保存时使用的 API。
    bulkActionsArray Of Action批量操作列表,配置后,表格可进行选中操作。
    defaultCheckedbooleanfalse当可批量操作时,默认是否全部勾选。
    messagesObject覆盖消息提示,如果不指定,将采用 api 返回的 message
    messages.fetchFailedstring获取失败时提示
    messages.saveOrderFailedstring保存顺序失败提示
    messages.saveOrderSuccessstring保存顺序成功提示
    messages.quickSaveFailedstring快速保存失败提示
    messages.quickSaveSuccessstring快速保存成功提示
    primaryFieldstring"id"设置 ID 字段名。
    defaultParamsObject设置默认 filter 默认参数,会在查询的时候一起发给后端
    pageFieldstring"page"设置分页页码字段名。
    perPageFieldstring"perPage"设置分页一页显示的多少条数据的字段名。注意:最好与 defaultParams 一起使用,请看下面例子。
    perPageAvailableArray<number>[5, 10, 20, 50, 100]设置一页显示多少条数据下拉框可选条数。
    orderFieldstring设置用来确定位置的字段名,设置后新的顺序将被赋值到该字段中。
    hideQuickSaveBtnbooleanfalse隐藏顶部快速保存提示
    autoJumpToTopOnPagerChangebooleanfalse当切分页的时候,是否自动跳顶部。
    syncResponse2Querybooleantrue将返回数据同步到过滤器上。
    keepItemSelectionOnPageChangebooleantrue保留条目选择,默认分页、搜素后,用户选择条目会被清空,开启此选项后会保留用户选择,可以实现跨页面批量操作。
    labelTplstring单条描述模板,keepItemSelectionOnPageChange设置为true后会把所有已选择条目列出来,此选项可以用来定制条目展示文案。
    headerToolbarArray['bulkActions', 'pagination']顶部工具栏配置
    footerToolbarArray['statistics', 'pagination']顶部工具栏配置
    \n", + "html": "

    CRUD

    增删改查模型,主要用来展现列表,并支持各类【增】【删】【改】【查】的操作。

    \n

    CRUD 支持三种模式:tablecardslist,默认为 table

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"Action.md" 指定为 CRUD 渲染器
    modestring"table""table" 、 "cards" 或者 "list"
    titlestring""可设置成空,当设置成空时,没有标题栏
    classNamestring表格外层 Dom 的类名
    apiApiCRUD 用来获取列表数据的 api。
    filterForm设置过滤器,当该表单提交后,会把数据带给当前 Action.md 刷新列表。
    filterTogglablebooleanfalse是否可显隐过滤器
    filterDefaultVisiblebooleantrue设置过滤器默认是否可见。
    initFetchbooleantrue是否初始化的时候拉取数据, 只针对有 filter 的情况, 没有 filter 初始都会拉取数据
    intervalnumber3000刷新时间(最低 3000)
    silentPollingbooleanfalse配置刷新时是否隐藏加载动画
    stopAutoRefreshWhenstring""通过表达式来配置停止刷新的条件
    stopAutoRefreshWhenModalIsOpenbooleanfalse当有弹框时关闭自动刷新,关闭弹框又恢复
    syncLocationbooleantrue是否将过滤条件的参数同步到地址栏
    draggablebooleanfalse是否可通过拖拽排序
    itemDraggableOnboolean表达式来配置是否可拖拽排序
    saveOrderApiApi保存排序的 api。
    quickSaveApiApi快速编辑后用来批量保存的 API。
    quickSaveItemApiApi快速编辑配置成及时保存时使用的 API。
    bulkActionsArray Of Action批量操作列表,配置后,表格可进行选中操作。
    defaultCheckedbooleanfalse当可批量操作时,默认是否全部勾选。
    messagesObject覆盖消息提示,如果不指定,将采用 api 返回的 message
    messages.fetchFailedstring获取失败时提示
    messages.saveOrderFailedstring保存顺序失败提示
    messages.saveOrderSuccessstring保存顺序成功提示
    messages.quickSaveFailedstring快速保存失败提示
    messages.quickSaveSuccessstring快速保存成功提示
    primaryFieldstring"id"设置 ID 字段名。
    defaultParamsObject设置默认 filter 默认参数,会在查询的时候一起发给后端
    pageFieldstring"page"设置分页页码字段名。
    perPageFieldstring"perPage"设置分页一页显示的多少条数据的字段名。注意:最好与 defaultParams 一起使用,请看下面例子。
    perPageAvailableArray<number>[5, 10, 20, 50, 100]设置一页显示多少条数据下拉框可选条数。
    orderFieldstring设置用来确定位置的字段名,设置后新的顺序将被赋值到该字段中。
    hideQuickSaveBtnbooleanfalse隐藏顶部快速保存提示
    autoJumpToTopOnPagerChangebooleanfalse当切分页的时候,是否自动跳顶部。
    syncResponse2Querybooleantrue将返回数据同步到过滤器上。
    keepItemSelectionOnPageChangebooleantrue保留条目选择,默认分页、搜素后,用户选择条目会被清空,开启此选项后会保留用户选择,可以实现跨页面批量操作。
    labelTplstring单条描述模板,keepItemSelectionOnPageChange设置为true后会把所有已选择条目列出来,此选项可以用来定制条目展示文案。
    headerToolbarArray['bulkActions', 'pagination']顶部工具栏配置
    footerToolbarArray['statistics', 'pagination']顶部工具栏配置
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/CRUD.md', function(require, exports, module) { "label": "CRUD", "fragment": "crud", "fullPath": "#crud", - "level": 3 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Card.js b/gh-pages/docs/renderers/Card.js index da8a2556..dea11fbc 100644 --- a/gh-pages/docs/renderers/Card.js +++ b/gh-pages/docs/renderers/Card.js @@ -1,7 +1,7 @@ define('docs/renderers/Card.md', function(require, exports, module) { module.exports = { - "html": "

    Card

    卡片的展示形式。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"card"指定为 Card 渲染器
    classNamestring"panel-default"外层 Dom 的类名
    headerObjectCard 头部内容设置
    header.classNamestring头部类名
    header.titlestring标题
    header.subTitlestring副标题
    header.descstring描述
    header.avatarstring图片
    header.highlightboolean是否点亮
    header.avatarClassNamestring"pull-left thumb avatar b-3x m-r"图片类名
    bodyArray 或者 Field内容容器,主要用来放置 Field
    bodyClassNamestring"padder m-t-sm m-b-sm"内容区域类名
    actionsArray Of Button按钮区域
    \n
    \n", + "html": "

    Card

    卡片的展示形式。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"card"指定为 Card 渲染器
    classNamestring"panel-default"外层 Dom 的类名
    headerObjectCard 头部内容设置
    header.classNamestring头部类名
    header.titlestring标题
    header.subTitlestring副标题
    header.descstring描述
    header.avatarstring图片
    header.highlightboolean是否点亮
    header.avatarClassNamestring"pull-left thumb avatar b-3x m-r"图片类名
    bodyArray 或者 Field内容容器,主要用来放置 Field
    bodyClassNamestring"padder m-t-sm m-b-sm"内容区域类名
    actionsArray Of Button按钮区域
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Card.md', function(require, exports, module) { "label": "Card", "fragment": "card", "fullPath": "#card", - "level": 2 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Cards.js b/gh-pages/docs/renderers/Cards.js index 114f3ee0..af08963f 100644 --- a/gh-pages/docs/renderers/Cards.js +++ b/gh-pages/docs/renderers/Cards.js @@ -1,7 +1,7 @@ define('docs/renderers/Cards.md', function(require, exports, module) { module.exports = { - "html": "

    Cards

    卡片集合。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"cards" 指定为卡片集合。
    titlestring标题
    sourcestring${items}数据源, 绑定当前环境变量
    placeholderstring‘暂无数据’当没数据的时候的文字提示
    classNamestring外层 CSS 类名
    headerClassNamestringamis-grid-header顶部外层 CSS 类名
    footerClassNamestringamis-grid-footer底部外层 CSS 类名
    itemClassNamestringcol-sm-4 col-md-3卡片 CSS 类名
    cardCard配置卡片信息
    \n
    \n", + "html": "

    Cards

    卡片集合。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"cards" 指定为卡片集合。
    titlestring标题
    sourcestring${items}数据源, 绑定当前环境变量
    placeholderstring‘暂无数据’当没数据的时候的文字提示
    classNamestring外层 CSS 类名
    headerClassNamestringamis-grid-header顶部外层 CSS 类名
    footerClassNamestringamis-grid-footer底部外层 CSS 类名
    itemClassNamestringcol-sm-4 col-md-3卡片 CSS 类名
    cardCard配置卡片信息
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Cards.md', function(require, exports, module) { "label": "Cards", "fragment": "cards", "fullPath": "#cards", - "level": 2 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Carousel.js b/gh-pages/docs/renderers/Carousel.js index 804694ce..003427fe 100644 --- a/gh-pages/docs/renderers/Carousel.js +++ b/gh-pages/docs/renderers/Carousel.js @@ -1,7 +1,7 @@ define('docs/renderers/Carousel.md', function(require, exports, module) { module.exports = { - "html": "

    Carousel

    轮播图

    \n
      \n
    • type 请设置成 carousel
    • \n
    • className 外层 Dom 的类名
    • \n
    • options 轮播面板数据,默认[],支持以下模式
        \n
      • 图片
          \n
        • image 图片链接
        • \n
        • imageClassName 图片类名
        • \n
        • title 图片标题
        • \n
        • titleClassName 图片标题类名
        • \n
        • description 图片描述
        • \n
        • descriptionClassName 图片描述类名
        • \n
        \n
      • \n
      • html HTML 自定义,同Tpl一致
      • \n
      \n
    • \n
    • auto 是否自动轮播,默认true
    • \n
    • interval 切换动画间隔,默认5s
    • \n
    • duration 切换动画时长,默认0.5s
    • \n
    • width 宽度,默认auto
    • \n
    • height 高度,默认200px
    • \n
    • controls 显示左右箭头、底部圆点索引,默认['dots', 'arrows']
    • \n
    • controlsTheme 左右箭头、底部圆点索引颜色,默认light,另有dark模式
    • \n
    • animation 切换动画效果,默认fade,另有slide模式
    • \n
    \n
    \n", + "html": "

    Carousel

    轮播图

    \n
      \n
    • type 请设置成 carousel
    • \n
    • className 外层 Dom 的类名
    • \n
    • options 轮播面板数据,默认[],支持以下模式
        \n
      • 图片
          \n
        • image 图片链接
        • \n
        • imageClassName 图片类名
        • \n
        • title 图片标题
        • \n
        • titleClassName 图片标题类名
        • \n
        • description 图片描述
        • \n
        • descriptionClassName 图片描述类名
        • \n
        \n
      • \n
      • html HTML 自定义,同Tpl一致
      • \n
      \n
    • \n
    • auto 是否自动轮播,默认true
    • \n
    • interval 切换动画间隔,默认5s
    • \n
    • duration 切换动画时长,默认0.5s
    • \n
    • width 宽度,默认auto
    • \n
    • height 高度,默认200px
    • \n
    • controls 显示左右箭头、底部圆点索引,默认['dots', 'arrows']
    • \n
    • controlsTheme 左右箭头、底部圆点索引颜色,默认light,另有dark模式
    • \n
    • animation 切换动画效果,默认fade,另有slide模式
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Carousel.md', function(require, exports, module) { "label": "Carousel", "fragment": "carousel", "fullPath": "#carousel", - "level": 3 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Chart.js b/gh-pages/docs/renderers/Chart.js index b2bf070b..4e4c352a 100644 --- a/gh-pages/docs/renderers/Chart.js +++ b/gh-pages/docs/renderers/Chart.js @@ -1,7 +1,7 @@ define('docs/renderers/Chart.md', function(require, exports, module) { module.exports = { - "html": "

    Chart

    图表渲染器,采用 echarts 渲染,配置格式跟 echarts 相同,配置文档文档

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"chart"指定为 chart 渲染器
    classNamestring外层 Dom 的类名
    bodyContainer内容容器
    apiapi配置项远程地址
    initFetchboolean是否默认拉取
    intervalnumber刷新时间(最低 3000)
    configobject/string设置 eschars 的配置项,当为string的时候可以设置 function 等配置项
    styleobject设置根元素的 style
    \n
    \n", + "html": "

    Chart

    图表渲染器,采用 echarts 渲染,配置格式跟 echarts 相同,配置文档文档

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"chart"指定为 chart 渲染器
    classNamestring外层 Dom 的类名
    bodyContainer内容容器
    apiapi配置项远程地址
    initFetchboolean是否默认拉取
    intervalnumber刷新时间(最低 3000)
    configobject/string设置 eschars 的配置项,当为string的时候可以设置 function 等配置项
    styleobject设置根元素的 style
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Chart.md', function(require, exports, module) { "label": "Chart", "fragment": "chart", "fullPath": "#chart", - "level": 3 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Collapse.js b/gh-pages/docs/renderers/Collapse.js index aa93a2bd..fcdfda49 100644 --- a/gh-pages/docs/renderers/Collapse.js +++ b/gh-pages/docs/renderers/Collapse.js @@ -1,7 +1,7 @@ define('docs/renderers/Collapse.md', function(require, exports, module) { module.exports = { - "html": "

    Collapse

    折叠器

    \n
      \n
    • type 请设置成 collapse
    • \n
    • title 标题
    • \n
    • collapsed 默认是否要收起。
    • \n
    • className CSS 类名,默认:bg-white wrapper
    • \n
    • headingClassName 标题 CSS 类名,默认:font-thin b-b b-light text-lg p-b-xs
    • \n
    • bodyClassName 内容 CSS 类名。
    • \n
    \n
    \n", + "html": "

    Collapse

    折叠器

    \n
      \n
    • type 请设置成 collapse
    • \n
    • title 标题
    • \n
    • collapsed 默认是否要收起。
    • \n
    • className CSS 类名,默认:bg-white wrapper
    • \n
    • headingClassName 标题 CSS 类名,默认:font-thin b-b b-light text-lg p-b-xs
    • \n
    • bodyClassName 内容 CSS 类名。
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Collapse.md', function(require, exports, module) { "label": "Collapse", "fragment": "collapse", "fullPath": "#collapse", - "level": 3 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Column.js b/gh-pages/docs/renderers/Column.js index 998f7ec8..9164aab7 100644 --- a/gh-pages/docs/renderers/Column.js +++ b/gh-pages/docs/renderers/Column.js @@ -1,7 +1,7 @@ define('docs/renderers/Column.md', function(require, exports, module) { module.exports = { - "html": "

    Column

    表格中的列配置

    \n
      \n
    • type 默认为 text,支持: texthtmltplimageprogressstatusdatedatetimetimejsonmapping参考 Field 说明Operation
    • \n
    • name 用来关联列表数据中的变量 key
    • \n
    • label 列标题。
    • \n
    • groupName 如果想要分组,请设置这个!
    • \n
    • copyable 开启后,会支持内容点击复制。
    • \n
    • width 列宽度。
    • \n
    • popOver 是否支持点击查看详情。当内容较长时,可以开启此配置。
    • \n
    • quickEdit 配置后在内容区增加一个编辑按钮,点击后弹出一个编辑框。
    • \n
    • toggled 控制默认是展示还是不展示,只有 Table 的 columnsTogglable 开启了才有效。
    • \n
    \n", + "html": "

    Column

    表格中的列配置

    \n
      \n
    • type 默认为 text,支持: texthtmltplimageprogressstatusdatedatetimetimejsonmapping参考 Field 说明Operation
    • \n
    • name 用来关联列表数据中的变量 key
    • \n
    • label 列标题。
    • \n
    • groupName 如果想要分组,请设置这个!
    • \n
    • copyable 开启后,会支持内容点击复制。
    • \n
    • width 列宽度。
    • \n
    • popOver 是否支持点击查看详情。当内容较长时,可以开启此配置。
    • \n
    • quickEdit 配置后在内容区增加一个编辑按钮,点击后弹出一个编辑框。
    • \n
    • toggled 控制默认是展示还是不展示,只有 Table 的 columnsTogglable 开启了才有效。
    • \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Column.md', function(require, exports, module) { "label": "Column", "fragment": "column", "fullPath": "#column", - "level": 3 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Dialog.js b/gh-pages/docs/renderers/Dialog.js index 835eeabe..84971a27 100644 --- a/gh-pages/docs/renderers/Dialog.js +++ b/gh-pages/docs/renderers/Dialog.js @@ -1,7 +1,7 @@ define('docs/renderers/Dialog.md', function(require, exports, module) { module.exports = { - "html": "

    Dialog

    Dialog 由 Action 触发。他是一个类似于 Page 的容器模型。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"dialog" 指定为 Dialog 渲染器
    titlestring 或者 Container弹出层标题
    bodyContainer往 Dialog 内容区加内容
    sizestring指定 dialog 大小,支持: xssmmdlg
    bodyClassNamestringmodal-bodyDialog body 区域的样式类名
    closeOnEscbooleanfalse是否支持按 Esc 关闭 Dialog
    disabledbooleanfalse如果设置此属性,则该 Dialog 只读没有提交操作。
    actionsArray Of Action可以不设置,默认只有【确认】和【取消】两个按钮。
    \n
    \n", + "html": "

    Dialog

    Dialog 由 Action 触发。他是一个类似于 Page 的容器模型。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"dialog" 指定为 Dialog 渲染器
    titlestring 或者 Container弹出层标题
    bodyContainer往 Dialog 内容区加内容
    sizestring指定 dialog 大小,支持: xssmmdlg
    bodyClassNamestringmodal-bodyDialog body 区域的样式类名
    closeOnEscbooleanfalse是否支持按 Esc 关闭 Dialog
    disabledbooleanfalse如果设置此属性,则该 Dialog 只读没有提交操作。
    actionsArray Of Action可以不设置,默认只有【确认】和【取消】两个按钮。
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Dialog.md', function(require, exports, module) { "label": "Dialog", "fragment": "dialog", "fullPath": "#dialog", - "level": 3 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Drawer.js b/gh-pages/docs/renderers/Drawer.js index 0e2fecf7..4171b8e7 100644 --- a/gh-pages/docs/renderers/Drawer.js +++ b/gh-pages/docs/renderers/Drawer.js @@ -1,7 +1,7 @@ define('docs/renderers/Drawer.md', function(require, exports, module) { module.exports = { - "html": "

    Drawer

    Drawer 由 Action 触发。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"drawer" 指定为 Drawer 渲染器
    titlestring 或者 Container弹出层标题
    bodyContainer往 Dialog 内容区加内容
    sizestring指定 dialog 大小,支持: xssmmdlg
    bodyClassNamestringmodal-bodyDialog body 区域的样式类名
    closeOnEscbooleanfalse是否支持按 Esc 关闭 Dialog
    overlaybooleantrue是否显示蒙层
    resizablebooleanfalse是否可通过拖拽改变 Drawer 大小
    actionsArray Of Action可以不设置,默认只有【确认】和【取消】两个按钮。
    \n
    \n", + "html": "

    Drawer

    Drawer 由 Action 触发。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"drawer" 指定为 Drawer 渲染器
    titlestring 或者 Container弹出层标题
    bodyContainer往 Dialog 内容区加内容
    sizestring指定 dialog 大小,支持: xssmmdlg
    bodyClassNamestringmodal-bodyDialog body 区域的样式类名
    closeOnEscbooleanfalse是否支持按 Esc 关闭 Dialog
    overlaybooleantrue是否显示蒙层
    resizablebooleanfalse是否可通过拖拽改变 Drawer 大小
    actionsArray Of Action可以不设置,默认只有【确认】和【取消】两个按钮。
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Drawer.md', function(require, exports, module) { "label": "Drawer", "fragment": "drawer", "fullPath": "#drawer", - "level": 3 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Field.js b/gh-pages/docs/renderers/Field.js index d0affe93..54c0ff0b 100644 --- a/gh-pages/docs/renderers/Field.js +++ b/gh-pages/docs/renderers/Field.js @@ -1,7 +1,7 @@ define('docs/renderers/Field.md', function(require, exports, module) { module.exports = { - "html": "

    Field

    主要用在 Table 的列配置 Column、List 的内容、Card 卡片的内容和表单的Static-XXX 中。它主要用来展示数据。

    \n
    \n

    Field 通用配置

      \n
    • name 绑定变量名。
    • \n
    • placeholder 当没有值时的展示内容。
    • \n
    • popOver 配置后在内容区增加一个放大按钮,点击后弹出一个详情弹框。\nboolean 简单的开启或者关闭\nObject 弹出的内容配置。请参考 Dialog 配置说明。
    • \n
    • quickEdit 配置后在内容区增加一个编辑按钮,点击后弹出一个编辑框。\nboolean 简单的开启或者关闭\nObject 快速编辑详情,请参考 FormItem 配置。\n.mode 模式如果设置为 inline 模式,则直接展示输入框,而不需要点击按钮后展示。\n.saveImmediately 开启后,直接保存,而不是等全部操作完后批量保存。
    • \n
    • copyable 配置后会在内容区增加一个复制按钮,点击后把内容复制到剪切板。\ntodo
    • \n
    \n

    Tpl(Field)

    请参考tpl

    \n

    Plain(Field)

    请参考Plain

    \n

    Json(Field)

    todo

    \n

    Date(Field)

    用来显示日期。

    \n
      \n
    • type 请设置为 date
    • \n
    • format 默认为 YYYY-MM-DD,时间格式,请参考 moment 中的格式用法。
    • \n
    • valueFormat 默认为 X,时间格式,请参考 moment 中的格式用法。
    • \n
    \n

    Mapping(Field)

    用来对值做映射显示。

    \n
      \n
    • type 请设置为 date
    • \n
    • map 映射表, 比如

      \n
      {\n    \"type\": \"mapping\",\n    \"name\": \"flag\",\n    \"map\": {\n        \"1\": \"<span class='label label-default'>One</span>\",\n        \"*\": \"其他 ${flag}\"\n    }\n}\n
      \n

      当值为 1 时,显示 One, 当值为其他时会命中 * 所以显示 其他 flag的值

      \n
    • \n
    \n

    Image(Field)

    用来展示图片。

    \n
      \n
    • type 请设置为 image
    • \n
    • description 图片描述。
    • \n
    • defaultImage 默认图片地址。
    • \n
    • className CSS 类名。
    • \n
    • src 图片地址,支持变量。如果想动态显示,请勿配置。
    • \n
    \n

    Progress(Field)

    用来展示进度条。

    \n
      \n
    • type 请设置为 progress
    • \n
    • showLabel 是否显示文字
    • \n
    • map 等级配置\n默认

      \n
      [\"bg-danger\", \"bg-warning\", \"bg-info\", \"bg-success\", \"bg-success\"]\n
      \n

      展示的样式取决于当前值在什么区间段,比如以上的配置,把 100 切成了 5 分,前 1/5, 即 25 以前显示 bg-danger 背景。50 ~ 75 显示 bg-info 背景。

      \n
    • \n
    • progressClassName 进度外层 CSS 类名 默认为: progress-xs progress-striped active m-t-xs m-b-none

      \n
    • \n
    • progressBarClassName 进度条 CSS 类名。
    • \n
    \n

    Status(Field)

    用来显示状态,用图表展示。

    \n
      \n
    • type 请设置为 status
    • \n
    • map 图标配置

      \n

      默认:

      \n
      [\"fa fa-times text-danger\", \"fa fa-check text-success\"]\n
      \n

      即如果值 value % map.length 等于 0 则显示第一个图标。value % map.length 等于 1 则显示第二个图标,无限类推。所以说 map 其实不只是支持 2 个,可以任意个。

      \n

      这个例子,当值为 0 、2、4 ... 时显示红 X, 当值为 1, 3, 5 ... \b 绿

      \n
    • \n
    \n

    Switch(Field)

    用来占一个开关。

    \n
      \n
    • type 请设置为 switch
    • \n
    • option 选项说明
    • \n
    • trueValue 勾选后的值
    • \n
    • falseValue 未勾选的值
    • \n
    \n", + "html": "

    Field

    主要用在 Table 的列配置 Column、List 的内容、Card 卡片的内容和表单的Static-XXX 中。它主要用来展示数据。

    \n
    \n

    Field 通用配置

      \n
    • name 绑定变量名。
    • \n
    • placeholder 当没有值时的展示内容。
    • \n
    • popOver 配置后在内容区增加一个放大按钮,点击后弹出一个详情弹框。\nboolean 简单的开启或者关闭\nObject 弹出的内容配置。请参考 Dialog 配置说明。
    • \n
    • quickEdit 配置后在内容区增加一个编辑按钮,点击后弹出一个编辑框。\nboolean 简单的开启或者关闭\nObject 快速编辑详情,请参考 FormItem 配置。\n.mode 模式如果设置为 inline 模式,则直接展示输入框,而不需要点击按钮后展示。\n.saveImmediately 开启后,直接保存,而不是等全部操作完后批量保存。
    • \n
    • copyable 配置后会在内容区增加一个复制按钮,点击后把内容复制到剪切板。\ntodo
    • \n
    \n

    Tpl(Field)

    请参考tpl

    \n

    Plain(Field)

    请参考Plain

    \n

    Json(Field)

    todo

    \n

    Date(Field)

    用来显示日期。

    \n
      \n
    • type 请设置为 date
    • \n
    • format 默认为 YYYY-MM-DD,时间格式,请参考 moment 中的格式用法。
    • \n
    • valueFormat 默认为 X,时间格式,请参考 moment 中的格式用法。
    • \n
    \n

    Mapping(Field)

    用来对值做映射显示。

    \n
      \n
    • type 请设置为 date
    • \n
    • map 映射表, 比如

      \n
      {\n    \"type\": \"mapping\",\n    \"name\": \"flag\",\n    \"map\": {\n        \"1\": \"<span class='label label-default'>One</span>\",\n        \"*\": \"其他 ${flag}\"\n    }\n}\n
      \n

      当值为 1 时,显示 One, 当值为其他时会命中 * 所以显示 其他 flag的值

      \n
    • \n
    \n

    Image(Field)

    用来展示图片。

    \n
      \n
    • type 请设置为 image
    • \n
    • description 图片描述。
    • \n
    • defaultImage 默认图片地址。
    • \n
    • className CSS 类名。
    • \n
    • src 图片地址,支持变量。如果想动态显示,请勿配置。
    • \n
    \n

    Progress(Field)

    用来展示进度条。

    \n
      \n
    • type 请设置为 progress
    • \n
    • showLabel 是否显示文字
    • \n
    • map 等级配置\n默认

      \n
      [\"bg-danger\", \"bg-warning\", \"bg-info\", \"bg-success\", \"bg-success\"]\n
      \n

      展示的样式取决于当前值在什么区间段,比如以上的配置,把 100 切成了 5 分,前 1/5, 即 25 以前显示 bg-danger 背景。50 ~ 75 显示 bg-info 背景。

      \n
    • \n
    • progressClassName 进度外层 CSS 类名 默认为: progress-xs progress-striped active m-t-xs m-b-none

      \n
    • \n
    • progressBarClassName 进度条 CSS 类名。
    • \n
    \n

    Status(Field)

    用来显示状态,用图表展示。

    \n
      \n
    • type 请设置为 status
    • \n
    • map 图标配置

      \n

      默认:

      \n
      [\"fa fa-times text-danger\", \"fa fa-check text-success\"]\n
      \n

      即如果值 value % map.length 等于 0 则显示第一个图标。value % map.length 等于 1 则显示第二个图标,无限类推。所以说 map 其实不只是支持 2 个,可以任意个。

      \n

      这个例子,当值为 0 、2、4 ... 时显示红 X, 当值为 1, 3, 5 ... \b 绿

      \n
    • \n
    \n

    Switch(Field)

    用来占一个开关。

    \n
      \n
    • type 请设置为 switch
    • \n
    • option 选项说明
    • \n
    • trueValue 勾选后的值
    • \n
    • falseValue 未勾选的值
    • \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,67 +10,67 @@ define('docs/renderers/Field.md', function(require, exports, module) { "label": "Field", "fragment": "field", "fullPath": "#field", - "level": 2, + "level": 1, "children": [ { "label": "Field 通用配置", "fragment": "field-%E9%80%9A%E7%94%A8%E9%85%8D%E7%BD%AE", "fullPath": "#field-%E9%80%9A%E7%94%A8%E9%85%8D%E7%BD%AE", - "level": 3 + "level": 2 }, { "label": "Tpl(Field)", "fragment": "tpl-field-", "fullPath": "#tpl-field-", - "level": 3 + "level": 2 }, { "label": "Plain(Field)", "fragment": "plain-field-", "fullPath": "#plain-field-", - "level": 3 + "level": 2 }, { "label": "Json(Field)", "fragment": "json-field-", "fullPath": "#json-field-", - "level": 3 + "level": 2 }, { "label": "Date(Field)", "fragment": "date-field-", "fullPath": "#date-field-", - "level": 3 + "level": 2 }, { "label": "Mapping(Field)", "fragment": "mapping-field-", "fullPath": "#mapping-field-", - "level": 3 + "level": 2 }, { "label": "Image(Field)", "fragment": "image-field-", "fullPath": "#image-field-", - "level": 3 + "level": 2 }, { "label": "Progress(Field)", "fragment": "progress-field-", "fullPath": "#progress-field-", - "level": 3 + "level": 2 }, { "label": "Status(Field)", "fragment": "status-field-", "fullPath": "#status-field-", - "level": 3 + "level": 2 }, { "label": "Switch(Field)", "fragment": "switch-field-", "fullPath": "#switch-field-", - "level": 3 + "level": 2 } ] } diff --git a/gh-pages/docs/renderers/Form/Datetime.js b/gh-pages/docs/renderers/Form/Datetime.js index 350fd41f..97d76e6a 100644 --- a/gh-pages/docs/renderers/Form/Datetime.js +++ b/gh-pages/docs/renderers/Form/Datetime.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Datetime.md', function(require, exports, module) { module.exports = { - "html": "

    Datetime

    日期时间类型。

    \n
      \n
    • type 请设置成 datetime
    • \n
    • format 默认 X 即时间戳格式,用来提交的时间格式。更多格式类型请参考 moment.
    • \n
    • inputFormat 默认 YYYY-MM-DD HH:mm:ss 用来配置显示的时间格式。
    • \n
    • placeholder 默认 请选择日期
    • \n
    • timeConstraints 请参考: react-datetime
    • \n
    • value 这里面 value 需要特殊说明一下,因为支持相对值。如:
        \n
      • -2mins 2 分钟前
      • \n
      • +2days 2 天后
      • \n
      • -10week 十周前
      • \n
      \n
    • \n
    • minDate 限制最小日期,可用 ${xxx} 取值,或者输入相对时间,或者时间戳。如:${start}+3days+3days+2hours或者 ${start|default:-2days}+3days
    • \n
    • maxDate 限制最小日期,可用 ${xxx} 取值,或者输入相对时间,或者时间戳。如:${start}+3days+3days+2hours或者 ${start|default:-2days}+3days
    • \n
    • minTime 限制最小时间,可用 ${xxx} 取值,或者输入相对时间,或者时间戳。如:${start}+3days+3days+2hours或者 ${start|default:-2days}+3days
    • \n
    • maxTime 限制最大时间,可用 ${xxx} 取值,或者输入相对时间,或者时间戳。如:${start}+3days+3days+2hours或者 ${start|default:-2days}+3days

      \n

      可用单位: minhourdayweekmonthyear。所有单位支持复数形式。

      \n
    • \n
    • 更多配置请参考 FormItem

      \n
    • \n
    \n
    \n", + "html": "

    Datetime

    日期时间类型。

    \n
      \n
    • type 请设置成 datetime
    • \n
    • format 默认 X 即时间戳格式,用来提交的时间格式。更多格式类型请参考 moment.
    • \n
    • inputFormat 默认 YYYY-MM-DD HH:mm:ss 用来配置显示的时间格式。
    • \n
    • placeholder 默认 请选择日期
    • \n
    • timeConstraints 请参考: react-datetime
    • \n
    • value 这里面 value 需要特殊说明一下,因为支持相对值。如:
        \n
      • -2mins 2 分钟前
      • \n
      • +2days 2 天后
      • \n
      • -10week 十周前
      • \n
      \n
    • \n
    • minDate 限制最小日期,可用 ${xxx} 取值,或者输入相对时间,或者时间戳。如:${start}+3days+3days+2hours或者 ${start|default:-2days}+3days
    • \n
    • maxDate 限制最小日期,可用 ${xxx} 取值,或者输入相对时间,或者时间戳。如:${start}+3days+3days+2hours或者 ${start|default:-2days}+3days
    • \n
    • minTime 限制最小时间,可用 ${xxx} 取值,或者输入相对时间,或者时间戳。如:${start}+3days+3days+2hours或者 ${start|default:-2days}+3days
    • \n
    • maxTime 限制最大时间,可用 ${xxx} 取值,或者输入相对时间,或者时间戳。如:${start}+3days+3days+2hours或者 ${start|default:-2days}+3days

      \n

      可用单位: minhourdayweekmonthyear。所有单位支持复数形式。

      \n
    • \n
    • 更多配置请参考 FormItem

      \n
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Datetime.md', function(require, exports, module) { "label": "Datetime", "fragment": "datetime", "fullPath": "#datetime", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Editor.js b/gh-pages/docs/renderers/Form/Editor.js index d659e859..868f9be2 100644 --- a/gh-pages/docs/renderers/Form/Editor.js +++ b/gh-pages/docs/renderers/Form/Editor.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Editor.md', function(require, exports, module) { module.exports = { - "html": "

    Editor

    XXX-Editor

      \n
    • type 请设置成 editor 或者 bat-editorc-editorcoffeescript-editorcpp-editorcsharp-editorcss-editordockerfile-editorfsharp-editorgo-editorhandlebars-editorhtml-editorini-editorjava-editorjavascript-editorjson-editorless-editorlua-editormarkdown-editormsdax-editorobjective-c-editorphp-editorplaintext-editorpostiats-editorpowershell-editorpug-editorpython-editorr-editorrazor-editorruby-editorsb-editorscss-editorsol-editorsql-editorswift-editortypescript-editorvb-editorxml-editoryaml-editor
    • \n
    • language 默认为 javascripttypeeditor 的时候有用。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n

    Diff-Editor

      \n
    • type 请设置成 diff-editor
    • \n
    • language 默认为 javascripttypediff-editor 的时候有用
    • \n
    • diffValue 设置左侧编辑器的值,支持${xxx}获取变量
    • \n
    • disabled 配置 右侧编辑器 是否可编辑,左侧编辑器始终不可编辑
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n

    PS: 当用作纯展示时,可以通过value配置项,设置右侧编辑器的值

    \n
    \n", + "html": "

    Editor

    XXX-Editor

      \n
    • type 请设置成 editor 或者 bat-editorc-editorcoffeescript-editorcpp-editorcsharp-editorcss-editordockerfile-editorfsharp-editorgo-editorhandlebars-editorhtml-editorini-editorjava-editorjavascript-editorjson-editorless-editorlua-editormarkdown-editormsdax-editorobjective-c-editorphp-editorplaintext-editorpostiats-editorpowershell-editorpug-editorpython-editorr-editorrazor-editorruby-editorsb-editorscss-editorsol-editorsql-editorswift-editortypescript-editorvb-editorxml-editoryaml-editor
    • \n
    • language 默认为 javascripttypeeditor 的时候有用。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n

    Diff-Editor

      \n
    • type 请设置成 diff-editor
    • \n
    • language 默认为 javascripttypediff-editor 的时候有用
    • \n
    • diffValue 设置左侧编辑器的值,支持${xxx}获取变量
    • \n
    • disabled 配置 右侧编辑器 是否可编辑,左侧编辑器始终不可编辑
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n

    PS: 当用作纯展示时,可以通过value配置项,设置右侧编辑器的值

    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,19 +10,21 @@ define('docs/renderers/Form/Editor.md', function(require, exports, module) { "label": "Editor", "fragment": "editor", "fullPath": "#editor", - "level": 3 - }, - { - "label": "XXX-Editor", - "fragment": "xxx-editor", - "fullPath": "#xxx-editor", - "level": 3 - }, - { - "label": "Diff-Editor", - "fragment": "diff-editor", - "fullPath": "#diff-editor", - "level": 3 + "level": 2, + "children": [ + { + "label": "XXX-Editor", + "fragment": "xxx-editor", + "fullPath": "#xxx-editor", + "level": 3 + }, + { + "label": "Diff-Editor", + "fragment": "diff-editor", + "fullPath": "#diff-editor", + "level": 3 + } + ] } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Email.js b/gh-pages/docs/renderers/Form/Email.js index 0c8e8c0e..a0f9ec94 100644 --- a/gh-pages/docs/renderers/Form/Email.js +++ b/gh-pages/docs/renderers/Form/Email.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Email.md', function(require, exports, module) { module.exports = { - "html": "

    Email

    Email 输入框。

    \n
      \n
    • type 请设置成 email
    • \n
    • addOn 输入框附加组件,比如附带一个提示文字,或者附带一个提交按钮。
    • \n
    • addOn.type 请选择 textbutton 或者 submit
    • \n
    • addOn.label 文字说明
    • \n
    • addOn.xxx 其他参数请参考按钮配置部分。
    • \n
    • clearable 在有值的时候是否显示一个删除图标在右侧。
    • \n
    • resetValue 默认为 "", 删除后设置此配置项给定的值。
    • \n
    • options 可选,选项配置,类型为数组,成员格式如下,配置后用户输入内容时会作为选项提示辅助输入。
        \n
      • label 文字
      • \n
      • value
      • \n
      \n
    • \n
    • source 通过 options 只能配置静态数据,如果设置了 source 则会从接口拉取,实现动态效果。
    • \n
    • autoComplete 跟 source 不同的是,每次用户输入都会去接口获取提示。
    • \n
    • multiple 默认为 false, 设置成 true 表示可多选。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", + "html": "

    Email

    Email 输入框。

    \n
      \n
    • type 请设置成 email
    • \n
    • addOn 输入框附加组件,比如附带一个提示文字,或者附带一个提交按钮。
    • \n
    • addOn.type 请选择 textbutton 或者 submit
    • \n
    • addOn.label 文字说明
    • \n
    • addOn.xxx 其他参数请参考按钮配置部分。
    • \n
    • clearable 在有值的时候是否显示一个删除图标在右侧。
    • \n
    • resetValue 默认为 "", 删除后设置此配置项给定的值。
    • \n
    • options 可选,选项配置,类型为数组,成员格式如下,配置后用户输入内容时会作为选项提示辅助输入。
        \n
      • label 文字
      • \n
      • value
      • \n
      \n
    • \n
    • source 通过 options 只能配置静态数据,如果设置了 source 则会从接口拉取,实现动态效果。
    • \n
    • autoComplete 跟 source 不同的是,每次用户输入都会去接口获取提示。
    • \n
    • multiple 默认为 false, 设置成 true 表示可多选。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Email.md', function(require, exports, module) { "label": "Email", "fragment": "email", "fullPath": "#email", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/FieldSet.js b/gh-pages/docs/renderers/Form/FieldSet.js index 90df2b1d..4a69e1ef 100644 --- a/gh-pages/docs/renderers/Form/FieldSet.js +++ b/gh-pages/docs/renderers/Form/FieldSet.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/FieldSet.md', function(require, exports, module) { module.exports = { - "html": "

    FieldSet

    多个输入框可以通过 fieldSet 捆绑在一起。

    \n
      \n
    • type 请设置成 fieldSet
    • \n
    • title 标题
    • \n
    • controls 表单项集合。
    • \n
    • mode 展示默认,跟 Form 中的模式一样,选择: normalhorizontal或者inline
    • \n
    • horizontal 当为水平模式时,用来控制左右占比。
    • \n
    • horizontal.label 左边 label 的宽度占比。
    • \n
    • horizontal.right 右边控制器的宽度占比。
    • \n
    • horizontal.offset 当没有设置 label 时,右边控制器的偏移量。
    • \n
    • collapsable 配置是否可折叠,默认为 true
    • \n
    • collapsed 默认是否折叠。
    • \n
    • className CSS 类名
    • \n
    • headingClassName 标题 CSS 类名
    • \n
    • bodyClassName 内容区域 CSS 类名
    • \n
    \n
    \n", + "html": "

    FieldSet

    多个输入框可以通过 fieldSet 捆绑在一起。

    \n
      \n
    • type 请设置成 fieldSet
    • \n
    • title 标题
    • \n
    • controls 表单项集合。
    • \n
    • mode 展示默认,跟 Form 中的模式一样,选择: normalhorizontal或者inline
    • \n
    • horizontal 当为水平模式时,用来控制左右占比。
    • \n
    • horizontal.label 左边 label 的宽度占比。
    • \n
    • horizontal.right 右边控制器的宽度占比。
    • \n
    • horizontal.offset 当没有设置 label 时,右边控制器的偏移量。
    • \n
    • collapsable 配置是否可折叠,默认为 true
    • \n
    • collapsed 默认是否折叠。
    • \n
    • className CSS 类名
    • \n
    • headingClassName 标题 CSS 类名
    • \n
    • bodyClassName 内容区域 CSS 类名
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/FieldSet.md', function(require, exports, module) { "label": "FieldSet", "fragment": "fieldset", "fullPath": "#fieldset", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/File.js b/gh-pages/docs/renderers/Form/File.js index 361f6272..de2dc2e1 100644 --- a/gh-pages/docs/renderers/Form/File.js +++ b/gh-pages/docs/renderers/Form/File.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/File.md', function(require, exports, module) { module.exports = { - "html": "

    File

    文件输入,amis 也默认处理了图片存储,提交给 API 的是文件的下载地址。

    \n
      \n
    • type 请设置成 file
    • \n
    • reciever 默认 /api/upload/file 如果想自己存储,请设置此选项。(PS: 如果想存自己的 bos, 系统配置中可以直接填写自己的 bos 配置。)
    • \n
    • accept 默认 text/plain 默认只支持纯文本,要支持其他类型,请配置此属性。
    • \n
    • maxSize 默认没有限制,当设置后,文件大小大于此值将不允许上传。
    • \n
    • multiple 是否多选。
    • \n
    • maxLength 默认没有限制,当设置后,一次只允许上传指定数量文件。
    • \n
    • joinValues 多选时是否将多个值用 delimiter 连接起来。
    • \n
    • extractValue 默认为 false, joinValues设置为false时生效, 开启后将选中的选项 value 的值封装为数组,作为当前表单项的值。
    • \n
    • delimiter 链接符
    • \n
    • autoUpload 是否选择完就自动开始上传?默认为 true
    • \n
    • fileField 默认 file, 如果你不想自己存储,则可以忽略此属性。
    • \n
    • downloadUrl 默认显示文件路径的时候会支持直接下载,可以支持加前缀如:http://xx.dom/filename= ,如果不希望这样,可以把当前配置项设置为 false
    • \n
    • useChunk 默认为 'auto' amis 所在服务器,限制了文件上传大小不得超出 10M,所以 amis 在用户选择大文件的时候,自动会改成分块上传模式。
    • \n
    • chunkSize 分块大小,默认为 5M.
    • \n
    • startChunkApi 默认 /api/upload/startChunk 想自己存储时才需要关注。
    • \n
    • chunkApi 默认 /api/upload/chunk 想自己存储时才需要关注。
    • \n
    • finishChunkApi 默认 /api/upload/finishChunk 想自己存储时才需要关注。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", + "html": "

    File

    文件输入,amis 也默认处理了图片存储,提交给 API 的是文件的下载地址。

    \n
      \n
    • type 请设置成 file
    • \n
    • reciever 默认 /api/upload/file 如果想自己存储,请设置此选项。(PS: 如果想存自己的 bos, 系统配置中可以直接填写自己的 bos 配置。)
    • \n
    • accept 默认 text/plain 默认只支持纯文本,要支持其他类型,请配置此属性。
    • \n
    • maxSize 默认没有限制,当设置后,文件大小大于此值将不允许上传。
    • \n
    • multiple 是否多选。
    • \n
    • maxLength 默认没有限制,当设置后,一次只允许上传指定数量文件。
    • \n
    • joinValues 多选时是否将多个值用 delimiter 连接起来。
    • \n
    • extractValue 默认为 false, joinValues设置为false时生效, 开启后将选中的选项 value 的值封装为数组,作为当前表单项的值。
    • \n
    • delimiter 链接符
    • \n
    • autoUpload 是否选择完就自动开始上传?默认为 true
    • \n
    • fileField 默认 file, 如果你不想自己存储,则可以忽略此属性。
    • \n
    • downloadUrl 默认显示文件路径的时候会支持直接下载,可以支持加前缀如:http://xx.dom/filename= ,如果不希望这样,可以把当前配置项设置为 false
    • \n
    • useChunk 默认为 'auto' amis 所在服务器,限制了文件上传大小不得超出 10M,所以 amis 在用户选择大文件的时候,自动会改成分块上传模式。
    • \n
    • chunkSize 分块大小,默认为 5M.
    • \n
    • startChunkApi 默认 /api/upload/startChunk 想自己存储时才需要关注。
    • \n
    • chunkApi 默认 /api/upload/chunk 想自己存储时才需要关注。
    • \n
    • finishChunkApi 默认 /api/upload/finishChunk 想自己存储时才需要关注。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/File.md', function(require, exports, module) { "label": "File", "fragment": "file", "fullPath": "#file", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Form.js b/gh-pages/docs/renderers/Form/Form.js index 80ee0359..b22612b5 100644 --- a/gh-pages/docs/renderers/Form/Form.js +++ b/gh-pages/docs/renderers/Form/Form.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Form.md', function(require, exports, module) { module.exports = { - "html": "

    Form

    表单渲染器,主要用来展示或者接收用户输入后将数据提交给后端或者其他组件。

    \n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"form" 指定为 Form 渲染器
    modestringnormal表单展示方式,可以是:normalhorizontal 或者 inline
    horizontalObject{"left":"col-sm-2", "right":"col-sm-10", "offset":"col-sm-offset-2"}当 mode 为 horizontal 时有用,用来控制 label
    titlestring"表单"Form 的标题
    submitTextString"提交"默认的提交按钮名称,如果设置成空,则可以把默认按钮去掉。
    classNamestring外层 Dom 的类名
    controlsArray of FormItemForm 表单项集合
    actionsArray of ActionForm 提交按钮,成员为 Action
    messagesObject消息提示覆写,默认消息读取的是 API 返回的消息,但是在此可以覆写它。
    messages.fetchSuccessstring获取成功时提示
    messages.fetchFailedstring获取失败时提示
    messages.saveFailedstring保存成功时提示
    messages.saveSuccessstring保存失败时提示
    wrapWithPanelbooleantrue是否让 Form 用 panel 包起来,设置为 false 后,actions 将无效。
    panelClassNamebooleantrue是否让 Form 用 panel 包起来,设置为 false 后,actions 将无效。
    apiApiForm 用来保存数据的 api。
    initApiApiForm 用来获取初始数据的 api。
    intervalnumber3000刷新时间(最低 3000)
    silentPollingbooleanfalse配置刷新时是否显示加载动画
    stopAutoRefreshWhenstring""通过表达式 来配置停止刷新的条件
    initAsyncApiApiForm 用来获取初始数据的 api,与 initApi 不同的是,会一直轮训请求该接口,直到返回 finished 属性为 true 才 结束。
    initFetchbooleantrue设置了 initApi 或者 initAsyncApi 后,默认会开始就发请求,设置为 false 后就不会起始就请求接口
    initFetchOnstring用表达式来配置
    initFinishedFieldstringfinished设置了 initAsyncApi 后,默认会从返回数据的 data.finished 来判断是否完成,也可以设置成其他的 xxx,就会从 data.xxx 中获取
    initCheckIntervalnumber3000设置了 initAsyncApi 以后,默认拉取的时间间隔
    schemaApiApi已不支持,请改用 controls 里面放置 Service 渲染器实现
    asyncApiApi设置此属性后,表单提交发送保存接口后,还会继续轮训请求该接口,直到返回 finished 属性为 true 才 结束。
    checkIntervalnumber3000轮训请求的时间间隔,默认为 3 秒。设置 asyncApi 才有效
    finishedFieldstring"finished"如果决定结束的字段名不是 finished 请设置此属性,比如 is_success
    submitOnChangebooleanfalse表单修改即提交
    submitOnInitbooleanfalse初始就提交一次
    resetAfterSubmitbooleanfalse提交后是否重置表单
    primaryFieldstring"id"设置主键 id, 当设置后,检测表单是否完成时(asyncApi),只会携带此数据。
    targetstring默认表单提交自己会通过发送 api 保存数据,但是也可以设定另外一个 form 的 name 值,或者另外一个 CRUD 模型的 name 值。 如果 target 目标是一个 Form ,则目标 Form 会重新触发 initApi,api 可以拿到当前 form 数据。如果目标是一个 CRUD 模型,则目标模型会重新触发搜索,参数为当前 Form 数据。当目标是 window 时,会把当前表单的数据附带到页面地址上。
    redirectstring设置此属性后,Form 保存成功后,自动跳转到指定页面。支持相对地址,和绝对地址(相对于组内的)。
    reloadstring操作完后刷新目标对象。请填写目标组件设置的 name 值,如果填写为 window 则让当前页面整体刷新。
    autoFocusbooleanfalse是否自动聚焦。
    canAccessSuperDatabooleantrue指定是否可以自动获取上层的数据并映射到表单项上
    persistDatabooleantrue指定表单是否开启本地缓存
    clearPersistDataAfterSubmitbooleantrue指定表单提交成功后是否清除本地缓存
    namestring设置一个名字后,方便其他组件与其通信
    \n

    表单项都是通过 controls 设置的,类型是数组,成员主要是FormItem,默认一行一个(当然 form 是 inline 模式时例外),如果想一行多个,可以将多个FormItem放在一个 Group 里面。

    \n
    \n

    水平模式的 Form 也支持 Group 展现。

    \n
    \n", + "html": "

    Form

    表单渲染器,主要用来展示或者接收用户输入后将数据提交给后端或者其他组件。

    \n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"form" 指定为 Form 渲染器
    modestringnormal表单展示方式,可以是:normalhorizontal 或者 inline
    horizontalObject{"left":"col-sm-2", "right":"col-sm-10", "offset":"col-sm-offset-2"}当 mode 为 horizontal 时有用,用来控制 label
    titlestring"表单"Form 的标题
    submitTextString"提交"默认的提交按钮名称,如果设置成空,则可以把默认按钮去掉。
    classNamestring外层 Dom 的类名
    controlsArray of FormItemForm 表单项集合
    actionsArray of ActionForm 提交按钮,成员为 Action
    messagesObject消息提示覆写,默认消息读取的是 API 返回的消息,但是在此可以覆写它。
    messages.fetchSuccessstring获取成功时提示
    messages.fetchFailedstring获取失败时提示
    messages.saveFailedstring保存成功时提示
    messages.saveSuccessstring保存失败时提示
    wrapWithPanelbooleantrue是否让 Form 用 panel 包起来,设置为 false 后,actions 将无效。
    panelClassNamebooleantrue是否让 Form 用 panel 包起来,设置为 false 后,actions 将无效。
    apiApiForm 用来保存数据的 api。
    initApiApiForm 用来获取初始数据的 api。
    intervalnumber3000刷新时间(最低 3000)
    silentPollingbooleanfalse配置刷新时是否显示加载动画
    stopAutoRefreshWhenstring""通过表达式 来配置停止刷新的条件
    initAsyncApiApiForm 用来获取初始数据的 api,与 initApi 不同的是,会一直轮训请求该接口,直到返回 finished 属性为 true 才 结束。
    initFetchbooleantrue设置了 initApi 或者 initAsyncApi 后,默认会开始就发请求,设置为 false 后就不会起始就请求接口
    initFetchOnstring用表达式来配置
    initFinishedFieldstringfinished设置了 initAsyncApi 后,默认会从返回数据的 data.finished 来判断是否完成,也可以设置成其他的 xxx,就会从 data.xxx 中获取
    initCheckIntervalnumber3000设置了 initAsyncApi 以后,默认拉取的时间间隔
    schemaApiApi已不支持,请改用 controls 里面放置 Service 渲染器实现
    asyncApiApi设置此属性后,表单提交发送保存接口后,还会继续轮训请求该接口,直到返回 finished 属性为 true 才 结束。
    checkIntervalnumber3000轮训请求的时间间隔,默认为 3 秒。设置 asyncApi 才有效
    finishedFieldstring"finished"如果决定结束的字段名不是 finished 请设置此属性,比如 is_success
    submitOnChangebooleanfalse表单修改即提交
    submitOnInitbooleanfalse初始就提交一次
    resetAfterSubmitbooleanfalse提交后是否重置表单
    primaryFieldstring"id"设置主键 id, 当设置后,检测表单是否完成时(asyncApi),只会携带此数据。
    targetstring默认表单提交自己会通过发送 api 保存数据,但是也可以设定另外一个 form 的 name 值,或者另外一个 CRUD 模型的 name 值。 如果 target 目标是一个 Form ,则目标 Form 会重新触发 initApi,api 可以拿到当前 form 数据。如果目标是一个 CRUD 模型,则目标模型会重新触发搜索,参数为当前 Form 数据。当目标是 window 时,会把当前表单的数据附带到页面地址上。
    redirectstring设置此属性后,Form 保存成功后,自动跳转到指定页面。支持相对地址,和绝对地址(相对于组内的)。
    reloadstring操作完后刷新目标对象。请填写目标组件设置的 name 值,如果填写为 window 则让当前页面整体刷新。
    autoFocusbooleanfalse是否自动聚焦。
    canAccessSuperDatabooleantrue指定是否可以自动获取上层的数据并映射到表单项上
    persistDatabooleantrue指定表单是否开启本地缓存
    clearPersistDataAfterSubmitbooleantrue指定表单提交成功后是否清除本地缓存
    namestring设置一个名字后,方便其他组件与其通信
    \n

    表单项都是通过 controls 设置的,类型是数组,成员主要是FormItem,默认一行一个(当然 form 是 inline 模式时例外),如果想一行多个,可以将多个FormItem放在一个 Group 里面。

    \n
    \n

    水平模式的 Form 也支持 Group 展现。

    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Form.md', function(require, exports, module) { "label": "Form", "fragment": "form", "fullPath": "#form", - "level": 2 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/FormItem.js b/gh-pages/docs/renderers/Form/FormItem.js index 68177df3..7bf58595 100644 --- a/gh-pages/docs/renderers/Form/FormItem.js +++ b/gh-pages/docs/renderers/Form/FormItem.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/FormItem.md', function(require, exports, module) { module.exports = { - "html": "

    FormItem

    Form 中主要是由各种 FormItem 组成。FormItem 中主要包含这些字段。

    \n
      \n
    • name 字段名,表单提交时的 key。
    • \n
    • value 值,可以通过它设置默认值。
    • \n
    • label 描述标题,当表单为水平布局时,左边即便是不设置 label 为了保持对齐也会留空,如果想要去掉空白,请设置成 false
    • \n
    • description 描述内容。
    • \n
    • placeholder 占位内容。
    • \n
    • type 指定表单类型,如: texttextareadateemail等等
    • \n
    • inline 是否为 inline 模式。
    • \n
    • submitOnChange 是否该表单项值发生变化时就提交当前表单。
    • \n
    • className 表单最外层类名。
    • \n
    • disabled 当前表单项是否是禁用状态。
    • \n
    • disabledOn 通过表达式来配置当前表单项的禁用状态。
    • \n
    • visible 是否可见。
    • \n
    • visibleOn 通过表达式来配置当前表单项是否显示。
    • \n
    • hidden 是否隐藏,不要跟 visible visibleOn 同时配置
    • \n
    • hiddenOn 通过表达式来配置当前表单项是否隐藏。
    • \n
    • inputClassName 表单控制器类名。
    • \n
    • labelClassName label 的类名。
    • \n
    • required 是否为必填。
    • \n
    • requiredOn 通过表达式来配置当前表单项是否为必填。
    • \n
    • validations 格式验证,支持设置多个,多个规则用英文逗号隔开。

      \n
        \n
      • isEmptyString 必须是空白字符。
      • \n
      • isEmail 必须是 Email。
      • \n
      • isUrl 必须是 Url。
      • \n
      • isNumeric 必须是 数值。
      • \n
      • isAlpha 必须是 字母。
      • \n
      • isAlphanumeric 必须是 字母或者数字。
      • \n
      • isInt 必须是 整形。
      • \n
      • isFloat 必须是 浮点形。
      • \n
      • isLength:length 是否长度正好等于设定值。
      • \n
      • minLength:length 最小长度。
      • \n
      • maxLength:length 最大长度。
      • \n
      • maximum:length 最大值。
      • \n
      • minimum:length 最小值。
      • \n
      • equals:xxx 当前值必须完全等于 xxx。
      • \n
      • equalsField:xxx 当前值必须与 xxx 变量值一致。
      • \n
      • isJson 是否是合法的 Json 字符串。
      • \n
      • notEmptyString 要求输入内容不是空白。
      • \n
      • isUrlPath 是 url 路径。
      • \n
      • matchRegexp:/foo/ 必须命中某个正则。
      • \n
      • matchRegexp1:/foo/ 必须命中某个正则。
      • \n
      • matchRegexp2:/foo/ 必须命中某个正则。
      • \n
      • matchRegexp3:/foo/ 必须命中某个正则。
      • \n
      • matchRegexp4:/foo/ 必须命中某个正则。\n如:
      • \n
      \n
      {\n  \"validations\": \"isNumeric,minimum:10\",\n\n  // 或者对象配置方式, 推荐\n  \"validations\": {\n    \"isNumeric\": true,\n    \"minimum\": 10\n  }\n}\n
      \n
    • \n
    • validationErrors 自定义错误提示, 配置为对象, key 为规则名, value 为错误提示字符串(提示:其中$1表示输入)\n如:

      \n
      {\n    \"validationErrors\": {\n        \"isEmail\": \"请输入正确的邮箱地址\"\n    }\n}\n
      \n
    • \n
    • validateOnChange 是否修改就验证数值,默认当表单提交过就会每次修改验证,如果要关闭请设置为 false,即便是关了,表单提交前还是会验证的。
    • \n
    \n
    \n

    不同类型的表单,可配置项还有更多,具体请看下面对应的类型。

    \n", + "html": "

    FormItem

    Form 中主要是由各种 FormItem 组成。FormItem 中主要包含这些字段。

    \n
      \n
    • name 字段名,表单提交时的 key。
    • \n
    • value 值,可以通过它设置默认值。
    • \n
    • label 描述标题,当表单为水平布局时,左边即便是不设置 label 为了保持对齐也会留空,如果想要去掉空白,请设置成 false
    • \n
    • description 描述内容。
    • \n
    • placeholder 占位内容。
    • \n
    • type 指定表单类型,如: texttextareadateemail等等
    • \n
    • inline 是否为 inline 模式。
    • \n
    • submitOnChange 是否该表单项值发生变化时就提交当前表单。
    • \n
    • className 表单最外层类名。
    • \n
    • disabled 当前表单项是否是禁用状态。
    • \n
    • disabledOn 通过表达式来配置当前表单项的禁用状态。
    • \n
    • visible 是否可见。
    • \n
    • visibleOn 通过表达式来配置当前表单项是否显示。
    • \n
    • hidden 是否隐藏,不要跟 visible visibleOn 同时配置
    • \n
    • hiddenOn 通过表达式来配置当前表单项是否隐藏。
    • \n
    • inputClassName 表单控制器类名。
    • \n
    • labelClassName label 的类名。
    • \n
    • required 是否为必填。
    • \n
    • requiredOn 通过表达式来配置当前表单项是否为必填。
    • \n
    • validations 格式验证,支持设置多个,多个规则用英文逗号隔开。

      \n
        \n
      • isEmptyString 必须是空白字符。
      • \n
      • isEmail 必须是 Email。
      • \n
      • isUrl 必须是 Url。
      • \n
      • isNumeric 必须是 数值。
      • \n
      • isAlpha 必须是 字母。
      • \n
      • isAlphanumeric 必须是 字母或者数字。
      • \n
      • isInt 必须是 整形。
      • \n
      • isFloat 必须是 浮点形。
      • \n
      • isLength:length 是否长度正好等于设定值。
      • \n
      • minLength:length 最小长度。
      • \n
      • maxLength:length 最大长度。
      • \n
      • maximum:length 最大值。
      • \n
      • minimum:length 最小值。
      • \n
      • equals:xxx 当前值必须完全等于 xxx。
      • \n
      • equalsField:xxx 当前值必须与 xxx 变量值一致。
      • \n
      • isJson 是否是合法的 Json 字符串。
      • \n
      • notEmptyString 要求输入内容不是空白。
      • \n
      • isUrlPath 是 url 路径。
      • \n
      • matchRegexp:/foo/ 必须命中某个正则。
      • \n
      • matchRegexp1:/foo/ 必须命中某个正则。
      • \n
      • matchRegexp2:/foo/ 必须命中某个正则。
      • \n
      • matchRegexp3:/foo/ 必须命中某个正则。
      • \n
      • matchRegexp4:/foo/ 必须命中某个正则。\n如:
      • \n
      \n
      {\n  \"validations\": \"isNumeric,minimum:10\",\n\n  // 或者对象配置方式, 推荐\n  \"validations\": {\n    \"isNumeric\": true,\n    \"minimum\": 10\n  }\n}\n
      \n
    • \n
    • validationErrors 自定义错误提示, 配置为对象, key 为规则名, value 为错误提示字符串(提示:其中$1表示输入)\n如:

      \n
      {\n    \"validationErrors\": {\n        \"isEmail\": \"请输入正确的邮箱地址\"\n    }\n}\n
      \n
    • \n
    • validateOnChange 是否修改就验证数值,默认当表单提交过就会每次修改验证,如果要关闭请设置为 false,即便是关了,表单提交前还是会验证的。
    • \n
    \n
    \n

    不同类型的表单,可配置项还有更多,具体请看下面对应的类型。

    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/FormItem.md', function(require, exports, module) { "label": "FormItem", "fragment": "formitem", "fullPath": "#formitem", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Formula.js b/gh-pages/docs/renderers/Form/Formula.js index de14e09a..7f93064b 100644 --- a/gh-pages/docs/renderers/Form/Formula.js +++ b/gh-pages/docs/renderers/Form/Formula.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Formula.md', function(require, exports, module) { module.exports = { - "html": "

    Formula

    公式类型,可以设置公式,并将结果设置给目标值。

    \n
      \n
    • type 请设置成 formula
    • \n
    • name 这是变量名,公式结果将作用到此处指定的变量中去。
    • \n
    • formula 公式。如: data.var_a + 2,其实就是 JS 表达式。
    • \n
    • condition 作用条件。有两种写法
        \n
      • 用 tpl 语法,把关联的字段写上如: ${xxx} ${yyy} 意思是当 xxx 和 yyy 的取值结果变化了就再应用一次公式结果。
      • \n
      • 自己写判断如: data.xxx == "a" && data.xxx !== data.__prev.xxx 当 xxx 变化了,且新的值是字符 "a" 时应用,可以写更加复杂的判断。
      • \n
      \n
    • \n
    • initSet 初始化时是否设置。默认是 true
    • \n
    • autoSet 观察公式结果,如果计算结果有变化,则自动应用到变量上。默认为 true
    • \n
    • id 定义个名字,当某个按钮的目标指定为此值后,会触发一次公式应用。这个机制可以在 autoSet 为 false 时用来手动触发。
      \n

      为什么不是设置 name?\n因为 name 值已经用来设置目标变量名了,这个表单项肯定已经存在了,所以不是唯一了,不能够被按钮指定。

      \n
      \n
    • \n
    \n
    \n", + "html": "

    Formula

    公式类型,可以设置公式,并将结果设置给目标值。

    \n
      \n
    • type 请设置成 formula
    • \n
    • name 这是变量名,公式结果将作用到此处指定的变量中去。
    • \n
    • formula 公式。如: data.var_a + 2,其实就是 JS 表达式。
    • \n
    • condition 作用条件。有两种写法
        \n
      • 用 tpl 语法,把关联的字段写上如: ${xxx} ${yyy} 意思是当 xxx 和 yyy 的取值结果变化了就再应用一次公式结果。
      • \n
      • 自己写判断如: data.xxx == "a" && data.xxx !== data.__prev.xxx 当 xxx 变化了,且新的值是字符 "a" 时应用,可以写更加复杂的判断。
      • \n
      \n
    • \n
    • initSet 初始化时是否设置。默认是 true
    • \n
    • autoSet 观察公式结果,如果计算结果有变化,则自动应用到变量上。默认为 true
    • \n
    • id 定义个名字,当某个按钮的目标指定为此值后,会触发一次公式应用。这个机制可以在 autoSet 为 false 时用来手动触发。
      \n

      为什么不是设置 name?\n因为 name 值已经用来设置目标变量名了,这个表单项肯定已经存在了,所以不是唯一了,不能够被按钮指定。

      \n
      \n
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Formula.md', function(require, exports, module) { "label": "Formula", "fragment": "formula", "fullPath": "#formula", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Grid.js b/gh-pages/docs/renderers/Form/Grid.js index 1ceb84ba..918a9852 100644 --- a/gh-pages/docs/renderers/Form/Grid.js +++ b/gh-pages/docs/renderers/Form/Grid.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Grid.md', function(require, exports, module) { module.exports = { - "html": "

    Grid(FormItem)

    支持 form 内部再用 grid 布局。

    \n
      \n
    • type 请设置成 grid
    • \n
    • columns 数据,用来配置列内容。每个 column 又一个独立的渲染器。
    • \n
    • columns[x].columnClassName 配置列的 className
    • \n
    • columns[x].controls 如果配置了表单集合,同时没有指定 type 类型,则优先展示表单集合。
    • \n
    • columns[x].xs 设置极小屏幕宽度占比 1 - 12。
    • \n
    • columns[x].xsHidden 设置极小屏幕是否隐藏。
    • \n
    • columns[x].xsOffset 设置极小屏幕偏移量 1 - 12。
    • \n
    • columns[x].xsPull 设置极小屏幕靠左的距离占比:1 - 12 。
    • \n
    • columns[x].xsPush 设置极小屏幕靠右的距离占比:1 - 12 。
    • \n
    • columns[x].sm 设置小屏幕宽度占比 1 - 12。
    • \n
    • columns[x].smHidden 设置小屏幕是否隐藏。
    • \n
    • columns[x].smOffset 设置小屏幕偏移量 1 - 12。
    • \n
    • columns[x].smPull 设置小屏幕靠左的距离占比:1 - 12 。
    • \n
    • columns[x].smPush 设置小屏幕靠右的距离占比:1 - 12 。
    • \n
    • columns[x].md 设置平板屏幕宽度占比 1 - 12。
    • \n
    • columns[x].mdHidden 设置平板屏幕是否隐藏。
    • \n
    • columns[x].mdOffset 设置平板屏幕偏移量 1 - 12。
    • \n
    • columns[x].mdPull 设置平板屏幕靠左的距离占比:1 - 12 。
    • \n
    • columns[x].mdPush 设置平板屏幕靠右的距离占比:1 - 12 。
    • \n
    • columns[x].lg 设置 PC 屏幕宽度占比 1 - 12。
    • \n
    • columns[x].lgHidden 设置 PC 屏幕是否隐藏。
    • \n
    • columns[x].lgOffset 设置 PC 屏幕偏移量 1 - 12。
    • \n
    • columns[x].lgPull 设置 PC 屏幕靠左的距离占比:1 - 12 。
    • \n
    • columns[x].lgPush 设置 PC 屏幕靠右的距离占比:1 - 12 。
    • \n
    \n
    \n", + "html": "

    Grid(FormItem)

    支持 form 内部再用 grid 布局。

    \n
      \n
    • type 请设置成 grid
    • \n
    • columns 数据,用来配置列内容。每个 column 又一个独立的渲染器。
    • \n
    • columns[x].columnClassName 配置列的 className
    • \n
    • columns[x].controls 如果配置了表单集合,同时没有指定 type 类型,则优先展示表单集合。
    • \n
    • columns[x].xs 设置极小屏幕宽度占比 1 - 12。
    • \n
    • columns[x].xsHidden 设置极小屏幕是否隐藏。
    • \n
    • columns[x].xsOffset 设置极小屏幕偏移量 1 - 12。
    • \n
    • columns[x].xsPull 设置极小屏幕靠左的距离占比:1 - 12 。
    • \n
    • columns[x].xsPush 设置极小屏幕靠右的距离占比:1 - 12 。
    • \n
    • columns[x].sm 设置小屏幕宽度占比 1 - 12。
    • \n
    • columns[x].smHidden 设置小屏幕是否隐藏。
    • \n
    • columns[x].smOffset 设置小屏幕偏移量 1 - 12。
    • \n
    • columns[x].smPull 设置小屏幕靠左的距离占比:1 - 12 。
    • \n
    • columns[x].smPush 设置小屏幕靠右的距离占比:1 - 12 。
    • \n
    • columns[x].md 设置平板屏幕宽度占比 1 - 12。
    • \n
    • columns[x].mdHidden 设置平板屏幕是否隐藏。
    • \n
    • columns[x].mdOffset 设置平板屏幕偏移量 1 - 12。
    • \n
    • columns[x].mdPull 设置平板屏幕靠左的距离占比:1 - 12 。
    • \n
    • columns[x].mdPush 设置平板屏幕靠右的距离占比:1 - 12 。
    • \n
    • columns[x].lg 设置 PC 屏幕宽度占比 1 - 12。
    • \n
    • columns[x].lgHidden 设置 PC 屏幕是否隐藏。
    • \n
    • columns[x].lgOffset 设置 PC 屏幕偏移量 1 - 12。
    • \n
    • columns[x].lgPull 设置 PC 屏幕靠左的距离占比:1 - 12 。
    • \n
    • columns[x].lgPush 设置 PC 屏幕靠右的距离占比:1 - 12 。
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Grid.md', function(require, exports, module) { "label": "Grid(FormItem)", "fragment": "grid-formitem-", "fullPath": "#grid-formitem-", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Group.js b/gh-pages/docs/renderers/Form/Group.js index 705f7cb6..2998e434 100644 --- a/gh-pages/docs/renderers/Form/Group.js +++ b/gh-pages/docs/renderers/Form/Group.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Group.md', function(require, exports, module) { module.exports = { - "html": "

    Group

    表单项集合中,默认都是一行一个,如果想要一行多个,请用 Group 包裹起来。

    \n
      \n
    • type 请设置成 group
    • \n
    • controls 表单项集合。
    • \n
    • mode 展示默认,跟 Form 中的模式一样,选择: normalhorizontal或者inline
    • \n
    • horizontal 当为水平模式时,用来控制左右占比。
    • \n
    • horizontal.label 左边 label 的宽度占比。
    • \n
    • horizontal.right 右边控制器的宽度占比。
    • \n
    • horizontal.offset 当没有设置 label 时,右边控制器的偏移量。
    • \n
    • className CSS 类名。
    • \n
    \n
    \n", + "html": "

    Group

    表单项集合中,默认都是一行一个,如果想要一行多个,请用 Group 包裹起来。

    \n
      \n
    • type 请设置成 group
    • \n
    • controls 表单项集合。
    • \n
    • mode 展示默认,跟 Form 中的模式一样,选择: normalhorizontal或者inline
    • \n
    • horizontal 当为水平模式时,用来控制左右占比。
    • \n
    • horizontal.label 左边 label 的宽度占比。
    • \n
    • horizontal.right 右边控制器的宽度占比。
    • \n
    • horizontal.offset 当没有设置 label 时,右边控制器的偏移量。
    • \n
    • className CSS 类名。
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Group.md', function(require, exports, module) { "label": "Group", "fragment": "group", "fullPath": "#group", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/HBox.js b/gh-pages/docs/renderers/Form/HBox.js index d77f0d9b..682fd298 100644 --- a/gh-pages/docs/renderers/Form/HBox.js +++ b/gh-pages/docs/renderers/Form/HBox.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/HBox.md', function(require, exports, module) { module.exports = { - "html": "

    HBox(FormItem)

    支持 form 内部再用 HBox 布局,实现左右排列。没错用 Group 也能实现,所以还是推荐用 Group

    \n
      \n
    • type 请设置成 hbox
    • \n
    • columns 数据,用来配置列内容。每个 column 又一个独立的渲染器。
    • \n
    • columns[x].columnClassName 配置列的 className
    • \n
    • columns[x].controls 如果配置了表单集合,同时没有指定 type 类型,则优先展示表单集合。
    • \n
    \n
    \n", + "html": "

    HBox(FormItem)

    支持 form 内部再用 HBox 布局,实现左右排列。没错用 Group 也能实现,所以还是推荐用 Group

    \n
      \n
    • type 请设置成 hbox
    • \n
    • columns 数据,用来配置列内容。每个 column 又一个独立的渲染器。
    • \n
    • columns[x].columnClassName 配置列的 className
    • \n
    • columns[x].controls 如果配置了表单集合,同时没有指定 type 类型,则优先展示表单集合。
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/HBox.md', function(require, exports, module) { "label": "HBox(FormItem)", "fragment": "hbox-formitem-", "fullPath": "#hbox-formitem-", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Hidden.js b/gh-pages/docs/renderers/Form/Hidden.js index e1863aab..05cfcef9 100644 --- a/gh-pages/docs/renderers/Form/Hidden.js +++ b/gh-pages/docs/renderers/Form/Hidden.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Hidden.md', function(require, exports, module) { module.exports = { - "html": "

    Hidden

    隐藏字段类型,默认表单提交,只会发送 controls 里面的这些成员,对于隐藏的字段同时又希望提交表单的时候带过去,请把表单项配置成 hidden 类型。

    \n
      \n
    • type 请设置成 hidden
    • \n
    \n", + "html": "

    Hidden

    隐藏字段类型,默认表单提交,只会发送 controls 里面的这些成员,对于隐藏的字段同时又希望提交表单的时候带过去,请把表单项配置成 hidden 类型。

    \n
      \n
    • type 请设置成 hidden
    • \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Hidden.md', function(require, exports, module) { "label": "Hidden", "fragment": "hidden", "fullPath": "#hidden", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Image.js b/gh-pages/docs/renderers/Form/Image.js index 3ae54bce..d4c5910a 100644 --- a/gh-pages/docs/renderers/Form/Image.js +++ b/gh-pages/docs/renderers/Form/Image.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Image.md', function(require, exports, module) { module.exports = { - "html": "

    Image

    图片格式输入,默认 amis 会直接存储在 FEX 的 hiphoto 里面,提交到 form 是直接的图片 url。

    \n
      \n
    • type 请设置成 image
    • \n
    • reciever 默认 /api/upload 如果想自己存储,请设置此选项。
    • \n
    • multiple 是否多选。
    • \n
    • maxLength 默认没有限制,当设置后,一次只允许上传指定数量文件。
    • \n
    • joinValues 多选时是否将多个值用 delimiter 连接起来。
    • \n
    • extractValue 默认为 false, joinValues设置为false时生效, 开启后将选中的选项 value 的值封装为数组,作为当前表单项的值。
    • \n
    • delimiter 连接符,默认是 ,, 多选时且 joinValuestrue 时用来连接值。
    • \n
    • autoUpload 是否选择完就自动开始上传?默认为 true
    • \n
    • compress 默认 true 如果想默认压缩请开启。
    • \n
    • compressOptions
        \n
      • maxWidth 设置最大宽度。
      • \n
      • maxHeight 设置最大高度。
      • \n
      \n
    • \n
    • showCompressOptions 默认为 false, 开启后,允许用户输入压缩选项。
    • \n
    • crop 用来设置是否支持裁剪。
        \n
      • aspectRatio 浮点型,默认 11:1,如果要设置 16:9 请设置 1.777777777777777716 / 9
      • \n
      \n
    • \n
    • allowInput 默认都是通过用户选择图片后上传返回图片地址,如果开启此选项,则可以允许用户图片地址。
    • \n
    • limit 限制图片大小,超出不让上传。
        \n
      • width 限制图片宽度。
      • \n
      • height 限制图片高度。
      • \n
      • minWidth 限制图片最小宽度。
      • \n
      • minHeight 限制图片最小高度。
      • \n
      • maxWidth 限制图片最大宽度。
      • \n
      • maxHeight 限制图片最大高度。
      • \n
      \n
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", + "html": "

    Image

    图片格式输入,默认 amis 会直接存储在 FEX 的 hiphoto 里面,提交到 form 是直接的图片 url。

    \n
      \n
    • type 请设置成 image
    • \n
    • reciever 默认 /api/upload 如果想自己存储,请设置此选项。
    • \n
    • multiple 是否多选。
    • \n
    • maxLength 默认没有限制,当设置后,一次只允许上传指定数量文件。
    • \n
    • joinValues 多选时是否将多个值用 delimiter 连接起来。
    • \n
    • extractValue 默认为 false, joinValues设置为false时生效, 开启后将选中的选项 value 的值封装为数组,作为当前表单项的值。
    • \n
    • delimiter 连接符,默认是 ,, 多选时且 joinValuestrue 时用来连接值。
    • \n
    • autoUpload 是否选择完就自动开始上传?默认为 true
    • \n
    • compress 默认 true 如果想默认压缩请开启。
    • \n
    • compressOptions
        \n
      • maxWidth 设置最大宽度。
      • \n
      • maxHeight 设置最大高度。
      • \n
      \n
    • \n
    • showCompressOptions 默认为 false, 开启后,允许用户输入压缩选项。
    • \n
    • crop 用来设置是否支持裁剪。
        \n
      • aspectRatio 浮点型,默认 11:1,如果要设置 16:9 请设置 1.777777777777777716 / 9
      • \n
      \n
    • \n
    • allowInput 默认都是通过用户选择图片后上传返回图片地址,如果开启此选项,则可以允许用户图片地址。
    • \n
    • limit 限制图片大小,超出不让上传。
        \n
      • width 限制图片宽度。
      • \n
      • height 限制图片高度。
      • \n
      • minWidth 限制图片最小宽度。
      • \n
      • minHeight 限制图片最小高度。
      • \n
      • maxWidth 限制图片最大宽度。
      • \n
      • maxHeight 限制图片最大高度。
      • \n
      \n
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Image.md', function(require, exports, module) { "label": "Image", "fragment": "image", "fullPath": "#image", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/List.js b/gh-pages/docs/renderers/Form/List.js index 3d68941e..ec83ef35 100644 --- a/gh-pages/docs/renderers/Form/List.js +++ b/gh-pages/docs/renderers/Form/List.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/List.md', function(require, exports, module) { module.exports = { - "html": "

    List(FormItem)

    简单的列表选择框。

    \n
      \n
    • type 请设置成 list
    • \n
    • options 选项配置,类型为数组,成员格式如下。
        \n
      • label 文字
      • \n
      • value
      • \n
      • image 图片的 http 地址。
      • \n
      \n
    • \n
    • source Api 地址,如果选项不固定,可以通过配置 source 动态拉取。
    • \n
    • multiple 默认为 false, 设置成 true 表示可多选。
    • \n
    • joinValues 默认为 true
    • \n
    • 单选模式:当用户选中某个选项时,选项中的 value 将被作为该表单项的值提交,否则,整个选项对象都会作为该表单项的值提交。
    • \n
    • 多选模式:选中的多个选项的 value 会通过 delimiter 连接起来,否则直接将以数组的形式提交值。
    • \n
    • delimiter 默认为 ,
    • \n
    • clearable 默认为 true, 表示可以取消选中。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n

    单选

    \n
    \n

    多选

    \n
    \n

    选项带图片

    \n
    \n", + "html": "

    List(FormItem)

    简单的列表选择框。

    \n
      \n
    • type 请设置成 list
    • \n
    • options 选项配置,类型为数组,成员格式如下。
        \n
      • label 文字
      • \n
      • value
      • \n
      • image 图片的 http 地址。
      • \n
      \n
    • \n
    • source Api 地址,如果选项不固定,可以通过配置 source 动态拉取。
    • \n
    • multiple 默认为 false, 设置成 true 表示可多选。
    • \n
    • joinValues 默认为 true
    • \n
    • 单选模式:当用户选中某个选项时,选项中的 value 将被作为该表单项的值提交,否则,整个选项对象都会作为该表单项的值提交。
    • \n
    • 多选模式:选中的多个选项的 value 会通过 delimiter 连接起来,否则直接将以数组的形式提交值。
    • \n
    • delimiter 默认为 ,
    • \n
    • clearable 默认为 true, 表示可以取消选中。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n

    单选

    \n
    \n

    多选

    \n
    \n

    选项带图片

    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/List.md', function(require, exports, module) { "label": "List(FormItem)", "fragment": "list-formitem-", "fullPath": "#list-formitem-", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Matrix.js b/gh-pages/docs/renderers/Form/Matrix.js index 7ba19fcf..6be868e4 100644 --- a/gh-pages/docs/renderers/Form/Matrix.js +++ b/gh-pages/docs/renderers/Form/Matrix.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Matrix.md', function(require, exports, module) { module.exports = { - "html": "

    Matrix

    矩阵类型的输入框。

    \n
      \n
    • type 请设置成 matrix
    • \n
    • columns 列信息, 数组中 label 字段是必须给出的
    • \n
    • rows 行信息, 数组中 label 字段是必须给出的
    • \n
    • rowLabel 行标题说明
    • \n
    • source Api 地址,如果选项不固定,可以通过配置 source 动态拉取。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", + "html": "

    Matrix

    矩阵类型的输入框。

    \n
      \n
    • type 请设置成 matrix
    • \n
    • columns 列信息, 数组中 label 字段是必须给出的
    • \n
    • rows 行信息, 数组中 label 字段是必须给出的
    • \n
    • rowLabel 行标题说明
    • \n
    • source Api 地址,如果选项不固定,可以通过配置 source 动态拉取。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Matrix.md', function(require, exports, module) { "label": "Matrix", "fragment": "matrix", "fullPath": "#matrix", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/NestedSelect.js b/gh-pages/docs/renderers/Form/NestedSelect.js index 019d556a..5de94e92 100644 --- a/gh-pages/docs/renderers/Form/NestedSelect.js +++ b/gh-pages/docs/renderers/Form/NestedSelect.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/NestedSelect.md', function(require, exports, module) { module.exports = { - "html": "

    NestedSelect

    树形结构选择框。

    \n
      \n
    • type 请设置成 nested-select
    • \n
    • options 类似于 selectoptions, 并且支持通过 children 无限嵌套。
    • \n
    • source Api 地址,如果选项不固定,可以通过配置 source 动态拉取。
    • \n
    • multiple 默认为 false, 设置成 true 表示可多选。
    • \n
    • joinValues 默认为 true
    • \n
    • 单选模式:当用户选中某个选项时,选项中的 value 将被作为该表单项的值提交,否则,整个选项对象都会作为该表单项的值提交。
    • \n
    • 多选模式:选中的多个选项的 value 会通过 delimiter 连接起来,否则直接将以数组的形式提交值。
    • \n
    • extractValue 默认为 false, joinValues设置为false时生效, 开启后将选中的选项 value 的值封装为数组,作为当前表单项的值。
    • \n
    • delimiter 默认为 ,
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", + "html": "

    NestedSelect

    树形结构选择框。

    \n
      \n
    • type 请设置成 nested-select
    • \n
    • options 类似于 selectoptions, 并且支持通过 children 无限嵌套。
    • \n
    • source Api 地址,如果选项不固定,可以通过配置 source 动态拉取。
    • \n
    • multiple 默认为 false, 设置成 true 表示可多选。
    • \n
    • joinValues 默认为 true
    • \n
    • 单选模式:当用户选中某个选项时,选项中的 value 将被作为该表单项的值提交,否则,整个选项对象都会作为该表单项的值提交。
    • \n
    • 多选模式:选中的多个选项的 value 会通过 delimiter 连接起来,否则直接将以数组的形式提交值。
    • \n
    • extractValue 默认为 false, joinValues设置为false时生效, 开启后将选中的选项 value 的值封装为数组,作为当前表单项的值。
    • \n
    • delimiter 默认为 ,
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/NestedSelect.md', function(require, exports, module) "label": "NestedSelect", "fragment": "nestedselect", "fullPath": "#nestedselect", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Number.js b/gh-pages/docs/renderers/Form/Number.js index 9d0cb7d9..c4db3180 100644 --- a/gh-pages/docs/renderers/Form/Number.js +++ b/gh-pages/docs/renderers/Form/Number.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Number.md', function(require, exports, module) { module.exports = { - "html": "

    Number

    数字输入框。

    \n
      \n
    • type 请设置成 number
    • \n
    • min 最小值,支持用${xxx}获取变量
    • \n
    • max 最大值,支持用${xxx}获取变量
    • \n
    • step 步长
    • \n
    • precision 精度
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", + "html": "

    Number

    数字输入框。

    \n
      \n
    • type 请设置成 number
    • \n
    • min 最小值,支持用${xxx}获取变量
    • \n
    • max 最大值,支持用${xxx}获取变量
    • \n
    • step 步长
    • \n
    • precision 精度
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Number.md', function(require, exports, module) { "label": "Number", "fragment": "number", "fullPath": "#number", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Panel.js b/gh-pages/docs/renderers/Form/Panel.js index a0ec7579..69915f4f 100644 --- a/gh-pages/docs/renderers/Form/Panel.js +++ b/gh-pages/docs/renderers/Form/Panel.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Panel.md', function(require, exports, module) { module.exports = { - "html": "

    Panel(FormItem)

    还是为了布局,可以把一部分 FormItem 合并到一个 panel 里面单独展示。

    \n
      \n
    • title panel 标题
    • \n
    • body Container 可以是其他渲染模型。
    • \n
    • bodyClassName body 的 className.
    • \n
    • footer Container 可以是其他渲染模型。
    • \n
    • footerClassName footer 的 className.
    • \n
    • controlsbody 二选一,如果设置了 controls 优先显示表单集合。
    • \n
    \n
    \n", + "html": "

    Panel(FormItem)

    还是为了布局,可以把一部分 FormItem 合并到一个 panel 里面单独展示。

    \n
      \n
    • title panel 标题
    • \n
    • body Container 可以是其他渲染模型。
    • \n
    • bodyClassName body 的 className.
    • \n
    • footer Container 可以是其他渲染模型。
    • \n
    • footerClassName footer 的 className.
    • \n
    • controlsbody 二选一,如果设置了 controls 优先显示表单集合。
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Panel.md', function(require, exports, module) { "label": "Panel(FormItem)", "fragment": "panel-formitem-", "fullPath": "#panel-formitem-", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Password.js b/gh-pages/docs/renderers/Form/Password.js index e2ebd2d2..fdb0fb8b 100644 --- a/gh-pages/docs/renderers/Form/Password.js +++ b/gh-pages/docs/renderers/Form/Password.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Password.md', function(require, exports, module) { module.exports = { - "html": "

    Password

    密码输入框。

    \n
      \n
    • type 请设置成 password
    • \n
    • addOn 输入框附加组件,比如附带一个提示文字,或者附带一个提交按钮。
    • \n
    • addOn.type 请选择 textbutton 或者 submit
    • \n
    • addOn.label 文字说明
    • \n
    • addOn.xxx 其他参数请参考按钮配置部分。
    • \n
    • clearable 在有值的时候是否显示一个删除图标在右侧。
    • \n
    • resetValue 默认为 "", 删除后设置此配置项给定的值。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n", + "html": "

    Password

    密码输入框。

    \n
      \n
    • type 请设置成 password
    • \n
    • addOn 输入框附加组件,比如附带一个提示文字,或者附带一个提交按钮。
    • \n
    • addOn.type 请选择 textbutton 或者 submit
    • \n
    • addOn.label 文字说明
    • \n
    • addOn.xxx 其他参数请参考按钮配置部分。
    • \n
    • clearable 在有值的时候是否显示一个删除图标在右侧。
    • \n
    • resetValue 默认为 "", 删除后设置此配置项给定的值。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Password.md', function(require, exports, module) { "label": "Password", "fragment": "password", "fullPath": "#password", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Picker.js b/gh-pages/docs/renderers/Form/Picker.js index 5831c2a9..53ab43c9 100644 --- a/gh-pages/docs/renderers/Form/Picker.js +++ b/gh-pages/docs/renderers/Form/Picker.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Picker.md', function(require, exports, module) { module.exports = { - "html": "

    Picker

    列表选取。可以静态数据,或者通过接口拉取动态数据。

    \n
      \n
    • type 请设置成 picker
    • \n
    • multiple 是否为多选。
    • \n
    • options 选项配置,类型为数组,成员格式如下。
        \n
      • label 文字
      • \n
      • value
      • \n
      \n
    • \n
    • source Api 地址,如果选项不固定,可以通过配置 source 动态拉取。 另外也可以用 $xxxx 来获取当前作用域中的变量。
    • \n
    • joinValues 默认为 true
    • \n
    • 单选模式:当用户选中某个选项时,选项中的 value 将被作为该表单项的值提交,否则,整个选项对象都会作为该表单项的值提交。
    • \n
    • 多选模式:选中的多个选项的 value 会通过 delimiter 连接起来,否则直接将以数组的形式提交值。
    • \n
    • extractValue 默认为 false, joinValues设置为false时生效, 开启后将选中的选项 value 的值封装为数组,作为当前表单项的值。
    • \n
    • delimiter 默认为 ,
    • \n
    • modalMode 设置 dialog 或者 drawer,用来配置弹出方式。
    • \n
    • pickerSchema 默认为 {mode: 'list', listItem: {title: '${label}'}}, 即用 List 类型的渲染,来展示列表信息。更多的玩法请参考 CRUD 的配置。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", + "html": "

    Picker

    列表选取。可以静态数据,或者通过接口拉取动态数据。

    \n
      \n
    • type 请设置成 picker
    • \n
    • multiple 是否为多选。
    • \n
    • options 选项配置,类型为数组,成员格式如下。
        \n
      • label 文字
      • \n
      • value
      • \n
      \n
    • \n
    • source Api 地址,如果选项不固定,可以通过配置 source 动态拉取。 另外也可以用 $xxxx 来获取当前作用域中的变量。
    • \n
    • joinValues 默认为 true
    • \n
    • 单选模式:当用户选中某个选项时,选项中的 value 将被作为该表单项的值提交,否则,整个选项对象都会作为该表单项的值提交。
    • \n
    • 多选模式:选中的多个选项的 value 会通过 delimiter 连接起来,否则直接将以数组的形式提交值。
    • \n
    • extractValue 默认为 false, joinValues设置为false时生效, 开启后将选中的选项 value 的值封装为数组,作为当前表单项的值。
    • \n
    • delimiter 默认为 ,
    • \n
    • modalMode 设置 dialog 或者 drawer,用来配置弹出方式。
    • \n
    • pickerSchema 默认为 {mode: 'list', listItem: {title: '${label}'}}, 即用 List 类型的渲染,来展示列表信息。更多的玩法请参考 CRUD 的配置。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Picker.md', function(require, exports, module) { "label": "Picker", "fragment": "picker", "fullPath": "#picker", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Radios.js b/gh-pages/docs/renderers/Form/Radios.js index 339cd8bc..a46218ce 100644 --- a/gh-pages/docs/renderers/Form/Radios.js +++ b/gh-pages/docs/renderers/Form/Radios.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Radios.md', function(require, exports, module) { module.exports = { - "html": "

    Radios

    单选框

    \n
      \n
    • type 请设置成 radios
    • \n
    • options 选项配置,类型为数组,成员格式如下。
        \n
      • label 文字
      • \n
      • value
      • \n
      \n
    • \n
    • source Api 地址,如果选项不固定,可以通过配置 source 动态拉取。
    • \n
    • columnsCount 默认为 1 可以配置成一行显示多个。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", + "html": "

    Radios

    单选框

    \n
      \n
    • type 请设置成 radios
    • \n
    • options 选项配置,类型为数组,成员格式如下。
        \n
      • label 文字
      • \n
      • value
      • \n
      \n
    • \n
    • source Api 地址,如果选项不固定,可以通过配置 source 动态拉取。
    • \n
    • columnsCount 默认为 1 可以配置成一行显示多个。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Radios.md', function(require, exports, module) { "label": "Radios", "fragment": "radios", "fullPath": "#radios", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Range.js b/gh-pages/docs/renderers/Form/Range.js index 56a86942..81d510f4 100644 --- a/gh-pages/docs/renderers/Form/Range.js +++ b/gh-pages/docs/renderers/Form/Range.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Range.md', function(require, exports, module) { module.exports = { - "html": "

    Range

    范围输入框。

    \n
      \n
    • type 请设置成 range
    • \n
    • min 最小值
    • \n
    • max 最大值
    • \n
    • step 步长
    • \n
    • multiple 支持选择范围,默认为false
    • \n
    • joinValuse 默认为 true,选择的 value 会通过 delimiter 连接起来,否则直接将以{min: 1, max: 100}的形式提交,开启multiple时有效
    • \n
    • delimiter 默认为 ,
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", + "html": "

    Range

    范围输入框。

    \n
      \n
    • type 请设置成 range
    • \n
    • min 最小值
    • \n
    • max 最大值
    • \n
    • step 步长
    • \n
    • multiple 支持选择范围,默认为false
    • \n
    • joinValuse 默认为 true,选择的 value 会通过 delimiter 连接起来,否则直接将以{min: 1, max: 100}的形式提交,开启multiple时有效
    • \n
    • delimiter 默认为 ,
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Range.md', function(require, exports, module) { "label": "Range", "fragment": "range", "fullPath": "#range", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Repeat.js b/gh-pages/docs/renderers/Form/Repeat.js index cd130b02..3c16b8bb 100644 --- a/gh-pages/docs/renderers/Form/Repeat.js +++ b/gh-pages/docs/renderers/Form/Repeat.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Repeat.md', function(require, exports, module) { module.exports = { - "html": "

    Repeat

    可用来设置重复频率

    \n
      \n
    • type 请设置成 repeat
    • \n
    • options 默认: hourly,daily,weekly,monthly, 可用配置 secondly,minutely,hourly,daily,weekdays,weekly,monthly,yearly
    • \n
    • placeholder 默认为 不重复, 当不指定值时的说明。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", + "html": "

    Repeat

    可用来设置重复频率

    \n
      \n
    • type 请设置成 repeat
    • \n
    • options 默认: hourly,daily,weekly,monthly, 可用配置 secondly,minutely,hourly,daily,weekdays,weekly,monthly,yearly
    • \n
    • placeholder 默认为 不重复, 当不指定值时的说明。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Repeat.md', function(require, exports, module) { "label": "Repeat", "fragment": "repeat", "fullPath": "#repeat", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Rich-Text.js b/gh-pages/docs/renderers/Form/Rich-Text.js index c2852e38..0cf5302f 100644 --- a/gh-pages/docs/renderers/Form/Rich-Text.js +++ b/gh-pages/docs/renderers/Form/Rich-Text.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Rich-Text.md', function(require, exports, module) { module.exports = { - "html": "

    Rich-Text

    富文本编辑器

    \n
      \n
    • type 请设置成 rich-text
    • \n
    • saveAsUbb 是否保存为 ubb 格式
    • \n
    • reciever 默认的图片保存 API /api/upload/image
    • \n
    • size 框的大小,可以设置成 md 或者 lg 来增大输入框。
    • \n
    • buttons 默认为

      \n
      [\n    'paragraphFormat',\n    'quote',\n    'color',\n    '|',\n    'bold',\n    'italic',\n    'underline',\n    'strikeThrough',\n    '|',\n    'formatOL',\n    'formatUL',\n    'align',\n    '|',\n    'insertLink',\n    'insertImage',\n    'insertTable',\n    '|',\n    'undo',\n    'redo',\n    'html',\n];\n
      \n
    • \n
    • options Object 类型,给富文本的配置信息。请参考 https://www.froala.com/wysiwyg-editor/docs/options

      \n
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", + "html": "

    Rich-Text

    富文本编辑器

    \n
      \n
    • type 请设置成 rich-text
    • \n
    • saveAsUbb 是否保存为 ubb 格式
    • \n
    • reciever 默认的图片保存 API /api/upload/image
    • \n
    • size 框的大小,可以设置成 md 或者 lg 来增大输入框。
    • \n
    • buttons 默认为

      \n
      [\n    'paragraphFormat',\n    'quote',\n    'color',\n    '|',\n    'bold',\n    'italic',\n    'underline',\n    'strikeThrough',\n    '|',\n    'formatOL',\n    'formatUL',\n    'align',\n    '|',\n    'insertLink',\n    'insertImage',\n    'insertTable',\n    '|',\n    'undo',\n    'redo',\n    'html',\n];\n
      \n
    • \n
    • options Object 类型,给富文本的配置信息。请参考 https://www.froala.com/wysiwyg-editor/docs/options

      \n
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Rich-Text.md', function(require, exports, module) { "label": "Rich-Text", "fragment": "rich-text", "fullPath": "#rich-text", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Select.js b/gh-pages/docs/renderers/Form/Select.js index 2b4de947..83d4f60e 100644 --- a/gh-pages/docs/renderers/Form/Select.js +++ b/gh-pages/docs/renderers/Form/Select.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Select.md', function(require, exports, module) { module.exports = { - "html": "

    Select

    选项表单。

    \n
      \n
    • type 请设置成 select
    • \n
    • options 选项配置,类型为数组,成员格式如下。
        \n
      • label 文字
      • \n
      • value
      • \n
      \n
    • \n
    • source Api 地址,如果选项不固定,可以通过配置 source 动态拉取。另外也可以用 $xxxx 来获取当前作用域中的变量。
    • \n
    • autoComplete 跟 source 不同的是,每次用户输入都会去接口获取提示。
    • \n
    • multiple 默认为 false, 设置成 true 表示可多选。
    • \n
    • joinValues 默认为 true
    • \n
    • 单选模式:当用户选中某个选项时,选项中的 value 将被作为该表单项的值提交,否则,整个选项对象都会作为该表单项的值提交。
    • \n
    • 多选模式:选中的多个选项的 value 会通过 delimiter 连接起来,否则直接将以数组的形式提交值。
    • \n
    • extractValue 默认为 false, joinValues设置为false时生效, 开启后将选中的选项 value 的值封装为数组,作为当前表单项的值。
    • \n
    • delimiter 默认为 ,
    • \n
    • clearable 默认为 false, 当设置为 true 时,已选中的选项右侧会有个小 X 用来取消设置。
    • \n
    • searchable 默认为 false,表示可以通过输入部分内容检索出选项。
    • \n
    • checkall 默认为 false 开启后支持全选
    • \n
    • checkAllLabel 默认为 全选, 全选的文字
    • \n
    • defaultCheckAll 是否默认全选,默认为false
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n

    单选

    \n
    \n

    多选

    \n
    \n", + "html": "

    Select

    选项表单。

    \n
      \n
    • type 请设置成 select
    • \n
    • options 选项配置,类型为数组,成员格式如下。
        \n
      • label 文字
      • \n
      • value
      • \n
      \n
    • \n
    • source Api 地址,如果选项不固定,可以通过配置 source 动态拉取。另外也可以用 $xxxx 来获取当前作用域中的变量。
    • \n
    • autoComplete 跟 source 不同的是,每次用户输入都会去接口获取提示。
    • \n
    • multiple 默认为 false, 设置成 true 表示可多选。
    • \n
    • joinValues 默认为 true
    • \n
    • 单选模式:当用户选中某个选项时,选项中的 value 将被作为该表单项的值提交,否则,整个选项对象都会作为该表单项的值提交。
    • \n
    • 多选模式:选中的多个选项的 value 会通过 delimiter 连接起来,否则直接将以数组的形式提交值。
    • \n
    • extractValue 默认为 false, joinValues设置为false时生效, 开启后将选中的选项 value 的值封装为数组,作为当前表单项的值。
    • \n
    • delimiter 默认为 ,
    • \n
    • clearable 默认为 false, 当设置为 true 时,已选中的选项右侧会有个小 X 用来取消设置。
    • \n
    • searchable 默认为 false,表示可以通过输入部分内容检索出选项。
    • \n
    • checkall 默认为 false 开启后支持全选
    • \n
    • checkAllLabel 默认为 全选, 全选的文字
    • \n
    • defaultCheckAll 是否默认全选,默认为false
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n

    单选

    \n
    \n

    多选

    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Select.md', function(require, exports, module) { "label": "Select", "fragment": "select", "fullPath": "#select", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Service.js b/gh-pages/docs/renderers/Form/Service.js index ada9e51e..582b257b 100644 --- a/gh-pages/docs/renderers/Form/Service.js +++ b/gh-pages/docs/renderers/Form/Service.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Service.md', function(require, exports, module) { module.exports = { - "html": "

    Service(FormItem)

    目前看到的配置方式都是静态配置,如果你想动态配置,即配置项由接口决定,那么就使用此渲染器。

    \n
      \n
    • type 请设置成 service
    • \n
    • api 数据接口
    • \n
    • initFetch 初始是否拉取
    • \n
    • schemaApi 配置接口,即由接口返回内容区的配置信息。\n正常期待返回是一个渲染器的配置如:

      \n
      {\n    \"type\": \"tpl\",\n    \"tpl\": \"这是内容。\"\n}\n
      \n

      但是,由于是在 form 里面,支持返回

      \n
      {\n    \"controls\": [\n        // 表单项配置\n    ]\n}\n
      \n
    • \n
    • initFetchSchema 是否初始拉取配置接口。

      \n
    • \n
    • name 取个名字方便别的组件与之交互。比如某个按钮的 target 设置成次 name, 则会触发重新拉取。
    • \n
    • body 内容容器,如果配置 schemaApi 则不需要配置,否则不配置的话,就没有内容展现。
    • \n
    \n
    \n", + "html": "

    Service(FormItem)

    目前看到的配置方式都是静态配置,如果你想动态配置,即配置项由接口决定,那么就使用此渲染器。

    \n
      \n
    • type 请设置成 service
    • \n
    • api 数据接口
    • \n
    • initFetch 初始是否拉取
    • \n
    • schemaApi 配置接口,即由接口返回内容区的配置信息。\n正常期待返回是一个渲染器的配置如:

      \n
      {\n    \"type\": \"tpl\",\n    \"tpl\": \"这是内容。\"\n}\n
      \n

      但是,由于是在 form 里面,支持返回

      \n
      {\n    \"controls\": [\n        // 表单项配置\n    ]\n}\n
      \n
    • \n
    • initFetchSchema 是否初始拉取配置接口。

      \n
    • \n
    • name 取个名字方便别的组件与之交互。比如某个按钮的 target 设置成次 name, 则会触发重新拉取。
    • \n
    • body 内容容器,如果配置 schemaApi 则不需要配置,否则不配置的话,就没有内容展现。
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Service.md', function(require, exports, module) { "label": "Service(FormItem)", "fragment": "service-formitem-", "fullPath": "#service-formitem-", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/SubForm.js b/gh-pages/docs/renderers/Form/SubForm.js index 40b4dbab..bafd3a0d 100644 --- a/gh-pages/docs/renderers/Form/SubForm.js +++ b/gh-pages/docs/renderers/Form/SubForm.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/SubForm.md', function(require, exports, module) { module.exports = { - "html": "

    SubForm

    formItem 还可以是子表单类型。

    \n
      \n
    • type 请设置成 form
    • \n
    • multiple 默认为 false 配置是否为多选模式
    • \n
    • labelField 当值中存在这个字段,则按钮名称将使用此字段的值来展示。
    • \n
    • btnLabel 按钮默认名称
    • \n
    • minLength 限制最小长度。
    • \n
    • maxLength 限制最大长度。
    • \n
    • addButtonClassName 新增按钮 CSS 类名 默认:btn-success btn-sm
    • \n
    • editButtonClassName 修改按钮 CSS 类名 默认:btn-info btn-addon btn-sm
    • \n
    • form 字表单的配置\ntitle 标题\ncontrols 请参考 Form 中的配置说明。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", + "html": "

    SubForm

    formItem 还可以是子表单类型。

    \n
      \n
    • type 请设置成 form
    • \n
    • multiple 默认为 false 配置是否为多选模式
    • \n
    • labelField 当值中存在这个字段,则按钮名称将使用此字段的值来展示。
    • \n
    • btnLabel 按钮默认名称
    • \n
    • minLength 限制最小长度。
    • \n
    • maxLength 限制最大长度。
    • \n
    • addButtonClassName 新增按钮 CSS 类名 默认:btn-success btn-sm
    • \n
    • editButtonClassName 修改按钮 CSS 类名 默认:btn-info btn-addon btn-sm
    • \n
    • form 字表单的配置\ntitle 标题\ncontrols 请参考 Form 中的配置说明。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/SubForm.md', function(require, exports, module) { "label": "SubForm", "fragment": "subform", "fullPath": "#subform", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Switch.js b/gh-pages/docs/renderers/Form/Switch.js index eaf9d85d..641c9121 100644 --- a/gh-pages/docs/renderers/Form/Switch.js +++ b/gh-pages/docs/renderers/Form/Switch.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Switch.md', function(require, exports, module) { module.exports = { - "html": "

    Switch

    可选框,和 checkbox 完全等价。

    \n
      \n
    • type 请设置成 switch
    • \n
    • option 选项说明
    • \n
    • trueValue 默认 true
    • \n
    • falseValue 默认 false
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", + "html": "

    Switch

    可选框,和 checkbox 完全等价。

    \n
      \n
    • type 请设置成 switch
    • \n
    • option 选项说明
    • \n
    • trueValue 默认 true
    • \n
    • falseValue 默认 false
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Switch.md', function(require, exports, module) { "label": "Switch", "fragment": "switch", "fullPath": "#switch", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Table.js b/gh-pages/docs/renderers/Form/Table.js index 01ffe396..379bd931 100644 --- a/gh-pages/docs/renderers/Form/Table.js +++ b/gh-pages/docs/renderers/Form/Table.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Table.md', function(require, exports, module) { module.exports = { - "html": "

    Table(FormItem)

    可以用来展现数据的,可以用来展示数组类型的数据,比如 multiple 的子 form

    \n
      \n
    • type 请设置成 table
    • \n
    • columns 数组类型,用来定义列信息。
    • \n
    \n
    \n

    当然也可以用来作为表单输入。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"table"指定为 Table 渲染器
    addablebooleanfalse是否可增加一行
    editablebooleanfalse是否可编辑
    removablebooleanfalse是否可删除
    showAddBtnbooleantrue是否显示添加按钮
    addApiapi-新增时提交的 API
    updateApiapi-修改时提交的 API
    deleteApiapi-删除时提交的 API
    addBtnLabelstring增加按钮名称
    addBtnIconstring"fa fa-plus"增加按钮图标
    updateBtnLabelstring""更新按钮名称
    updateBtnIconstring"fa fa-pencil"更新按钮图标
    deleteBtnLabelstring""删除按钮名称
    deleteBtnIconstring"fa fa-minus"删除按钮图标
    confirmBtnLabelstring""确认编辑按钮名称
    confirmBtnIconstring"fa fa-check"确认编辑按钮图标
    cancelBtnLabelstring""取消编辑按钮名称
    cancelBtnIconstring"fa fa-times"取消编辑按钮图标
    columnsarray[]列信息
    columns[x].quickEditboolean 或者 object-配合 editable 为 true 一起使用
    columns[x].quickEditOnUpdateboolean 或者 object-可以用来区分新建模式和更新模式的编辑配置
    \n\n
    \n", + "html": "

    Table(FormItem)

    可以用来展现数据的,可以用来展示数组类型的数据,比如 multiple 的子 form

    \n
      \n
    • type 请设置成 table
    • \n
    • columns 数组类型,用来定义列信息。
    • \n
    \n
    \n

    当然也可以用来作为表单输入。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"table"指定为 Table 渲染器
    addablebooleanfalse是否可增加一行
    editablebooleanfalse是否可编辑
    removablebooleanfalse是否可删除
    showAddBtnbooleantrue是否显示添加按钮
    addApiapi-新增时提交的 API
    updateApiapi-修改时提交的 API
    deleteApiapi-删除时提交的 API
    addBtnLabelstring增加按钮名称
    addBtnIconstring"fa fa-plus"增加按钮图标
    updateBtnLabelstring""更新按钮名称
    updateBtnIconstring"fa fa-pencil"更新按钮图标
    deleteBtnLabelstring""删除按钮名称
    deleteBtnIconstring"fa fa-minus"删除按钮图标
    confirmBtnLabelstring""确认编辑按钮名称
    confirmBtnIconstring"fa fa-check"确认编辑按钮图标
    cancelBtnLabelstring""取消编辑按钮名称
    cancelBtnIconstring"fa fa-times"取消编辑按钮图标
    columnsarray[]列信息
    columns[x].quickEditboolean 或者 object-配合 editable 为 true 一起使用
    columns[x].quickEditOnUpdateboolean 或者 object-可以用来区分新建模式和更新模式的编辑配置
    \n\n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Table.md', function(require, exports, module) { "label": "Table(FormItem)", "fragment": "table-formitem-", "fullPath": "#table-formitem-", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Tabs.js b/gh-pages/docs/renderers/Form/Tabs.js index 9a91abc8..5a9b16c1 100644 --- a/gh-pages/docs/renderers/Form/Tabs.js +++ b/gh-pages/docs/renderers/Form/Tabs.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Tabs.md', function(require, exports, module) { module.exports = { - "html": "

    Tabs(FormItem)

    多个输入框也可以通过选项卡来分组。

    \n
      \n
    • type 请设置成 tabs
    • \n
    • tabs 选项卡数组
    • \n
    • tabs[x].title 标题
    • \n
    • tabs[x].controls 表单项集合。
    • \n
    • tabs[x].body 内容容器,跟 controls 二选一。
    • \n
    • tabClassName 选项卡 CSS 类名。
    • \n
    \n
    \n", + "html": "

    Tabs(FormItem)

    多个输入框也可以通过选项卡来分组。

    \n
      \n
    • type 请设置成 tabs
    • \n
    • tabs 选项卡数组
    • \n
    • tabs[x].title 标题
    • \n
    • tabs[x].controls 表单项集合。
    • \n
    • tabs[x].body 内容容器,跟 controls 二选一。
    • \n
    • tabClassName 选项卡 CSS 类名。
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Tabs.md', function(require, exports, module) { "label": "Tabs(FormItem)", "fragment": "tabs-formitem-", "fullPath": "#tabs-formitem-", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Text.js b/gh-pages/docs/renderers/Form/Text.js index be4c287b..1e7d3779 100644 --- a/gh-pages/docs/renderers/Form/Text.js +++ b/gh-pages/docs/renderers/Form/Text.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Text.md', function(require, exports, module) { module.exports = { - "html": "

    Text

    普通的文本输入框。

    \n
      \n
    • type 请设置成 text
    • \n
    • addOn 输入框附加组件,比如附带一个提示文字,或者附带一个提交按钮。
    • \n
    • addOn.type 请选择 textbutton 或者 submit
    • \n
    • addOn.label 文字说明
    • \n
    • addOn.xxx 其他参数请参考按钮配置部分。
    • \n
    • clearable 在有值的时候是否显示一个删除图标在右侧。
    • \n
    • resetValue 默认为 "", 删除后设置此配置项给定的值。
    • \n
    • options 可选,选项配置,类型为数组,成员格式如下,配置后用户输入内容时会作为选项提示辅助输入。
        \n
      • label 文字
      • \n
      • value
      • \n
      \n
    • \n
    • source 通过 options 只能配置静态数据,如果设置了 source 则会从接口拉取,实现动态效果。
    • \n
    • autoComplete 跟 source 不同的是,每次用户输入都会去接口获取提示。
    • \n
    • multiple 默认为 false, 设置成 true 表示可多选。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n

    带提示功能

    \n
    \n", + "html": "

    Text

    普通的文本输入框。

    \n
      \n
    • type 请设置成 text
    • \n
    • addOn 输入框附加组件,比如附带一个提示文字,或者附带一个提交按钮。
    • \n
    • addOn.type 请选择 textbutton 或者 submit
    • \n
    • addOn.label 文字说明
    • \n
    • addOn.xxx 其他参数请参考按钮配置部分。
    • \n
    • clearable 在有值的时候是否显示一个删除图标在右侧。
    • \n
    • resetValue 默认为 "", 删除后设置此配置项给定的值。
    • \n
    • options 可选,选项配置,类型为数组,成员格式如下,配置后用户输入内容时会作为选项提示辅助输入。
        \n
      • label 文字
      • \n
      • value
      • \n
      \n
    • \n
    • source 通过 options 只能配置静态数据,如果设置了 source 则会从接口拉取,实现动态效果。
    • \n
    • autoComplete 跟 source 不同的是,每次用户输入都会去接口获取提示。
    • \n
    • multiple 默认为 false, 设置成 true 表示可多选。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n

    带提示功能

    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Text.md', function(require, exports, module) { "label": "Text", "fragment": "text", "fullPath": "#text", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Textarea.js b/gh-pages/docs/renderers/Form/Textarea.js index 5c96d77a..cc67ec39 100644 --- a/gh-pages/docs/renderers/Form/Textarea.js +++ b/gh-pages/docs/renderers/Form/Textarea.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Textarea.md', function(require, exports, module) { module.exports = { - "html": "

    Textarea

    多行文本输入框。

    \n
      \n
    • type 请设置成 textarea
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", + "html": "

    Textarea

    多行文本输入框。

    \n
      \n
    • type 请设置成 textarea
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Textarea.md', function(require, exports, module) { "label": "Textarea", "fragment": "textarea", "fullPath": "#textarea", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Time.js b/gh-pages/docs/renderers/Form/Time.js index affc885d..f625fa65 100644 --- a/gh-pages/docs/renderers/Form/Time.js +++ b/gh-pages/docs/renderers/Form/Time.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Time.md', function(require, exports, module) { module.exports = { - "html": "

    Time

    时间类型。

    \n
      \n
    • type 请设置成 time
    • \n
    • format 默认 X 即时间戳格式,用来提交的时间格式。更多格式类型请参考 moment.
    • \n
    • inputFormat 默认 HH:mm 用来配置显示的时间格式。
    • \n
    • placeholder 默认 请选择日期
    • \n
    • timeConstraints 请参考: react-datetime
    • \n
    • value 这里面 value 需要特殊说明一下,因为支持相对值。如:
        \n
      • -2mins 2 分钟前
      • \n
      • +2days 2 天后
      • \n
      • -10week 十周前
      • \n
      \n
    • \n
    • minTime 限制最小时间,可用 ${xxx} 取值,或者输入相对时间,或者时间戳。如:${start}+3days+3days+2hours或者 ${start|default:-2days}+3days
    • \n
    • maxTime 限制最大时间,可用 ${xxx} 取值,或者输入相对时间,或者时间戳。如:${start}+3days+3days+2hours或者 ${start|default:-2days}+3days

      \n

      可用单位: minhourdayweekmonthyear。所有单位支持复数形式。

      \n
    • \n
    • 更多配置请参考 FormItem

      \n
    • \n
    \n
    \n", + "html": "

    Time

    时间类型。

    \n
      \n
    • type 请设置成 time
    • \n
    • format 默认 X 即时间戳格式,用来提交的时间格式。更多格式类型请参考 moment.
    • \n
    • inputFormat 默认 HH:mm 用来配置显示的时间格式。
    • \n
    • placeholder 默认 请选择日期
    • \n
    • timeConstraints 请参考: react-datetime
    • \n
    • value 这里面 value 需要特殊说明一下,因为支持相对值。如:
        \n
      • -2mins 2 分钟前
      • \n
      • +2days 2 天后
      • \n
      • -10week 十周前
      • \n
      \n
    • \n
    • minTime 限制最小时间,可用 ${xxx} 取值,或者输入相对时间,或者时间戳。如:${start}+3days+3days+2hours或者 ${start|default:-2days}+3days
    • \n
    • maxTime 限制最大时间,可用 ${xxx} 取值,或者输入相对时间,或者时间戳。如:${start}+3days+3days+2hours或者 ${start|default:-2days}+3days

      \n

      可用单位: minhourdayweekmonthyear。所有单位支持复数形式。

      \n
    • \n
    • 更多配置请参考 FormItem

      \n
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Time.md', function(require, exports, module) { "label": "Time", "fragment": "time", "fullPath": "#time", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Tree.js b/gh-pages/docs/renderers/Form/Tree.js index 14803076..d9f63fe3 100644 --- a/gh-pages/docs/renderers/Form/Tree.js +++ b/gh-pages/docs/renderers/Form/Tree.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Tree.md', function(require, exports, module) { module.exports = { - "html": "

    Tree

    树形结构输入框。

    \n
      \n
    • type 请设置成 tree
    • \n
    • options 类似于 selectoptions, 并且支持通过 children 无限嵌套。
    • \n
    • source Api 地址,如果选项不固定,可以通过配置 source 动态拉取。
    • \n
    • hideRoot 默认是会显示一个顶级,如果不想显示,请设置 false
    • \n
    • rootLabel 默认为 顶级,当 hideRoot 不为 false 时有用,用来设置顶级节点的文字。
    • \n
    • showIcon 是否显示投标,默认为 true
    • \n
    • showRadio 是否显示单选按钮,multiple 为 false 是有效。
    • \n
    • cascade 设置成 true 时当选中父节点时不自动选择子节点。
    • \n
    • withChildren 是指成 true,选中父节点时,值里面将包含子节点的值,否则只会保留父节点的值。
    • \n
    • multiple 默认为 false, 设置成 true 表示可多选。
    • \n
    • joinValues 默认为 true
    • \n
    • 单选模式:当用户选中某个选项时,选项中的 value 将被作为该表单项的值提交,否则,整个选项对象都会作为该表单项的值提交。
    • \n
    • 多选模式:选中的多个选项的 value 会通过 delimiter 连接起来,否则直接将以数组的形式提交值。
    • \n
    • extractValue 默认为 false, joinValues设置为false时生效, 开启后将选中的选项 value 的值封装为数组,作为当前表单项的值。
    • \n
    • delimiter 默认为 ,
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", + "html": "

    Tree

    树形结构输入框。

    \n
      \n
    • type 请设置成 tree
    • \n
    • options 类似于 selectoptions, 并且支持通过 children 无限嵌套。
    • \n
    • source Api 地址,如果选项不固定,可以通过配置 source 动态拉取。
    • \n
    • hideRoot 默认是会显示一个顶级,如果不想显示,请设置 false
    • \n
    • rootLabel 默认为 顶级,当 hideRoot 不为 false 时有用,用来设置顶级节点的文字。
    • \n
    • showIcon 是否显示投标,默认为 true
    • \n
    • showRadio 是否显示单选按钮,multiple 为 false 是有效。
    • \n
    • cascade 设置成 true 时当选中父节点时不自动选择子节点。
    • \n
    • withChildren 是指成 true,选中父节点时,值里面将包含子节点的值,否则只会保留父节点的值。
    • \n
    • multiple 默认为 false, 设置成 true 表示可多选。
    • \n
    • joinValues 默认为 true
    • \n
    • 单选模式:当用户选中某个选项时,选项中的 value 将被作为该表单项的值提交,否则,整个选项对象都会作为该表单项的值提交。
    • \n
    • 多选模式:选中的多个选项的 value 会通过 delimiter 连接起来,否则直接将以数组的形式提交值。
    • \n
    • extractValue 默认为 false, joinValues设置为false时生效, 开启后将选中的选项 value 的值封装为数组,作为当前表单项的值。
    • \n
    • delimiter 默认为 ,
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Tree.md', function(require, exports, module) { "label": "Tree", "fragment": "tree", "fullPath": "#tree", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/TreeSelect.js b/gh-pages/docs/renderers/Form/TreeSelect.js index ce0e47df..46ab1358 100644 --- a/gh-pages/docs/renderers/Form/TreeSelect.js +++ b/gh-pages/docs/renderers/Form/TreeSelect.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/TreeSelect.md', function(require, exports, module) { module.exports = { - "html": "

    TreeSelect

    树形结构选择框。

    \n
      \n
    • type 请设置成 tree-select
    • \n
    • options 类似于 selectoptions, 并且支持通过 children 无限嵌套。
    • \n
    • source Api 地址,如果选项不固定,可以通过配置 source 动态拉取。
    • \n
    • hideRoot 默认是会显示一个顶级,如果不想显示,请设置 false
    • \n
    • rootLabel 默认为 顶级,当 hideRoot 不为 false 时有用,用来设置顶级节点的文字。
    • \n
    • showIcon 是否显示投标,默认为 true
    • \n
    • showRadio 是否显示单选按钮,multiple 为 false 是有效。
    • \n
    • cascade 设置成 true 时当选中父节点时不自动选择子节点。
    • \n
    • withChildren 是指成 true,选中父节点时,值里面将包含子节点的值,否则只会保留父节点的值。
    • \n
    • multiple 默认为 false, 设置成 true 表示可多选。
    • \n
    • joinValues 默认为 true
    • \n
    • 单选模式:当用户选中某个选项时,选项中的 value 将被作为该表单项的值提交,否则,整个选项对象都会作为该表单项的值提交。
    • \n
    • 多选模式:选中的多个选项的 value 会通过 delimiter 连接起来,否则直接将以数组的形式提交值。
    • \n
    • extractValue 默认为 false, joinValues设置为false时生效, 开启后将选中的选项 value 的值封装为数组,作为当前表单项的值。
    • \n
    • delimiter 默认为 ,
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", + "html": "

    TreeSelect

    树形结构选择框。

    \n
      \n
    • type 请设置成 tree-select
    • \n
    • options 类似于 selectoptions, 并且支持通过 children 无限嵌套。
    • \n
    • source Api 地址,如果选项不固定,可以通过配置 source 动态拉取。
    • \n
    • hideRoot 默认是会显示一个顶级,如果不想显示,请设置 false
    • \n
    • rootLabel 默认为 顶级,当 hideRoot 不为 false 时有用,用来设置顶级节点的文字。
    • \n
    • showIcon 是否显示投标,默认为 true
    • \n
    • showRadio 是否显示单选按钮,multiple 为 false 是有效。
    • \n
    • cascade 设置成 true 时当选中父节点时不自动选择子节点。
    • \n
    • withChildren 是指成 true,选中父节点时,值里面将包含子节点的值,否则只会保留父节点的值。
    • \n
    • multiple 默认为 false, 设置成 true 表示可多选。
    • \n
    • joinValues 默认为 true
    • \n
    • 单选模式:当用户选中某个选项时,选项中的 value 将被作为该表单项的值提交,否则,整个选项对象都会作为该表单项的值提交。
    • \n
    • 多选模式:选中的多个选项的 value 会通过 delimiter 连接起来,否则直接将以数组的形式提交值。
    • \n
    • extractValue 默认为 false, joinValues设置为false时生效, 开启后将选中的选项 value 的值封装为数组,作为当前表单项的值。
    • \n
    • delimiter 默认为 ,
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/TreeSelect.md', function(require, exports, module) { "label": "TreeSelect", "fragment": "treeselect", "fullPath": "#treeselect", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Form/Url.js b/gh-pages/docs/renderers/Form/Url.js index fd315b33..bfb8db23 100644 --- a/gh-pages/docs/renderers/Form/Url.js +++ b/gh-pages/docs/renderers/Form/Url.js @@ -1,7 +1,7 @@ define('docs/renderers/Form/Url.md', function(require, exports, module) { module.exports = { - "html": "

    Url

    URL 输入框。

    \n
      \n
    • type 请设置成 url
    • \n
    • addOn 输入框附加组件,比如附带一个提示文字,或者附带一个提交按钮。
    • \n
    • addOn.type 请选择 textbutton 或者 submit
    • \n
    • addOn.label 文字说明
    • \n
    • addOn.xxx 其他参数请参考按钮配置部分。
    • \n
    • clearable 在有值的时候是否显示一个删除图标在右侧。
    • \n
    • resetValue 默认为 "", 删除后设置此配置项给定的值。
    • \n
    • options 可选,选项配置,类型为数组,成员格式如下,配置后用户输入内容时会作为选项提示辅助输入。
        \n
      • label 文字
      • \n
      • value
      • \n
      \n
    • \n
    • source 通过 options 只能配置静态数据,如果设置了 source 则会从接口拉取,实现动态效果。
    • \n
    • autoComplete 跟 source 不同的是,每次用户输入都会去接口获取提示。
    • \n
    • multiple 默认为 false, 设置成 true 表示可多选。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", + "html": "

    Url

    URL 输入框。

    \n
      \n
    • type 请设置成 url
    • \n
    • addOn 输入框附加组件,比如附带一个提示文字,或者附带一个提交按钮。
    • \n
    • addOn.type 请选择 textbutton 或者 submit
    • \n
    • addOn.label 文字说明
    • \n
    • addOn.xxx 其他参数请参考按钮配置部分。
    • \n
    • clearable 在有值的时候是否显示一个删除图标在右侧。
    • \n
    • resetValue 默认为 "", 删除后设置此配置项给定的值。
    • \n
    • options 可选,选项配置,类型为数组,成员格式如下,配置后用户输入内容时会作为选项提示辅助输入。
        \n
      • label 文字
      • \n
      • value
      • \n
      \n
    • \n
    • source 通过 options 只能配置静态数据,如果设置了 source 则会从接口拉取,实现动态效果。
    • \n
    • autoComplete 跟 source 不同的是,每次用户输入都会去接口获取提示。
    • \n
    • multiple 默认为 false, 设置成 true 表示可多选。
    • \n
    • 更多配置请参考 FormItem
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Form/Url.md', function(require, exports, module) { "label": "Url", "fragment": "url", "fullPath": "#url", - "level": 3 + "level": 2 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Grid.js b/gh-pages/docs/renderers/Grid.js index a07e1474..c0253c58 100644 --- a/gh-pages/docs/renderers/Grid.js +++ b/gh-pages/docs/renderers/Grid.js @@ -1,7 +1,7 @@ define('docs/renderers/Grid.md', function(require, exports, module) { module.exports = { - "html": "

    Grid

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"grid"指定为 Grid 渲染器
    classNamestring外层 Dom 的类名
    columnsArray列集合
    columns[x]Container成员可以是其他渲染器
    columns[x].xsint宽度占比: 1 - 12
    columns[x].xsHiddenboolean是否隐藏
    columns[x].xsOffsetint偏移量 1 - 12
    columns[x].xsPullint靠左的距离占比:1 - 12
    columns[x].xsPushint靠右的距离占比: 1 - 12
    columns[x].smint宽度占比: 1 - 12
    columns[x].smHiddenboolean是否隐藏
    columns[x].smOffsetint偏移量 1 - 12
    columns[x].smPullint靠左的距离占比:1 - 12
    columns[x].smPushint靠右的距离占比: 1 - 12
    columns[x].mdint宽度占比: 1 - 12
    columns[x].mdHiddenboolean是否隐藏
    columns[x].mdOffsetint偏移量 1 - 12
    columns[x].mdPullint靠左的距离占比:1 - 12
    columns[x].mdPushint靠右的距离占比: 1 - 12
    columns[x].lgint宽度占比: 1 - 12
    columns[x].lgHiddenboolean是否隐藏
    columns[x].lgOffsetint偏移量 1 - 12
    columns[x].lgPullint靠左的距离占比:1 - 12
    columns[x].lgPushint靠右的距离占比: 1 - 12
    \n

    更多使用说明,请参看 Grid Props

    \n
    \n", + "html": "

    Grid

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"grid"指定为 Grid 渲染器
    classNamestring外层 Dom 的类名
    columnsArray列集合
    columns[x]Container成员可以是其他渲染器
    columns[x].xsint宽度占比: 1 - 12
    columns[x].xsHiddenboolean是否隐藏
    columns[x].xsOffsetint偏移量 1 - 12
    columns[x].xsPullint靠左的距离占比:1 - 12
    columns[x].xsPushint靠右的距离占比: 1 - 12
    columns[x].smint宽度占比: 1 - 12
    columns[x].smHiddenboolean是否隐藏
    columns[x].smOffsetint偏移量 1 - 12
    columns[x].smPullint靠左的距离占比:1 - 12
    columns[x].smPushint靠右的距离占比: 1 - 12
    columns[x].mdint宽度占比: 1 - 12
    columns[x].mdHiddenboolean是否隐藏
    columns[x].mdOffsetint偏移量 1 - 12
    columns[x].mdPullint靠左的距离占比:1 - 12
    columns[x].mdPushint靠右的距离占比: 1 - 12
    columns[x].lgint宽度占比: 1 - 12
    columns[x].lgHiddenboolean是否隐藏
    columns[x].lgOffsetint偏移量 1 - 12
    columns[x].lgPullint靠左的距离占比:1 - 12
    columns[x].lgPushint靠右的距离占比: 1 - 12
    \n

    更多使用说明,请参看 Grid Props

    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Grid.md', function(require, exports, module) { "label": "Grid", "fragment": "grid", "fullPath": "#grid", - "level": 2 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/HBox.js b/gh-pages/docs/renderers/HBox.js index 8040d12e..59c00e45 100644 --- a/gh-pages/docs/renderers/HBox.js +++ b/gh-pages/docs/renderers/HBox.js @@ -1,7 +1,7 @@ define('docs/renderers/HBox.md', function(require, exports, module) { module.exports = { - "html": "

    HBox

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"hbox"指定为 HBox 渲染器
    classNamestring外层 Dom 的类名
    columnsArray列集合
    columns[x]Container成员可以是其他渲染器
    columns[x].columnClassNamestring"wrapper-xs"列上类名
    \n
    \n", + "html": "

    HBox

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"hbox"指定为 HBox 渲染器
    classNamestring外层 Dom 的类名
    columnsArray列集合
    columns[x]Container成员可以是其他渲染器
    columns[x].columnClassNamestring"wrapper-xs"列上类名
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/HBox.md', function(require, exports, module) { "label": "HBox", "fragment": "hbox", "fullPath": "#hbox", - "level": 2 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Html.js b/gh-pages/docs/renderers/Html.js index a250708d..f48219a1 100644 --- a/gh-pages/docs/renderers/Html.js +++ b/gh-pages/docs/renderers/Html.js @@ -1,18 +1,11 @@ define('docs/renderers/Html.md', function(require, exports, module) { module.exports = { - "html": "

    Html

    html, 当需要用到变量时,请用 Tpl 代替。

    \n
    \n", + "html": "

    \b# Html

    \n

    html, 当需要用到变量时,请用 Tpl 代替。

    \n
    \n", "toc": { "label": "目录", "type": "toc", - "children": [ - { - "label": "Html", - "fragment": "html", - "fullPath": "#html", - "level": 3 - } - ], + "children": [], "level": 0 } }; diff --git a/gh-pages/docs/renderers/List.js b/gh-pages/docs/renderers/List.js index 2d510744..667505a1 100644 --- a/gh-pages/docs/renderers/List.js +++ b/gh-pages/docs/renderers/List.js @@ -1,7 +1,7 @@ define('docs/renderers/List.md', function(require, exports, module) { module.exports = { - "html": "

    List

    列表展示。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"list" 指定为列表展示。
    titlestring标题
    sourcestring${items}数据源, 绑定当前环境变量
    placeholderstring‘暂无数据’当没数据的时候的文字提示
    classNamestring外层 CSS 类名
    headerClassNamestringamis-list-header顶部外层 CSS 类名
    footerClassNamestringamis-list-footer底部外层 CSS 类名
    listItemArray配置单条信息
    listItem.titlestring标题,支持模板语法如: \\${xxx}
    listItem.titleClassNamestringh5标题 CSS 类名
    listItem.subTitlestring副标题,支持模板语法如: \\${xxx}
    listItem.avatarstring图片地址,支持模板语法如: \\${xxx}
    listItem.avatarClassNamestringthumb-sm avatar m-r图片 CSS 类名
    listItem.descstring描述,支持模板语法如: \\${xxx}
    listItem.bodyArray 或者 Field内容容器,主要用来放置 Field
    listItem.actionsArray Of Button按钮区域
    \n
    \n", + "html": "

    List

    列表展示。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"list" 指定为列表展示。
    titlestring标题
    sourcestring${items}数据源, 绑定当前环境变量
    placeholderstring‘暂无数据’当没数据的时候的文字提示
    classNamestring外层 CSS 类名
    headerClassNamestringamis-list-header顶部外层 CSS 类名
    footerClassNamestringamis-list-footer底部外层 CSS 类名
    listItemArray配置单条信息
    listItem.titlestring标题,支持模板语法如: \\${xxx}
    listItem.titleClassNamestringh5标题 CSS 类名
    listItem.subTitlestring副标题,支持模板语法如: \\${xxx}
    listItem.avatarstring图片地址,支持模板语法如: \\${xxx}
    listItem.avatarClassNamestringthumb-sm avatar m-r图片 CSS 类名
    listItem.descstring描述,支持模板语法如: \\${xxx}
    listItem.bodyArray 或者 Field内容容器,主要用来放置 Field
    listItem.actionsArray Of Button按钮区域
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/List.md', function(require, exports, module) { "label": "List", "fragment": "list", "fullPath": "#list", - "level": 2 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Nav.js b/gh-pages/docs/renderers/Nav.js index f5147635..7e4b852e 100644 --- a/gh-pages/docs/renderers/Nav.js +++ b/gh-pages/docs/renderers/Nav.js @@ -1,7 +1,7 @@ define('docs/renderers/Nav.md', function(require, exports, module) { module.exports = { - "html": "

    Nav

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"tabs"指定为 Nav 渲染器
    classNamestring外层 Dom 的类名
    stackedbooleantrue设置成 false 可以以 tabs 的形式展示
    linksArray链接集合
    links[x].labelstring名称
    links[x].tostring链接地址
    links[x].iconstring图标
    links[x].activeboolean是否高亮
    links[x].activeOn表达式是否高亮的条件,留空将自动分析链接地址
    \n

    链接集合。

    \n
    \n
    \n", + "html": "

    Nav

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"tabs"指定为 Nav 渲染器
    classNamestring外层 Dom 的类名
    stackedbooleantrue设置成 false 可以以 tabs 的形式展示
    linksArray链接集合
    links[x].labelstring名称
    links[x].tostring链接地址
    links[x].iconstring图标
    links[x].activeboolean是否高亮
    links[x].activeOn表达式是否高亮的条件,留空将自动分析链接地址
    \n

    链接集合。

    \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Nav.md', function(require, exports, module) { "label": "Nav", "fragment": "nav", "fullPath": "#nav", - "level": 2 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Page.js b/gh-pages/docs/renderers/Page.js index f9d4e5d6..5bf77f96 100644 --- a/gh-pages/docs/renderers/Page.js +++ b/gh-pages/docs/renderers/Page.js @@ -1,7 +1,7 @@ define('docs/renderers/Page.md', function(require, exports, module) { module.exports = { - "html": "

    Page

    Json 配置最外层是一个 Page 渲染器。他主要包含标题,副标题,提示信息等设置,需要注意的是,他有三个容器区域分别是:内容区、边栏区和工具条区,在容器里面放不同的渲染器,就能配置出不同的页面来。

    \n
    \n
    \n

    PS: 代码支持及时编辑预览

    \n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"page"指定为 Page 渲染器。
    titlestring页面标题
    subTitlestring页面副标题
    remarkstring标题附近会出现一个提示图标,鼠标放上去会提示该内容。
    asideContainer往页面的边栏区域加内容
    toolbarContainer往页面的右上角加内容,需要注意的是,当有 Title 是,区域在右上角,没有时区域就在顶部
    bodyContainer往页面的内容区域加内容
    classNamestring外层 dom 类名
    toolbarClassNamestringv-middle wrapper text-right bg-light b-bToolbar dom 类名
    bodyClassNamestringwrapperBody dom 类名
    asideClassNamestringw page-aside-region bg-autoAside dom 类名
    headerClassNamestringbg-light b-b wrapperHeader 区域 dom 类名
    initApiApiPage 用来获取初始数据的 api。返回的数据可以整个 page 级别使用。
    initFetchbooleantrue是否起始拉取 initApi
    initFetchOnstring是否起始拉取 initApi, 通过表达式配置
    intervalnumber3000刷新时间(最低 3000)
    silentPollingbooleanfalse配置刷新时是否显示加载动画
    stopAutoRefreshWhenstring""通过表达式来配置停止刷新的条件
    \n", + "html": "

    Page

    Json 配置最外层是一个 Page 渲染器。他主要包含标题,副标题,提示信息等设置,需要注意的是,他有三个容器区域分别是:内容区、边栏区和工具条区,在容器里面放不同的渲染器,就能配置出不同的页面来。

    \n
    \n
    \n

    PS: 代码支持及时编辑预览

    \n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"page"指定为 Page 渲染器。
    titlestring页面标题
    subTitlestring页面副标题
    remarkstring标题附近会出现一个提示图标,鼠标放上去会提示该内容。
    asideContainer往页面的边栏区域加内容
    toolbarContainer往页面的右上角加内容,需要注意的是,当有 Title 是,区域在右上角,没有时区域就在顶部
    bodyContainer往页面的内容区域加内容
    classNamestring外层 dom 类名
    toolbarClassNamestringv-middle wrapper text-right bg-light b-bToolbar dom 类名
    bodyClassNamestringwrapperBody dom 类名
    asideClassNamestringw page-aside-region bg-autoAside dom 类名
    headerClassNamestringbg-light b-b wrapperHeader 区域 dom 类名
    initApiApiPage 用来获取初始数据的 api。返回的数据可以整个 page 级别使用。
    initFetchbooleantrue是否起始拉取 initApi
    initFetchOnstring是否起始拉取 initApi, 通过表达式配置
    intervalnumber3000刷新时间(最低 3000)
    silentPollingbooleanfalse配置刷新时是否显示加载动画
    stopAutoRefreshWhenstring""通过表达式来配置停止刷新的条件
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Page.md', function(require, exports, module) { "label": "Page", "fragment": "page", "fullPath": "#page", - "level": 2 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Panel.js b/gh-pages/docs/renderers/Panel.js index 8cbbdeb4..600ed559 100644 --- a/gh-pages/docs/renderers/Panel.js +++ b/gh-pages/docs/renderers/Panel.js @@ -1,7 +1,7 @@ define('docs/renderers/Panel.md', function(require, exports, module) { module.exports = { - "html": "

    Panel

    可以把相关信息以盒子的形式展示到一块。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"panel"指定为 Panel 渲染器
    classNamestring"panel-default"外层 Dom 的类名
    headerClassNamestring"panel-heading"header 区域的类名
    footerClassNamestring"panel-footer bg-light lter wrapper"footer 区域的类名
    actionsClassNamestring"panel-footer"actions 区域的类名
    bodyClassNamestring"panel-body"body 区域的类名
    titlestring标题
    headerContainer顶部容器
    bodyContainer内容容器
    footerContainer底部容器
    affixFooterboolean是否固定底部容器
    actionsArray Of Button按钮区域
    \n
    \n", + "html": "

    Panel

    可以把相关信息以盒子的形式展示到一块。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"panel"指定为 Panel 渲染器
    classNamestring"panel-default"外层 Dom 的类名
    headerClassNamestring"panel-heading"header 区域的类名
    footerClassNamestring"panel-footer bg-light lter wrapper"footer 区域的类名
    actionsClassNamestring"panel-footer"actions 区域的类名
    bodyClassNamestring"panel-body"body 区域的类名
    titlestring标题
    headerContainer顶部容器
    bodyContainer内容容器
    footerContainer底部容器
    affixFooterboolean是否固定底部容器
    actionsArray Of Button按钮区域
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Panel.md', function(require, exports, module) { "label": "Panel", "fragment": "panel", "fullPath": "#panel", - "level": 3 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Plain.js b/gh-pages/docs/renderers/Plain.js index 6aef9c7c..68b78726 100644 --- a/gh-pages/docs/renderers/Plain.js +++ b/gh-pages/docs/renderers/Plain.js @@ -1,7 +1,7 @@ define('docs/renderers/Plain.md', function(require, exports, module) { module.exports = { - "html": "

    Plain

    plain, 单纯的文字输出来。

    \n
    \n", + "html": "

    Plain

    plain, 单纯的文字输出来。

    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Plain.md', function(require, exports, module) { "label": "Plain", "fragment": "plain", "fullPath": "#plain", - "level": 3 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/QRCode.js b/gh-pages/docs/renderers/QRCode.js index 36d2f04f..6faaeeac 100644 --- a/gh-pages/docs/renderers/QRCode.js +++ b/gh-pages/docs/renderers/QRCode.js @@ -1,7 +1,7 @@ define('docs/renderers/QRCode.md', function(require, exports, module) { module.exports = { - "html": "

    QRCode

    二维码显示组件

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"qr-code"指定为 QRCode 渲染器
    classNamestring外层 Dom 的类名
    codeSizenumber128二维码的宽高大小
    backgroundColorstring"#fff"二维码背景色
    foregroundColorstring"#000"二维码前景色
    levelstring"L"二维码复杂级别,有('L' 'M' 'Q' 'H')四种
    valuestring"https://www.baidu.com"扫描二维码后显示的文本,如果要显示某个页面请输入完整 url("http://...""https://..."开头),支持使用 ${xxx} 来获取变量
    \n
    \n", + "html": "

    QRCode

    二维码显示组件

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"qr-code"指定为 QRCode 渲染器
    classNamestring外层 Dom 的类名
    codeSizenumber128二维码的宽高大小
    backgroundColorstring"#fff"二维码背景色
    foregroundColorstring"#000"二维码前景色
    levelstring"L"二维码复杂级别,有('L' 'M' 'Q' 'H')四种
    valuestring"https://www.baidu.com"扫描二维码后显示的文本,如果要显示某个页面请输入完整 url("http://...""https://..."开头),支持使用 ${xxx} 来获取变量
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/QRCode.md', function(require, exports, module) { "label": "QRCode", "fragment": "qrcode", "fullPath": "#qrcode", - "level": 2 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Service.js b/gh-pages/docs/renderers/Service.js index 6ddcb891..9fd84df1 100644 --- a/gh-pages/docs/renderers/Service.js +++ b/gh-pages/docs/renderers/Service.js @@ -1,7 +1,7 @@ define('docs/renderers/Service.md', function(require, exports, module) { module.exports = { - "html": "

    Service

    功能型容器,自身不负责展示内容,主要职责在于通过配置的 api 拉取数据,数据可用于子组件。\n该组件初始化时就会自动拉取一次数据,后续如果需要刷新,请结合 Action 实现,可以把 Action 的 actionType 设置为 reload, target 为该组件的 name 值。\n同时该组件,还支持 api 数值自动监听,比如 getData?type=$type 只要当前环境 type 值发生变化,就会自动重新拉取。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"service"指定为 service 渲染器
    classNamestring外层 Dom 的类名
    bodyContainer内容容器
    apiapi数据源 API 地址
    initFetchboolean是否默认拉取
    schemaApiapi用来获取远程 Schema 的 api
    initFetchSchemaboolean是否默认拉取 Schema
    messagesObject消息提示覆写,默认消息读取的是 API 返回的消息,但是在此可以覆写它。
    messages.fetchSuccessstring获取成功时提示
    messages.fetchFailedstring"初始化失败"获取失败时提示
    intervalnumber3000刷新时间(最低 3000)
    silentPollingbooleanfalse配置刷新时是否显示加载动画
    stopAutoRefreshWhenstring""通过表达式来配置停止刷新的条件
    \n
    \n", + "html": "

    Service

    功能型容器,自身不负责展示内容,主要职责在于通过配置的 api 拉取数据,数据可用于子组件。\n该组件初始化时就会自动拉取一次数据,后续如果需要刷新,请结合 Action 实现,可以把 Action 的 actionType 设置为 reload, target 为该组件的 name 值。\n同时该组件,还支持 api 数值自动监听,比如 getData?type=$type 只要当前环境 type 值发生变化,就会自动重新拉取。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"service"指定为 service 渲染器
    classNamestring外层 Dom 的类名
    bodyContainer内容容器
    apiapi数据源 API 地址
    initFetchboolean是否默认拉取
    schemaApiapi用来获取远程 Schema 的 api
    initFetchSchemaboolean是否默认拉取 Schema
    messagesObject消息提示覆写,默认消息读取的是 API 返回的消息,但是在此可以覆写它。
    messages.fetchSuccessstring获取成功时提示
    messages.fetchFailedstring"初始化失败"获取失败时提示
    intervalnumber3000刷新时间(最低 3000)
    silentPollingbooleanfalse配置刷新时是否显示加载动画
    stopAutoRefreshWhenstring""通过表达式来配置停止刷新的条件
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Service.md', function(require, exports, module) { "label": "Service", "fragment": "service", "fullPath": "#service", - "level": 2 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Static.js b/gh-pages/docs/renderers/Static.js index ecc5a2a4..691ffcb9 100644 --- a/gh-pages/docs/renderers/Static.js +++ b/gh-pages/docs/renderers/Static.js @@ -1,7 +1,7 @@ define('docs/renderers/Static.md', function(require, exports, module) { module.exports = { - "html": "

    Static

    纯用来展现数据的。

    \n
      \n
    • type 请设置成 static
    • \n
    • name 变量名。
    • \n
    • value 值,可以通过它设置默认值。
    • \n
    • label 描述标题,当表单为水平布局时,左边即便是不设置 label 为了保持对齐也会留空,如果想要去掉空白,请设置成 false
    • \n
    • description 描述内容。
    • \n
    • placeholder 占位内容,默认 -
    • \n
    • inline 是否为 inline 模式。
    • \n
    • className 表单最外层类名。
    • \n
    • visible 是否可见。
    • \n
    • visibleOn 通过表达式来配置当前表单项是否显示。
    • \n
    • hidden 是否隐藏,不要跟 visible visibleOn 同时配置
    • \n
    • hiddenOn 通过表达式来配置当前表单项是否隐藏。
    • \n
    • inputClassName 表单控制器类名。
    • \n
    • labelClassName label 的类名。
    • \n
    • tpl 如果想一次展示多条数据,可以考虑用 tpl,模板引擎是 lodash template,同时你还可以简单用 $ 取值。 具体请查看 tpl
    • \n
    \n
    \n

    Static-XXX

      \n
    • type 请设置成 static-tplstatic-plainstatic-jsonstatic-datestatic-datetimestatic-timestatic-mappingstatic-imagestatic-progressstatic-status或者static-switch
    • \n
    \n

    纯用来展示数据的,用法跟 crud 里面的Column一样, 且支持 quickEdit 和 popOver 功能。

    \n
    \n", + "html": "

    Static

    纯用来展现数据的。

    \n
      \n
    • type 请设置成 static
    • \n
    • name 变量名。
    • \n
    • value 值,可以通过它设置默认值。
    • \n
    • label 描述标题,当表单为水平布局时,左边即便是不设置 label 为了保持对齐也会留空,如果想要去掉空白,请设置成 false
    • \n
    • description 描述内容。
    • \n
    • placeholder 占位内容,默认 -
    • \n
    • inline 是否为 inline 模式。
    • \n
    • className 表单最外层类名。
    • \n
    • visible 是否可见。
    • \n
    • visibleOn 通过表达式来配置当前表单项是否显示。
    • \n
    • hidden 是否隐藏,不要跟 visible visibleOn 同时配置
    • \n
    • hiddenOn 通过表达式来配置当前表单项是否隐藏。
    • \n
    • inputClassName 表单控制器类名。
    • \n
    • labelClassName label 的类名。
    • \n
    • tpl 如果想一次展示多条数据,可以考虑用 tpl,模板引擎是 lodash template,同时你还可以简单用 $ 取值。 具体请查看 tpl
    • \n
    \n
    \n

    Static-XXX

      \n
    • type 请设置成 static-tplstatic-plainstatic-jsonstatic-datestatic-datetimestatic-timestatic-mappingstatic-imagestatic-progressstatic-status或者static-switch
    • \n
    \n

    纯用来展示数据的,用法跟 crud 里面的Column一样, 且支持 quickEdit 和 popOver 功能。

    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,13 +10,15 @@ define('docs/renderers/Static.md', function(require, exports, module) { "label": "Static", "fragment": "static", "fullPath": "#static", - "level": 3 - }, - { - "label": "Static-XXX", - "fragment": "static-xxx", - "fullPath": "#static-xxx", - "level": 3 + "level": 2, + "children": [ + { + "label": "Static-XXX", + "fragment": "static-xxx", + "fullPath": "#static-xxx", + "level": 3 + } + ] } ], "level": 0 diff --git a/gh-pages/docs/renderers/Table.js b/gh-pages/docs/renderers/Table.js index 76240c4b..ce30c64f 100644 --- a/gh-pages/docs/renderers/Table.js +++ b/gh-pages/docs/renderers/Table.js @@ -1,7 +1,7 @@ define('docs/renderers/Table.md', function(require, exports, module) { module.exports = { - "html": "

    Table

    表格展示。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"table" 指定为 table 渲染器
    titlestring标题
    sourcestring${items}数据源, 绑定当前环境变量
    affixHeaderbooleantrue是否固定表头
    columnsTogglableauto 或者 booleanauto展示列显示开关, 自动即:列数量大于或等于 5 个时自动开启
    placeholderstring‘暂无数据’当没数据的时候的文字提示
    classNamestringpanel-default外层 CSS 类名
    tableClassNamestringtable-db table-striped表格 CSS 类名
    headerClassNamestringAction.md-table-header顶部外层 CSS 类名
    footerClassNamestringAction.md-table-footer底部外层 CSS 类名
    toolbarClassNamestringAction.md-table-toolbar工具栏 CSS 类名
    columnsArray of Column用来设置列信息
    \n
    \n", + "html": "

    Table

    表格展示。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"table" 指定为 table 渲染器
    titlestring标题
    sourcestring${items}数据源, 绑定当前环境变量
    affixHeaderbooleantrue是否固定表头
    columnsTogglableauto 或者 booleanauto展示列显示开关, 自动即:列数量大于或等于 5 个时自动开启
    placeholderstring‘暂无数据’当没数据的时候的文字提示
    classNamestringpanel-default外层 CSS 类名
    tableClassNamestringtable-db table-striped表格 CSS 类名
    headerClassNamestringAction.md-table-header顶部外层 CSS 类名
    footerClassNamestringAction.md-table-footer底部外层 CSS 类名
    toolbarClassNamestringAction.md-table-toolbar工具栏 CSS 类名
    columnsArray of Column用来设置列信息
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Table.md', function(require, exports, module) { "label": "Table", "fragment": "table", "fullPath": "#table", - "level": 3 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Tabs.js b/gh-pages/docs/renderers/Tabs.js index c8fd1f01..4c276bf4 100644 --- a/gh-pages/docs/renderers/Tabs.js +++ b/gh-pages/docs/renderers/Tabs.js @@ -1,7 +1,7 @@ define('docs/renderers/Tabs.md', function(require, exports, module) { module.exports = { - "html": "

    Tabs

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"tabs"指定为 Tabs 渲染器
    classNamestring外层 Dom 的类名
    tabsClassNamestringTabs Dom 的类名
    tabsArraytabs 内容
    tabs[x].titlestringTab 标题
    tabs[x].iconiconTab 的图标
    tabs[x].tabContainer内容区
    tabs[x].hashstring设置以后将跟 url 的 hash 对应
    tabs[x].reloadboolean设置以后内容每次都会重新渲染,对于 crud 的重新拉取很有用
    tabs[x].classNamestring"bg-white b-l b-r b-b wrapper-md"Tab 区域样式
    \n
    \n", + "html": "

    Tabs

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"tabs"指定为 Tabs 渲染器
    classNamestring外层 Dom 的类名
    tabsClassNamestringTabs Dom 的类名
    tabsArraytabs 内容
    tabs[x].titlestringTab 标题
    tabs[x].iconiconTab 的图标
    tabs[x].tabContainer内容区
    tabs[x].hashstring设置以后将跟 url 的 hash 对应
    tabs[x].reloadboolean设置以后内容每次都会重新渲染,对于 crud 的重新拉取很有用
    tabs[x].classNamestring"bg-white b-l b-r b-b wrapper-md"Tab 区域样式
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Tabs.md', function(require, exports, module) { "label": "Tabs", "fragment": "tabs", "fullPath": "#tabs", - "level": 2 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Tasks.js b/gh-pages/docs/renderers/Tasks.js index d213a9ac..6cd62f29 100644 --- a/gh-pages/docs/renderers/Tasks.js +++ b/gh-pages/docs/renderers/Tasks.js @@ -1,7 +1,7 @@ define('docs/renderers/Tasks.md', function(require, exports, module) { module.exports = { - "html": "

    Tasks

    任务操作集合,类似于 orp 上线。

    \n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"tasks"指定为 Tasks 渲染器
    classNamestring外层 Dom 的类名
    tableClassNamestringtable Dom 的类名
    itemsArray任务列表
    items[x].labelstring任务名称
    items[x].keystring任务键值,请唯一区分
    items[x].remarkstring当前任务状态,支持 html
    items[x].statusstring任务状态: 0: 初始状态,不可操作。1: 就绪,可操作状态。2: 进行中,还没有结束。3:有错误,不可重试。4: 已正常结束。5:有错误,且可以重试。
    checkApiapi返回任务列表,返回的数据请参考 items。
    submitApiapi提交任务使用的 API
    reSubmitApiapi如果任务失败,且可以重试,提交的时候会使用此 API
    intervalnumber3000当有任务进行中,会每隔一段时间再次检测,而时间间隔就是通过此项配置,默认 3s。
    taskNameLabelstring任务名称任务名称列说明
    operationLabelstring操作操作列说明
    statusLabelstring状态状态列说明
    remarkLabelstring备注备注列说明
    btnTextstring上线操作按钮文字
    retryBtnTextstring重试重试操作按钮文字
    btnClassNamestringbtn-sm btn-default配置容器按钮 className
    retryBtnClassNamestringbtn-sm btn-danger配置容器重试按钮 className
    statusLabelMaparray["label-warning", "label-info", "label-success", "label-danger", "label-default", "label-danger"]状态显示对应的类名配置
    statusTextMaparray["未开始", "就绪", "进行中", "出错", "已完成", "出错"]状态显示对应的文字显示配置
    \n
    \n", + "html": "

    Tasks

    任务操作集合,类似于 orp 上线。

    \n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"tasks"指定为 Tasks 渲染器
    classNamestring外层 Dom 的类名
    tableClassNamestringtable Dom 的类名
    itemsArray任务列表
    items[x].labelstring任务名称
    items[x].keystring任务键值,请唯一区分
    items[x].remarkstring当前任务状态,支持 html
    items[x].statusstring任务状态: 0: 初始状态,不可操作。1: 就绪,可操作状态。2: 进行中,还没有结束。3:有错误,不可重试。4: 已正常结束。5:有错误,且可以重试。
    checkApiapi返回任务列表,返回的数据请参考 items。
    submitApiapi提交任务使用的 API
    reSubmitApiapi如果任务失败,且可以重试,提交的时候会使用此 API
    intervalnumber3000当有任务进行中,会每隔一段时间再次检测,而时间间隔就是通过此项配置,默认 3s。
    taskNameLabelstring任务名称任务名称列说明
    operationLabelstring操作操作列说明
    statusLabelstring状态状态列说明
    remarkLabelstring备注备注列说明
    btnTextstring上线操作按钮文字
    retryBtnTextstring重试重试操作按钮文字
    btnClassNamestringbtn-sm btn-default配置容器按钮 className
    retryBtnClassNamestringbtn-sm btn-danger配置容器重试按钮 className
    statusLabelMaparray["label-warning", "label-info", "label-success", "label-danger", "label-default", "label-danger"]状态显示对应的类名配置
    statusTextMaparray["未开始", "就绪", "进行中", "出错", "已完成", "出错"]状态显示对应的文字显示配置
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Tasks.md', function(require, exports, module) { "label": "Tasks", "fragment": "tasks", "fullPath": "#tasks", - "level": 2 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Tpl.js b/gh-pages/docs/renderers/Tpl.js index 9000dc32..4c92e950 100644 --- a/gh-pages/docs/renderers/Tpl.js +++ b/gh-pages/docs/renderers/Tpl.js @@ -1,7 +1,7 @@ define('docs/renderers/Tpl.md', function(require, exports, module) { module.exports = { - "html": "

    Tpl

    tpl 类型的渲染器支持用 JS 模板引擎来组织输出,采用的 lodash 的 template,关于语法部分,请前往 lodash 文档页面。

    \n
    \n

    可用 js 方法。

    \n
      \n
    • formatDate(value, format='LLL', inputFormat='') 格式化时间格式,关于 format 请前往 moment 文档页面。
    • \n
    • formatTimeStamp(value, format='LLL') 格式化时间戳为字符串。
    • \n
    • formatNumber(number) 格式化数字格式,加上千分位。
    • \n
    • countDown(value) 倒计时,显示离指定时间还剩下多少天,只支持时间戳。
    • \n
    • 下面 filters 中的方法也可以使用如: <%= date(data.xxx, 'YYYY-MM-DD')%>
    • \n
    • 可以联系我们添加更多公用方法。
    • \n
    \n

    如:

    \n
    {\n    \"data\": {\n        \"user\": \"no one\"\n    },\n    \"body\": {\n        \"type\": \"tpl\",\n        \"tpl\": \"User: <%= formatDate(data.time, 'YYYY-MM-DD') %>\"\n    }\n}\n
    \n

    如果只想简单取下变量,可以用 $xxx 或者 ${xxx}。同时如果不指定类型,默认就是 tpl, 所以以上示例可以简化为。

    \n
    \n

    取值支持多级,如果层级比较深可以用 . 来分割如: ${xx.xxx.xx}\n另外 $& 表示直接获取当前的 data

    \n
    \n
    \n

    通过 $xxx 取到的值,默认是不做任何处理,如果希望把 html 转义了的,请使用:${xxx | html}

    \n

    从上面的语法可以看出来,取值时是支持指定 filter 的,那么有哪些 filter 呢?

    \n
      \n
    • html 转义 html 如:${xxx|html}
    • \n
    • json json stringify。
    • \n
    • raw 表示不转换, 原样输出。
    • \n
    • date 做日期转换如: ${xxx | date:YYYY-MM-DD}
    • \n
    • number 自动给数字加千分位。${xxx | number} 9999 => 9,999
    • \n
    • trim 把前后多余的空格去掉。
    • \n
    • percent 格式化成百分比。${xxx | percent} 0.8232343 => 82.32%
    • \n
    • round 四舍五入取整。
    • \n
    • truncate 切除, 当超出 200 个字符时,后面的部分直接显示 ...。 ${desc | truncate:500:...}
    • \n
    • url_encode 做 url encode 转换。
    • \n
    • url_decode 做 url decode 转换。
    • \n
    • default 当值为空时,显示其他值代替。 ${xxx | default:-} 当为空时显示 -
    • \n
    • join 当值是 array 时,可以把内容连起来。\\${xxx | join:,}
    • \n
    • first 获取数组的第一个成员。
    • \n
    • last 获取数组的最后一个成员。
    • \n
    • pick 如果是对象则从当前值中再次查找值如: ${xxx|pick:yyy} 等价于 ${xxx.yyy}。如果是数组,则做 map 操作,操作完后还是数组,不过成员已经变成了你选择的东西。
    • \n
    • ubb2html 我想你应该不需要,贴吧定制的 ubb 格式。
    • \n
    • html2ubb 我想你应该不需要,贴吧定制的 ubb 格式。
    • \n
    • split 可以将字符传通过分隔符分离成数组,默认分隔符为 , 如: ${ids|split|last} 即取一段用逗号分割的数值中的最后一个。
    • \n
    • nth 取数组中的第 n 个成员。如: ${ids|split|nth:1}
    • \n
    • str2date 请参考 date 中日期默认值的设置格式。
    • \n
    • duration 格式化成时间端如:2 -=> 2秒 67 => 1分7秒 1111111 => 13天21时39分31秒
    • \n
    • asArray 将数据包成数组如: a => [a]
    • \n
    • lowerCase 转小写
    • \n
    • upperCase 转大写
    • \n
    • base64Encode base64 转码
    • \n
    • base64Decode base64 解码
    • \n
    \n

    组合使用。

    \n
      \n
    • ${&|json|html} 把当前可用的数据全部打印出来。\\$& 取当前值,json 做 json stringify,然后 html 转义。
    • \n
    • ${rows:first|pick:id} 把 rows 中的第一条数据中的 id 取到。
    • \n
    • ${rows|pick:id|join:,}
    • \n
    \n", + "html": "

    Tpl

    tpl 类型的渲染器支持用 JS 模板引擎来组织输出,采用的 lodash 的 template,关于语法部分,请前往 lodash 文档页面。

    \n
    \n

    可用 js 方法。

    \n
      \n
    • formatDate(value, format='LLL', inputFormat='') 格式化时间格式,关于 format 请前往 moment 文档页面。
    • \n
    • formatTimeStamp(value, format='LLL') 格式化时间戳为字符串。
    • \n
    • formatNumber(number) 格式化数字格式,加上千分位。
    • \n
    • countDown(value) 倒计时,显示离指定时间还剩下多少天,只支持时间戳。
    • \n
    • 下面 filters 中的方法也可以使用如: <%= date(data.xxx, 'YYYY-MM-DD')%>
    • \n
    • 可以联系我们添加更多公用方法。
    • \n
    \n

    如:

    \n
    {\n    \"data\": {\n        \"user\": \"no one\"\n    },\n    \"body\": {\n        \"type\": \"tpl\",\n        \"tpl\": \"User: <%= formatDate(data.time, 'YYYY-MM-DD') %>\"\n    }\n}\n
    \n

    如果只想简单取下变量,可以用 $xxx 或者 ${xxx}。同时如果不指定类型,默认就是 tpl, 所以以上示例可以简化为。

    \n
    \n

    取值支持多级,如果层级比较深可以用 . 来分割如: ${xx.xxx.xx}\n另外 $& 表示直接获取当前的 data

    \n
    \n
    \n

    通过 $xxx 取到的值,默认是不做任何处理,如果希望把 html 转义了的,请使用:${xxx | html}

    \n

    从上面的语法可以看出来,取值时是支持指定 filter 的,那么有哪些 filter 呢?

    \n
      \n
    • html 转义 html 如:${xxx|html}
    • \n
    • json json stringify。
    • \n
    • raw 表示不转换, 原样输出。
    • \n
    • date 做日期转换如: ${xxx | date:YYYY-MM-DD}
    • \n
    • number 自动给数字加千分位。${xxx | number} 9999 => 9,999
    • \n
    • trim 把前后多余的空格去掉。
    • \n
    • percent 格式化成百分比。${xxx | percent} 0.8232343 => 82.32%
    • \n
    • round 四舍五入取整。
    • \n
    • truncate 切除, 当超出 200 个字符时,后面的部分直接显示 ...。 ${desc | truncate:500:...}
    • \n
    • url_encode 做 url encode 转换。
    • \n
    • url_decode 做 url decode 转换。
    • \n
    • default 当值为空时,显示其他值代替。 ${xxx | default:-} 当为空时显示 -
    • \n
    • join 当值是 array 时,可以把内容连起来。\\${xxx | join:,}
    • \n
    • first 获取数组的第一个成员。
    • \n
    • last 获取数组的最后一个成员。
    • \n
    • pick 如果是对象则从当前值中再次查找值如: ${xxx|pick:yyy} 等价于 ${xxx.yyy}。如果是数组,则做 map 操作,操作完后还是数组,不过成员已经变成了你选择的东西。
    • \n
    • ubb2html 我想你应该不需要,贴吧定制的 ubb 格式。
    • \n
    • html2ubb 我想你应该不需要,贴吧定制的 ubb 格式。
    • \n
    • split 可以将字符传通过分隔符分离成数组,默认分隔符为 , 如: ${ids|split|last} 即取一段用逗号分割的数值中的最后一个。
    • \n
    • nth 取数组中的第 n 个成员。如: ${ids|split|nth:1}
    • \n
    • str2date 请参考 date 中日期默认值的设置格式。
    • \n
    • duration 格式化成时间端如:2 -=> 2秒 67 => 1分7秒 1111111 => 13天21时39分31秒
    • \n
    • asArray 将数据包成数组如: a => [a]
    • \n
    • lowerCase 转小写
    • \n
    • upperCase 转大写
    • \n
    • base64Encode base64 转码
    • \n
    • base64Decode base64 解码
    • \n
    \n

    组合使用。

    \n
      \n
    • ${&|json|html} 把当前可用的数据全部打印出来。\\$& 取当前值,json 做 json stringify,然后 html 转义。
    • \n
    • ${rows:first|pick:id} 把 rows 中的第一条数据中的 id 取到。
    • \n
    • ${rows|pick:id|join:,}
    • \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Tpl.md', function(require, exports, module) { "label": "Tpl", "fragment": "tpl", "fullPath": "#tpl", - "level": 3 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Types.js b/gh-pages/docs/renderers/Types.js index 88e21cdb..8221eecf 100644 --- a/gh-pages/docs/renderers/Types.js +++ b/gh-pages/docs/renderers/Types.js @@ -1,7 +1,7 @@ define('docs/renderers/Types.md', function(require, exports, module) { module.exports = { - "html": "

    类型说明

    Container

    Container 不是一个特定的渲染器,而是 amis 中一个特殊类型,它是以下类型的任何一种。

    \n
      \n
    • String 字符串,可以包含 html 片段。
    • \n
    • Object 指定一个渲染器如: {"type": "button", "label": "按钮"}
    • \n
    • Array 还可以是一个数组,数组的成员可以就是一个 Container.
    • \n
    \n

    示例:

    \n
    {\n    \"container\": \"普通一段字符串\"\n}\n
    \n
    {\n    \"container\": {\n        \"type\": \"button\",\n        \"label\": \"按钮\"\n    }\n}\n
    \n
    {\n    \"container\": [\n        \"普通一段字符串\",\n\n        {\n            \"type\": \"button\",\n            \"label\": \"按钮\"\n        },\n\n        [\"普通一段字符串\", \"普通一段字符串\"]\n    ]\n}\n
    \n

    API

    Api 类型可以是字符串或者对象。API 中可以直接设置数据发送结构,注意看示例。

    \n
      \n
    • String [<type>:]<url>

      \n
        \n
      • <type> 可以是: getpostputdelete或者raw
      • \n
      • <url> 即 api 地址,支持通过 $key 取变量。
      • \n
      \n

      如:

      \n
        * `get:http://imis.tieba.baidu.com/yule/list?start=$startTime&end=$endTime`\n  * `get:http://imis.tieba.baidu.com/yule/list?$$` 拿所有可用数据。\n  * `get:http://imis.tieba.baidu.com/yule/list?data=$$` 拿所有可用数据。\n
    • \n
    • Object

      \n
        \n
      • url api 地址
      • \n
      • method 可以是:getpostput或者delete
      • \n
      • data 数据体
      • \n
      • headers 头部,配置方式和 data 配置一样,下面不详讲。如果要使用,请前往群组系统配置中,添加允许。
      • \n
      \n

      如:

      \n

      取某个变量。

      \n
      {\n    \"url\": \"http://imis.tieba.baidu.com/yule/list\",\n    \"method\": \"post\",\n    \"data\": {\n        \"start\": \"$startTime\"\n    }\n}\n
      \n

      直接将所有可用数据映射给 all 变量。

      \n
      {\n    \"url\": \"http://imis.tieba.baidu.com/yule/list\",\n    \"method\": \"post\",\n    \"data\": {\n        \"all\": \"$$\"\n    }\n}\n
      \n

      正常如果指定了 data,则只会发送 data 指定的数据了,如果想要保留原有数据,只定制修改一部分。

      \n
      {\n    \"url\": \"http://imis.tieba.baidu.com/yule/list\",\n    \"method\": \"post\",\n    \"data\": {\n        \"&\": \"$$\", // 原来的数据先 copy 过来。\n        \"a\": \"123\",\n        \"b\": \"${b}\"\n    }\n}\n
      \n

      如果目标变量是数组,而发送的数据,有不希望把成员全部发送过去,可以这样配置。

      \n
      {\n    \"url\": \"http://imis.tieba.baidu.com/yule/list\",\n    \"method\": \"post\",\n    \"data\": {\n        \"all\": {\n            \"$rows\": {\n                \"a\": \"$a\",\n                \"b\": \"$b\"\n            }\n        }\n    }\n}\n
      \n

      如果 \\$rows 的结构为 [{a: 1, b: 2, c: 3, d: 4}, {a: 1, b: 2, c: 3, d: 4}], 经过上述映射后,实际发送的数据为 {all: [{a: 1, b:2}, {a: 1, b: 2}]}

      \n
    • \n
    \n

    注意

    \n

    amis 所有值为 url 的如: "http://www.baidu.com" 都会被替换成 proxy 代理,如果不希望这么做,请明确指示如: "raw:http://www.baidu.com"。还有为了安全,amis 默认只能转发公司内部 API 接口,如果您的接口在外网环境,也请明确指示如:"external:http://www.baidu.com"

    \n

    表达式

    配置项中,所有 boolean 类型的配置,都可以用 JS 表达式来配置。所有boolean 配置项,后面加个 On 则是表达式配置方式,可以用 js 语法来根据当前模型中的数据来决定是否启用。\n如:FormItem 中的 disabledOnhiddenOnvisibleOnCRUD 中的 itemDraggableOn 等等。

    \n
    \n

    为了能加入权限控制,表达是中允许可以用 acl.can 方法来检测当前用户是否拥有某个权限。\n如: {"disabledOn": "!can('some-resource')"}。权限能力部分,请前往能力管理,\n权限配置请前往权限配置管理。

    \n", + "html": "

    类型说明

    Container

    Container 不是一个特定的渲染器,而是 amis 中一个特殊类型,它是以下类型的任何一种。

    \n
      \n
    • String 字符串,可以包含 html 片段。
    • \n
    • Object 指定一个渲染器如: {"type": "button", "label": "按钮"}
    • \n
    • Array 还可以是一个数组,数组的成员可以就是一个 Container.
    • \n
    \n

    示例:

    \n
    {\n    \"container\": \"普通一段字符串\"\n}\n
    \n
    {\n    \"container\": {\n        \"type\": \"button\",\n        \"label\": \"按钮\"\n    }\n}\n
    \n
    {\n    \"container\": [\n        \"普通一段字符串\",\n\n        {\n            \"type\": \"button\",\n            \"label\": \"按钮\"\n        },\n\n        [\"普通一段字符串\", \"普通一段字符串\"]\n    ]\n}\n
    \n

    API

    Api 类型可以是字符串或者对象。API 中可以直接设置数据发送结构,注意看示例。

    \n
      \n
    • String [<type>:]<url>

      \n
        \n
      • <type> 可以是: getpostputdelete或者raw
      • \n
      • <url> 即 api 地址,支持通过 $key 取变量。
      • \n
      \n

      如:

      \n
        * `get:http://imis.tieba.baidu.com/yule/list?start=$startTime&end=$endTime`\n  * `get:http://imis.tieba.baidu.com/yule/list?$$` 拿所有可用数据。\n  * `get:http://imis.tieba.baidu.com/yule/list?data=$$` 拿所有可用数据。\n
    • \n
    • Object

      \n
        \n
      • url api 地址
      • \n
      • method 可以是:getpostput或者delete
      • \n
      • data 数据体
      • \n
      • headers 头部,配置方式和 data 配置一样,下面不详讲。如果要使用,请前往群组系统配置中,添加允许。
      • \n
      \n

      如:

      \n

      取某个变量。

      \n
      {\n    \"url\": \"http://imis.tieba.baidu.com/yule/list\",\n    \"method\": \"post\",\n    \"data\": {\n        \"start\": \"$startTime\"\n    }\n}\n
      \n

      直接将所有可用数据映射给 all 变量。

      \n
      {\n    \"url\": \"http://imis.tieba.baidu.com/yule/list\",\n    \"method\": \"post\",\n    \"data\": {\n        \"all\": \"$$\"\n    }\n}\n
      \n

      正常如果指定了 data,则只会发送 data 指定的数据了,如果想要保留原有数据,只定制修改一部分。

      \n
      {\n    \"url\": \"http://imis.tieba.baidu.com/yule/list\",\n    \"method\": \"post\",\n    \"data\": {\n        \"&\": \"$$\", // 原来的数据先 copy 过来。\n        \"a\": \"123\",\n        \"b\": \"${b}\"\n    }\n}\n
      \n

      如果目标变量是数组,而发送的数据,有不希望把成员全部发送过去,可以这样配置。

      \n
      {\n    \"url\": \"http://imis.tieba.baidu.com/yule/list\",\n    \"method\": \"post\",\n    \"data\": {\n        \"all\": {\n            \"$rows\": {\n                \"a\": \"$a\",\n                \"b\": \"$b\"\n            }\n        }\n    }\n}\n
      \n

      如果 \\$rows 的结构为 [{a: 1, b: 2, c: 3, d: 4}, {a: 1, b: 2, c: 3, d: 4}], 经过上述映射后,实际发送的数据为 {all: [{a: 1, b:2}, {a: 1, b: 2}]}

      \n
    • \n
    \n

    注意

    \n

    amis 所有值为 url 的如: "http://www.baidu.com" 都会被替换成 proxy 代理,如果不希望这么做,请明确指示如: "raw:http://www.baidu.com"。还有为了安全,amis 默认只能转发公司内部 API 接口,如果您的接口在外网环境,也请明确指示如:"external:http://www.baidu.com"

    \n

    表达式

    配置项中,所有 boolean 类型的配置,都可以用 JS 表达式来配置。所有boolean 配置项,后面加个 On 则是表达式配置方式,可以用 js 语法来根据当前模型中的数据来决定是否启用。\n如:FormItem 中的 disabledOnhiddenOnvisibleOnCRUD 中的 itemDraggableOn 等等。

    \n
    \n

    为了能加入权限控制,表达是中允许可以用 acl.can 方法来检测当前用户是否拥有某个权限。\n如: {"disabledOn": "!can('some-resource')"}。权限能力部分,请前往能力管理,\n权限配置请前往权限配置管理。

    \n", "toc": { "label": "目录", "type": "toc", @@ -10,25 +10,25 @@ define('docs/renderers/Types.md', function(require, exports, module) { "label": "类型说明", "fragment": "%E7%B1%BB%E5%9E%8B%E8%AF%B4%E6%98%8E", "fullPath": "#%E7%B1%BB%E5%9E%8B%E8%AF%B4%E6%98%8E", - "level": 2, + "level": 1, "children": [ { "label": "Container", "fragment": "container", "fullPath": "#container", - "level": 3 + "level": 2 }, { "label": "API", "fragment": "api", "fullPath": "#api", - "level": 3 + "level": 2 }, { "label": "表达式", "fragment": "%E8%A1%A8%E8%BE%BE%E5%BC%8F", "fullPath": "#%E8%A1%A8%E8%BE%BE%E5%BC%8F", - "level": 3 + "level": 2 } ] } diff --git a/gh-pages/docs/renderers/Video.js b/gh-pages/docs/renderers/Video.js index baa7f7ae..468820ca 100644 --- a/gh-pages/docs/renderers/Video.js +++ b/gh-pages/docs/renderers/Video.js @@ -1,7 +1,7 @@ define('docs/renderers/Video.md', function(require, exports, module) { module.exports = { - "html": "

    Video

    视频播放器。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"video"指定为 video 渲染器
    classNamestring外层 Dom 的类名
    srcstring视频地址
    posterstring视频封面地址
    mutedboolean是否静音
    autoPlayboolean是否自动播放
    ratesarray倍数,格式为[1.0, 1.5, 2.0]
    \n
    \n", + "html": "

    Video

    视频播放器。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"video"指定为 video 渲染器
    classNamestring外层 Dom 的类名
    srcstring视频地址
    posterstring视频封面地址
    mutedboolean是否静音
    autoPlayboolean是否自动播放
    ratesarray倍数,格式为[1.0, 1.5, 2.0]
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Video.md', function(require, exports, module) { "label": "Video", "fragment": "video", "fullPath": "#video", - "level": 3 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Wizard.js b/gh-pages/docs/renderers/Wizard.js index 3d4df888..d28c01f5 100644 --- a/gh-pages/docs/renderers/Wizard.js +++ b/gh-pages/docs/renderers/Wizard.js @@ -1,7 +1,7 @@ define('docs/renderers/Wizard.md', function(require, exports, module) { module.exports = { - "html": "

    Wizard

    表单向导,能够配置多个步骤引导用户一步一步完成表单提交。

    \n
      \n
    • type 请设置 wizard
    • \n
    • mode 展示模式,请选择:horizontal 或者 vertical,默认为 horizontal
    • \n
    • api 最后一步保存的接口。
    • \n
    • initApi 初始化数据接口。
    • \n
    • initFetch 初始是否拉取数据。
    • \n
    • initFetchOn 初始是否拉取数据,通过表达式来配置。
    • \n
    • actionPrevLabel 上一步按钮名称,默认:上一步
    • \n
    • actionNextLabel 下一步按钮名称下一步
    • \n
    • actionNextSaveLabel 保存并下一步按钮名称,默认:保存并下一步
    • \n
    • actionFinishLabel 完成按钮名称,默认:完成
    • \n
    • className 外层 CSS 类名。
    • \n
    • actionClassName 按钮 CSS 类名,默认:btn-sm btn-default
    • \n
    • reload 操作完后刷新目标对象。请填写目标组件设置的 name 值,如果填写为 window 则让当前页面整体刷新。
    • \n
    • redirect 操作完后跳转。
    • \n
    • target 可以把数据提交给别的组件而不是自己保存。请填写目标组件设置的 name 值,如果填写为 window 则把数据同步到地址栏上,同时依赖这些数据的组件会自动重新刷新。
    • \n
    • steps 数组,配置步骤信息。
    • \n
    • steps[x].title 步骤标题。
    • \n
    • steps[x].mode 展示默认,跟 Form 中的模式一样,选择: normalhorizontal或者inline
    • \n
    • steps[x].horizontal 当为水平模式时,用来控制左右占比。
    • \n
    • steps[x].horizontal.label 左边 label 的宽度占比。
    • \n
    • steps[x].horizontal.right 右边控制器的宽度占比。
    • \n
    • steps[x].horizontal.offset 当没有设置 label 时,右边控制器的偏移量。
    • \n
    • steps[x].api 当前步骤保存接口,可以不配置。
    • \n
    • steps[x].initApi 当前步骤数据初始化接口。
    • \n
    • steps[x].initFetch 当前步骤数据初始化接口是否初始拉取。
    • \n
    • steps[x].initFetchOn 当前步骤数据初始化接口是否初始拉取,用表达式来决定。
    • \n
    • steps[x].controls 当前步骤的表单项集合,请参考 FormItem
    • \n
    \n
    \n", + "html": "

    Wizard

    表单向导,能够配置多个步骤引导用户一步一步完成表单提交。

    \n
      \n
    • type 请设置 wizard
    • \n
    • mode 展示模式,请选择:horizontal 或者 vertical,默认为 horizontal
    • \n
    • api 最后一步保存的接口。
    • \n
    • initApi 初始化数据接口。
    • \n
    • initFetch 初始是否拉取数据。
    • \n
    • initFetchOn 初始是否拉取数据,通过表达式来配置。
    • \n
    • actionPrevLabel 上一步按钮名称,默认:上一步
    • \n
    • actionNextLabel 下一步按钮名称下一步
    • \n
    • actionNextSaveLabel 保存并下一步按钮名称,默认:保存并下一步
    • \n
    • actionFinishLabel 完成按钮名称,默认:完成
    • \n
    • className 外层 CSS 类名。
    • \n
    • actionClassName 按钮 CSS 类名,默认:btn-sm btn-default
    • \n
    • reload 操作完后刷新目标对象。请填写目标组件设置的 name 值,如果填写为 window 则让当前页面整体刷新。
    • \n
    • redirect 操作完后跳转。
    • \n
    • target 可以把数据提交给别的组件而不是自己保存。请填写目标组件设置的 name 值,如果填写为 window 则把数据同步到地址栏上,同时依赖这些数据的组件会自动重新刷新。
    • \n
    • steps 数组,配置步骤信息。
    • \n
    • steps[x].title 步骤标题。
    • \n
    • steps[x].mode 展示默认,跟 Form 中的模式一样,选择: normalhorizontal或者inline
    • \n
    • steps[x].horizontal 当为水平模式时,用来控制左右占比。
    • \n
    • steps[x].horizontal.label 左边 label 的宽度占比。
    • \n
    • steps[x].horizontal.right 右边控制器的宽度占比。
    • \n
    • steps[x].horizontal.offset 当没有设置 label 时,右边控制器的偏移量。
    • \n
    • steps[x].api 当前步骤保存接口,可以不配置。
    • \n
    • steps[x].initApi 当前步骤数据初始化接口。
    • \n
    • steps[x].initFetch 当前步骤数据初始化接口是否初始拉取。
    • \n
    • steps[x].initFetchOn 当前步骤数据初始化接口是否初始拉取,用表达式来决定。
    • \n
    • steps[x].controls 当前步骤的表单项集合,请参考 FormItem
    • \n
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Wizard.md', function(require, exports, module) { "label": "Wizard", "fragment": "wizard", "fullPath": "#wizard", - "level": 3 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/Wrapper.js b/gh-pages/docs/renderers/Wrapper.js index 3094e9c3..b4466bd7 100644 --- a/gh-pages/docs/renderers/Wrapper.js +++ b/gh-pages/docs/renderers/Wrapper.js @@ -1,7 +1,7 @@ define('docs/renderers/Wrapper.md', function(require, exports, module) { module.exports = { - "html": "

    Wrapper

    简单的一个容器。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"wrapper"指定为 Wrapper 渲染器
    classNamestring外层 Dom 的类名
    sizestring支持: xssmmdlg
    bodyContainer内容容器
    \n
    \n", + "html": "

    Wrapper

    简单的一个容器。

    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    属性名类型默认值说明
    typestring"wrapper"指定为 Wrapper 渲染器
    classNamestring外层 Dom 的类名
    sizestring支持: xssmmdlg
    bodyContainer内容容器
    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/Wrapper.md', function(require, exports, module) { "label": "Wrapper", "fragment": "wrapper", "fullPath": "#wrapper", - "level": 3 + "level": 1 } ], "level": 0 diff --git a/gh-pages/docs/renderers/iFrame.js b/gh-pages/docs/renderers/iFrame.js index 64502b56..b0694a7a 100644 --- a/gh-pages/docs/renderers/iFrame.js +++ b/gh-pages/docs/renderers/iFrame.js @@ -1,7 +1,7 @@ define('docs/renderers/iFrame.md', function(require, exports, module) { module.exports = { - "html": "

    iFrame

    如果需要内嵌外部站点,可用 iframe 来实现。

    \n
    \n", + "html": "

    iFrame

    如果需要内嵌外部站点,可用 iframe 来实现。

    \n
    \n", "toc": { "label": "目录", "type": "toc", @@ -10,7 +10,7 @@ define('docs/renderers/iFrame.md', function(require, exports, module) { "label": "iFrame", "fragment": "iframe", "fullPath": "#iframe", - "level": 2 + "level": 1 } ], "level": 0 diff --git a/gh-pages/index.html b/gh-pages/index.html index dae272bb..0af333a9 100644 --- a/gh-pages/index.html +++ b/gh-pages/index.html @@ -9,6 +9,8 @@ + @@ -24,9 +26,10 @@
    - + +