# nutui

**Repository Path**: gester/nutui

## Basic Information

- **Project Name**: nutui
- **Description**: 基于 vite 构建 京东风格移动端 Vue2、Vue3、组件库（支持小程序开发）
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: v4
- **Homepage**: https://nutui.jd.com
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 208
- **Created**: 2024-12-26
- **Last Updated**: 2024-12-26

## Categories & Tags

**Categories**: Uncategorized

**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">JD-style mobile UI components based on Vue2 & Vue3 that support users to develop H5 and mini-programs.</p>

<p align="center">
  <a href="https://github.com/jdf2e/nutui/pulls">
    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" alt="PRs Welcome">
  </a>
  <a href="https://app.codecov.io/gh/jdf2e/nutui">
    <img src="https://img.shields.io/codecov/c/github/jdf2e/nutui" alt="coverage"/>
  </a>
  <a href="https://github.com/jdf2e/nutui/blob/v4/LICENSE">
    <img src="https://img.shields.io/npm/l/@nutui/nutui.svg" alt="license"/>
  </a>
  <a href="https://www.npmjs.com/package/@nutui/nutui">
    <img src="https://img.shields.io/npm/v/@nutui/nutui.svg?style=flat-square">
  </a>
  <a href="https://www.npmjs.com/package/@nutui/nutui">
    <img src="https://img.shields.io/npm/dt/@nutui/nutui.svg?style=flat-square">
  </a>
</p>
<p align="center">
  <a href="https://github.com/jdf2e/nutui/graphs/contributors">
    <img src="https://img.shields.io/github/contributors/jdf2e/nutui" alt="GitHub contributors">
  </a>
  <a href="https://github.com/jdf2e/nutui/commits">
    <img src="https://img.shields.io/github/commit-activity/m/jdf2e/nutui" alt="GitHub commit activity">
  </a>
  <a href="https://github.com/jdf2e/nutui/issues">
    <img src="https://img.shields.io/github/issues-closed/jdf2e/nutui" alt="GitHub closed issues">
  </a>
  <a href="https://github.com/jdf2e/nutui/commits">
    <img src="https://img.shields.io/github/commits-since/jdf2e/nutui/latest/v4" alt="GitHub commits since latest release (by date)">
  </a>
  <a href="https://github.com/jdf2e/nutui/releases">
    <img src="https://img.shields.io/github/release-date/jdf2e/nutui" alt="GitHub Release Date">
  </a>
  <a href="https://www.jsdelivr.com/package/npm/@nutui/nutui">
    <img src="https://data.jsdelivr.com/v1/package/npm/@nutui/nutui/badge" alt="jsdelivr">
  </a>
</p>

<p align="center">
   <img src="https://img12.360buyimg.com/imagetools/jfs/t1/162421/39/13392/9425/6052ea60E592310a9/264bdff23ef5fe95.png" width="164" alt="NutUI" />
  &nbsp;
   <img src="https://img10.360buyimg.com/imagetools/jfs/t1/211804/23/22232/12144/634e4801Eac435cb6/cfd9e1773cf9423d.png" width="167" title="Scan the QR code with JD APP">
  &nbsp;
  <img src="https://storage.360buyimg.com/jdc-article/gh_f2231eb941be_258.jpg" width="166" title="Scan the QR code with WeChat">
  &nbsp;
   <img src="https://img12.360buyimg.com/imagetools/jfs/t1/205124/1/15643/30360/62aad730Ea5734bf9/703bb91a0b73282f.png" width="170" title="Scan the QR code with Alipay">
</p>

---

> Nut[nʌt]: the one Squirrel Scrat pursues resolutely for a lifetime and will never let go even if it causes a catastrophe from the animated film ***Ice Age***.

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

## Features

* 🚀 80+ High Quality Components
* 💪 Write Once, Multi-End Use
* 📖 Based on JD APP 10.0 Visual Specifications
* 🍭 Support Tree Shaking
* 📖 Extensive Documentation and Demos
* 💪 Written in TypeScript
* 💪 Support SSR (Experimental)
* 🍭 Support Custom Themes with 700+ Style Variables
* 🌍 Support i18n
* 🍭 80%+ Unit Test Coverage
* 📖 Provide Sketch Design Resources

## Document

