Lin UI, not just an UI component library!
一套基于微信小程序原生语法实现的高质量 UI 组件库
---
:collision::collision::collision:**林间有风团队招人啦**:collision::collision::collision:
林间有风是一个致力于让 Web 开发变得简单而优雅的开源团队。
目前团队的两款产品 Lin CMS 和 Lin UI 在 Github Star 均为 2000+
我们希望你：
1. 真正热爱开源，热爱编程，对开源有自己的理解
2. 熟悉微信小程序官网文档和开发规范
3. 熟悉 JavaScript、ES6、Vue 等前端相关生态
4. 如果上述技术栈和你不符，但你仍然很热爱开源的话，我们也欢迎你的加入
你将得到的：
1. 参与大型开源项目的开发，学习团队如何严格的遵循开发规范，并享受帮助其他开发者的乐趣。
2. 从一名普通“码农”变成真正的开发者，从枯燥的业务开发中抽身，站在更底层的角度思考问题。
3. 为你的简历增光添彩，一个优秀的开源项目能为你本身的能力背书，在求职时也是非常亮眼的一点
:mailbox:简历投递邮箱：juzi214032@qq.com，主题格式 林间有风+姓名+学生/在职
---
## 目录
- [目录](#目录)
- [简介](#简介)
- [快速上手](#快速上手)
- [安装](#安装)
- [引入](#引入)
- [讨论交流](#讨论交流)
- [贡献代码](#贡献代码)
- [开源协议](#开源协议)
## 简介
Lin UI 是一套基于 **微信小程序原生语法** 实现的高质量 UI 组件库。遵循简洁、易用、美观的设计规范。
## 快速上手
**务必勾选`增强编译`、`Es6 转 ES5`以及`使用 npm 模块`选项**，[参考图片](https://cdn.talelin.com/20210128165243.png)
### 安装
1. 初始化你的项目为一个 NPM 项目
```
npm init -y
```
> 若项目根目录已包含 package.json 文件，则可跳过该步骤
2. 安装 Lin UI
```
npm i lin-ui
```
3. 配置微信开发者工具
要正确安装 Lin UI，需将微信开发者工具的如下**三个选项全部勾选上**，[参考图片](https://cdn.talelin.com/20210128165243.png)
- `使用 npm 模块`
- `增强编译`
- `ES6 转 ES5`
> 设置路径：微信开发者工具右上角 -> 详情 -> 本地设置
4. 构建 NPM 模块
微信开发者工具配置完成以后，还需进行一次 NPM 模块的构建
> 按钮位置：微信开发者工具顶部 -> 工具 -> 构建 npm
> **若你本地没有 Node.js 环境，无法使用 NPM 安装，则可以采用[源码方式安装](https://doc.mini.talelin.com/start/#方式二：下载代码)**
### 引入
1. 配置微信开发者工具
- 要正确使用 Lin UI，需将微信开发者工具的 `Es6 转 ES5` 和 `增强编译` 选项勾选上
> 设置路径：微信开发者工具右上角 -> 详情 -> 本地设置
- **将基础库版本设置到 `>=2.8.2`**
2. 在页面中引入
```json
{
"usingComponents":{
"l-button":"/miniprogram_npm/lin-ui/button/index"
}
}
```
3. 在页面中使用
```html
默认按钮
```
> 我们建议你在引入 Lin UI 组件时，都统一命名为 `l-{组件名}` 格式，遵循此规范将使你的项目代码更加清晰
**至此，Lin UI 已成功引入至你的项目中了！**
## 讨论交流
## 贡献代码
我们的代码基于 develop 分支开发，欢迎提交 Pull Request 进行代码贡献。
在提交 Pull Request 之前，请详细阅读我们的[开发规范](https://github.com/TaleLin/lin-ui/wiki)，否则可能因为 Commit 信息不规范等原因被关闭 Pull Request。
## 开源协议
[MIT](LICENSE) © 2020 林间有风
