klook-web-uikit/README.md

A Component Library for Vue.js

# klook-web-uikit #

klook desktop website uikit built on Vue.js.

## Docs
[klook web uikit docs](https://klook-web-uikit-doc.firebaseapp.com/).

## Install
`npm i klook-web-uikit -E`

## Quick start
```
//全部引入
import Vue from 'vue';
import uikit from 'klook-web-uikit';
import 'klook-web-uikit/dist/klook-web-uikit.css';

Vue.use(uikit);

/*
按需引入
目前使用 babel-plugin-import 有问题，仍然会把 klook-web-uikit.js 打包进来，暂时只能单独引入。
需要在 webpack 相关 loader 配置中 include klook-web-uikit/src
*/
import KlkSymbol from 'klook-web-uikit/src/components/symbol';
import 'klook-web-uikit/src/scss/vendors/custom.scss';
import 'klook-web-uikit/src/scss/components/symbol.scss';

Vue.component('KlkSymbol', KlkSymbol);
......

<klk-symbol href='close' size="16" color="#000"></klk-symbol>

```

## Compatibility
* Vue.js 2.x
* Modern browsers and Internet Explorer 10+.

## Who's using klook-web-uikit
* [klook](https://www.klook.com)