Skip to content

Latest commit

 

History

History
134 lines (90 loc) · 6.66 KB

README.md

File metadata and controls

134 lines (90 loc) · 6.66 KB
Raw

logo

轻量、可靠的小程序端 Taro React UI 组件库

介绍

Taroify 是移动端组件库 Vant 的 Taro React 版本，两者基于相同的视觉规范，提供近似一致的 API 接口，助力开发者快速搭建小程序应用。

✨ 特性

  • 🚀 性能极佳，组件平均体积小于 1KB（min+gzip）
  • 💎 70+ 个高质量组件，覆盖移动端主流场景
  • 💪 使用 TypeScript 编写，提供完整的类型定义
  • 💪 单元测试覆盖率超过 90%，提供稳定性保障
  • 📖 提供完善的中文文档和组件示例
  • 🍭 支持 React
  • 🍭 支持主题定制，内置 700+ 个主题变量
  • 🍭 支持按需引入和 Tree Shaking

浏览器支持

支持现代浏览器以及 Chrome >= 51、iOS >= 10.0。

安装

在现有项目中使用 Taroify 时，可以通过 npm 进行安装

npm i @taroify/core

当然，你也可以通过 yarn 或 pnpm 进行安装

yarn add @taroify/core

pnpm add @taroify/core

快速上手

import { Button } from "@taroify/core"
import "@taroify/core/button/style"

function Index() {
  return <Button color="primary">按钮</Button>
}

更多使用方式，请参考快速上手

贡献代码

修改代码请阅读我们的开发指南。

使用过程中发现任何问题都可以提 Issue 给我们，当然，我们也非常欢迎你给我们发 PR。

微信交流群

备注 "taroify" 加好友后邀请进群

贡献者

Vant 官方生态

由 Vant 官方团队维护的项目如下：

项目 描述
vant Vant Vue 版
vant-weapp Vant 微信小程序版
vant-demo Vant 官方示例合集
vant-cli 开箱即用的组件库搭建工具
vant-icons Vant 图标库
vant-touch-emulator 在桌面端使用 Vant 的辅助库

社区生态

由社区维护的项目如下，欢迎补充：

项目 描述
3lang3/react-vant 参照 Vant 打造的 React 移动端组件库
rc-ui-lib 参照 Vant 打造的 React 框架移动端组件库
vant-aliapp Vant 支付宝小程序版
taroify Vant Taro React 版
vant-theme Vant 在线主题预览工具
@antmjs/vantui 基于 Vant Weapp 开发的多端组件库，同时支持 Taro 和 React

赞助者

开发一个 UI 组件库是一项耗时的工作，尤其是要多端适配。Taroify 经常为此肝到深夜 ……

如果您认为 Taroify 帮助到了您的开发工作，您可以捐赠 Taroify 的研发工作，捐赠无门槛，哪怕是一杯可乐也好（相信这比打赏主播更有意义）。

支持者

@Yorksh1re @akazwz @Yang @coderYarn @蔡包 @王昆

鸣谢

Vant - 感谢 Vant 团队多年来的不断维护，让 Taroify 能够站在巨人的肩膀上。

WebStorm - 感谢 JetBrains 团队提供的集成开发环境，使得 Taroify 可以快速开发。

开源协议

本项目基于 MIT 协议，请自由地享受和参与开源。

友情推荐

项目 描述
mockm 一款优雅解决前端开发过程中各种接口问题的 nodejs 工具
taro-hooks 为 Taro 而设计的 Hooks Library
tarojs-router-next Taro 小程序路由库 / 自动生成带参数类型提示的路由方法 / 允许传递任意类型、任意大小的参数数据 / 同步的路由方法调用 / koa 体验一致的路由中间件