# chlorine-ui 组件库

### 快速开始

#### 安装组件库

```bash
npm install @cmtlyt/chlorine-ui
```

#### 引用组件库

```js
// 全部引入
import '@cmtlyt/chlorine-ui/dist/style/index.css'
import chlorineUI from '@cmtlyt/chlorine-ui'
Vue.use(chlorineUI)

// 按需引入
import '@cmtlyt/chlorine-ui/dist/style/index.css'
import { clButton } from '@cmtlyt/chlorine-ui'
Vue.use(clButton)
// 或
Vue.component(clButton)
// 或
export default {
  components: {
    clButton,
  },
}
```

#### 引用指令集

```js
import { clMove } from '@cmtlyt/chlorine-ui/dist/directive'
Vue.directive('clMove', clMove)
// 或
export default {
  directives: {
    clMove,
  },
}
```

#### 重新打包文档须知

> 因依赖包版本问题需要如下步骤才可打包文档,但不影响本地预览

1. 将根目录的 package-docs.json 文件和 docs 整个文件夹复制到一个空的目录
2. 在新目录中修改 package-docs.json 文件名为 package.json 然后`npm install`安装依赖
3. 运行`npm run docs:build`即可打包文档,但不建议上传作者仓库!