Skip to content

TaleLin/lin-ui-doc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Lin UI, not just an UI component library!
一套基于微信小程序原生语法实现的高质量 UI 组件库

目录

简介

Lin UI 是一套基于 微信小程序原生语法 实现的高质量 UI 组件库。遵循简洁、易用、美观的设计规范。

快速上手

务必勾选Es6 转 ES5使用 npm 模块选项参考图片

安装

  1. 初始化你的项目为一个 NPM 项目

    npm init -y
    

    若项目根目录已包含 package.json 文件,则可跳过该步骤

  2. 安装 Lin UI

    npm i lin-ui
    
  3. 配置微信开发者工具 要正确安装 Lin UI,需将微信开发者工具的如下两个选项全部勾选上参考图片

    • 使用 npm 模块
    • ES6 转 ES5

    设置路径:微信开发者工具右上角 -> 详情 -> 本地设置

  4. 构建 NPM 模块 微信开发者工具配置完成以后,还需进行一次 NPM 模块的构建

    按钮位置:微信开发者工具顶部 -> 工具 -> 构建 npm

若你本地没有 Node.js 环境,无法使用 NPM 安装,则可以采用源码方式安装

引入

  1. 配置微信开发者工具

    • 要正确使用 Lin UI,需将微信开发者工具的 Es6 转 ES5 选项勾选上

      设置路径:微信开发者工具右上角 -> 详情 -> 本地设置

    • 将基础库版本设置到 >=2.8.2

  2. 在页面中引入

    {
      "usingComponents":{
        "l-button":"/miniprogram_npm/lin-ui/button/index"
      }
    }
  3. 在页面中使用

     <l-button type="default">默认按钮</l-button>

    我们建议你在引入 Lin UI 组件时,都统一命名为 l-{组件名} 格式,遵循此规范将使你的项目代码更加清晰

    至此,Lin UI 已成功引入至你的项目中了!

讨论交流

用户案例

Lin UI 经过大量用户实践,已产生出非常多的优秀案例,点击链接可查看其他用户的提交的案例小程序。

贡献代码

我们的代码基于 develop 分支开发,欢迎提交 Pull Request 进行代码贡献。

在提交 Pull Request 之前,请详细阅读我们的开发规范,否则可能因为 Commit 信息不规范等原因被关闭 Pull Request。

开源协议

MIT © 2021 林间有风