iview/README.md

126 lines
2.7 KiB
Markdown
Raw Normal View History

2016-09-24 22:43:55 +08:00
<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>
2016-09-16 22:10:02 +08:00
2016-10-31 09:27:16 +08:00
# 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)
2016-10-31 01:21:53 +00:00
2016-09-24 22:43:55 +08:00
### A high quality UI Components Library with Vue.js
2016-09-16 22:10:02 +08:00
2017-02-28 16:49:54 +08:00
> This branch is for Vue 2.x
2017-01-19 09:39:41 -06:00
2016-09-16 22:10:02 +08:00
## Docs
### [中文文档](https://www.iviewui.com)
2017-01-23 07:40:43 +08:00
### English (Coming soon)
2016-09-16 22:10:02 +08:00
2017-02-28 16:49:54 +08:00
## Programming
2017-03-01 14:28:44 +08:00
- [x] Grid
- [x] Layout
- [x] Button
- [x] Icon
2017-03-01 15:23:12 +08:00
- [x] Input
2017-03-01 17:01:22 +08:00
- [x] Radio
2017-03-01 17:58:40 +08:00
- [x] Checkbox
2017-03-02 11:19:00 +08:00
- [x] Switch
2017-02-28 16:49:54 +08:00
- [ ] Table
2017-03-06 18:24:57 +08:00
- [x] Select
2017-03-03 17:46:09 +08:00
- [x] Slider
2017-02-28 16:49:54 +08:00
- [ ] DatePicker
- [ ] TimePicker
2017-03-06 17:30:39 +08:00
- [x] Cascader
2017-02-28 16:49:54 +08:00
- [ ] Transfer
- [x] InputNumber
2017-03-03 11:39:35 +08:00
- [x] Rate
- [x] Upload
2017-02-28 16:49:54 +08:00
- [ ] Form
2017-03-02 11:50:02 +08:00
- [x] Alert
2017-03-03 11:39:35 +08:00
- [x] Card
2017-02-28 16:49:54 +08:00
- [ ] Message
- [ ] Notice
- [ ] Modal
- [x] Progress
2017-03-02 12:05:57 +08:00
- [x] Badge
- [x] Collapse
- [x] Timeline
2017-03-02 12:22:15 +08:00
- [x] Tag
2017-03-03 14:00:16 +08:00
- [x] Tooltip
- [x] Poptip
- [x] Carousel
- [x] Tree
- [x] Menu
2017-03-03 13:38:46 +08:00
- [x] Tabs
2017-03-03 17:46:09 +08:00
- [x] Dropdown
2017-02-28 16:49:54 +08:00
- [ ] Page
2017-03-03 21:05:30 +08:00
- [x] Breadcrumb
- [x] Steps
2017-02-28 16:49:54 +08:00
- [ ] LoadingBar
- [x] Circle
- [x] Affix
2017-02-28 16:49:54 +08:00
- [ ] BackTop
2017-03-06 13:43:15 +08:00
- [x] Spin
2017-02-28 16:49:54 +08:00
2016-09-24 22:43:55 +08:00
## Overview
### [组件概览Component Overview](https://www.iviewui.com/overview)
## Features
- High quality and rich functions
- Friendly APIs,free and flexible
2016-12-15 09:39:00 +08:00
- Great Documentation
- It is quite beautiful
- Using .vue file development mode
- Based on npm + webpack + babel, using ES2015
2016-09-24 22:43:55 +08:00
## Install
2017-03-03 21:05:30 +08:00
### Install vue-webpack project in the first place
2016-09-24 22:43:55 +08:00
2016-11-14 14:31:00 +08:00
Use [iview-project](https://github.com/iview/iview-project)(Recommended) Or [vue-cli](https://github.com/vuejs/vue-cli)
2016-09-24 22:43:55 +08:00
### Install iView
2016-11-14 14:35:56 +08:00
using npm
```
2016-09-24 22:43:55 +08:00
npm install iview --save
2016-11-14 14:35:56 +08:00
```
Or using script tag for global use
```
2016-11-14 14:31:00 +08:00
<script type="text/javascript" src="iview.min.js"></script>
2016-09-24 22:43:55 +08:00
```
## Usage
```html
<template>
2016-11-14 14:31:00 +08:00
<Slider :value.sync="value" range></Slider>
2016-09-24 22:43:55 +08:00
</template>
<script>
export default {
2016-11-14 14:31:00 +08:00
data () {
return {
value: [20, 50]
}
}
2016-09-24 22:43:55 +08:00
}
</script>
```
Use css
```js
import 'iview/dist/styles/iview.css';
```
## Browser Support
Normal browsers and Internet Explorer 9+.
## Links
2017-02-22 14:35:15 +08:00
- [TalkingData](https://github.com/TalkingData)
2016-09-24 22:43:55 +08:00
- [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)