Blame view

README.md 7.3 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
              </a>
            </td>
5b14ea60   Aresn   Update README.md
32
            <td align="center" valign="middle">
8041e636   Aresn   update sponsors info
33
              <a href="https://e.coding.net/?utm_source=iview" target="_blank">
ef538ed0   Aresn   update sponers
34
                <img width="300" src="https://file.iviewui.com/asd/asd-coding3.png">
5b14ea60   Aresn   Update README.md
35
36
              </a>
            </td>
d5d1d065   Aresn   Update README.md
37
              <td align="center" valign="middle">
5b14ea60   Aresn   Update README.md
38
39
40
41
              <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>
d5d1d065   Aresn   Update README.md
42
          </tr>
e0d2712d   Aresn   update sponsor info
43
44
45
46
47
48
49
            <tr>
                <td align="center" valign="middle">
                <a href="https://uniapp.dcloud.io/?hmsr=iview&hmpl=&hmcu=&hmkw=&hmci=" target="_blank">
                  <img width="300" src="https://file.iviewui.com/asd/asd-uniapp.png">
                </a>
                </td>
            </tr>
5b14ea60   Aresn   Update README.md
50
51
52
        </tbody>
  </table>
  
153455c0   Aresn   Update README.md
53
  > 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.
c1cfacb2   梁灏   update readme
54
  
c1cfacb2   梁灏   update readme
55
56
  ## Docs
  
f30ad0dc   Aresn   Update README.md
57
  **[3.x](https://www.iviewui.com)** | [2.x](http://v2.iviewui.com) | [1.x](http://v1.iviewui.com)
c1cfacb2   梁灏   update readme
58
  
27f0d894   梁灏   update readme
59
60
  ## Features
  
fded311f   梁灏   update readme
61
  - Dozens of useful and beautiful components.
692be62c   md678685   Fix some English ...
62
  - Friendly API. It's made for people with any skill level.
1d5e9fc3   Sergio Crisostomo   README updates
63
  - Extensive documentation and demos.
68f50634   梁灏   update readme
64
  - It is quite beautiful.
692be62c   md678685   Fix some English ...
65
  - Supports both Vue.js 2 and Vue.js 1.
27f0d894   梁灏   update readme
66
  
d44e817e   梁灏   update Readme
67
68
  ## Who's using iView
  
ac61e3c4   Aresn   Update README.md
69
  - [TalkingData 腾云天下](http://www.talkingdata.com/)
0bb43097   梁灏   update Readme
70
71
72
73
74
75
76
77
  - [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
78
  - [iFLYTEK 科大讯飞](http://www.iflytek.com/)
ac61e3c4   Aresn   Update README.md
79
  - [LY 同程艺龙](https://www.ly.com/)
d44e817e   梁灏   update Readme
80
81
82
  
  > 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
83
84
  ## Install
  
78c92444   梁灏   update usage
85
  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
86
  
78c92444   梁灏   update usage
87
  We also provide a starter kit [iview-project](https://github.com/iview/iview-project) for you.
27f0d894   梁灏   update readme
88
89
90
  
  ### Install iView
  
692be62c   md678685   Fix some English ...
91
  Using npm:
2218620b   Aresn   Update README.md
92
  ```
27f0d894   梁灏   update readme
93
  npm install iview --save
2218620b   Aresn   Update README.md
94
  ```
692be62c   md678685   Fix some English ...
95
96
  
  Using a script tag for global use:
1d5e9fc3   Sergio Crisostomo   README updates
97
  
d270488b   梁灏   update readme
98
  ```html
e48950bd   梁灏   update readme
99
  <script type="text/javascript" src="iview.min.js"></script>
1d5e9fc3   Sergio Crisostomo   README updates
100
  <link rel="stylesheet" href="dist/styles/iview.css">
27f0d894   梁灏   update readme
101
102
  ```
  
692be62c   md678685   Fix some English ...
103
  You can find more info [on the website](https://www.iviewui.com/docs/guide/install-en).
1d5e9fc3   Sergio Crisostomo   README updates
104
  
27f0d894   梁灏   update readme
105
106
  ## Usage
  
8fc450f5   梁灏   update readme
107
  ```vue
27f0d894   梁灏   update readme
108
  <template>
8fc450f5   梁灏   update readme
109
      <Slider v-model="value" range />
27f0d894   梁灏   update readme
110
111
  </template>
  <script>
27f0d894   梁灏   update readme
112
      export default {
e48950bd   梁灏   update readme
113
114
115
116
117
          data () {
              return {
                  value: [20, 50]
              }
          }
27f0d894   梁灏   update readme
118
119
120
      }
  </script>
  ```
1d5e9fc3   Sergio Crisostomo   README updates
121
122
123
  
  Using css via `import`:
  
27f0d894   梁灏   update readme
124
125
126
127
  ```js
  import 'iview/dist/styles/iview.css';
  ```
  
fded311f   梁灏   update readme
128
129
  ## Compatibility
  
692be62c   md678685   Fix some English ...
130
131
132
133
  - 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
134
  - Supports TypeScript
692be62c   md678685   Fix some English ...
135
  - Supports [Electron](http://electron.atom.io/)
55eab40f   Aresn   Update README.md
136
  - Most components and features support IE9 and above browsers, some components and features do not support IE
27f0d894   梁灏   update readme
137
  
1d5e9fc3   Sergio Crisostomo   README updates
138
139
  ## Community
  
692be62c   md678685   Fix some English ...
140
  If you want to contribute or have questions or bugs to report:
1d5e9fc3   Sergio Crisostomo   README updates
141
  
692be62c   md678685   Fix some English ...
142
143
144
  **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
145
  
c9080021   梁灏   update readme
146
  ## Major Contributors
55be6f6a   Aresn   Update README.md
147
148
149
150
  |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
151
  |[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
152
  [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
153
  
d270488b   梁灏   update readme
154
  
3dc7ac4f   梁灏   update readme
155
  ## Ecosystem Links
27f0d894   梁灏   update readme
156
  
3c345ce9   梁灏   update readme
157
158
  - [iView Developer](https://dev.iviewui.com)
  - [iView Run](https://run.iviewui.com)
3dc7ac4f   梁灏   update readme
159
  - [iView-Admin](https://github.com/iview/iview-admin)
3dc7ac4f   梁灏   update readme
160
  - [iView-Loader](https://github.com/iview/iview-loader)
859dcd0a   Aresn   Update README.md
161
  - [iView-Plugin](https://github.com/iview/vue-cli-plugin-iview)
3dc7ac4f   梁灏   update readme
162
  - [iView-Area](https://github.com/iview/iview-area)
3c345ce9   梁灏   update readme
163
  - [iView-Editor](https://github.com/iview/iview-editor)
644c37b3   梁灏   update License
164
  
7005f2e9   Daryl.Xu   fix: sponsors typo
165
  ## Sponsors
eaddbfb0   Aresn   Update README.md
166
167
  ![](https://opencollective.com/iview/tiers/sponsor.svg?avatarHeight=36)
  
3c2879dd   Aresn   Add backers
168
169
170
  ## Backers
  ![](https://opencollective.com/iview/tiers/backer.svg?avatarHeight=36)
  
62a40f4f   梁灏   LICENSE add ionicons
171
172
173
  ## License
  [MIT](http://opensource.org/licenses/MIT)
  
8be3ad5f   EyreFreeᵈᵉᵛ   Change gitter bad...
174
  Copyright (c) 2016-present, iView