From f7462b0cfc34d69b48be73fecffc8c8a19894882 Mon Sep 17 00:00:00 2001 From: guy Date: Thu, 14 Sep 2017 15:08:03 +0800 Subject: [PATCH] doc --- uidoc/OVERVIEW.md | 5 +++++ uidoc/README.md | 23 ++++++++++++++++++----- uidoc/START.md | 3 +++ uidoc/SUMMARY.md | 6 +++++- uidoc/package-lock.json | 1 - 5 files changed, 31 insertions(+), 7 deletions(-) create mode 100644 uidoc/OVERVIEW.md create mode 100644 uidoc/START.md diff --git a/uidoc/OVERVIEW.md b/uidoc/OVERVIEW.md new file mode 100644 index 000000000..4dd2d34d8 --- /dev/null +++ b/uidoc/OVERVIEW.md @@ -0,0 +1,5 @@ +# 通用规范 +1. 控件都会提供setValue, getValue, populate这几个方法来设置值,获取值(展示类控件除外)和刷新控件 +2. 控件都会提供setEnable, setVisible, setValid这几个方法来设置使能,是否可见,是否有效状态,并且在fineui2.0之后,会自动给子组件设置同样的状态,不要重写这些方法,一些需要在设置状态时的额外操作可以通过重写_setXXX来实现 +3. 使用populate来清空或者重置布局,不要使用empty, 慎用resize +4. 谨慎监听和触发BI.Controller.EVENT_CHANGE事件,一般来说,控件都会有一个BI.ClassName.EVENT_CHANGE事件,一些特殊的事件会在对应控件文档中列出 \ No newline at end of file diff --git a/uidoc/README.md b/uidoc/README.md index 693e42484..c39fd092d 100644 --- a/uidoc/README.md +++ b/uidoc/README.md @@ -1,7 +1,20 @@ # FineUIdocs -FineUI的交互、前端以及视觉文档规范 +FineUI文档 + + +## 文档地址 + +GithubPages: [https://fanruan.github.io/fineui](https://fanruan.github.io/fineui) + +CodingPages: [http://fanruan.coding.me/fineui](http://fanruan.coding.me/fineui) + + +## Demo + +CodingPages: [http://fanruan.coding.me/fineui/dist/index.html](http://fanruan.coding.me/fineui/dist/index.html) + + +## 代码设计文档 + +KMS: [http://www.finedevelop.com/display/DR/FineUI](http://www.finedevelop.com/display/DR/FineUI) -####1. 控件都会提供setValue, getValue, populate这几个方法来设置值,获取值(展示类控件除外)和刷新控件 -####2. 控件都会提供setEnable, setVisible, setValid这几个方法来设置使能,是否可见,是否有效状态,并且在fineui2.0之后,会自动给子组件设置同样的状态,不要重写这些方法,一些需要在设置状态时的额外操作可以通过重写_setXXX来实现 -####3. 使用populate来清空或者重置布局,不要使用empty, 慎用resize -####4. 谨慎监听和触发BI.Controller.EVENT_CHANGE事件,一般来说,控件都会有一个BI.ClassName.EVENT_CHANGE事件,一些特殊的事件会在对应控件文档中列出 \ No newline at end of file diff --git a/uidoc/START.md b/uidoc/START.md new file mode 100644 index 000000000..49a09c401 --- /dev/null +++ b/uidoc/START.md @@ -0,0 +1,3 @@ +## 开发教程 + +KMS: [http://www.finedevelop.com/pages/viewpage.action?pageId=15330077](http://www.finedevelop.com/pages/viewpage.action?pageId=15330077) diff --git a/uidoc/SUMMARY.md b/uidoc/SUMMARY.md index bde22d126..daa6818a2 100644 --- a/uidoc/SUMMARY.md +++ b/uidoc/SUMMARY.md @@ -1,7 +1,11 @@ # Summary ## 总览 -* [文档规范](README.md) +* [概览](README.md) +* [起步](START.md) + +## 通用规范 +* [通用规范](OVERVIEW.md) ## 核心控件 * 布局 diff --git a/uidoc/package-lock.json b/uidoc/package-lock.json index c091091a7..f8139f244 100644 --- a/uidoc/package-lock.json +++ b/uidoc/package-lock.json @@ -2,7 +2,6 @@ "name": "fineuidocs", "version": "1.0.0", "lockfileVersion": 1, - "requires": true, "dependencies": { "abab": { "version": "1.0.3",