130 lines
4.9 KiB
Markdown
130 lines
4.9 KiB
Markdown
<p align="center">
|
|
<a href="https://www.iviewui.com">
|
|
<img width="200" src="https://file.iviewui.com/logo.svg">
|
|
</a>
|
|
</p>
|
|
|
|
# iView
|
|
[](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)
|
|
|
|
### A high quality UI Toolkit built on Vue.js.
|
|
|
|
> This branch is for Vue.js 2.x.
|
|
>
|
|
> The branch for Vue.js 1.x can be found [here](https://github.com/iview/iview/tree/master).
|
|
|
|
## Docs
|
|
|
|
### [English (2.0)](https://www.iviewui.com)
|
|
### [中文文档 (2.0)](https://www.iviewui.com)
|
|
[中文文档 (1.0)](http://v1.iviewui.com)
|
|
|
|
## Overview
|
|
|
|
### [Component Overview](https://www.iviewui.com/overview)
|
|
|
|
## 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/)
|
|
- [JD](http://www.jd.com/)
|
|
- [DiDi](http://www.didichuxing.com/)
|
|
|
|
> If your company or products use iView, welcome to click [here](https://github.com/iview/iview/issues/2143) to leave a message.
|
|
|
|
## Install
|
|
|
|
> Please install Webpack first!
|
|
|
|
We recommend you create your project through [iView Cli](https://github.com/iview/iview-cli) or [iview-project](https://github.com/iview/iview-project). You can also use [vue-cli](https://github.com/vuejs/vue-cli).
|
|
|
|
### 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 [Electron](http://electron.atom.io/)
|
|
- iView does not support IE8 or below since [Vue.js](https://vuejs.org/v2/guide/reactivity.html) uses `Object.defineProperty` to track changes which is not supported by these browsers.
|
|
|
|
## 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 `admin@aresn.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) |  |
|
|
|
|
|
|
## Links
|
|
|
|
- [TalkingData](https://github.com/TalkingData)
|
|
- [Vue](https://github.com/vuejs/vue)
|
|
- [Webpack](https://github.com/webpack/webpack)
|
|
- [Ionicons](https://github.com/driftyco/ionicons)
|
|
- [Ant Design](https://github.com/ant-design/ant-design)
|
|
|
|
## License
|
|
[MIT](http://opensource.org/licenses/MIT)
|
|
|
|
Copyright (c) 2016-present, iView
|