| 1 | # Kero
|
| 2 |
|
| 3 |
|
| 4 |
|
| 5 | ## 1、介绍
|
| 6 |
|
| 7 | Kero 做为 `MVVM` 架构中 `Model` 层的增强，主要功能有：
|
| 8 |
|
| 9 | * 以行、列的形式对数据做存储，并对外暴露一批增删改查的API，方便开发者对页面数据的处理，而且所有开发者之间做到统一，减少出错概率。
|
| 10 |
|
| 11 | * 数据增加状态标识新增或修改，方便开发者使用。
|
| 12 |
|
| 13 | * 具有分页缓存能力，可在前台处理分页(非必要情况下，不推荐前台分页)。
|
| 14 |
|
| 15 | * 具有事件触发器，把数据变化触发出去，供开发者监听使用。
|
| 16 |
|
| 17 | ## 2、快速上手
|
| 18 | [控件使用说明](https://github.com/iuap-design/grid/blob/master/docs/grid.md)
|
| 19 |
|
| 20 | ## 3、开发说明
|
| 21 |
|
| 22 | ### 目录说明
|
| 23 |
|
| 24 | ```
|
| 25 | ├─css 控件css
|
| 26 | ├─dist 产出后的资源
|
| 27 | ├─docs 文档相关
|
| 28 | ├─examples 示例文件
|
| 29 | ├─datatable 关联datatable示例
|
| 30 | ├─ui 单独控件示例
|
| 31 | ├─snippets 文档及代码片段
|
| 32 | ├─docs 文档片段
|
| 33 | │ ├─grid.md 文档片段:replaceui将替换为ui示例，replacedatatable将替换为datatable示例。
|
| 34 | └─examples 示例片段
|
| 35 | └─grid 与grid.md对应的目录,示例目录下必须存在widget.css,widget.html,widget.js,说明.txt
|
| 36 | └─datatable 关联datatable示例片段
|
| 37 | └─ui 单独控件示例片段
|
| 38 | ├─vendor 第三方库，后续删除
|
| 39 | ├─app.js 依据snippets中的片段生成docs以及examples中的最终产出
|
| 40 | ├─gulpfile.js 通过gulp对项目源文件（CSS/JS）生成dist中的最终产出
|
| 41 | ├─package.json node说明
|
| 42 | └─README.md 项目说明
|
| 43 | ```
|
| 44 | ####snippets详细说明：
|
| 45 |
|
| 46 | docs目录与examples目录结构需要对应：docs下md文件在examples对应目录下存在同样名称的文件夹，并且此文件夹下面包含datatable以及ui文件夹用于存放对应示例片段
|
| 47 |
|
| 48 | 示例1：
|
| 49 |
|
| 50 | docs/grid.md
|
| 51 |
|
| 52 | examples/examples/grid/datatable以及examples/examples/grid/ui
|
| 53 |
|
| 54 | 示例2：
|
| 55 |
|
| 56 | docs/dir/grid.md
|
| 57 |
|
| 58 | examples/examples/dir/grid/datatable以及examples/examples/dir/grid/ui
|
| 59 |
|
| 60 |
|
| 61 | ### 控件开发过程说明
|
| 62 |
|
| 63 | 针对控件进行开发，修改css以及js文件之后通过调用gulp dist来生成项目产出
|
| 64 |
|
| 65 | $ gulp dist
|
| 66 |
|
| 67 | ### 示例及文档开发过程说明
|
| 68 |
|
| 69 | 针对示例及文档进行开发，修改snippets文件之后通过node app.js来生成示例及文档产出
|
| 70 |
|
| 71 | $ node app.js
|