feat: 文档优化

This commit is contained in:
wuduoyi 2020-12-22 15:31:57 +08:00
parent 0f76b48f3a
commit ac11695469
2 changed files with 16 additions and 10 deletions

View File

@ -92,6 +92,7 @@ amis 是一个低代码前端框架,它使用 JSON 配置来生成页面,可
"size": "sm",
"api": "https://houtai.baidu.com/api/sample/reset"
},
"export-excel",
{
"type": "tpl",
"tpl": "一共有 ${count} 行数据。",
@ -121,7 +122,7 @@ amis 是一个低代码前端框架,它使用 JSON 配置来生成页面,可
},
{
"name": "engine",
"label": "Rendering engine",
"label": "渲染引擎",
"sortable": true,
"searchable": true,
"type": "text",
@ -129,7 +130,7 @@ amis 是一个低代码前端框架,它使用 JSON 配置来生成页面,可
},
{
"name": "platform",
"label": "Platform(s)",
"label": "平台",
"popOver": {
"body": {
"type": "tpl",
@ -141,7 +142,7 @@ amis 是一个低代码前端框架,它使用 JSON 配置来生成页面,可
},
{
"name": "grade",
"label": "CSS grade",
"label": "CSS 等级",
"quickEdit": {
"mode": "inline",
"type": "select",
@ -169,21 +170,26 @@ amis 是一个低代码前端框架,它使用 JSON 配置来生成页面,可
}
```
这个界面虽然用 `Bootstrap` 也能快速搭起来,但要想体验好就需要加很多细节功能,比如:
这个界面虽然用 `Bootstrap` 及各种前端 UI 库也能做出个大概,但仔细观察会发现它有大量细节功能,比如:
- 数据动态加载
- 可以对数据做筛选
- 有按钮可以刷新数据
- 编辑单行数据
- 批量修改和删除
- 查询某列
- 按某列排序
- 隐藏某列
- 开启整页内容拖拽排序
- 表格有分页(页数还会同步到地址栏)
- 如果往下拖动还有首行冻结来方便查看表头等
- 表格有分页(页数还能同步到地址栏,不过这个例子中关了)
- 有数据汇总
- 支持导出 Excel
- 「渲染引擎」那列的表头有提示文字
- 鼠标移动到「平台」那列的内容时还有放大镜符号,可以展开查看更多
- 如果往下拖动还有首行冻结来方便查看表头(因为文档页面的限制,这个功能在这里看不出来)
全部实现这些需要大量的代码。
但可以看到,用 amis 只需要 **150** 行 JSON 配置(嘿,其中 40 多行只有一个括号),你不需要了解 `React/Vue`、`Webpack`,甚至不需要很了解 `JavaScript`,即便没学过 amis 也能猜到大部分配置的作用,只需要简单配置就能完成所有页面开发。
但可以看到,用 amis 只需要 **157** 行 JSON 配置(其中 47 行只有一个括号),你不需要了解 `React/Vue`、`Webpack`,甚至不需要很了解 `JavaScript`,即便没学过 amis 也能猜到大部分配置的作用,只需要简单配置就能完成所有页面开发。
这正是建立 amis 的初衷,我们认为:**对于大部分常用页面,应该使用最简单的方法来实现**,甚至不需要学习各种框架和工具。

View File

@ -71,7 +71,6 @@ const LazyComponent = lazyData(
title: '全局',
controls: [Global]
}
// TODO: grid, radar, dataZoom, visualMap, axisPointer, brush, geo, parallel, parallelAxis, singleAxis, timeline, graphic, calendar, dataset, aria,
]
}
])
@ -82,7 +81,8 @@ const LazyComponent = lazyData(
);
export default {
title: 'ECharts 编辑器',
title:
'ECharts 图表可视化编辑,用于演示如何基于 amis 将任意 json 配置改造成可视化编辑',
data: {
config: example
},