Skip to content

Latest commit

 

History

History
101 lines (67 loc) · 2.42 KB

README.md

File metadata and controls

101 lines (67 loc) · 2.42 KB
logo

轻量、灵活的微信小程序组件

npm version download License-MIT

在线文档

http://wxui.linjiafu.top

简介

lin-wx-ui 是一款基于 原生微信小程序 的前端 UI 组件库,主要集成了我平时在开发中使用到的 UI 组件

预览

扫描下方小程序二维码,体验组件库示例:

qrcode

特性

  • 基于 原生微信小程序 开发的 UI 组件库
  • 使用 typescript 编写
  • 使用 npm + gulp 的工作流
  • 提供单元测试用例
  • 提供完善的使用文档

安装

方式一. 通过 npm 安装 (推荐)

小程序已经支持使用 npm 安装第三方包,详见 npm 支持

# 通过 npm 安装
npm i lin-wx-ui -S --production

# 通过 yarn 安装
yarn add lin-wx-ui --production

方式二. 下载代码

直接通过 git 下载 lin-wx-ui 源代码,并将dist目录拷贝到自己的项目中

git clone https://github.com/c10342/lin-wx-ui.git

使用组件

以按钮组件为例,只需要在 json 文件中引入按钮对应的自定义组件即可

{
  "usingComponents": {
    "lin-button": "/path/to/lin-wx-ui/dist/button/index"
  }
}

接着就可以在 wxml 中直接使用组件

<lin-button type="primary">按钮</lin-button>

在开发者工具中预览

# 安装项目依赖
npm install

# 执行组件编译
npm run dev

打开微信开发者工具,把lin-wx-ui/example目录添加进去就可以预览示例了。

贡献

如果你在使用 lin-wx-ui 时遇到问题,或者有好的建议,欢迎给我提 Issue

LICENSE

MIT