forked from kissyteam/kissy
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME
37 lines (31 loc) · 1.19 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
KISSY - An Enjoyable JavaScript Library
* Source: http://github.com/kissyteam/kissy
* License: http://github.com/kissyteam/kissy/blob/master/LICENSE
==============
愿 景
==============
小巧灵活,简洁实用,使用起来让人感觉愉悦。
Keep It
Simple & Stupid, Short & Sweet, Slim & Sexy...
Yeah!
==============
目 录
==============
- build: 构建好的发布文件
- docs: API、实例、教程等文档
- src: 源码、测试等开发资源
- thirtd-party: 第三方库
- tools: 打包压缩等自动化工具
==============
代码结构
==============
内部代码组织:采用 module, sub module 来分拆和组织代码
外部调用接口:component 形式,包括工具型组件 utils 和 UI 型组件 widgets
==============
命名约定
==============
原则:尽量避免潜在冲突,同时力求精简短小和见名知意。
- 全局变量: g_ks_comp_xxx 比如: g_ks_suggest_callback
- class/id 命名: ks-comp[-xxx] 比如: ks-editor-toolbar-item
- data 属性命名: data-ks-comp[-xxx] 比如: data-ks-switchable
- hook 规范: KS_Comp 比如: KS_Slide