Skip to content

Commit

Permalink
Update README.md and bump
Browse files Browse the repository at this point in the history
  • Loading branch information
Lil-C0der committed May 29, 2020
1 parent 26d8ec5 commit 1b19148
Show file tree
Hide file tree
Showing 4 changed files with 2,001 additions and 96 deletions.
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
*.js linguist-language=Vue
*.html linguist-language=Vue
94 changes: 60 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,41 @@
<p align="center">
<a href="https://github.com/zyqq/wheel" target="_blank" rel="noopener noreferrer">
<img src="https://s1.ax1x.com/2020/05/29/tuoTM9.png" alt="Echo Wheel logo">
</a>
</p>

<p align="center">
<a href="https://travis-ci.org/github/Lil-C0der/Woo-UI" target="_blank">
<img src="https://travis-ci.org/Lil-C0der/Woo-UI.svg?branch=master" alt="Build Status">
</a>
<a href='https://coveralls.io/github/Lil-C0der/Woo-UI?branch=master' target='_blank'>
<img src='https://coveralls.io/repos/github/Lil-C0der/Woo-UI/badge.svg?branch=master' alt='Coverage Status' />
</a>
<a href="https://www.npmjs.com/package/woo-ui" target="_blank">
<img src="https://img.shields.io/npm/v/woo-ui" alt="Version">
</a>
<a href="https://www.npmjs.com/package/woo-ui" target="_blank">
<img src="https://img.shields.io/npm/l/woo-ui" alt="License">
</a>
</p>

# Woo - UI

[![NPM version](https://img.shields.io/npm/v/woo.svg)](https://www.npmjs.com/package/woo-ui)
我自己的 UI 组件库

## 简介

[![Build Status](https://travis-ci.org/Lil-C0der/Woo-UI.svg?branch=master)](https://travis-ci.org/Lil-C0der/Woo)
这是我在学习 `Vue.js` 过程中基于 `Vue 2.6` 开发的一套 `UI` 组件库,包含了一些自己常用的组件,PC 端和移动端都可以使用。点 [这里](https://lil-c0der.github.io/Woo-UI/) 预览

[![Coverage Status](https://coveralls.io/repos/github/Lil-C0der/Woo-UI/badge.svg?branch=master)](https://coveralls.io/github/Lil-C0der/Woo-UI?branch=master)
其中部分组件的样式结构与 API 的设计借鉴了一些我使用过的成熟 `UI` 框架,例如 `Element``Ant Design Vue`

注意: 玩具项目,请不要在生产环境中使用

## 开发指南

1. 添加 CSS 样式

使用之前,确保你的浏览器支持标准盒模型,即 border-box
使用之前,请务必确保你的浏览器支持标准盒模型,即 border-box

IE8+浏览器支持

Expand All @@ -22,25 +47,6 @@
}
```

同时还需设置一些 CSS 变量(后续会改为 SCSS 变量)

IE15+浏览器支持

```
:root {
--button-height: 32px;
--font-size: 14px;
--border-radius: 4px;
--button-bg: #f6f6f6;
--button-bg-hover: #f1f1f1;
--button-bg-active: #d0d0d0;
--color: #333;
--color-active: #fefefe;
--border-color: #dcdfe6;
--border-color-hover: #c0c4cc;
}
```

2. 安装

推荐使用 npm 安装
Expand All @@ -53,23 +59,43 @@

```
import { Button, Icon } from "woo-ui";
import "woo-ui/dist/index.css";
import "woo-ui/dist/woo.css";
export default {
name: "App",
components: {
"woo-button": Button,
"woo-icon": Icon,
},
name: "App",
components: {
"woo-button": Button,
"woo-icon": Icon,
},
};
```

## 文档

## Q&A
## 已有组件

- [x] 按钮 Button
- [x] 图标 Icon
- [x] 输入框 Input
- [x] 栅格系统 Grid
- [x] 布局 Layout
- [x] 短提示 Toast
- [x] 气泡提示框 Popover
- [x] 标签页 Tabs
- [x] 折叠面板 Collapse
- [x] 级联选择器 Cascader
- [x] 轮播图 Slide
- [x] 菜单 Menu

## TODO

- [ ] 表单验证
- [ ] 分页器
- [ ] 表格
- [ ] 图片上传
- [ ] Sticky 组件

## 更新日志
## 开源许可

## 联系我
[MIT](http://opensource.org/licenses/MIT) License.

## 贡献代码
Copyright (c) 2020-present, Lil-C0der

0 comments on commit 1b19148

Please sign in to comment.