README.md

    logo

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

    PRs Welcome license GitHub contributors GitHub Release Date GitHub commit activity

    NutUI-React   NutUI-React


    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
    • 📖 Based on JD APP 11.0 Visual Specifications
    • 🍭 Support Tree Shaking
    • 📖 Extensive Documentation and Demos
    • 💪 Written in TypeScript
    • 💪 Support SSR (Experimental)
    • 🍭 Support Custom Themes
    • 🍭 90%+ Unit Test Coverage
    • 📖 Provide Sketch Design Resources

    Running locally

    running with H5

    # Clone repository
    git clone https://github.com/jdf2e/nutui-react.git
    
    # Enter the project dictionary
    cd nutui-react
    
    # Install dependencies
    npm install
    
    # Start development
    npm run dev
    
    # visit in browser: http:http://localhost:3000 (you don't have to open it manually if you've run it in the browser again)

    running with mini-program

    # Clone repository
    git clone https://github.com/jdf2e/nutui-react.git
    
    # Enter the project dictionary
    cd nutui-react
    
    # Install dependencies
    npm install
    
    # Start development
    # dir:src/sites/mobile-taro/dist/weapp
    npm run dev:taro:weapp
    
    # OR run as jd mini-program
    # dir:src/sites/mobile-taro/dist/jd
    npm run dev:taro:jd

    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

    Links

    Communication

    Version WeChat Group JD Dongdong Group
    NutUI React Reply 「NutUI-React」 after following 1025679314
    NutUI x Taro Reply 「NutUI-React」 after following 1022545110

    Join Us

    NutUI Community

    Welcome To NutUI-React 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](https://github.com/ryanhanwu/, 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

    Stargazers

    Stargazers repo roster for @jdf2e/nutui-react

    Forkers

    Forkers repo roster for @jdf2e/nutui-react

    Milestones

    Milestones

    Release Notes

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

    Open Source License

    This project is based on MIT protocol

    项目简介

    当前项目暂无项目简介

    发行版本

    当前项目没有发行版本

    贡献者 56

    全部贡献者

    开发语言

    • TypeScript 81.9 %
    • SCSS 11.1 %
    • HTML 4.3 %
    • JavaScript 2.1 %
    • CSS 0.6 %