# nutui-react

**Repository Path**: jd-platform-opensource/nutui-react

## Basic Information

- **Project Name**: nutui-react
- **Description**: 京东风格的轻量级移动端 React 组件库
- **Primary Language**: TypeScript
- **License**: Not specified
- **Default Branch**: next
- **Homepage**: https://nutui.jd.com/react
- **GVP Project**: No

## Statistics

- **Stars**: 101
- **Forks**: 26
- **Created**: 2022-01-10
- **Last Updated**: 2025-06-17

## Categories & Tags

**Categories**: react-extensions

**Tags**: None

## README

<p align="center">
    <img alt="logo" src="https://img11.360buyimg.com/imagetools/jfs/t1/211965/25/7152/22022/61b16785E433119bb/aa41d7a9f7e823f3.png" width="150" style="margin-bottom: 10px;">
</p>

<p align="center">京东风格的轻量级 React 组件库，支持移动端 H5 和小程序开发</p>

<p align="center">
    <a href="http://makeapullrequest.com">
    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" alt="PRs Welcome" />
  </a>
  <a href="https://github.com/jdf2e/nutui-react">
    <img src="https://img.shields.io/npm/l/@nutui/nutui-react.svg" alt="license"/>
  </a>
  <a href="https://www.npmjs.com/package/@nutui/nutui-react">
    <img src="https://img.shields.io/npm/v/@nutui/nutui-react.svg?style=flat-square">
  </a>
  <a href="https://www.npmjs.com/package/@nutui/nutui-react">
    <img src="https://img.shields.io/npm/dt/@nutui/nutui-react.svg?style=flat-square">
  </a>
  <a href="https://github.com/jdf2e/nutui-react">
    <img src="https://img.shields.io/github/contributors/jdf2e/nutui-react" alt="GitHub contributors">
  </a>
  <a href="https://github.com/jdf2e/nutui-react">
    <img src="https://img.shields.io/github/release-date/jdf2e/nutui-react" alt="GitHub Release Date">
  </a>
  <a href="https://github.com/jdf2e/nutui-react">
    <img src="https://img.shields.io/github/commit-activity/w/jdf2e/nutui-react" alt="GitHub commit activity">
   </a>
</p>

<p align='center'>
  <img src="https://img12.360buyimg.com/imagetools/jfs/t1/202336/18/18586/7437/61b832ccE0b13d53d/18605da7232a5a0e.png" height="180" alt="NutUI-React" />  &nbsp;
  <img src="https://img13.360buyimg.com/imagetools/jfs/t1/102323/22/33163/27773/632a7855E75c9fa02/8c351778f47d24f5.jpg" width="200" alt="NutUI-React" />
</p>

---

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

简体中文 | [English](./README.md)

## 特性

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

## 项目运行

### 本地运行H5

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

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

# 安装依赖
pnpm install

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

```

### 本地运行小程序

```sh
# 克隆仓库
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**

## 链接

<ul>
    <li>
        <a href="https://github.com/jdf2e/nutui-react/discussions">
            Discussions  (用👍投票)
        </a>
    </li>
    <li>
        <a href="https://github.com/jdf2e/nutui-react/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22">
            Feature Requests (用👍投票)
        </a>
    </li>
     <li>
        <a href="https://github.com/jdf2e/nutui-react/labels/bug%203.0">
            Bugs (用👍投票)
        </a>
    </li>
     <li>
        <a href="https://github.com/jdf2e/nutui-react/issues?q=is%3Aissue+is%3Aopen+label%3Aquestion">
            Question  (用👍投票)
        </a>
    </li>
</ul>

## 开发交流

| 版本 | 微信群 | 内部咚咚群 |
| --- | --- | --- |
| [NutUI React](https://github.com/jdf2e/nutui-react/issues) | <img src="https://storage.360buyimg.com/imgtools/17c67beff6-4acf07c0-609c-11ed-a6ef-69df15b605e4.png" width="100" /> 关注后回复「NutUI-React」 | 1025679314 |
| [NutUI x Taro](https://github.com/jdf2e/nutui/issues) | <img src="https://camo.githubusercontent.com/db4276b4ee4b443158195e943e9e678cb4d2afb7580f70d4d817ef0a90413aec/687474703a2f2f73746f726167652e333630627579696d672e636f6d2f7461726f2d6a642d636f6d2f7374617469632f636f6e746163745f7461726f5f6e757475695f71722e706e67" width="100" /> 关注后回复「NutUI-React」 | 1022545110 |

## 参与共建

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

#### NutUI 社区共建倡议

[NutUI-React 邀您共建，Contributor 您好](https://github.com/jdf2e/nutui-react/discussions/348)

#### 为 NutUI 贡献代码

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

欢迎社区开发者参与共建，在贡献您的代码之前请先阅读 [《NutUI 贡献指南》](https://github.com/jdf2e/nutui-react/discussions/348)。

## 问题反馈与建议

[给 NutUI 提 Issue](https://nutui.jd.com/nutui-issue-helper/?repo=jdf2e/nutui-react&lang=zh-cn)

> 在反馈问题之前，推荐阅读 [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way)、[《如何向开源社区提问题》](https://github.com/seajs/seajs/issues/545)和[《如何有效地报告 Bug》](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs-cn.html)，这样您能够更容易获得理解和帮助。

[参与 NutUI 社区讨论](https://github.com/jdf2e/nutui-react/discussions)

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

## 贡献者们

感谢以下所有给 NutUI 贡献过代码的 [开发者](https://github.com/jdf2e/nutui-react/graphs/contributors)。

<a href="https://github.com/jdf2e/nutui-react/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=jdf2e/nutui-react" />
</a>

## Stargazers

[![Stargazers repo roster for @jdf2e/nutui-react](https://reporoster.com/stars/jdf2e/nutui-react)](https://github.com/jdf2e/nutui-react/stargazers)

## Forkers

[![Forkers repo roster for @jdf2e/nutui-react](https://reporoster.com/forks/jdf2e/nutui-react)](https://github.com/jdf2e/nutui-react/network/members)

## 开发计划

[Milestones](https://github.com/jdf2e/nutui-react/projects)

## 更新日志

本项目遵从 [Angular Style Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153)，更新日志请查阅 [Release](https://github.com/jdf2e/nutui-react/releases)。

## 开源协议

本项目基于 **MIT** 协议