From 84b5c48991726afb8e23614f579a276cde027fa0 Mon Sep 17 00:00:00 2001 From: RickCole21 Date: Mon, 24 Aug 2020 14:27:13 +0800 Subject: [PATCH] doc --- docs/components/crud.md | 2 ++ docs/index.md | 28 ++++++++++++++-------------- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/docs/components/crud.md b/docs/components/crud.md index b3014ea9..0149f116 100755 --- a/docs/components/crud.md +++ b/docs/components/crud.md @@ -1074,6 +1074,8 @@ crud 组件支持通过配置`headerToolbar`和`footerToolbar`属性，实现在 在`headerToolbar`或者`footerToolbar`数组中添加`bulkActions`字符串，并且在 crud 上配置`bulkActions`行为按钮数组，可以实现选中表格项并批量操作的功能。 +> 需要设置`primaryField`用于标识选中状态，配置当前行数据中的某一**唯一标识字段**，例如`id`，否则可能会出现无法选中的问题 + ```schema:height="600" scope="body" { "type": "crud", diff --git a/docs/index.md b/docs/index.md index d7633120..342bbae2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,9 +14,9 @@ amis 是一个低代码前端框架，它使用 JSON 配置来生成页面，可 ## 为什么要做 amis？🤔 -在经历了十几年的发展后，前端开发变得越来越复杂，门槛也越来越高，要使用当下流行的 UI 组件库，你必须懂 npm、webpack、react/vue，必须熟悉 ES 6 语法，最好还了解状态管理（比如 Redux），如果没接触过函数式编程，一开始入门就很困难，而它还有巨大的 [生态](https://github.com/markerikson/redux-ecosystem-links)，相关的库有 2347 个。 +在经历了十几年的发展后，前端开发变得越来越复杂，门槛也越来越高，要使用当下流行的 UI 组件库，你必须懂 `npm`、`webpack`、`react/vue`，必须熟悉 `ES6` 语法，最好还了解状态管理（比如 `Redux`），如果没接触过函数式编程，一开始入门就很困难，而它还有巨大的 [生态](https://github.com/markerikson/redux-ecosystem-links)，相关的库有 **2347** 个。 -然而前端技术的发展不会停滞，等学完这些后可能会发现大家都用 Hooks 了、某个打包工具取代 Webpack 了。。。 +然而前端技术的发展不会停滞，等学完这些后可能会发现大家都用 `Hooks` 了、某个打包工具取代 `Webpack` 了。。。 而有时候你只是为了做个普通的增删改查界面，用于系统管理，类似下面这种： @@ -167,20 +167,21 @@ amis 是一个低代码前端框架，它使用 JSON 配置来生成页面，可 } ``` -这个界面虽然用 Bootstrap 也能快速搭起来，但要想体验好就需要加很多细节功能，比如： +这个界面虽然用 `Bootstrap` 也能快速搭起来，但要想体验好就需要加很多细节功能，比如： - 数据动态加载 - 编辑单行数据 -- 批量删除和修改 +- 批量修改和删除 - 查询某列 - 按某列排序 - 隐藏某列 - 开启整页内容拖拽排序 -- 表格有分页（页数还会同步到地址栏，刷新页面试试） +- 表格有分页（页数还会同步到地址栏） - 如果往下拖动还有首行冻结来方便查看表头等 - 全部实现这些需要大量的代码。 -然而上面也看到了，在 amis 里只需要 150 行 JSON 配置（嘿，其中 40 多行只有一个括号），你不需要了解 React/Vue、Webpack，甚至不需要了解 JavaScript，即便没学过 amis 也能猜到大部分配置的作用，只需要简单配置就能完成所有页面开发 +全部实现这些需要大量的代码。 + +然而上面也看到了，在 amis 里只需要 **150** 行 JSON 配置（嘿，其中 40 多行只有一个括号），你不需要了解 `React/Vue`、`Webpack`，甚至不需要很了解 `JavaScript`，即便没学过 amis 也能猜到大部分配置的作用，只需要简单配置就能完成所有页面开发 这正是建立 amis 的初衷，我们认为：**对于大部分常用页面，应该使用最简单的方法来实现**，而不是越来越复杂。 @@ -194,23 +195,22 @@ amis 是一个低代码前端框架，它使用 JSON 配置来生成页面，可 > JSON 是一种轻量级的数据交换格式，简洁和清晰的层次结构使得它成为理想的数据交换语言。它易于人阅读和编写，同时也易于机器解析和生成，能够有效地提升网络传输效率。 > -> 更多关于 JSON 的知识，可以阅读[百度百科](https://baike.baidu.com/item/JSON) +> 更多关于 JSON 的知识，可以阅读 [百度百科](https://baike.baidu.com/item/JSON) ## amis 的其它亮点 ✨ - **提供完整的界面解决方案**：其它 UI 框架必须使用 JavaScript 来组装业务逻辑，而 amis 只需 JSON 配置就能完成完整功能开发，包括数据获取、表单提交及验证等功能； - **内置 100+ 种 UI 组件**：包括其它 UI 框架都会不提供的富文本编辑器、代码编辑器等，能满足各种页面组件展现的需求，而且对于特殊的展现形式还可以通过 [自定义组件](./start/custom.md) 来扩充； - **容器支持无限级嵌套**：可以通过组合来满足各种布局需求； -- **经历了长时间的实战考验**：amis 在百度内部得到了广泛使用，在 4 年多的时间里创建了 **3w** 多页面，从内容审核到机器管理，从数据分析到模型训练，amis 满足了各种各样的页面需求。 +- **经历了长时间的实战考验**：amis 在百度内部得到了广泛使用，**在 4 年多的时间里创建了 3 万+ 页面**，从内容审核到机器管理，从数据分析到模型训练，amis 满足了各种各样的页面需求。 ## amis 不适合做什么？😶 使用 JSON 有优点但也有明显缺点，在以下场合并不适合 amis： -- 大量定制 UI，尤其是面向普通客户（toC）的产品页面 - - JSON 配置使得 amis 更适合做有大量常见 UI 组件的页面，但对于面向普通客户的页面，往往追求个性化的视觉效果，这种情况下用 amis 就不合适，实际上绝大部分前端 UI 组件库也都不适合，只能定制开发。 -- 有极为复杂的交互，或者对交互有很特殊的要求 - - 有些复杂的前端功能，比如可视化编辑器，其中有大量定制的拖拽操作，这种需要依赖原生 DOM 实现的功能无法使用 amis。 +- **大量定制 UI**：JSON 配置使得 amis 更适合做有大量常见 UI 组件的页面，但对于面向普通客户（toC）的页面，往往追求个性化的视觉效果，这种情况下用 amis 就不合适，实际上绝大部分前端 UI 组件库也都不适合，只能定制开发。 +- **极为复杂或特殊的交互**： + - 有些复杂的前端功能，比如 可视化编辑器，其中有大量定制的拖拽操作，这种需要依赖原生 DOM 实现的功能无法使用 amis。 - 但对于某些交互固定的领域，比如图连线，amis 后续会有专门的组件来实现。 ## 阅读建议 👆 @@ -220,4 +220,4 @@ amis 是一个低代码前端框架，它使用 JSON 配置来生成页面，可 ## 让我们马上开始吧！ -点击页面底部的下一篇，继续后续部分的阅读。 +点击页面底部的下一篇，继续阅读文档。