137 lines
5.9 KiB
Markdown
137 lines
5.9 KiB
Markdown
<p align="center">
|
|
<a href="http://iview.talkingdata.com/">
|
|
<img width="200" src="https://file.iviewui.com/logo-new.svg">
|
|
</a>
|
|
</p>
|
|
|
|
<h1>
|
|
iView
|
|
<h3>A high quality UI Toolkit built on Vue.js.</h3>
|
|
</h1>
|
|
|
|
[](https://travis-ci.org/iview/iview)
|
|
[](https://www.npmjs.org/package/iview)
|
|
[](https://npmjs.org/package/iview)
|
|
[](https://npmjs.org/package/iview)
|
|
|
|
|
|
[](https://gitter.im/iview/iview?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
[](#backers)
|
|
[](#sponers)
|
|
|
|
|
|
## Docs
|
|
|
|
**[3.x](http://iview.talkingdata.com/)** | [2.x](http://v2.iviewui.com) | [1.x](http://v1.iviewui.com)
|
|
|
|
## 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.
|
|
|
|
## Who's using iView
|
|
|
|
- [TalkingData 腾云天下](http://www.talkingdata.com/)
|
|
- [Alibaba 阿里巴巴](http://www.alibaba.com/)
|
|
- [Baidu 百度](https://www.baidu.com/)
|
|
- [Tencent 腾讯](https://www.tencent.com/)
|
|
- [Toutiao 今日头条](https://www.toutiao.com/)
|
|
- [JD 京东](http://www.jd.com/)
|
|
- [DiDi 滴滴](http://www.didichuxing.com/)
|
|
- [Meituan 美团](http://www.meituan.com/)
|
|
- [Sina 新浪](http://www.sina.com.cn/)
|
|
- [iFLYTEK 科大讯飞](http://www.iflytek.com/)
|
|
- [LY 同程艺龙](https://www.ly.com/)
|
|
|
|
> If your company or products use iView, welcome to click [here](https://github.com/iview/iview/issues/2143) to leave a message.
|
|
|
|
## Install
|
|
|
|
We provide an [iView plugin](https://github.com/iview/vue-cli-plugin-iview) for Vue CLI 3, which you can use to quickly build an iView-based project.
|
|
|
|
We also provide a starter kit [iview-project](https://github.com/iview/iview-project) for you.
|
|
|
|
### Install iView
|
|
|
|
Using npm:
|
|
```
|
|
npm install iview --save
|
|
```
|
|
|
|
Using a script tag for global use:
|
|
|
|
```html
|
|
<script type="text/javascript" src="iview.min.js"></script>
|
|
<link rel="stylesheet" href="dist/styles/iview.css">
|
|
```
|
|
|
|
You can find more info [on the website](https://www.iviewui.com/docs/guide/install-en).
|
|
|
|
## Usage
|
|
|
|
```vue
|
|
<template>
|
|
<Slider v-model="value" range />
|
|
</template>
|
|
<script>
|
|
export default {
|
|
data () {
|
|
return {
|
|
value: [20, 50]
|
|
}
|
|
}
|
|
}
|
|
</script>
|
|
```
|
|
|
|
Using css via `import`:
|
|
|
|
```js
|
|
import 'iview/dist/styles/iview.css';
|
|
```
|
|
|
|
## Compatibility
|
|
|
|
- Supports Vue.js 2.x
|
|
- Supports Vue.js 1.x - [visit 1.0 docs](http://v1.iviewui.com/)
|
|
- Supports SSR
|
|
- Supports [Nuxt.js](https://nuxtjs.org/)
|
|
- Supports TypeScript
|
|
- Supports [Electron](http://electron.atom.io/)
|
|
- Most components and features support IE9 and above browsers, some components and features do not support IE
|
|
|
|
## Community
|
|
|
|
If you want to contribute or have questions or bugs to report:
|
|
|
|
**Questions:** Find other users at the [Gitter chat](https://gitter.im/iview/iview) or post on [StackOverflow using `[iview-ui]` tag](https://stackoverflow.com/questions/tagged/iview-ui)
|
|
**Bugs:** [File a issue here](https://github.com/iview/iview/issues) - please provide a example so we can help you better
|
|
**Contribute:** Contact us in [Gitter chat](https://gitter.im/iview/iview), WeChat or via mail to `iview@tendcloud.com`. PRs welcome!
|
|
|
|
## Major Contributors
|
|
|Name|Avatar|Name|Avatar|Name|Avatar|
|
|
|---|---|---|---|---|---|
|
|
|[Aresn](https://github.com/icarusion) |  |[jingsam](https://github.com/jingsam) |  | [rijn](https://github.com/rijn) |  |
|
|
|[lcx960324](https://github.com/lcx960324) |  |[GITleonine1989](https://github.com/GITleonine1989) |  |[huixisheng](https://github.com/huixisheng) |  |
|
|
|[Sergio Crisostomo](https://github.com/SergioCrisostomo) |  | [lison16](https://github.com/lison16) |  | [Xotic750](https://github.com/Xotic750) |  |
|
|
[huanghong1125](https://github.com/huanghong1125) |  | [yangdan8](https://github.com/yangdan8) |  |
|
|
|
|
|
|
## Ecosystem Links
|
|
|
|
- [iView Developer](https://dev.iviewui.com)
|
|
- [iView Run](https://run.iviewui.com)
|
|
- [iView-Admin](https://github.com/iview/iview-admin)
|
|
- [iView-Loader](https://github.com/iview/iview-loader)
|
|
- [iView-Plugin](https://github.com/iview/vue-cli-plugin-iview)
|
|
- [iView-Area](https://github.com/iview/iview-area)
|
|
- [iView-Editor](https://github.com/iview/iview-editor)
|
|
|
|
|
|
## License
|
|
[MIT](http://opensource.org/licenses/MIT)
|
|
|
|
Copyright (c) 2016-present, TalkingData
|