-
Notifications
You must be signed in to change notification settings - Fork 15
组件命名及目录结构
Cody Chan edited this page Jul 6, 2017
·
2 revisions
为了更方便构建工具的工作和项目整体统一,需要有些约定
- 分类:目前分为
form-表单
、layout-布局
、navigation-导航
、notice-通知
、widget-其它
几大类 - 组件: 一般意义的外部暴露的组件,如
KLButton
、KLInput
等 - 对外子组件:这种组件原则上不可以单独使用,所以属于子组件,如
KLFormItem
KLCrumbItem
等 - 对内子组件:这个就是普通的内部使用的组件,具有完整组件的结构,但是不对外暴露,如
Dropdown
TableBody
等
注:虽然
KLPager
被KLTable
使用,但是因为其可以单独使用,故不属于子组件
- 所有
组件
放到src/js/components
目录对应分类
下,并以KLXxxYyy
命名组件类名和目录,对应的注册名为kl-xxx-yyy
-
对外子组件
放于附属的父组件
直接目录下,命名方式同组件
-
对内子组件
以XxxYyy
命名类名和目录,对应注册名xxx-yyy
(最好其实是不注册),目录位置分为三种:- 只被某个特定
组件
(以及对应的对外子组件
)使用:位于父组件
的直接目录下 - 被同一个
分类
下多个组件
(以及对应的对外子组件
)使用:位于分类
的common
目录下 - 被多个
分类
的组件使用:位于src/js/components/common
下(目前暂未整理)
- 只被某个特定
见这里