Blame view

README.md 2.61 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
  
b6af9572   Aresn   add gitter.im
7
  # iView  [![](https://img.shields.io/travis/iview/iview.svg?style=flat-square)](https://travis-ci.org/iview/iview) [![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) [![Join the chat at https://gitter.im/iview/iview](https://badges.gitter.im/iview/iview.svg)](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
8
  
b13ae9c5   梁灏   update readme
9
  ### A high quality  UI Toolkit with both Vue.js 2.0 and 1.0 
c1cfacb2   梁灏   update readme
10
  
b13ae9c5   梁灏   update readme
11
12
13
  > 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
14
  
c1cfacb2   梁灏   update readme
15
16
  ## Docs
  
b13ae9c5   梁灏   update readme
17
  ### [中文文档(1.0版)](https://www.iviewui.com)
763ac47d   Aresn   Update README.md
18
  ### English (Coming soon)
c1cfacb2   梁灏   update readme
19
  
27f0d894   梁灏   update readme
20
21
22
23
24
25
  ## Overview
  
  ### [组件概览(Component Overview)](https://www.iviewui.com/overview)
  
  ## Features
  
27f0d894   梁灏   update readme
26
27
  - High quality and rich functions
  - Friendly APIs,free and flexible
10f622ac   梁灏   update issue desc
28
29
  - Great Documentation
  - It is quite beautiful
31182c69   梁灏   release 2.0.0-rc.1
30
  - Support Vue.js 2 and Vue.js 1
10f622ac   梁灏   update issue desc
31
  - Based on npm + webpack + babel, using ES2015
27f0d894   梁灏   update readme
32
  
b13ae9c5   梁灏   update readme
33
  ## Programming
2c513e34   梁灏   update readme
34
  ![iView](https://raw.githubusercontent.com/iview/iview/2.0/assets/iview2.png)
b13ae9c5   梁灏   update readme
35
  
27f0d894   梁灏   update readme
36
37
  ## Install
  
c06e99d0   huixisheng   Support Breadcrumb
38
  ### Install vue-webpack project in the first place
27f0d894   梁灏   update readme
39
  
e48950bd   梁灏   update readme
40
  Use [iview-project](https://github.com/iview/iview-project)(Recommended) Or [vue-cli](https://github.com/vuejs/vue-cli)
27f0d894   梁灏   update readme
41
42
43
  
  ### Install iView
  
2218620b   Aresn   Update README.md
44
45
  using npm
  ```
27f0d894   梁灏   update readme
46
  npm install iview --save
2218620b   Aresn   Update README.md
47
48
49
  ```
  Or using script tag for global use
  ```
e48950bd   梁灏   update readme
50
  <script type="text/javascript" src="iview.min.js"></script>
27f0d894   梁灏   update readme
51
52
53
54
  ```
  
  ## Usage
  
27f0d894   梁灏   update readme
55
56
  ```html
  <template>
b13ae9c5   梁灏   update readme
57
      <Slider v-model="value" range></Slider>
27f0d894   梁灏   update readme
58
59
  </template>
  <script>
27f0d894   梁灏   update readme
60
      export default {
e48950bd   梁灏   update readme
61
62
63
64
65
          data () {
              return {
                  value: [20, 50]
              }
          }
27f0d894   梁灏   update readme
66
67
68
69
70
71
72
73
74
75
76
77
78
79
      }
  </script>
  ```
  Use css
  ```js
  import 'iview/dist/styles/iview.css';
  ```
  
  ## Browser Support
  
  Normal browsers and Internet Explorer 9+.
  
  ## Links
  
cfb4aad4   Aresn   Update README.md
80
  - [TalkingData](https://github.com/TalkingData)
27f0d894   梁灏   update readme
81
82
83
84
  - [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
85
86
87
88
89
90
91
92
  
  ## Related open source projects
  In iView, Some of the components and style codes refer to the following projects:
  - [AntDesign](https://github.com/ant-design/ant-design)
  - [Element](https://github.com/ElemeFE/element)
  - [vue-antd](https://github.com/okoala/vue-antd)
  - [vue-beauty](https://github.com/FE-Driver/vue-beauty)
  - [Vux](https://github.com/airyland/vux)