Blame view

README.md 4.61 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
  
d270488b   梁灏   update readme
16
  ### A high quality  UI Toolkit built on Vue.js.
c1cfacb2   梁灏   update readme
17
  
b13ae9c5   梁灏   update readme
18
19
20
  > This branch is for Vue.js 2.x
  >
  > [HERE](https://github.com/iview/iview/tree/master) is for Vue.js 1.x
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
35
  - Dozens of useful and beautiful components.
  - Friendly API. It's made for people with all skill levels.
1d5e9fc3   Sergio Crisostomo   README updates
36
  - Extensive documentation and demos.
68f50634   梁灏   update readme
37
  - It is quite beautiful.
1d5e9fc3   Sergio Crisostomo   README updates
38
  - Supports Vue.js 2 and Vue.js 1.
27f0d894   梁灏   update readme
39
  
27f0d894   梁灏   update readme
40
41
  ## Install
  
1d5e9fc3   Sergio Crisostomo   README updates
42
  > Please install Webpack first
27f0d894   梁灏   update readme
43
  
1d5e9fc3   Sergio Crisostomo   README updates
44
  We recommend you install 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
  
2218620b   Aresn   Update README.md
48
49
  using npm
  ```
27f0d894   梁灏   update readme
50
  npm install iview --save
2218620b   Aresn   Update README.md
51
52
  ```
  Or using script tag for global use
1d5e9fc3   Sergio Crisostomo   README updates
53
  
d270488b   梁灏   update readme
54
  ```html
e48950bd   梁灏   update readme
55
  <script type="text/javascript" src="iview.min.js"></script>
1d5e9fc3   Sergio Crisostomo   README updates
56
  <link rel="stylesheet" href="dist/styles/iview.css">
27f0d894   梁灏   update readme
57
58
  ```
  
1d5e9fc3   Sergio Crisostomo   README updates
59
60
  More info [in the website](https://www.iviewui.com/docs/guide/install-en)
  
27f0d894   梁灏   update readme
61
62
  ## Usage
  
8fc450f5   梁灏   update readme
63
  ```vue
27f0d894   梁灏   update readme
64
  <template>
8fc450f5   梁灏   update readme
65
      <Slider v-model="value" range />
27f0d894   梁灏   update readme
66
67
  </template>
  <script>
27f0d894   梁灏   update readme
68
      export default {
e48950bd   梁灏   update readme
69
70
71
72
73
          data () {
              return {
                  value: [20, 50]
              }
          }
27f0d894   梁灏   update readme
74
75
76
      }
  </script>
  ```
1d5e9fc3   Sergio Crisostomo   README updates
77
78
79
  
  Using css via `import`:
  
27f0d894   梁灏   update readme
80
81
82
83
  ```js
  import 'iview/dist/styles/iview.css';
  ```
  
fded311f   梁灏   update readme
84
85
86
87
88
  ## Compatibility
  
  - Support Vue.js 2.x
  - Support Vue.js 1.x [Visit 1.0 doc](http://v1.iviewui.com/)
  - Support SSR
1d5e9fc3   Sergio Crisostomo   README updates
89
  - Support [Nuxt.js](https://nuxtjs.org/)
fded311f   梁灏   update readme
90
91
  - [Electron](http://electron.atom.io/)
  - iView does not support IE8 or below since [Vue.js](https://vuejs.org/v2/guide/reactivity.html) is using Object.defineProperty which do not be supported by these browsers to track changes.
27f0d894   梁灏   update readme
92
  
1d5e9fc3   Sergio Crisostomo   README updates
93
94
95
96
97
98
99
  ## Community
  
  If you want to contribute, have questions or bugs to report:
  
  **Questions:** you can find other users at [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) and please provide a example so we can help you better  
  **Contribute:** welcome to contact us in [Gitter chat](https://gitter.im/iview/iview), WeChat or via mail to `admin@aresn.com`. PRs welcome!
27f0d894   梁灏   update readme
100
  
c9080021   梁灏   update readme
101
  ## Major Contributors
55be6f6a   Aresn   Update README.md
102
103
104
105
106
  |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
107
  
d270488b   梁灏   update readme
108
  
27f0d894   梁灏   update readme
109
110
  ## Links
  
cfb4aad4   Aresn   Update README.md
111
  - [TalkingData](https://github.com/TalkingData)
27f0d894   梁灏   update readme
112
113
  - [Vue](https://github.com/vuejs/vue)
  - [Webpack](https://github.com/webpack/webpack)
1d5e9fc3   Sergio Crisostomo   README updates
114
  - [Ionicons](https://github.com/driftyco/ionicons)
27f0d894   梁灏   update readme
115
  - [Ant Design](https://github.com/ant-design/ant-design)
644c37b3   梁灏   update License
116
  
62a40f4f   梁灏   LICENSE add ionicons
117
118
119
  ## License
  [MIT](http://opensource.org/licenses/MIT)
  
8be3ad5f   EyreFreeᵈᵉᵛ   Change gitter bad...
120
  Copyright (c) 2016-present, iView