Skip to content

Latest commit

 

History

History
224 lines (163 loc) · 8.89 KB

README_EN.md

File metadata and controls

224 lines (163 loc) · 8.89 KB
Raw

logo

JD-style mobile UI components based on Vue2 & Vue3 that support users to develop H5 and mini-programs.

PRs Welcome Coverage Status license

GitHub contributors GitHub commit activity GitHub closed issues GitHub commits since latest release (by date) GitHub Release Date

NutUI      

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.

简体中文 | 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

// Vue2
npm i @nutui/nutui@2
// Vue3 H5
npm i @nutui/nutui
// Vue3 Mini Programs
npm i @nutui/nutui-taro

Usage

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

Awesome-NutUI

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.

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 <script> tag), it is recommended to use the umd compressed version.

  • es nutui.es.js

  • umd nutui.umd.js

Cases

NutUI has been used in our production environment, and widely used in the industry for cross-platform development.

NutUI

View more cases

We are collecting more excellent cases, please click here to submit.

Links

Communication

Version WeChat Group JD Dongdong Group
NutUI Vue Reply 'NutUI' after following 82957939
NutUI x Taro Reply 'NutUI' after following 1022545110

Join Us

NutUI Community

Welcome To NutUI Community

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.

Issue & Discussion

Report issues to NutUI

It is highly recommended to read How To Ask Questions The Smart Way, How To Ask Questions Of GitHub Community and How to Report Bugs Effectively, then you can get understanding and help more easily.

NutUI Discussion

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

Contributors

Thanks to all the following developers who have contributed code to NutUI.

contributors

Milestones

Milestones

Release Notes

NutUI follows Angular Style Commit Message Conventions. The up-to-date release notes are available on Release.

Github Stargazers

stargazers