README_ZH.md

京东风格的轻量级 React 组件库，支持移动端 H5 和小程序开发

 

---

Nut[nʌt]，源自电影《冰河世纪》里松鼠 Scrat "执迷不悟"，一生追求，即便引发大灾难也绝不松手的坚果。

简体中文 | English

特性

• 🚀 70+ 高质量组件, 覆盖移动端主流场景
• 📖 基于京东 APP 11.0 视觉规范
• 🍭 支持按需引用
• 📖 详尽的文档和示例
• 💪 支持 TypeScript
• 💪 支持服务端渲染（测试阶段）
• 🍭 支持定制主题
• 🍭 单元测试覆盖率超过90%, 保障稳定性
• 📖 提供 Sketch 设计资源

项目运行

本地运行H5

# 克隆仓库
git clone https://github.com/jdf2e/nutui-react.git

# 进入项目根目录
cd nutui-react

# 安装依赖
pnpm install

# 进入开发模式
# 浏览器访问：http://localhost:3000（如果已启动前台程序，则不需打开此地址）
pnpm run dev

本地运行小程序

# 克隆仓库
git clone https://github.com/jdf2e/nutui-react.git

# 进入项目根目录
cd nutui-react

# 安装依赖
pnpm install

# 进入小程序开发模式
# 访问：src/sites/mobile-taro/dist/weapp
pnpm run dev:taro:weapp

# 其他小程序类似，如京东小程序
# 访问：src/sites/mobile-taro/dist/jd
pnpm run dev:taro:jd

构建版本

AMD 环境、Webpack、Vite 等构建工具环境、服务端建议使用 es 版，非模块化环境（如通过 <script> 标签直接引用）建议使用 umd 压缩版。

• es nutui.react.es.js

• umd nutui.umd.js

链接

• Discussions (用👍投票)
• Feature Requests (用👍投票)
• Bugs (用👍投票)
• Question (用👍投票)

开发交流

版本	微信群	内部咚咚群
NutUI React	关注后回复「NutUI-React」	1025679314
NutUI x Taro	关注后回复「NutUI-React」	1022545110

参与共建

如果您对这个项目感兴趣，欢迎参与贡献，也欢迎 "Star" 支持一下 ^_^

NutUI 社区共建倡议

NutUI-React 邀您共建，Contributor 您好

为 NutUI 贡献代码

NutUI 的共建方向主要分为：解决 issue、修复 bug、新增组件、增加国际化、UI 定制、平台适配、跨端扩展等。

欢迎社区开发者参与共建，在贡献您的代码之前请先阅读 《NutUI 贡献指南》。

问题反馈与建议

给 NutUI 提 Issue

在反馈问题之前，推荐阅读 《提问的智慧》、《如何向开源社区提问题》和《如何有效地报告 Bug》，这样您能够更容易获得理解和帮助。

参与 NutUI 社区讨论

如果您有任何想法、疑问或建议，都可以参与社区讨论分享您的观点。

贡献者们

感谢以下所有给 NutUI 贡献过代码的 开发者。

Stargazers

Forkers

开发计划

Milestones

更新日志

本项目遵从 Angular Style Commit Message Conventions，更新日志请查阅 Release。

开源协议

本项目基于 MIT 协议