Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

client-components

tincker170.3.58

佳学慧客户端Vue组件库

readme

客户端组件库 🎨

简介

客户端组件库,为了减少粘贴复制造成的功能缺失,把通用程度很高且重要组件统一管理

安装

npm install client-components

使用

import Vue from 'vue';
import ClientUI from 'client-components';
import 'client-components/package/index.less';

Vue.use(ClientUI);

开发规范 📏

1. 所有组件都放在 src/components 下,每个组件对应一个文件夹,统一中划线命名,组件名和文件夹同名。

2. 每个文件夹下新建一个 index.js 文件负责导出组件,导出统一用 export default。组件开发完毕后在 component 目录里的 index.js 导出已编写的组件

3. 每个组件 ❗ 必须提供 name 属性 ❗,name 命名规则可以大驼峰,如果未提供组件无法注册。

4. 每个组件写一个 markdown 来说明组件如何使用,一个 demo 文件夹下写一个组件示例,组件示例命名同组件名(示例请看 modal 组件下的 modal.md)

5. 说明:shared 存放所有组件公用的一些方法【directives: 自定义指令】 【mixins: 混入】【utils:工具函数】,其中工具函数统一通过 index.js 文件导出,工具函数请通过功能区分文件,区分方法可以讨论。

6. 说明:style 存放公共样式

启动文档

npm run docs:dev

启动项目

npm run serve

待开发组件

  • <input disabled="" type="checkbox"> Radio
  • <input disabled="" type="checkbox"> CheckBox
  • <input disabled="" type="checkbox"> Toast

TODO

  • <input disabled="" type="checkbox"> 组件内的样式提取到一个单独文件内