Blame view

README.md 5.8 KB
27f0d894   梁灏   update readme
1
2
  <p align="center">
      <a href="https://www.iviewui.com">
d9cbf61e   Aresn   Update README.md
3
          <img width="200" src="https://file.iviewui.com/logo-new.svg">
27f0d894   梁灏   update readme
4
5
      </a>
  </p>
c1cfacb2   梁灏   update readme
6
  
1d5e9fc3   Sergio Crisostomo   README updates
7
8
  # iView
  [![](https://img.shields.io/travis/iview/iview.svg?style=flat-square)](https://travis-ci.org/iview/iview)
25177f5a   Aresn   Update README.md
9
10
11
12
13
14
  [![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)
e4c90174   jess   setup Open Collec...
15
16
  [![Backers on Open Collective](https://opencollective.com/iview/backers/badge.svg)](#backers)
  [![Sponsors on Open Collective](https://opencollective.com/iview/sponsors/badge.svg)](#sponsors) 
ecd50b8f   The Gitter Badger   Add Gitter badge
17
  
692be62c   md678685   Fix some English ...
18
  ### A high quality UI Toolkit built on Vue.js.
c1cfacb2   梁灏   update readme
19
  
c1cfacb2   梁灏   update readme
20
21
  ## Docs
  
f30ad0dc   Aresn   Update README.md
22
  **[3.x](https://www.iviewui.com)** | [2.x](http://v2.iviewui.com) | [1.x](http://v1.iviewui.com)
c1cfacb2   梁灏   update readme
23
  
27f0d894   梁灏   update readme
24
25
  ## Features
  
fded311f   梁灏   update readme
26
  - Dozens of useful and beautiful components.
692be62c   md678685   Fix some English ...
27
  - Friendly API. It's made for people with any skill level.
1d5e9fc3   Sergio Crisostomo   README updates
28
  - Extensive documentation and demos.
68f50634   梁灏   update readme
29
  - It is quite beautiful.
692be62c   md678685   Fix some English ...
30
  - Supports both Vue.js 2 and Vue.js 1.
27f0d894   梁灏   update readme
31
  
d44e817e   梁灏   update Readme
32
33
  ## Who's using iView
  
ac61e3c4   Aresn   Update README.md
34
  - [TalkingData 腾云天下](http://www.talkingdata.com/)
0bb43097   梁灏   update Readme
35
36
37
38
39
40
41
42
  - [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/)
19a11e3b   Aresn   Update README.md
43
  - [iFLYTEK 科大讯飞](http://www.iflytek.com/)
ac61e3c4   Aresn   Update README.md
44
  - [LY 同程艺龙](https://www.ly.com/)
d44e817e   梁灏   update Readme
45
46
47
  
  > If your company or products use iView, welcome to click [here](https://github.com/iview/iview/issues/2143) to leave a message.
  
27f0d894   梁灏   update readme
48
49
  ## Install
  
78c92444   梁灏   update usage
50
  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.
27f0d894   梁灏   update readme
51
  
78c92444   梁灏   update usage
52
  We also provide a starter kit [iview-project](https://github.com/iview/iview-project) for you.
27f0d894   梁灏   update readme
53
54
55
  
  ### Install iView
  
692be62c   md678685   Fix some English ...
56
  Using npm:
2218620b   Aresn   Update README.md
57
  ```
27f0d894   梁灏   update readme
58
  npm install iview --save
2218620b   Aresn   Update README.md
59
  ```
692be62c   md678685   Fix some English ...
60
61
  
  Using a script tag for global use:
1d5e9fc3   Sergio Crisostomo   README updates
62
  
d270488b   梁灏   update readme
63
  ```html
e48950bd   梁灏   update readme
64
  <script type="text/javascript" src="iview.min.js"></script>
1d5e9fc3   Sergio Crisostomo   README updates
65
  <link rel="stylesheet" href="dist/styles/iview.css">
27f0d894   梁灏   update readme
66
67
  ```
  
692be62c   md678685   Fix some English ...
68
  You can find more info [on the website](https://www.iviewui.com/docs/guide/install-en).
1d5e9fc3   Sergio Crisostomo   README updates
69
  
27f0d894   梁灏   update readme
70
71
  ## Usage
  
8fc450f5   梁灏   update readme
72
  ```vue
27f0d894   梁灏   update readme
73
  <template>
8fc450f5   梁灏   update readme
74
      <Slider v-model="value" range />
27f0d894   梁灏   update readme
75
76
  </template>
  <script>
27f0d894   梁灏   update readme
77
      export default {
e48950bd   梁灏   update readme
78
79
80
81
82
          data () {
              return {
                  value: [20, 50]
              }
          }
27f0d894   梁灏   update readme
83
84
85
      }
  </script>
  ```
1d5e9fc3   Sergio Crisostomo   README updates
86
87
88
  
  Using css via `import`:
  
27f0d894   梁灏   update readme
89
90
91
92
  ```js
  import 'iview/dist/styles/iview.css';
  ```
  
fded311f   梁灏   update readme
93
94
  ## Compatibility
  
692be62c   md678685   Fix some English ...
95
96
97
98
  - 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/)
f0185eb6   Aresn   Update README.md
99
  - Supports TypeScript
692be62c   md678685   Fix some English ...
100
  - Supports [Electron](http://electron.atom.io/)
55eab40f   Aresn   Update README.md
101
  - Most components and features support IE9 and above browsers, some components and features do not support IE
27f0d894   梁灏   update readme
102
  
1d5e9fc3   Sergio Crisostomo   README updates
103
104
  ## Community
  
692be62c   md678685   Fix some English ...
105
  If you want to contribute or have questions or bugs to report:
1d5e9fc3   Sergio Crisostomo   README updates
106
  
692be62c   md678685   Fix some English ...
107
108
109
  **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!
27f0d894   梁灏   update readme
110
  
c9080021   梁灏   update readme
111
  ## Major Contributors
55be6f6a   Aresn   Update README.md
112
113
114
115
  |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)  |
d45d2ee0   Aresn   Update README.md
116
  |[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)   | 
4380625d   Aresn   Update README.md
117
  [huanghong1125](https://github.com/huanghong1125) | ![](https://avatars3.githubusercontent.com/u/12794817?v=3&s=60) | [yangdan8](https://github.com/yangdan8) | ![](https://avatars2.githubusercontent.com/u/16515026?v=3&s=60) |
c9080021   梁灏   update readme
118
  
d270488b   梁灏   update readme
119
  
3dc7ac4f   梁灏   update readme
120
  ## Ecosystem Links
27f0d894   梁灏   update readme
121
  
3c345ce9   梁灏   update readme
122
123
  - [iView Developer](https://dev.iviewui.com)
  - [iView Run](https://run.iviewui.com)
3dc7ac4f   梁灏   update readme
124
125
  - [iView-Admin](https://github.com/iview/iview-admin)
  - [iView-Doc](https://github.com/iview/iview-doc)
3dc7ac4f   梁灏   update readme
126
127
  - [iView-Loader](https://github.com/iview/iview-loader)
  - [iView-Area](https://github.com/iview/iview-area)
3c345ce9   梁灏   update readme
128
129
  - [iView-Editor](https://github.com/iview/iview-editor)
  - [iView-Cli](https://github.com/iview/iview-cli)
644c37b3   梁灏   update License
130
  
62a40f4f   梁灏   LICENSE add ionicons
131
132
133
  ## License
  [MIT](http://opensource.org/licenses/MIT)
  
8be3ad5f   EyreFreeᵈᵉᵛ   Change gitter bad...
134
  Copyright (c) 2016-present, iView