iview/README.md

128 lines
5.9 KiB
Markdown
Raw Normal View History

2016-09-24 22:43:55 +08:00
<p align="center">
2020-09-03 15:53:31 +08:00
<a href="https://www.iviewui.com">
<img width="200" src="https://file.iviewui.com/view-ui-logo-new.svg">
2016-09-24 22:43:55 +08:00
</a>
</p>
2016-09-16 22:10:02 +08:00
2018-11-22 14:53:02 +08:00
<h1>
2020-09-03 15:53:31 +08:00
ViewUI
2018-11-22 14:53:02 +08:00
<h3>A high quality UI Toolkit built on Vue.js.</h3>
</h1>
2020-09-03 15:53:31 +08:00
> 该项目即为原先的 iView。iView 作者将在此仓库继续开发 iView 4.0 和后续版本,以及维护工作。新的组件库命名为 ViewUI原仓库 iView 作者不再提交内容。
>
> This project is the original iView. The iView author will continue to develop iView 4.0 and subsequent releases, as well as maintenance work, in this repository. The new component library is named ViewUI, and the iView author will no longer continue to submit content in the original repository.
2017-09-27 17:42:51 +02:00
[![](https://img.shields.io/travis/iview/iview.svg?style=flat-square)](https://travis-ci.org/iview/iview)
2020-09-03 15:53:31 +08:00
[![View UI](https://img.shields.io/npm/v/view-design.svg?style=flat-square)](https://www.npmjs.org/package/view-design)
[![NPM downloads](http://img.shields.io/npm/dm/iview.svg?style=flat-square)](https://npmjs.org/package/view-design)
[![NPM downloads](https://img.shields.io/npm/dt/iview.svg?style=flat-square)](https://npmjs.org/package/view-design)
2017-06-02 18:40:15 +08:00
![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)
2018-12-07 10:31:35 +08:00
[![Backers on Open Collective](https://opencollective.com/iview/tiers/backer/badge.svg?label=backer&color=brightgreen)](#backers)
2018-12-07 17:23:54 +08:00
[![Sponers on Open Collective](https://opencollective.com/iview/tiers/sponsor/badge.svg?label=sponsor&color=brightgreen)](#sponers)
2016-10-31 01:21:53 +00:00
2018-11-22 14:53:02 +08:00
2016-09-16 22:10:02 +08:00
## Docs
2020-09-03 15:53:31 +08:00
**[4.x](https://www.iviewui.com)** | [3.x](http://v3.iviewui.com) | [2.x](http://v2.iviewui.com) | [1.x](http://v1.iviewui.com)
2016-09-16 22:10:02 +08:00
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 any skill level.
2017-09-27 17:42:51 +02:00
- Extensive documentation and demos.
2017-07-17 18:02:24 +08:00
- It is quite beautiful.
- Supports both Vue.js 2 and Vue.js 1.
2016-09-24 22:43:55 +08:00
2020-09-03 15:53:31 +08:00
## Who's using ViewUI
2017-10-31 10:33:50 +08:00
2020-09-03 15:53:31 +08:00
![](https://file.iviewui.com/iview-design-dist/7fe5f4413704bbcb3ccc461ba92f6b50.jpg)
2017-10-31 10:33:50 +08:00
2016-09-24 22:43:55 +08:00
## Install
2020-09-03 15:53:31 +08:00
We provide an [View UI plugin](https://github.com/iview-design/vue-cli-plugin-viewui) for Vue CLI 3, which you can use to quickly build an ViewUI-based project.
2016-09-24 22:43:55 +08:00
2020-09-03 15:53:31 +08:00
We also provide a starter kit [view-ui-project](https://github.com/iview-design/view-ui-project) for you.
2016-09-24 22:43:55 +08:00
2020-09-03 15:53:31 +08:00
### Install View UI
2016-09-24 22:43:55 +08:00
Using npm:
2016-11-14 14:35:56 +08:00
```
2020-09-03 15:53:31 +08:00
npm install view-design --save
2016-11-14 14:35:56 +08:00
```
Using a script tag for global use:
2017-09-27 17:42:51 +02:00
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>
2017-09-27 17:42:51 +02:00
<link rel="stylesheet" href="dist/styles/iview.css">
2016-09-24 22:43:55 +08:00
```
You can find more info [on the website](https://www.iviewui.com/docs/guide/install-en).
2017-09-27 17:42:51 +02:00
2016-09-24 22:43:55 +08:00
## Usage
2017-10-13 17:11:25 +08:00
```vue
2016-09-24 22:43:55 +08:00
<template>
2017-10-13 17:11:25 +08:00
<Slider v-model="value" range />
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>
```
2017-09-27 17:42:51 +02:00
Using css via `import`:
2016-09-24 22:43:55 +08:00
```js
2020-09-03 15:53:31 +08:00
import 'view-design/dist/styles/iview.css';
2016-09-24 22:43:55 +08:00
```
2017-07-17 14:35:44 +08:00
## Compatibility
- Supports Vue.js 2.x
- Supports Vue.js 1.x - [visit 1.0 docs](http://v1.iviewui.com/)
- Supports SSR
- Supports [Nuxt.js](https://nuxtjs.org/)
2018-09-03 09:53:32 +08:00
- Supports TypeScript
- Supports [Electron](http://electron.atom.io/)
2018-08-31 16:04:12 +08:00
- Most components and features support IE9 and above browsers, some components and features do not support IE
2016-09-24 22:43:55 +08:00
2017-09-27 17:42:51 +02:00
## Community
If you want to contribute or have questions or bugs to report:
2017-09-27 17:42:51 +02:00
**Questions:** Find other users at the [Gitter chat](https://gitter.im/iview/iview) or post on [StackOverflow using `[iview-ui]` tag](https://stackoverflow.com/questions/tagged/iview-ui)
2020-09-03 15:53:31 +08:00
**Bugs:** [File a issue here](https://github.com/iview-design/iview/issues) - please provide a example so we can help you better
**Contribute:** Contact us in [Gitter chat](https://gitter.im/iview/iview), WeChat or via mail to `admin@aresn.com`. PRs welcome!
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) |
2018-03-28 10:49:24 +08:00
|[Sergio Crisostomo](https://github.com/SergioCrisostomo) | ![](https://avatars3.githubusercontent.com/u/5614559?v=3&s=60) | [lison16](https://github.com/lison16) | ![](https://avatars3.githubusercontent.com/u/20942571?v=3&s=60) | [Xotic750](https://github.com/Xotic750) | ![](https://avatars3.githubusercontent.com/u/216041?v=3&s=60) |
2018-09-03 09:47:05 +08:00
[huanghong1125](https://github.com/huanghong1125) | ![](https://avatars3.githubusercontent.com/u/12794817?v=3&s=60) | [yangdan8](https://github.com/yangdan8) | ![](https://avatars2.githubusercontent.com/u/16515026?v=3&s=60) |
2017-03-21 17:15:03 +08:00
2017-03-28 09:04:57 +08:00
2018-05-21 11:50:51 +08:00
## Ecosystem Links
2016-09-24 22:43:55 +08:00
2020-09-03 15:53:31 +08:00
- [View UI Pro](https://pro.iviewui.com/pro)
- [View UI Admin Pro](https://pro.iviewui.com/admin-pro)
- [Developer](https://dev.iviewui.com)
- [Run](https://run.iviewui.com)
2018-05-21 11:50:51 +08:00
- [iView-Loader](https://github.com/iview/iview-loader)
2020-09-03 15:53:31 +08:00
- [ViewUI-Plugin](https://github.com/iview/vue-cli-plugin-iview)
2018-12-07 10:28:22 +08:00
## License
[MIT](http://opensource.org/licenses/MIT)
2020-09-03 15:53:31 +08:00
Copyright (c) 2016-present, ViewDesign