Blame view

README.md 8.36 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
  
5b14ea60   Aresn   Update README.md
7
8
9
10
11
  <h1>
  iView
      <h3>A high quality UI Toolkit built on Vue.js.</h3>
  </h1>
  
1d5e9fc3   Sergio Crisostomo   README updates
12
  [![](https://img.shields.io/travis/iview/iview.svg?style=flat-square)](https://travis-ci.org/iview/iview)
25177f5a   Aresn   Update README.md
13
14
15
16
17
18
  [![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)
a462f272   Aresn   Update backers icon
19
  [![Backers on Open Collective](https://opencollective.com/iview/tiers/backer/badge.svg?label=backer&color=brightgreen)](#backers)
eaddbfb0   Aresn   Update README.md
20
  [![Sponers on Open Collective](https://opencollective.com/iview/tiers/sponsor/badge.svg?label=sponsor&color=brightgreen)](#sponers)
ecd50b8f   The Gitter Badger   Add Gitter badge
21
  
5b14ea60   Aresn   Update README.md
22
23
24
25
26
27
28
  
  <h2 align="center">Special Sponsors</h2>
  <table>
        <tbody>
          <tr>
            <td align="center" valign="middle">
              <a href="https://segmentfault.com/ls/1650000016424063" target="_blank">
dcfa8aca   Aresn   Update README.md
29
                <img width="300" src="https://file.iviewui.com/asd/asd-i-2.png">
5b14ea60   Aresn   Update README.md
30
31
32
33
34
35
36
37
38
              </a>
            </td>
            <td align="center" valign="middle">
              <a href="https://juejin.im/welcome/frontend?utm_source=iview&utm_medium=banner&utm_content=huoyue&utm_campaign=q4_website" target="_blank">
                <img width="300" src="https://file.iviewui.com/asd/asd-juejin3.png">
              </a>
            </td>
            <td align="center" valign="middle">
              <a href="https://studio.qcloud.coding.net/campaign/favorite-plugins/index?utm_source=iview" target="_blank">
ef538ed0   Aresn   update sponers
39
                <img width="300" src="https://file.iviewui.com/asd/asd-coding3.png">
5b14ea60   Aresn   Update README.md
40
41
42
43
44
45
46
47
48
              </a>
            </td>
          </tr>
          <tr>
            <td align="center" valign="middle">
              <a href="https://cn.udacity.com/fend/?utm_source=iviewui&utm_medium=banner&utm_campaign=fend" target="_blank">
                <img width="300" src="https://file.iviewui.com/asd/asd-u-new-2.png">
              </a>
            </td>
09a536fd   Aresn   Update README.md
49
  <!--           <td align="center" valign="middle">
5b14ea60   Aresn   Update README.md
50
51
52
              <a href="https://www.vaptcha.com/?from=iview" target="_blank">
                <img width="300" src="https://file.iviewui.com/asd/asd-vaptcha2.jpg">
              </a>
09a536fd   Aresn   Update README.md
53
            </td> -->
921bc86f   Aresn   Update README.md
54
  <!--           <td align="center" valign="middle">
5b14ea60   Aresn   Update README.md
55
56
57
              <a href="https://www.accesshub.cn/" target="_blank">
                <img width="300" src="https://file.iviewui.com/asd/asd-accesshub.jpg">
              </a>
921bc86f   Aresn   Update README.md
58
            </td> -->
09a5ac8e   Aresn   Update README.md
59
60
61
62
63
            <td align="center" valign="middle">
              <a href="https://juejin.im/book/5bc844166fb9a05cd676ebca" target="_blank">
                <img width="300" src="https://file.iviewui.com/asd/asd-v-book2.png">
              </a>
            </td>
5b14ea60   Aresn   Update README.md
64
65
66
67
          </tr>
        </tbody>
  </table>
  
153455c0   Aresn   Update README.md
68
69
70
71
72
  > If you'd like be a sponsor, to show your ads in GitHub and iView doc, please email admin@aresn.com to get more infomation.
  > 
  > (如果您想成为赞助商,在 GitHub 和 iView 文档展示您的广告,请邮件咨询 admin@aresn.com)
  >
  > (如果您有任何关于 iView 或 Vue.js 相关的问题,欢迎到 iView 社区提问 https://dev.iviewui.com/issues )
c1cfacb2   梁灏   update readme
73
  
c1cfacb2   梁灏   update readme
74
75
  ## Docs
  
f30ad0dc   Aresn   Update README.md
76
  **[3.x](https://www.iviewui.com)** | [2.x](http://v2.iviewui.com) | [1.x](http://v1.iviewui.com)
c1cfacb2   梁灏   update readme
77
  
27f0d894   梁灏   update readme
78
79
  ## Features
  
fded311f   梁灏   update readme
80
  - Dozens of useful and beautiful components.
692be62c   md678685   Fix some English ...
81
  - Friendly API. It's made for people with any skill level.
1d5e9fc3   Sergio Crisostomo   README updates
82
  - Extensive documentation and demos.
68f50634   梁灏   update readme
83
  - It is quite beautiful.
692be62c   md678685   Fix some English ...
84
  - Supports both Vue.js 2 and Vue.js 1.
27f0d894   梁灏   update readme
85
  
d44e817e   梁灏   update Readme
86
87
  ## Who's using iView
  
ac61e3c4   Aresn   Update README.md
88
  - [TalkingData 腾云天下](http://www.talkingdata.com/)
0bb43097   梁灏   update Readme
89
90
91
92
93
94
95
96
  - [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
97
  - [iFLYTEK 科大讯飞](http://www.iflytek.com/)
ac61e3c4   Aresn   Update README.md
98
  - [LY 同程艺龙](https://www.ly.com/)
d44e817e   梁灏   update Readme
99
100
101
  
  > 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
102
103
  ## Install
  
78c92444   梁灏   update usage
104
  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
105
  
78c92444   梁灏   update usage
106
  We also provide a starter kit [iview-project](https://github.com/iview/iview-project) for you.
27f0d894   梁灏   update readme
107
108
109
  
  ### Install iView
  
692be62c   md678685   Fix some English ...
110
  Using npm:
2218620b   Aresn   Update README.md
111
  ```
27f0d894   梁灏   update readme
112
  npm install iview --save
2218620b   Aresn   Update README.md
113
  ```
692be62c   md678685   Fix some English ...
114
115
  
  Using a script tag for global use:
1d5e9fc3   Sergio Crisostomo   README updates
116
  
d270488b   梁灏   update readme
117
  ```html
e48950bd   梁灏   update readme
118
  <script type="text/javascript" src="iview.min.js"></script>
1d5e9fc3   Sergio Crisostomo   README updates
119
  <link rel="stylesheet" href="dist/styles/iview.css">
27f0d894   梁灏   update readme
120
121
  ```
  
692be62c   md678685   Fix some English ...
122
  You can find more info [on the website](https://www.iviewui.com/docs/guide/install-en).
1d5e9fc3   Sergio Crisostomo   README updates
123
  
27f0d894   梁灏   update readme
124
125
  ## Usage
  
8fc450f5   梁灏   update readme
126
  ```vue
27f0d894   梁灏   update readme
127
  <template>
8fc450f5   梁灏   update readme
128
      <Slider v-model="value" range />
27f0d894   梁灏   update readme
129
130
  </template>
  <script>
27f0d894   梁灏   update readme
131
      export default {
e48950bd   梁灏   update readme
132
133
134
135
136
          data () {
              return {
                  value: [20, 50]
              }
          }
27f0d894   梁灏   update readme
137
138
139
      }
  </script>
  ```
1d5e9fc3   Sergio Crisostomo   README updates
140
141
142
  
  Using css via `import`:
  
27f0d894   梁灏   update readme
143
144
145
146
  ```js
  import 'iview/dist/styles/iview.css';
  ```
  
fded311f   梁灏   update readme
147
148
  ## Compatibility
  
692be62c   md678685   Fix some English ...
149
150
151
152
  - 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
153
  - Supports TypeScript
692be62c   md678685   Fix some English ...
154
  - Supports [Electron](http://electron.atom.io/)
55eab40f   Aresn   Update README.md
155
  - Most components and features support IE9 and above browsers, some components and features do not support IE
27f0d894   梁灏   update readme
156
  
1d5e9fc3   Sergio Crisostomo   README updates
157
158
  ## Community
  
692be62c   md678685   Fix some English ...
159
  If you want to contribute or have questions or bugs to report:
1d5e9fc3   Sergio Crisostomo   README updates
160
  
692be62c   md678685   Fix some English ...
161
162
163
  **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
164
  
c9080021   梁灏   update readme
165
  ## Major Contributors
55be6f6a   Aresn   Update README.md
166
167
168
169
  |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
170
  |[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
171
  [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
172
  
d270488b   梁灏   update readme
173
  
3dc7ac4f   梁灏   update readme
174
  ## Ecosystem Links
27f0d894   梁灏   update readme
175
  
3c345ce9   梁灏   update readme
176
177
  - [iView Developer](https://dev.iviewui.com)
  - [iView Run](https://run.iviewui.com)
3dc7ac4f   梁灏   update readme
178
179
  - [iView-Admin](https://github.com/iview/iview-admin)
  - [iView-Doc](https://github.com/iview/iview-doc)
3dc7ac4f   梁灏   update readme
180
181
  - [iView-Loader](https://github.com/iview/iview-loader)
  - [iView-Area](https://github.com/iview/iview-area)
3c345ce9   梁灏   update readme
182
183
  - [iView-Editor](https://github.com/iview/iview-editor)
  - [iView-Cli](https://github.com/iview/iview-cli)
644c37b3   梁灏   update License
184
  
eaddbfb0   Aresn   Update README.md
185
186
187
  ## Sponers
  ![](https://opencollective.com/iview/tiers/sponsor.svg?avatarHeight=36)
  
3c2879dd   Aresn   Add backers
188
189
190
  ## Backers
  ![](https://opencollective.com/iview/tiers/backer.svg?avatarHeight=36)
  
62a40f4f   梁灏   LICENSE add ionicons
191
192
193
  ## License
  [MIT](http://opensource.org/licenses/MIT)
  
8be3ad5f   EyreFreeᵈᵉᵛ   Change gitter bad...
194
  Copyright (c) 2016-present, iView