guy 7 years ago
parent
commit
f7462b0cfc
  1. 5
      uidoc/OVERVIEW.md
  2. 23
      uidoc/README.md
  3. 3
      uidoc/START.md
  4. 6
      uidoc/SUMMARY.md
  5. 1
      uidoc/package-lock.json

5
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事件,一些特殊的事件会在对应控件文档中列出

23
uidoc/README.md

@ -1,7 +1,20 @@
# FineUIdocs # 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事件,一些特殊的事件会在对应控件文档中列出

3
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)

6
uidoc/SUMMARY.md

@ -1,7 +1,11 @@
# Summary # Summary
## 总览 ## 总览
* [文档规范](README.md) * [概览](README.md)
* [起步](START.md)
## 通用规范
* [通用规范](OVERVIEW.md)
## 核心控件 ## 核心控件
* 布局 * 布局

1
uidoc/package-lock.json generated

@ -2,7 +2,6 @@
"name": "fineuidocs", "name": "fineuidocs",
"version": "1.0.0", "version": "1.0.0",
"lockfileVersion": 1, "lockfileVersion": 1,
"requires": true,
"dependencies": { "dependencies": {
"abab": { "abab": {
"version": "1.0.3", "version": "1.0.3",

Loading…
Cancel
Save