iview/README.md

109 lines
3.9 KiB
Markdown
Raw Normal View History

2016-09-24 22:43:55 +08:00
<p align="center">
<a href="https://www.iviewui.com">
2017-07-17 18:06:16 +08:00
<img width="200" src="https://file.iviewui.com/logo.svg">
2016-09-24 22:43:55 +08:00
</a>
</p>
2016-09-16 22:10:02 +08:00
2017-06-02 18:41:07 +08:00
# iView
[![](https://img.shields.io/travis/iview/iview.svg?style=flat-square)](https://travis-ci.org/iview/iview)
2017-06-02 18:40:15 +08:00
[![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)
2016-10-31 01:21:53 +00:00
2017-03-28 09:04:57 +08:00
### A high quality UI Toolkit built on Vue.js.
2016-09-16 22:10:02 +08:00
2017-03-09 23:01:55 +08:00
> This branch is for Vue.js 2.x
>
> [HERE](https://github.com/iview/iview/tree/master) is for Vue.js 1.x
2017-01-19 09:39:41 -06:00
2016-09-16 22:10:02 +08:00
## Docs
2017-06-28 13:23:23 +08:00
### [English (2.0)](https://www.iviewui.com)
2017-06-28 14:04:28 +08:00
### [中文文档 (2.0)](https://www.iviewui.com)
2017-03-28 09:04:57 +08:00
### [中文文档 (1.0)](http://v1.iviewui.com)
2016-09-16 22:10:02 +08:00
2016-09-24 22:43:55 +08:00
## Overview
2017-07-17 14:35:44 +08:00
### [Component Overview](https://www.iviewui.com/overview)
2016-09-24 22:43:55 +08:00
## Features
2017-07-17 14:35:44 +08:00
- Dozens of useful and beautiful components.
- Friendly API. It's made for people with all skill levels.
- Extensive documentation.
2017-07-17 18:02:24 +08:00
- It is quite beautiful.
2017-07-17 14:35:44 +08:00
- Support Vue.js 2 and Vue.js 1.
2016-09-24 22:43:55 +08:00
## Install
2017-07-17 14:35:44 +08:00
### Install webpack project in the first place
We recommend you install project through [iView Cli](https://github.com/iview/iview-cli) Or [iview-project](https://github.com/iview/iview-project).
2016-09-24 22:43:55 +08:00
2017-07-17 14:35:44 +08:00
You can also use [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
2017-03-28 09:04:57 +08:00
```html
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>
2017-03-09 23:01:55 +08:00
<Slider v-model="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';
```
2017-07-17 14:35:44 +08:00
## Compatibility
- Support Vue.js 2.x
- Support Vue.js 1.x [Visit 1.0 doc](http://v1.iviewui.com/)
- Support SSR
- Support Nuxt.js
- [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.
2016-09-24 22:43:55 +08:00
2017-03-21 17:15:03 +08:00
## Major Contributors
2017-08-25 14:18:41 +08:00
|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) |
2017-03-21 17:15:03 +08:00
2017-03-28 09:04:57 +08:00
2016-09-24 22:43:55 +08:00
## 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)
## License
[MIT](http://opensource.org/licenses/MIT)
Copyright (c) 2016-present, iView