vui-design/README.md

A high quality UI Toolkit based on Vue.js

<p align="center">
    <a href="https://vui-design.github.io/vui-design-doc/" target="_blank">
        <img width="200" height="200" src="https://avatars2.githubusercontent.com/u/64267499?s=460&u=0f84e7ba145db5f246474896a38518a48d68824c&v=4" />
    </a>
</p>

<h1 align="center">Vui Design</h1>

<p align="center">A high quality UI Toolkit based on Vue.js 2.x</p>

<div align="center">

[![NPM version][npm-image]][npm-url] [![NPM downloads][dm-image]][dm-url] [![NPM downloads][dt-image]][dt-url]

[![david deps][david-image]][david-url] [![david devDeps][david-dev-image]][david-dev-url]

[npm-image]: https://img.shields.io/npm/v/vui-design.svg?style=flat-square
[npm-url]: https://npmjs.org/package/vui-design
[dm-image]: https://img.shields.io/npm/dm/vui-design.svg?style=flat-square
[dm-url]: https://npmjs.org/package/vui-design
[dt-image]: https://img.shields.io/npm/dt/vui-design.svg?style=flat-square
[dt-url]: https://npmjs.org/package/vui-design
[david-image]: https://img.shields.io/david/vui-design/vui-design?style=flat-square
[david-dev-url]: https://david-dm.org/vui-design/vui-design?type=dev
[david-dev-image]: https://img.shields.io/david/dev/vui-design/vui-design?style=flat-square
[david-url]: https://david-dm.org/vui-design/vui-design

</div>

## Features

- Dozens of useful and beautiful components.
- Friendly API. It's made for people with any skill level.
- Extensive documentation and demos.
- It is quite beautiful.
- Supports both Vue.js 2 and Vue.js 1.

## Install

Using npm:
```
npm install vui-design --save
```

Using a script tag for global use:
```html
<script src="//unpkg.com/vui-design/dist/vui-design.min.js"></script>
<link type="text/css" rel="stylesheet" href="//unpkg.com/vui-design/dist/style/vui-design.css" />
```

You can find more info [on the website](https://vui-design.github.io/vui-design-doc/#/guide/install).

## Usage

``` javascript
import "vui-design/dist/style/vui-design.css";
import Vue from "vue";
import VuiDesign from "vui-design";

Vue.use(VuiDesign);

// or
import "vui-design/dist/style/vui-design.css";
import Vue from "vue";
import { Button, Input } from "vui-design";

Vue.use(Button);
Vue.use(Input);
```

For more information, please refer to [Getting Started](https://vui-design.github.io/vui-design-doc/#/guide/getting-started) in our documentation.

## Browser Support
Modern browsers and Internet Explorer 10+.

## Docs

[中文文档](https://vui-design.github.io/vui-design-doc/)

## Ecosystem Links

- [Vui Design Pro](https://github.com/vui-design/vui-design-pro)
- [Vui Design ECharts](https://github.com/vui-design/vui-design-echarts)

## Major Contributors
|Name|Avatar|
|---|---|
|[Vui Design](https://github.com/vui-design)|![](https://avatars.githubusercontent.com/u/64267499?v=3&s=60)|

## License
[MIT](http://opensource.org/licenses/MIT)

Copyright (c) 2018-present, Vui Design