# nutui
**Repository Path**: silverlong/nutui
## Basic Information
- **Project Name**: nutui
- **Description**: 基于 vite 构建 京东风格移动端 Vue2、Vue3、组件库（支持小程序开发）
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: next
- **Homepage**: https://nutui.jd.com
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 213
- **Created**: 2022-11-03
- **Last Updated**: 2022-11-03
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
JD-style mobile UI components based on Vue2 & Vue3 that support users to develop H5 and mini-programs.
---
> 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
* 🚀 70+ 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
## Installation
```bash
// Vue2
npm i @nutui/nutui@2
```
```bash
// Vue3 H5
npm i @nutui/nutui
```
```bash
// Vue3 Mini Programs
npm i @nutui/nutui-taro
```
## Usage
```js
import { createApp } from "vue";
import App from "./App.vue";
// Note: It will import all components in this way.
import NutUI from "@nutui/nutui";
// Delete the global style import if you customize for tree shaking.
import "@nutui/nutui/dist/style.css";
createApp(App).use(NutUI).mount("#app");
```
## Resources
[NutUI Quick Start](https://www.bilibili.com/video/BV14r4y1e7LK)
[Awesome-NutUI](https://github.com/jdf2e/nutui/blob/next/awesome.md)
## Themes
NutUI provides several sets of official themes from actual business inside JD.com. If they don't meet your needs, you can use Online Theme Editor.
* JD APP 10.0 Design (Vue3, default)
* JDT Design (Vue3)
* JD ToB Mall Design (Vue3)
* JD Enterprise Business Design (Vue3)
* JDL Design (Vue2)
## Version Intros
> `@nutui/nutui` and `@nutui/nutui-taro` are parallel versions with some differences. The version numbers are always the same. If you need compatibility with versions below iOS 10, please use `@nutui/nutui@2` .
* `NutUI 2x` and `NutUI-JDL` are built with Vue2 which support modern browsers, Android >= 4.0, iOS >= 8.0 and only for H5.
* `NutUI 3x` is built with Vue3 which supports modern browsers, Chrome >= 51 and iOS >= 10.0. You can use it to develop both H5 and mini-programs.
## Build Versions
> If you are using AMD environment or build tools such as Webpack, Vite, etc., we recommend using the `es` version. If it is a non-module environment (such as direct reference through the `