iview/README.md

152 lines
6.4 KiB
Markdown
Raw Normal View History

2016-09-24 22:43:55 +08:00
<p align="center">
<a href="https://www.iviewui.com">
2018-07-27 18:58:56 +08:00
<img width="200" src="https://file.iviewui.com/logo-new.svg">
2016-09-24 22:43:55 +08:00
</a>
</p>
2016-09-16 22:10:02 +08:00
2017-09-27 17:42:51 +02:00
# iView
[![](https://img.shields.io/travis/iview/iview.svg?style=flat-square)](https://travis-ci.org/iview/iview)
2017-06-02 18:40:15 +08:00
[![iView](https://img.shields.io/npm/v/iview.svg?style=flat-square)](https://www.npmjs.org/package/iview)
[![NPM downloads](http://img.shields.io/npm/dm/iview.svg?style=flat-square)](https://npmjs.org/package/iview)
[![NPM downloads](https://img.shields.io/npm/dt/iview.svg?style=flat-square)](https://npmjs.org/package/iview)
![JS gzip size](http://img.badgesize.io/https://unpkg.com/iview/dist/iview.min.js?compression=gzip&label=gzip%20size:%20JS&style=flat-square)
![CSS gzip size](http://img.badgesize.io/https://unpkg.com/iview/dist/styles/iview.css?compression=gzip&label=gzip%20size:%20CSS&style=flat-square)
[![Join the chat at https://gitter.im/iview/iview](https://img.shields.io/badge/chat-on_gitter-30b392.svg?style=flat-square)](https://gitter.im/iview/iview?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
setup Open Collective Hi, I'm making updates for Open Collective. Either you or a supporter signed this repo up for Open Collective. This pull request adds backers and sponsors from your Open Collective https://opencollective.com/iview❤️ It adds two badges at the top to show the latest number of backers and sponsors. It also adds placeholders so that the avatar/logo of new backers/sponsors can automatically be shown without having to update your README.md. [more info](https://github.com/opencollective/opencollective/wiki/Github-banner). See how it looks on this [repo](https://github.com/apex/apex#backers). You can also add a postinstall script to let people know after npm|yarn install that you are welcoming donations (optional). [More info](https://github.com/OpenCollective/opencollective-cli) You can also add a "Donate" button to your website and automatically show your backers and sponsors there with our widgets. Have a look here: https://opencollective.com/widgets P.S: As with any pull request, feel free to comment or suggest changes. The only thing "required" are the placeholders on the README because we believe it's important to acknowledge the people in your community that are contributing (financially or with code!). Thank you for your great contribution to the open source community. You are awesome! 🙌 And welcome to the open collective community! 😊 Come chat with us in the #opensource channel on https://slack.opencollective.com - great place to ask questions and share best practices with other open source sustainers!
2018-07-16 13:46:51 -07:00
[![Backers on Open Collective](https://opencollective.com/iview/backers/badge.svg)](#backers)
[![Sponsors on Open Collective](https://opencollective.com/iview/sponsors/badge.svg)](#sponsors)
2016-10-31 01:21:53 +00:00
### A high quality UI Toolkit built on Vue.js.
2016-09-16 22:10:02 +08:00
## Docs
2018-08-02 09:02:13 +08:00
### [3.0](https://www.iviewui.com)
2018-08-02 09:02:43 +08:00
2018-08-02 09:02:13 +08:00
[2.0](http://v2.iviewui.com)
2018-08-02 09:02:43 +08:00
2018-08-02 09:02:13 +08:00
[1.0](http://v1.iviewui.com)
2016-09-16 22:10:02 +08:00
2016-09-24 22:43:55 +08:00
## Features
2017-07-17 14:35:44 +08:00
- Dozens of useful and beautiful components.
- Friendly API. It's made for people with any skill level.
2017-09-27 17:42:51 +02:00
- Extensive documentation and demos.
2017-07-17 18:02:24 +08:00
- It is quite beautiful.
- Supports both Vue.js 2 and Vue.js 1.
2016-09-24 22:43:55 +08:00
2017-10-31 10:33:50 +08:00
## Who's using iView
- [TalkingData](http://www.talkingdata.com/)
2018-06-26 15:52:56 +08:00
- [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/)
2018-08-20 09:19:06 +08:00
- [iFLYTEK 科大讯飞](http://www.iflytek.com/)
- [同程艺龙](https://www.ly.com/)
2017-10-31 10:33:50 +08:00
> If your company or products use iView, welcome to click [here](https://github.com/iview/iview/issues/2143) to leave a message.
2016-09-24 22:43:55 +08:00
## Install
> Please install Webpack first!
2016-09-24 22:43:55 +08:00
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).
2016-09-24 22:43:55 +08:00
### Install iView
Using npm:
2016-11-14 14:35:56 +08:00
```
2016-09-24 22:43:55 +08:00
npm install iview --save
2016-11-14 14:35:56 +08:00
```
Using a script tag for global use:
2017-09-27 17:42:51 +02:00
2017-03-28 09:04:57 +08:00
```html
2016-11-14 14:31:00 +08:00
<script type="text/javascript" src="iview.min.js"></script>
2017-09-27 17:42:51 +02:00
<link rel="stylesheet" href="dist/styles/iview.css">
2016-09-24 22:43:55 +08:00
```
You can find more info [on the website](https://www.iviewui.com/docs/guide/install-en).
2017-09-27 17:42:51 +02:00
2016-09-24 22:43:55 +08:00
## Usage
2017-10-13 17:11:25 +08:00
```vue
2016-09-24 22:43:55 +08:00
<template>
2017-10-13 17:11:25 +08:00
<Slider v-model="value" range />
2016-09-24 22:43:55 +08:00
</template>
<script>
export default {
2016-11-14 14:31:00 +08:00
data () {
return {
value: [20, 50]
}
}
2016-09-24 22:43:55 +08:00
}
</script>
```
2017-09-27 17:42:51 +02:00
Using css via `import`:
2016-09-24 22:43:55 +08:00
```js
import 'iview/dist/styles/iview.css';
```
2017-07-17 14:35:44 +08:00
## 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.
2016-09-24 22:43:55 +08:00
2017-09-27 17:42:51 +02:00
## Community
If you want to contribute or have questions or bugs to report:
2017-09-27 17:42:51 +02:00
**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!
2016-09-24 22:43:55 +08:00
2017-03-21 17:15:03 +08:00
## Major Contributors
2017-08-25 14:18:41 +08:00
|Name|Avatar|Name|Avatar|Name|Avatar|
|---|---|---|---|---|---|
|[Aresn](https://github.com/icarusion) | ![](https://avatars3.githubusercontent.com/u/5370542?v=3&s=60) |[jingsam](https://github.com/jingsam) | ![](https://avatars3.githubusercontent.com/u/1522494?v=3&s=60) | [rijn](https://github.com/rijn) | ![](https://avatars2.githubusercontent.com/u/6976367?v=3&s=60) |
|[lcx960324](https://github.com/lcx960324) | ![](https://avatars3.githubusercontent.com/u/9768245?v=3&s=60) |[GITleonine1989](https://github.com/GITleonine1989) | ![](https://avatars1.githubusercontent.com/u/7582490?v=3&s=60) |[huixisheng](https://github.com/huixisheng) | ![](https://avatars1.githubusercontent.com/u/1518967?v=3&s=60) |
2018-03-28 10:49:24 +08:00
|[Sergio Crisostomo](https://github.com/SergioCrisostomo) | ![](https://avatars3.githubusercontent.com/u/5614559?v=3&s=60) | [lison16](https://github.com/lison16) | ![](https://avatars3.githubusercontent.com/u/20942571?v=3&s=60) | [Xotic750](https://github.com/Xotic750) | ![](https://avatars3.githubusercontent.com/u/216041?v=3&s=60) |
[huanghong1125](https://github.com/huanghong1125) | ![](https://avatars3.githubusercontent.com/u/12794817?v=3&s=60) |
2017-03-21 17:15:03 +08:00
setup Open Collective Hi, I'm making updates for Open Collective. Either you or a supporter signed this repo up for Open Collective. This pull request adds backers and sponsors from your Open Collective https://opencollective.com/iview❤️ It adds two badges at the top to show the latest number of backers and sponsors. It also adds placeholders so that the avatar/logo of new backers/sponsors can automatically be shown without having to update your README.md. [more info](https://github.com/opencollective/opencollective/wiki/Github-banner). See how it looks on this [repo](https://github.com/apex/apex#backers). You can also add a postinstall script to let people know after npm|yarn install that you are welcoming donations (optional). [More info](https://github.com/OpenCollective/opencollective-cli) You can also add a "Donate" button to your website and automatically show your backers and sponsors there with our widgets. Have a look here: https://opencollective.com/widgets P.S: As with any pull request, feel free to comment or suggest changes. The only thing "required" are the placeholders on the README because we believe it's important to acknowledge the people in your community that are contributing (financially or with code!). Thank you for your great contribution to the open source community. You are awesome! 🙌 And welcome to the open collective community! 😊 Come chat with us in the #opensource channel on https://slack.opencollective.com - great place to ask questions and share best practices with other open source sustainers!
2018-07-16 13:46:51 -07:00
### All Contributors
This project exists thanks to all the people who contribute.
<a href="graphs/contributors"><img src="https://opencollective.com/iview/contributors.svg?width=890&button=false" /></a>
### Backers
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/iview#backer)]
2018-07-17 08:55:54 +08:00
<a href="https://opencollective.com/iview#backers" target="_blank"><img src="https://opencollective.com/iview/backers.svg?width=890"></a>
setup Open Collective Hi, I'm making updates for Open Collective. Either you or a supporter signed this repo up for Open Collective. This pull request adds backers and sponsors from your Open Collective https://opencollective.com/iview❤️ It adds two badges at the top to show the latest number of backers and sponsors. It also adds placeholders so that the avatar/logo of new backers/sponsors can automatically be shown without having to update your README.md. [more info](https://github.com/opencollective/opencollective/wiki/Github-banner). See how it looks on this [repo](https://github.com/apex/apex#backers). You can also add a postinstall script to let people know after npm|yarn install that you are welcoming donations (optional). [More info](https://github.com/OpenCollective/opencollective-cli) You can also add a "Donate" button to your website and automatically show your backers and sponsors there with our widgets. Have a look here: https://opencollective.com/widgets P.S: As with any pull request, feel free to comment or suggest changes. The only thing "required" are the placeholders on the README because we believe it's important to acknowledge the people in your community that are contributing (financially or with code!). Thank you for your great contribution to the open source community. You are awesome! 🙌 And welcome to the open collective community! 😊 Come chat with us in the #opensource channel on https://slack.opencollective.com - great place to ask questions and share best practices with other open source sustainers!
2018-07-16 13:46:51 -07:00
### Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/iview#sponsor)]
<a href="https://opencollective.com/iview/sponsor/0/website" target="_blank"><img src="https://opencollective.com/iview/sponsor/0/avatar.svg"></a>
2017-03-28 09:04:57 +08:00
2018-05-21 11:50:51 +08:00
## Ecosystem Links
2016-09-24 22:43:55 +08:00
2018-05-21 11:50:51 +08:00
- [iView-Admin](https://github.com/iview/iview-admin)
- [iView-Doc](https://github.com/iview/iview-doc)
- [iView-Cli](https://github.com/iview/iview-cli)
- [iView-Loader](https://github.com/iview/iview-loader)
- [iView-Area](https://github.com/iview/iview-area)
## License
[MIT](http://opensource.org/licenses/MIT)
Copyright (c) 2016-present, iView