Site: [nutui.jd.com](https://nutui.jd.com)

[@nutui/nutui](https://nutui.jd.com/h5/vue/4x/#/zh-CN/guide/intro): Mobile H5 Components

[@nutui/nutui-taro](https://nutui.jd.com/taro/vue/4x/#/zh-CN/guide/intro): Taro Mini Programs(weapp, alipay, jd...) & Taro-H5

## Links

### Official Ecosystem

| Project | Description | Version |
| --- | --- | --- |
| [@nutui/nutui](https://github.com/jdf2e/nutui) | NutUI H5 | ![nutui](https://img.shields.io/npm/v/@nutui/nutui.svg?label=%20) |
| [@nutui/nutui-taro](https://github.com/jdf2e/nutui) | NutUI Taro | ![nutui](https://img.shields.io/npm/v/@nutui/nutui-taro.svg?label=%20) |
| [@nutui/icons-vue](https://github.com/jdf2e/nutui-icons) | icons of `@nutui/nutui` | ![nutui](https://img.shields.io/npm/v/@nutui/icons-vue.svg?label=%20) |
| [@nutui/icons-vue-taro](https://github.com/jdf2e/nutui-icons) | icons of `@nutui/nutui-taro` | ![nutui](https://img.shields.io/npm/v/@nutui/icons-vue-taro.svg?label=%20) |
| [@nutui/touch-emulator](packages/nutui-touch-emulator) | Using NutUI in desktop browsers | ![nutui](https://img.shields.io/npm/v/@nutui/touch-emulator.svg?label=%20) |
| [@nutui/auto-import-resolver](packages/nutui-auto-import-resolver) | resolver of `unplugin-auto-import` | ![nutui](https://img.shields.io/npm/v/@nutui/auto-import-resolver.svg?label=%20) |
| [@nutui/playground](packages/nutui-playground) | NutUI Playground | - |
| [nutui-demo](https://github.com/jdf2e/nutui-demo) | NutUI Demo | - |

### Community Ecosystem

| Project | Description |
| --- | --- |
| [nutui-uniapp](https://github.com/nutui-uniapp/nutui-uniapp) | uni-app UI Components based on NutUI 4.x |
| [jwaterwater/uni-nutui](https://github.com/jwaterwater/uni-nutui) | uni-app UI Components based on NutUI 3.x |
| [common-intellisense](https://github.com/Simon-He95/common-intellisense) | vscode extension for NutUI 4.x Intellisense |

## Status

![Alt](https://repobeats.axiom.co/api/embed/fd45cb2c6840153af6328b050e87ce01d785b72b.svg "Repobeats analytics image")

## Cases

NutUI has been used in our production environment, and widely used in the industry for cross-platform development.
<p>
<img src="https://raw.githubusercontent.com/jdf2e/nutui-user-cases/master/user-cases.jpg" alt="NutUI" />
</p>
<p><a href="https://nutui.jd.com/#/case">View more cases</a></p>

## Communication

| WeChat Group | JD Dongdong Group |
| --- |--- |
| <img src="https://storage.360buyimg.com/nutui-static/image/wx-code.png" width="100" /> Reply 'NutUI' after following | 82957939 |

## Join Us

### NutUI Community

[*Welcome To NutUI  Community*](https://github.com/jdf2e/nutui/issues/1789)

### Contribute to NutUI

There are some choices of contributing to NutUI as follows, solving issues, fixing bugs, adding new components, i18n, UI customization, platform and cross-end adaptation, etc.

You are very welcome to contribute code to NutUI. Before your pull requests, please read [*NutUI Developer Contributing Guide*](https://github.com/jdf2e/nutui/issues/1671).

## Issue & Discussion

[Report issues to NutUI](https://nutui.jd.com/nutui-issue-helper/?repo=jdf2e/nutui&lang=en)

> It is highly recommended to read [*How To Ask Questions The Smart Way*](http://www.catb.org/~esr/faqs/smart-questions.html), [*How To Ask Questions Of GitHub Community*](https://github.com/seajs/seajs/issues/545) and [*How to Report Bugs Effectively*](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html), then you can get understanding and help more easily.

[NutUI Discussion](https://github.com/jdf2e/nutui/discussions)

If you have any ideas, questions or suggestions, you can share your opinions here.

## Contributors

Thanks to all the following [developers](https://github.com/jdf2e/nutui/graphs/contributors) who have contributed code to NutUI.

<a href="https://github.com/jdf2e/nutui/graphs/contributors">
  <img src="https://opencollective.com/nutui/contributors.svg?width=890&button=false" alt="contributors">
</a>

## Release Notes

[Release](https://github.com/jdf2e/nutui/releases).

## License

[MIT](https://github.com/jdf2e/nutui/blob/v4/LICENSE)

## GitHub Stargazers

![stargazers](https://starchart.cc/jdf2e/nutui.svg)