基于 React 的京东风格移动端 UI 组件库,支持用户开发 H5 和小程序。
Nut[nʌt]:来自动画电影《冰河世纪》中松鼠 Scrat 一生孜孜不倦追求的坚果,即使造成灾难性后果也绝不放手。
English | 简体中文
特性
- 🚀 70+ 高质量组件
- 📖 基于京东 APP 11.0 视觉规范
- 🍭 支持 Tree Shaking
- 📖 详尽的文档和示例
- 💪 使用 TypeScript 编写
- 💪 支持服务端渲染(实验性)
- 🍭 支持自定义主题
- 🍭 单元测试覆盖率 90% 以上
- 📖 提供 Sketch 设计资源
本地运行
运行 H5 版本
# 克隆仓库
git clone https://github.com/jdf2e/nutui-react.git
# 进入项目目录
cd nutui-react
# 安装依赖
pnpm install
# 启动开发
pnpm run dev
# 在浏览器中访问:http://localhost:3000(如果你之前已经在浏览器中运行过,无需手动打开)
运行小程序版本
# 克隆仓库
git clone https://github.com/jdf2e/nutui-react.git
# 进入项目目录
cd nutui-react
# 安装依赖
pnpm install
# 启动开发
# 目录:packages/nutui-taro-demo/dist/weapp
pnpm run dev:taro:weapp
# 或者运行为京东小程序
# 目录:packages/nutui-taro-demo/dist/jd
pnpm run dev:taro:jd
构建版本
如果您使用的是 AMD 环境或者构建工具(如 Webpack、Vite 等),我们推荐使用
es
版本。如果是非模块化环境(如通过<script>
标签直接引用),则推荐使用umd
压缩版。
-
es nutui.es.js
-
umd nutui.umd.js
链接
交流
版本 | 微信群 | 京东咚咚群 |
---|---|---|
NutUI React | 关注后回复「NutUI-React」 | 1025679314 |
NutUI x Taro | 关注后回复「NutUI-React」 | 1022545110 |
加入我们
NutUI 社区
为 NutUI 贡献代码
有多种方式可以为 NutUI 做出贡献,包括解决问题、修复 bug、添加新组件、国际化、UI 定制、平台和跨端适配等。
我们非常欢迎您为 NutUI 贡献代码。在提交 pull request 之前,请阅读NutUI 开发者贡献指南。
问题与讨论
强烈建议阅读《提问的智慧》、《如何向开源社区提问题》和《如何有效地报告 Bug》,这样您可以更容易获得理解和帮助。
如果您有任何想法、问题或建议,可以在这里分享您的观点。
贡献者
感谢所有为 NutUI 贡献过代码的开发者。
Star 用户
Fork 用户
里程碑
发布说明
NutUI 遵循 Angular 风格的提交信息约定。最新的发布说明可在 Release 中查看。
开源许可
本项目基于 MIT 协议