Commit 27f0d89417ea02a3f5e00e7017d44df6382477c7
1 parent
45b672ca
update readme
update readme
Showing
3 changed files
with
73 additions
and
3 deletions
Show diff stats
README.md
| 1 | -# iView | 1 | +<p align="center"> |
| 2 | + <a href="https://www.iviewui.com"> | ||
| 3 | + <img width="200" src="https://raw.githubusercontent.com/iview/iview/master/assets/logo.png"> | ||
| 4 | + </a> | ||
| 5 | +</p> | ||
| 2 | 6 | ||
| 3 | -### A high quality UI components Library with Vue.js | 7 | +# iView (https://www.npmjs.org/package/iview) |
| 8 | + | ||
| 9 | +### A high quality UI Components Library with Vue.js | ||
| 4 | 10 | ||
| 5 | ## Docs | 11 | ## Docs |
| 6 | 12 | ||
| 7 | ### [中文文档](https://www.iviewui.com) | 13 | ### [中文文档](https://www.iviewui.com) |
| 8 | 14 | ||
| 15 | +## Overview | ||
| 16 | + | ||
| 17 | +### [组件概览（Component Overview）](https://www.iviewui.com/overview) | ||
| 18 | + | ||
| 19 | +## Features | ||
| 20 | + | ||
| 21 | +- Using .vue file development mode | ||
| 22 | +- Based on npm + webpack + babel, support ES2015 | ||
| 23 | +- High quality and rich functions | ||
| 24 | +- Friendly APIs,free and flexible | ||
| 25 | + | ||
| 9 | ## Programming | 26 | ## Programming |
| 10 | 27 | ||
| 11 |  | 28 |  |
| 12 | 29 | ||
| 30 | +## Install | ||
| 31 | + | ||
| 32 | +### Install vue-webpack project in the first place | ||
| 33 | + | ||
| 34 | +Use [vue-vueRouter-webpack](https://github.com/icarusion/vue-vueRouter-webpack)(Recommended) Or [vue-cli](https://github.com/vuejs/vue-cli) | ||
| 35 | + | ||
| 36 | +### Install iView | ||
| 37 | + | ||
| 38 | +```bash | ||
| 39 | +npm install iview --save | ||
| 40 | +``` | ||
| 41 | + | ||
| 42 | +### Babel support for iView in webpack | ||
| 43 | +```js | ||
| 44 | +module: { | ||
| 45 | + loaders: [ | ||
| 46 | + { test: /iview\/.*?js$/, loader: 'babel' }, | ||
| 47 | + { test: /\.js$/, loader: 'babel', exclude: /node_modules/ } | ||
| 48 | + ] | ||
| 49 | +} | ||
| 50 | +``` | ||
| 51 | + | ||
| 52 | +## Usage | ||
| 53 | + | ||
| 54 | +Use component as required | ||
| 55 | + | ||
| 56 | +```html | ||
| 57 | +<template> | ||
| 58 | + <Page :current="1" :total="100"></Page> | ||
| 59 | +</template> | ||
| 60 | +<script> | ||
| 61 | + import { Page } from 'iview'; | ||
| 62 | + export default { | ||
| 63 | + components: { Page } | ||
| 64 | + } | ||
| 65 | +</script> | ||
| 66 | +``` | ||
| 67 | +Use css | ||
| 68 | +```js | ||
| 69 | +import 'iview/dist/styles/iview.css'; | ||
| 70 | +``` | ||
| 71 | + | ||
| 72 | +## Browser Support | ||
| 73 | + | ||
| 74 | +Normal browsers and Internet Explorer 9+. | ||
| 75 | + | ||
| 76 | +## Links | ||
| 77 | + | ||
| 78 | +- [Vue](https://github.com/vuejs/vue) | ||
| 79 | +- [Webpack](https://github.com/webpack/webpack) | ||
| 80 | +- [ionicons](https://github.com/driftyco/ionicons) | ||
| 81 | +- [Ant Design](https://github.com/ant-design/ant-design) | ||
| 82 | + | ||
| 13 | # We have been in developing, please pay attention to the iView. | 83 | # We have been in developing, please pay attention to the iView. |
| 14 | \ No newline at end of file | 84 | \ No newline at end of file |
3.8 KB
package.json
| 1 | { | 1 | { |
| 2 | "name": "iview", | 2 | "name": "iview", |
| 3 | - "version": "0.0.23", | 3 | + "version": "0.9.0", |
| 4 | "title": "iView", | 4 | "title": "iView", |
| 5 | "description": "A high quality UI components Library with Vue.js", | 5 | "description": "A high quality UI components Library with Vue.js", |
| 6 | "homepage": "http://www.iviewui.com", | 6 | "homepage": "http://www.iviewui.com", |