hyperq / nutui Goto Github PK

京东风格的轻量级 Vue 组件库，支持移动端 H5 和 小程序开发

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

简体中文 | English

• 🚀 70+ 高质量组件，覆盖移动端主流场景
• 💪 支持一套代码同时开发 H5+多端小程序
• 📖 基于京东APP 10.0 视觉规范
• 🍭 支持按需引用
• 📖 详尽的文档和示例
• 💪 支持 TypeScript
• 💪 支持服务端渲染（测试阶段）
• 🍭 支持组件级别定制主题，内置 700+ 个变量
• 🌍 国际化支持，已支持英文，印尼语和繁体中文
• 🍭 单元测试覆盖率超过 80%，保障稳定性
• 📖 提供 Sketch 设计资源

官网：nutui.jd.com

@nutui/nutui：适用于移动端 H5 页面开发

@nutui/nutui-taro：支持开发 Taro 多端小程序（微信、支付宝、京东等小程序）和 Taro-H5 项目

// H5 项目
npm i @nutui/nutui

// Taro 小程序项目
npm i @nutui/nutui-taro

目前 NutUI 有以下版本：

• NutUI 4.x，默认推荐版本，定期迭代更新发版。
• NutUI 3.x，长期维护版本，会同步 V4 版本问题修复，不对 API 做调整，不定期发版。
• NutUI 2.x，仅修复重要阻塞性问题，不定期发版。

import { createApp } from "vue"
import App from "./App.vue"

import NutUI from "@nutui/nutui"
import "@nutui/nutui/dist/style.css"

createApp(App).use(NutUI).mount("#app")

NutUI 实战快速入门

awesome-nutui

我们提供了几套官方主题，来自京东内部实际业务，欢迎在项目中使用，如果不能满足需求，你也可以使用 ConfigProvider 组件自定义主题。

• 京东APP视觉（Vue3，默认）
• 京东零售B商城主题（Vue3）
• 京东企业业务主题（Vue3）
• 京东科技视觉（Vue3，NutUI3.0）
• 京东物流视觉（Vue2，NutUI2.0）

NutUI 已经投入了我们的生产环境中使用，业界也在广泛地使用 NutUI 开发多端应用。

更多案例

我们正在征集社区优秀案例，欢迎点击提交

• Discussions (用👍投票)
• Feature Requests (用👍投票)
• Bugs (用👍投票)
• Question (用👍投票)

版本	微信群	内部咚咚群
NutUI Vue	回复「NutUI」	82957939
NutUI x Taro	回复「NutUI」	1022545110

NutUI 邀您共建，Contributor 您好

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

欢迎社区开发者参与共建，在贡献您的代码之前请先阅读 《NutUI 贡献指南》。

给 NutUI 提 Issue

在反馈问题之前，推荐阅读 《提问的智慧》、《如何向开源社区提问题》和《如何有效地报告 Bug》，这样您能够更容易获得理解和帮助。

参与 NutUI 社区讨论

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

感谢以下所有给 NutUI 贡献过代码的 开发者。

Milestones

本项目遵从 Angular Style Commit Message Conventions，更新日志请查阅 Release。