Blame view

README.md 3.55 KB
27f0d894   梁灏   update readme
1
2
3
4
5
  <p align="center">
      <a href="https://www.iviewui.com">
          <img width="200" src="https://raw.githubusercontent.com/iview/iview/master/assets/logo.png">
      </a>
  </p>
c1cfacb2   梁灏   update readme
6
  
7efef86b   Aresn   Update README.md
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)
d270488b   梁灏   update readme
26
  ### [中文文档 (1.0)](http://v1.iviewui.com)
c1cfacb2   梁灏   update readme
27
  
27f0d894   梁灏   update readme
28
29
30
31
32
33
  ## Overview
  
  ### [组件概览(Component Overview)](https://www.iviewui.com/overview)
  
  ## Features
  
27f0d894   梁灏   update readme
34
35
  - High quality and rich functions
  - Friendly APIs,free and flexible
10f622ac   梁灏   update issue desc
36
37
  - Great Documentation
  - It is quite beautiful
31182c69   梁灏   release 2.0.0-rc.1
38
  - Support Vue.js 2 and Vue.js 1
10f622ac   梁灏   update issue desc
39
  - Based on npm + webpack + babel, using ES2015
27f0d894   梁灏   update readme
40
  
b13ae9c5   梁灏   update readme
41
  ## Programming
2c513e34   梁灏   update readme
42
  ![iView](https://raw.githubusercontent.com/iview/iview/2.0/assets/iview2.png)
b13ae9c5   梁灏   update readme
43
  
27f0d894   梁灏   update readme
44
45
  ## Install
  
c06e99d0   huixisheng   Support Breadcrumb
46
  ### Install vue-webpack project in the first place
27f0d894   梁灏   update readme
47
  
e48950bd   梁灏   update readme
48
  Use [iview-project](https://github.com/iview/iview-project)(Recommended) Or [vue-cli](https://github.com/vuejs/vue-cli)
27f0d894   梁灏   update readme
49
50
51
  
  ### Install iView
  
2218620b   Aresn   Update README.md
52
53
  using npm
  ```
27f0d894   梁灏   update readme
54
  npm install iview --save
2218620b   Aresn   Update README.md
55
56
  ```
  Or using script tag for global use
d270488b   梁灏   update readme
57
  ```html
e48950bd   梁灏   update readme
58
  <script type="text/javascript" src="iview.min.js"></script>
27f0d894   梁灏   update readme
59
60
61
62
  ```
  
  ## Usage
  
27f0d894   梁灏   update readme
63
64
  ```html
  <template>
b13ae9c5   梁灏   update readme
65
      <Slider v-model="value" range></Slider>
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
77
78
79
80
81
82
83
84
85
      }
  </script>
  ```
  Use css
  ```js
  import 'iview/dist/styles/iview.css';
  ```
  
  ## Browser Support
  
  Normal browsers and Internet Explorer 9+.
  
c9080021   梁灏   update readme
86
87
88
89
90
91
  ## Major Contributors
  |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)  |
dc7f5aef   Aresn   Update README.md
92
  |  [lcx960324](https://github.com/lcx960324)       |  ![](https://avatars3.githubusercontent.com/u/9768245?v=3&s=60)  |
c9080021   梁灏   update readme
93
94
95
  |  [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)  |
  
d270488b   梁灏   update readme
96
  
27f0d894   梁灏   update readme
97
98
  ## Links
  
cfb4aad4   Aresn   Update README.md
99
  - [TalkingData](https://github.com/TalkingData)
27f0d894   梁灏   update readme
100
101
102
103
  - [Vue](https://github.com/vuejs/vue)
  - [Webpack](https://github.com/webpack/webpack)
  - [ionicons](https://github.com/driftyco/ionicons)
  - [Ant Design](https://github.com/ant-design/ant-design)
644c37b3   梁灏   update License
104
  
62a40f4f   梁灏   LICENSE add ionicons
105
106
107
  ## License
  [MIT](http://opensource.org/licenses/MIT)
  
8be3ad5f   EyreFreeᵈᵉᵛ   Change gitter bad...
108
  Copyright (c) 2016-present, iView