Skip to content

Commit 36aa396

Browse files
committed
添加README.md
1 parent 05caf11 commit 36aa396

File tree

1 file changed

+102
-0
lines changed

1 file changed

+102
-0
lines changed

README.md

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
<p align="center">
2+
<img alt="logo" src="https://uviewui.com/common/logo.png" width="120" height="120" style="margin-bottom: 10px;">
3+
</p>
4+
<h3 align="center" style="margin: 30px 0 30px;font-weight: bold;font-size:40px;">uView</h3>
5+
<h3 align="center">多平台快速开发的UI框架</h3>
6+
7+
8+
## 说明
9+
10+
uView UI,是[uni-app](https://uniapp.dcloud.io/)生态优秀的UI框架,全面的组件和便捷的工具会让您信手拈来,如鱼得水
11+
12+
## 特性
13+
14+
- 兼容安卓,iOS,微信小程序,H5,QQ小程序,百度小程序,支付宝小程序,头条小程序
15+
- 60+精选组件,功能丰富,多端兼容,让您快速集成,开箱即用
16+
- 众多贴心的JS利器,让您飞镖在手,召之即来,百步穿杨
17+
- 众多的常用页面和布局,让您专注逻辑,事半功倍
18+
- 详尽的文档支持,现代化的演示效果
19+
- 按需引入,精简打包体积
20+
21+
22+
## 安装
23+
24+
```bash
25+
# npm方式安装
26+
npm i uview-ui
27+
```
28+
29+
## 快速上手
30+
31+
1. `main.js`引入uView库
32+
```js
33+
// main.js
34+
import uView from 'uview-ui';
35+
Vue.use(uView);
36+
```
37+
38+
2. `App.vue`引入基础样式(注意style标签需声明scss属性支持)
39+
```css
40+
/* App.vue */
41+
<style lang="scss">
42+
@import "uview-ui/index.scss";
43+
</style>
44+
```
45+
46+
3. `uni.scss`引入全局scss变量文件
47+
```css
48+
/* uni.scss */
49+
@import "uview-ui/themb.scss";
50+
```
51+
52+
4. `pages.json`配置easycom规则(按需引入)
53+
54+
```js
55+
// pages.json
56+
{
57+
"easycom": {
58+
"^u-(.*)": "uview-ui/components/u-$1/u-$1.vue"
59+
},
60+
// 此为本身已有的内容
61+
"pages": [
62+
// ......
63+
]
64+
}
65+
```
66+
67+
请通过[快速上手](https://uviewui.com/components/quickstart.html)了解更详细的内容
68+
69+
## 使用方法
70+
配置easycom规则后,自动按需引入,无需`import`组件,直接引用即可。
71+
72+
```html
73+
<template>
74+
<u-buton>按钮</u-buton>
75+
</template>
76+
```
77+
78+
请通过[快速上手](https://uviewui.com/components/quickstart.html)了解更详细的内容
79+
80+
## 链接
81+
82+
- [官方文档](https://uviewui.com/)
83+
- [更新日志](https://uviewui.com/components/changelog.html)
84+
- [升级指南](https://uviewui.com/components/changelog.html)
85+
- [关于我们](https://uviewui.com/cooperation/about.html)
86+
87+
## 预览
88+
89+
您可以通过**微信**扫码,查看最佳的演示效果。
90+
<br>
91+
<br>
92+
<img src="https://uviewui.com/common/weixin_mini_qrcode.png" width="220" height="220" >
93+
94+
<!-- ## 捐赠uView的研发
95+
96+
uView文档和源码全部开源免费,如果您认为uView帮到了您的开发工作,您可以捐赠uView的研发工作,捐赠无门槛,哪怕是一杯可乐也好(相信这比打赏主播更有意义)。
97+
98+
<img src="https://uviewui.com/common/wechat.png" width="220" >
99+
<img style="margin-left: 100px;" src="https://uviewui.com/common/alipay.png" width="220" >
100+
-->
101+
## 版权信息
102+
uView遵循[MIT](https://en.wikipedia.org/wiki/MIT_License)开源协议,意味着您无需支付任何费用,也无需授权,即可将uView应用到您的产品中。

0 commit comments

Comments
 (0)