Blame view

README.md 2.66 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
  
27f0d894   梁灏   update readme
9
  ### A high quality  UI Components Library with Vue.js
c1cfacb2   梁灏   update readme
10
  
d5ce7bd4   梁灏   update readme
11
  > This branch is for Vue 2.x
1cc06612   Rijn   updated README
12
  
c1cfacb2   梁灏   update readme
13
14
  ## Docs
  
9dde24b6   梁灏   add LoadingBar co...
15
  ### [中文文档](https://www.iviewui.com)
763ac47d   Aresn   Update README.md
16
  ### English (Coming soon)
c1cfacb2   梁灏   update readme
17
  
d5ce7bd4   梁灏   update readme
18
  ## Programming
c755733a   梁灏   support Grid
19
  - [x] Grid
d5ce7bd4   梁灏   update readme
20
  - [ ] Layout
d47ea998   梁灏   support Button an...
21
22
  - [x] Button
  - [x] Icon
fc7ef072   梁灏   support Input
23
  - [x] Input
06322514   梁灏   support Radio
24
  - [x] Radio
cbe03a12   梁灏   support Checkbox
25
  - [x] Checkbox
2d5ba278   梁灏   support Switch
26
  - [x] Switch
d5ce7bd4   梁灏   update readme
27
28
29
30
31
32
33
  - [ ] Table
  - [ ] Select
  - [ ] Slider
  - [ ] DatePicker
  - [ ] TimePicker
  - [ ] Cascader
  - [ ] Transfer
c97c42ab   梁灏   support InputNumber
34
  - [x] InputNumber
d5ce7bd4   梁灏   update readme
35
36
37
  - [ ] Rate
  - [ ] Upload
  - [ ] Form
5d122b37   梁灏   support Alert
38
  - [x] Alert
d5ce7bd4   梁灏   update readme
39
40
41
42
43
  - [ ] Card
  - [ ] Message
  - [ ] Notice
  - [ ] Modal
  - [ ] Progress
15368be1   梁灏   Support Badge
44
  - [x] Badge
d5ce7bd4   梁灏   update readme
45
  - [ ] Collapse
e31ab8ad   梁灏   finish Timeline &...
46
  - [x] Timeline
456daf34   梁灏   support Tag
47
  - [x] Tag
d5ce7bd4   梁灏   update readme
48
49
50
51
52
53
54
55
56
  - [ ] Tooltip
  - [ ] Poptip
  - [ ] Carousel
  - [ ] Tree
  - [ ] Menu
  - [ ] Tabs
  - [ ] Dropdown
  - [ ] Page
  - [ ] Breadcrumb
e31ab8ad   梁灏   finish Timeline &...
57
  - [x] Steps
d5ce7bd4   梁灏   update readme
58
59
  - [ ] LoadingBar
  - [ ] Circle
fcf37f49   梁灏   update webpack & ...
60
  - [x] Affix
d5ce7bd4   梁灏   update readme
61
62
63
  - [ ] BackTop
  - [ ] Spin
  
27f0d894   梁灏   update readme
64
65
66
67
68
69
  ## Overview
  
  ### [组件概览(Component Overview)](https://www.iviewui.com/overview)
  
  ## Features
  
27f0d894   梁灏   update readme
70
71
  - High quality and rich functions
  - Friendly APIs,free and flexible
10f622ac   梁灏   update issue desc
72
73
74
75
  - Great Documentation
  - It is quite beautiful
  - Using .vue file development mode
  - Based on npm + webpack + babel, using ES2015
27f0d894   梁灏   update readme
76
  
27f0d894   梁灏   update readme
77
78
79
80
  ## Install
  
  ### Install vue-webpack project in the first place 
  
e48950bd   梁灏   update readme
81
  Use [iview-project](https://github.com/iview/iview-project)(Recommended) Or [vue-cli](https://github.com/vuejs/vue-cli)
27f0d894   梁灏   update readme
82
83
84
  
  ### Install iView
  
2218620b   Aresn   Update README.md
85
86
  using npm
  ```
27f0d894   梁灏   update readme
87
  npm install iview --save
2218620b   Aresn   Update README.md
88
89
90
  ```
  Or using script tag for global use
  ```
e48950bd   梁灏   update readme
91
  <script type="text/javascript" src="iview.min.js"></script>
27f0d894   梁灏   update readme
92
93
94
95
  ```
  
  ## Usage
  
27f0d894   梁灏   update readme
96
97
  ```html
  <template>
e48950bd   梁灏   update readme
98
      <Slider :value.sync="value" range></Slider>
27f0d894   梁灏   update readme
99
100
  </template>
  <script>
27f0d894   梁灏   update readme
101
      export default {
e48950bd   梁灏   update readme
102
103
104
105
106
          data () {
              return {
                  value: [20, 50]
              }
          }
27f0d894   梁灏   update readme
107
108
109
110
111
112
113
114
115
116
117
118
119
120
      }
  </script>
  ```
  Use css
  ```js
  import 'iview/dist/styles/iview.css';
  ```
  
  ## Browser Support
  
  Normal browsers and Internet Explorer 9+.
  
  ## Links
  
cfb4aad4   Aresn   Update README.md
121
  - [TalkingData](https://github.com/TalkingData)
27f0d894   梁灏   update readme
122
123
124
125
  - [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)