Skip to content

组件命名及目录结构

Cody Chan edited this page Jul 6, 2017 · 2 revisions

为了更方便构建工具的工作和项目整体统一,需要有些约定

概念

  • 分类:目前分为 form-表单layout-布局navigation-导航notice-通知widget-其它 几大类
  • 组件: 一般意义的外部暴露的组件,如 KLButtonKLInput
  • 对外子组件:这种组件原则上不可以单独使用,所以属于子组件,如 KLFormItem KLCrumbItem
  • 对内子组件:这个就是普通的内部使用的组件,具有完整组件的结构,但是不对外暴露,如 Dropdown TableBody

注:虽然 KLPagerKLTable 使用,但是因为其可以单独使用,故不属于子组件

结构和命名

  • 所有组件放到 src/js/components 目录对应分类下,并以 KLXxxYyy 命名组件类名和目录,对应的注册名为 kl-xxx-yyy
  • 对外子组件 放于附属的父组件直接目录下,命名方式同组件
  • 对内子组件XxxYyy 命名类名和目录,对应注册名 xxx-yyy(最好其实是不注册),目录位置分为三种:
    • 只被某个特定组件(以及对应的对外子组件)使用:位于父组件的直接目录下
    • 被同一个分类下多个组件(以及对应的对外子组件)使用:位于分类common 目录下
    • 被多个分类的组件使用:位于 src/js/components/common 下(目前暂未整理)

文档 && 样式 && 注释

这里

Clone this wiki locally