Blame view

README.md 4.65 KB
27f0d894   梁灏   update readme
1
2
  <p align="center">
      <a href="https://www.iviewui.com">
1c26046d   梁灏   update readme
3
          <img width="200" src="https://file.iviewui.com/logo.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)
ecd50b8f   The Gitter Badger   Add Gitter badge
15
  
692be62c   md678685   Fix some English ...
16
  ### A high quality UI Toolkit built on Vue.js.
c1cfacb2   梁灏   update readme
17
  
692be62c   md678685   Fix some English ...
18
  > This branch is for Vue.js 2.x.
b13ae9c5   梁灏   update readme
19
  >
692be62c   md678685   Fix some English ...
20
  > The branch for Vue.js 1.x can be found [here](https://github.com/iview/iview/tree/master).
1cc06612   Rijn   updated README
21
  
c1cfacb2   梁灏   update readme
22
23
  ## Docs
  
5c2f982e   Aresn   update readme
24
  ### [English (2.0)](https://www.iviewui.com)
c4d36b0a   Aresn   update readme
25
  ### [中文文档 (2.0)](https://www.iviewui.com)
1d5e9fc3   Sergio Crisostomo   README updates
26
  [中文文档 (1.0)](http://v1.iviewui.com)
c1cfacb2   梁灏   update readme
27
  
27f0d894   梁灏   update readme
28
29
  ## Overview
  
fded311f   梁灏   update readme
30
  ### [Component Overview](https://www.iviewui.com/overview)
27f0d894   梁灏   update readme
31
32
33
  
  ## Features
  
fded311f   梁灏   update readme
34
  - Dozens of useful and beautiful components.
692be62c   md678685   Fix some English ...
35
  - Friendly API. It's made for people with any skill level.
1d5e9fc3   Sergio Crisostomo   README updates
36
  - Extensive documentation and demos.
68f50634   梁灏   update readme
37
  - It is quite beautiful.
692be62c   md678685   Fix some English ...
38
  - Supports both Vue.js 2 and Vue.js 1.
27f0d894   梁灏   update readme
39
  
27f0d894   梁灏   update readme
40
41
  ## Install
  
692be62c   md678685   Fix some English ...
42
  > Please install Webpack first!
27f0d894   梁灏   update readme
43
  
692be62c   md678685   Fix some English ...
44
  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).
27f0d894   梁灏   update readme
45
46
47
  
  ### Install iView
  
692be62c   md678685   Fix some English ...
48
  Using npm:
2218620b   Aresn   Update README.md
49
  ```
27f0d894   梁灏   update readme
50
  npm install iview --save
2218620b   Aresn   Update README.md
51
  ```
692be62c   md678685   Fix some English ...
52
53
  
  Using a script tag for global use:
1d5e9fc3   Sergio Crisostomo   README updates
54
  
d270488b   梁灏   update readme
55
  ```html
e48950bd   梁灏   update readme
56
  <script type="text/javascript" src="iview.min.js"></script>
1d5e9fc3   Sergio Crisostomo   README updates
57
  <link rel="stylesheet" href="dist/styles/iview.css">
27f0d894   梁灏   update readme
58
59
  ```
  
692be62c   md678685   Fix some English ...
60
  You can find more info [on the website](https://www.iviewui.com/docs/guide/install-en).
1d5e9fc3   Sergio Crisostomo   README updates
61
  
27f0d894   梁灏   update readme
62
63
  ## Usage
  
8fc450f5   梁灏   update readme
64
  ```vue
27f0d894   梁灏   update readme
65
  <template>
8fc450f5   梁灏   update readme
66
      <Slider v-model="value" range />
27f0d894   梁灏   update readme
67
68
  </template>
  <script>
27f0d894   梁灏   update readme
69
      export default {
e48950bd   梁灏   update readme
70
71
72
73
74
          data () {
              return {
                  value: [20, 50]
              }
          }
27f0d894   梁灏   update readme
75
76
77
      }
  </script>
  ```
1d5e9fc3   Sergio Crisostomo   README updates
78
79
80
  
  Using css via `import`:
  
27f0d894   梁灏   update readme
81
82
83
84
  ```js
  import 'iview/dist/styles/iview.css';
  ```
  
fded311f   梁灏   update readme
85
86
  ## Compatibility
  
692be62c   md678685   Fix some English ...
87
88
89
90
91
92
  - 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.
27f0d894   梁灏   update readme
93
  
1d5e9fc3   Sergio Crisostomo   README updates
94
95
  ## Community
  
692be62c   md678685   Fix some English ...
96
  If you want to contribute or have questions or bugs to report:
1d5e9fc3   Sergio Crisostomo   README updates
97
  
692be62c   md678685   Fix some English ...
98
99
100
  **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
101
  
c9080021   梁灏   update readme
102
  ## Major Contributors
55be6f6a   Aresn   Update README.md
103
104
105
106
107
  |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)  |
  |[Sergio Crisostomo](https://github.com/SergioCrisostomo)           |  ![](https://avatars3.githubusercontent.com/u/5614559?v=3&s=60)  |
c9080021   梁灏   update readme
108
  
d270488b   梁灏   update readme
109
  
27f0d894   梁灏   update readme
110
111
  ## Links
  
cfb4aad4   Aresn   Update README.md
112
  - [TalkingData](https://github.com/TalkingData)
27f0d894   梁灏   update readme
113
114
  - [Vue](https://github.com/vuejs/vue)
  - [Webpack](https://github.com/webpack/webpack)
1d5e9fc3   Sergio Crisostomo   README updates
115
  - [Ionicons](https://github.com/driftyco/ionicons)
27f0d894   梁灏   update readme
116
  - [Ant Design](https://github.com/ant-design/ant-design)
644c37b3   梁灏   update License
117
  
62a40f4f   梁灏   LICENSE add ionicons
118
119
120
  ## License
  [MIT](http://opensource.org/licenses/MIT)
  
8be3ad5f   EyreFreeᵈᵉᵛ   Change gitter bad...
121
  Copyright (c) 2016-present, iView