From a93603b49fb3d70bd279d885a0b87c4f4ce9f2f8 Mon Sep 17 00:00:00 2001 From: wuduoyi Date: Fri, 17 Jul 2020 11:47:05 +0800 Subject: [PATCH] =?UTF-8?q?=E5=A2=9E=E5=8A=A0=20JSON=20=E6=B8=B2=E6=9F=93?= =?UTF-8?q?=E5=99=A8=E7=9A=84=E8=AF=B4=E6=98=8E=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/renderers.md | 135 +++++++++++++++++++++-------------------- docs/renderers/JSON.md | 24 ++++++++ 2 files changed, 92 insertions(+), 67 deletions(-) create mode 100644 docs/renderers/JSON.md diff --git a/docs/renderers.md b/docs/renderers.md index 55079272..e558adcd 100644 --- a/docs/renderers.md +++ b/docs/renderers.md @@ -6,95 +6,96 @@ amis 页面是由一个个渲染模型组成的，并且支持无限层级嵌套 开始之前，请您一定要先阅读[基本用法](./basic.md)。 -- [Definitions](./renderers/Definitions.md): 建立当前页面公共的配置项 -- [Tpl](./renderers/Tpl.md): 支持用 JS 模板引擎来组织输出 - [Page](./renderers/Page.md): JSON 配置最外层的 Page 渲染器 - [Form](./renderers/Form/Form.md): 表单渲染器 - - [FormItem](./renderers/Form/FormItem.md): Form 中主要是由各种 FormItem 组成 - - [List](./renderers/Form/List.md): 简单的列表选择框 + - [FormItem](./renderers/Form/FormItem.md): 所有表单项都有的通用配置 + - [Array](./renderers/Form/Array.md): 数组输入框配置 - [Button-Group](./renderers/Form/Button-Group.md): 按钮集合 - - [Service](./renderers/Form/Service.md): 动态配置，配置项由接口决定 - - [Tabs](./renderers/Form/Tabs.md): 多个输入框通过选项卡来分组 - - [Table](./renderers/Form/Table.md): 可以用来展示数组类型的数据 - - [HBox](./renderers/Form/HBox.md): 支持 form 内部再用 HBox 布局 - - [Grid](./renderers/Form/Grid.md): 支持 form 内部再用 grid 布局 - - [Panel](./renderers/Form/Panel.md): 还是为了布局，可以把一部分 FormItem 合并到一个 panel 里面单独展示 - - [Hidden](./renderers/Form/Hidden.md): 隐藏字段类型 - - [Text](./renderers/Form/Text.md): 普通的文本输入框 - - [Textarea](./renderers/Form/Textarea.md): 多行文本输入框 - - [Url](./renderers/Form/Url.md): URL 输入框 - - [Email](./renderers/Form/Email.md): Email 输入框 - - [Password](./renderers/Form/Password.md): 密码输入框 - - [Number](./renderers/Form/Number.md): 数字输入框 - - [Tag](./renderers/Form/Tag.md): 标签输入框 - - [Select](./renderers/Form/Select.md): 选项表单 + - [Button-Toolbar](./renderers/Form/Button-Toolbar.md): 让多个按钮在一起放置 + - [Button](./renderers/Form/Button.md): 按钮, 包含 button、submit 和 reset - [Chained-Select](./renderers/Form/Chained-Select.md): 无限级别下拉 - [Checkbox](./renderers/Form/Checkbox.md): 勾选框 - [Checkboxes](./renderers/Form/Checkboxes.md): 复选框 - - [Radios](./renderers/Form/Radios.md): 单选框 - [City](./renderers/Form/City.md): 城市选择 - - [Rating](./renderers/Form/Rating.md): 评分 - - [Switch](./renderers/Form/Switch.md): 可选框，和 checkbox 完全等价 + - [Color](./renderers/Form/Color.md): 颜色选择器 + - [Combo](./renderers/Form/Combo.md): 组合模式 + - [Date-Range](./renderers/Form/Date-Range.md): 日期范围类型 - [Date](./renderers/Form/Date.md): 日期类型 - [Datetime](./renderers/Form/Datetime.md): 日期时间类型 - - [Time](./renderers/Form/Time.md): 时间类型 - - [Date-Range](./renderers/Form/Date-Range.md): 日期范围类型 - - [Transfer](./renderers/Form/Transfer.md): 穿梭器，用来勾选选项。 - - [TabsTransfer](./renderers/Form/TabsTransfer.md): 组合穿梭器，用来勾选选项。 - - [Color](./renderers/Form/Color.md): 颜色选择器 - - [Range](./renderers/Form/Range.md): 范围输入框 - - [Image](./renderers/Form/Image.md): 图片输入 - - [File](./renderers/Form/File.md): 文件输入 - - [Matrix](./renderers/Form/Matrix.md): 矩阵类型的输入框 - - [Tree](./renderers/Form/Tree.md): 树形结构输入框 - - [TreeSelect](./renderers/Form/TreeSelect.md): 树形结构选择框 - - [NestedSelect](./renderers/Form/NestedSelect.md): 树形结构选择框 - - [Button](./renderers/Form/Button.md): 按钮, 包含 button、submit 和 reset - - [Button-Toolbar](./renderers/Form/Button-Toolbar.md): 让多个按钮在一起放置 - - [Combo](./renderers/Form/Combo.md): 组合模式 - - [Array](./renderers/Form/Array.md): 数组输入框配置 - - [SubForm](./renderers/Form/SubForm.md): formItem 还可以是子表单类型 - - [Picker](./renderers/Form/Picker.md): 列表选取 - - [Formula](./renderers/Form/Formula.md): 公式类型 - - [Group](./renderers/Form/Group.md): 表单项集合 + - [Editor](./renderers/Form/Editor.md): 编辑器 + - [Email](./renderers/Form/Email.md): Email 输入框 - [FieldSet](./renderers/Form/FieldSet.md): 多个输入框可以通过 fieldSet 捆绑在一起 + - [File](./renderers/Form/File.md): 文件输入 + - [Formula](./renderers/Form/Formula.md): 公式类型 + - [Grid](./renderers/Form/Grid.md): 支持 form 内部再用 grid 布局 + - [Group](./renderers/Form/Group.md): 表单项集合 + - [HBox](./renderers/Form/HBox.md): 支持 form 内部再用 HBox 布局 + - [Hidden](./renderers/Form/Hidden.md): 隐藏字段类型 + - [Image](./renderers/Form/Image.md): 图片输入 + - [List](./renderers/Form/List.md): 简单的列表选择框 + - [Matrix](./renderers/Form/Matrix.md): 矩阵类型的输入框 + - [NestedSelect](./renderers/Form/NestedSelect.md): 树形结构选择框 + - [Number](./renderers/Form/Number.md): 数字输入框 + - [Panel](./renderers/Form/Panel.md): 还是为了布局，可以把一部分 FormItem 合并到一个 panel 里面单独展示 + - [Password](./renderers/Form/Password.md): 密码输入框 + - [Picker](./renderers/Form/Picker.md): 列表选取 + - [Radios](./renderers/Form/Radios.md): 单选框 + - [Range](./renderers/Form/Range.md): 范围输入框 + - [Rating](./renderers/Form/Rating.md): 评分 - [Repeat](./renderers/Form/Repeat.md): 可用来设置重复频率 - [Rich-Text](./renderers/Form/Rich-Text.md): 富文本编辑器 - - [Editor](./renderers/Form/Editor.md): 编辑器 + - [Select](./renderers/Form/Select.md): 选项表单 + - [Service](./renderers/Form/Service.md): 动态配置，配置项由接口决定 - [Static](./renderers/Static.md): 纯用来展现数据的 -- [Wizard](./renderers/Wizard.md): 表单向导 -- [Each](./renderers/Each.md): 基于现有变量循环输出渲染器 -- [Plain](./renderers/Plain.md): 单纯的文字输出 -- [Html](./renderers/Html.md): html, 当需要用到变量时，请用 Tpl 代替 + - [SubForm](./renderers/Form/SubForm.md): formItem 还可以是子表单类型 + - [Switch](./renderers/Form/Switch.md): 可选框，和 checkbox 完全等价 + - [Table](./renderers/Form/Table.md): 可以用来展示数组类型的数据 + - [Tabs](./renderers/Form/Tabs.md): 多个输入框通过选项卡来分组 + - [TabsTransfer](./renderers/Form/TabsTransfer.md): 组合穿梭器，用来勾选选项。 + - [Tag](./renderers/Form/Tag.md): 标签输入框 + - [Text](./renderers/Form/Text.md): 普通的文本输入框 + - [Textarea](./renderers/Form/Textarea.md): 多行文本输入框 + - [Time](./renderers/Form/Time.md): 时间类型 + - [Transfer](./renderers/Form/Transfer.md): 穿梭器，用来勾选选项。 + - [Tree](./renderers/Form/Tree.md): 树形结构输入框 + - [TreeSelect](./renderers/Form/TreeSelect.md): 树形结构选择框 + - [Url](./renderers/Form/Url.md): URL 输入框 - [Action](./renderers/Action.md): 一种特殊的渲染器，它本身是一个按钮，同时它能触发事件 -- [Dialog](./renderers/Dialog.md): Dialog 由 Action 触发。他是一个类似于 Page 的容器模型 -- [Drawer](./renderers/Drawer.md): Drawer 由 Action 触发 -- [Divider](./renderers/Divider.md): 分割线 +- [Alert](./renderers/Alert.md): 提示框 +- [Audio](./renderers/Audio.md): 音频播放器 +- [Button-Group](./renderers/Button-Group.md)： 按钮集合 +- [Card](./renderers/Card.md): 卡片的展示形式 +- [Cards](./renderers/Cards.md): 卡片集合 +- [Carousel](./renderers/Carousel.md): 轮播图 +- [Chart](./renderers/Chart.md): Echarts 图表渲染器 +- [Collapse](./renderers/Collapse.md): 折叠器 - [CRUD](./renderers/CRUD.md): 增删改查模型，主要用来展现列表 - [CRUD-Table](./renderers/CRUD-Table.md): 请参考 Table - [CRUD-Cards](./renderers/CRUD-Cards.md): 请参考 Cards - [CRUD-List](./renderers/CRUD-List.md): 请参考 List -- [Panel](./renderers/Panel.md): 可以把相关信息以盒子的形式展示到一块。 -- [Wrapper](./renderers/Wrapper.md): 简单的一个容器。 -- [Service](./renderers/Service.md): 功能型容器，自身不负责展示内容，主要职责在于通过配置的 api 拉取数据 -- [Chart](./renderers/Chart.md): 图表渲染器 -- [Collapse](./renderers/Collapse.md): 折叠器 -- [Carousel](./renderers/Carousel.md): 轮播图 -- [Alert](./renderers/Alert.md): 提示框 -- [Audio](./renderers/Audio.md): 音频播放器 -- [Video](./renderers/Video.md): 视频播放器 -- [Table](./renderers/Table.md): 表格展示 - - [Column](./renderers/Column.md): 表格中的列配置 -- [List](./renderers/List.md): 列表展示 -- [Card](./renderers/Card.md): 卡片的展示形式 -- [Cards](./renderers/Cards.md): 卡片集合 +- [Definitions](./renderers/Definitions.md): 建立当前页面公共的配置项 +- [Dialog](./renderers/Dialog.md): Dialog 由 Action 触发。他是一个类似于 Page 的容器模型 +- [Divider](./renderers/Divider.md): 分割线 +- [Drawer](./renderers/Drawer.md): Drawer 由 Action 触发 +- [Each](./renderers/Each.md): 基于现有变量循环输出渲染器 - [Field](./renderers/Field.md): 主要用在 Table 的列配置 Column、List 的内容、Card 卡片的内容和表单的 Static-XXX 中 -- [Tabs](./renderers/Tabs.md): 标签页 - [Grid](./renderers/Grid.md): Grid 布局 - [HBox](./renderers/HBox.md): HBox 布局 -- [Button-Group](./renderers/Button-Group.md)： 按钮集合 +- [Html](./renderers/Html.md): html, 当需要用到变量时，请用 Tpl 代替 - [iFrame](./renderers/iFrame.md)： 如果需要内嵌外部站点，可用 iframe 来实现 +- [JSON](./renderers/JSON.md): JSON 数据展现 +- [List](./renderers/List.md): 列表展示 - [Nav](./renderers/Nav.md): 菜单栏 -- [Tasks](./renderers/Tasks.md): 任务操作集合，适用于一步步操作 +- [Panel](./renderers/Panel.md): 可以把相关信息以盒子的形式展示到一块。 +- [Plain](./renderers/Plain.md): 单纯的文字输出 - [QRCode](./renderers/QRCode.md): 二维码显示组件 +- [Service](./renderers/Service.md): 功能型容器，自身不负责展示内容，主要职责在于通过配置的 api 拉取数据 +- [Table](./renderers/Table.md): 表格展示 + - [Column](./renderers/Column.md): 表格中的列配置 +- [Tabs](./renderers/Tabs.md): 标签页 +- [Tasks](./renderers/Tasks.md): 任务操作集合，适用于一步步操作 +- [Tpl](./renderers/Tpl.md): 支持用 JS 模板引擎来组织输出 - [Types](./renderers/Types.md): 类型说明文档 +- [Video](./renderers/Video.md): 视频播放器 +- [Wizard](./renderers/Wizard.md): 表单向导 +- [Wrapper](./renderers/Wrapper.md): 简单的一个容器 diff --git a/docs/renderers/JSON.md b/docs/renderers/JSON.md new file mode 100644 index 00000000..e3552c1a --- /dev/null +++ b/docs/renderers/JSON.md @@ -0,0 +1,24 @@ +## JSON + +可以用来显示深层嵌套的 JSON 内容。 + +| 属性名 | 类型 | 默认值 | 说明 | +| ----------- | -------- | ------------ | ---------------------------------------------- | +| type | `string` | `"json"` | 指定为 JSON 渲染器 | +| name | `string` | | 用于 CRUD 或 Form 中，通过这个 name 来获取数值 | +| jsonTheme | `string` | `"twilight"` | 颜色主题，还有一个是 `"eighties"` | +| levelExpand | `number` | 1 | 默认展开的层级 | + +```schema:height="150" scope="body" +{ + "type": "json", + "levelExpand": 2, + "value": { + "name": "amis", + "source": { + "github": "https://github.com/baidu/amis" + } + } +} + +```