|
|
@@ -1,58 +1,141 @@
|
|
|
-# NutUI 3
|
|
|
- [](https://github.com/jdf2e/nutui/) [](https://coveralls.io/github/jdf2e/nutui?branch=master) 
|
|
|
-
|
|
|
-京东风格的轻量级移动端 Vue2、Vue3 组件库(支持多端小程序开发)
|
|
|
-
|
|
|
-
|
|
|
-
|
|
|
-
|
|
|
-## 特性
|
|
|
-
|
|
|
-* 70+ 高质量组件(3.0 持续开发中)
|
|
|
-* 支持小程序开发
|
|
|
-* 基于京东APP 10.0 视觉规范
|
|
|
-* 支持按需引用
|
|
|
-* 详尽的文档和示例
|
|
|
-* 支持 TypeScript
|
|
|
-* 支持服务端渲染(测试阶段)
|
|
|
-* 支持定制主题
|
|
|
-* 单元测试覆盖(3.0 开发中)
|
|
|
+
|
|
|
+<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">京东风格的轻量级移动端 Vue2、Vue3 组件库</p>
|
|
|
+
|
|
|
+<p align="center">(支持一套代码生成 H5 和小程序)</p>
|
|
|
+
|
|
|
+<p align="center">
|
|
|
+ <img src="https://img.shields.io/npm/v/@nutui/nutui.svg" alt="npm version" />
|
|
|
+ <img src="https://api.travis-ci.org/jdf2e/nutui.svg?branch=master" alt="CI Status" />
|
|
|
+ <img src="https://coveralls.io/repos/github/jdf2e/nutui/badge.svg?branch=master" alt="Coverage Status" />
|
|
|
+ <img src="https://img.shields.io/npm/l/@nutui/nutui.svg" alt="license"/>
|
|
|
+</p>
|
|
|
+
|
|
|
+<!-- <p align="center">
|
|
|
+ <a href="https://www.oschina.net/project/top_cn_2021/?id=65&fr=nutui" style="width:600px;height:60px;background:#f00;color:#fff;padding:5px;">
|
|
|
+ NutUI 正在参加《2021 年度 OSC 中国开源项目》评选,请为我们投上宝贵的一票吧。 去投票💪
|
|
|
+ </a>
|
|
|
+</p> -->
|
|
|
+
|
|
|
+<p align="center">
|
|
|
+ <a href="https://www.oschina.net/project/top_cn_2021/?id=65&fr=nutui">
|
|
|
+ <img src="https://img11.360buyimg.com/imagetools/jfs/t1/139357/25/22692/81953/61b1bd11E7615bca2/f6eec2f25c6b8914.jpg" width="600" alt="license"/>
|
|
|
+ </a>
|
|
|
+</p>
|
|
|
+
|
|
|
+---
|
|
|
+
|
|
|
+
|
|
|
+## 特性
|
|
|
+
|
|
|
+* 🚀 70+ 高质量组件(3.0 持续开发中),覆盖移动端主流场景
|
|
|
+* 💪 支持小程序开发
|
|
|
+* 📖 基于京东APP 10.0 视觉规范
|
|
|
+* 🍭 支持按需引用
|
|
|
+* 📖 详尽的文档和示例
|
|
|
+* 💪 支持 TypeScript
|
|
|
+* 💪 支持服务端渲染(测试阶段)
|
|
|
+* 🍭 支持定制主题
|
|
|
+* 🍭 单元测试覆盖(3.0 开发中),保障稳定性
|
|
|
+* 📖 提供 Sketch 设计资源
|
|
|
|
|
|
## 示例 H5 & 小程序
|
|
|
|
|
|
-<img src="https://img12.360buyimg.com/imagetools/jfs/t1/162421/39/13392/9425/6052ea60E592310a9/264bdff23ef5fe95.png" width="200" alt="NutUI" />
|
|
|
-<img src="https://storage.360buyimg.com/jdc-article/gh_f2231eb941be_258.jpg" width="200" alt="NutUI" />
|
|
|
+<p>
|
|
|
+ <img src="https://img12.360buyimg.com/imagetools/jfs/t1/162421/39/13392/9425/6052ea60E592310a9/264bdff23ef5fe95.png" width="100" alt="NutUI" />
|
|
|
+ <img src="https://storage.360buyimg.com/jdc-article/gh_f2231eb941be_258.jpg" style="margin-left:40px" width="100" alt="NutUI" />
|
|
|
+</p>
|
|
|
+
|
|
|
+## 版本说明 & 支持环境
|
|
|
+
|
|
|
+> @nutui/nutui@next 和 @nutui/nutui-taro 属于并行版本,存在部分的差异化,版本号始终保持一致
|
|
|
+
|
|
|
+> 如果想要兼容低版本,请使用 @nutui/nutui
|
|
|
+
|
|
|
+* @nutui/nutui 基于 Vue2 视觉风格 JD APP 7.0 规范 ,只能开发 h5;支持现代浏览器以及 Android >= 4.0、iOS >= 8.0
|
|
|
|
|
|
-## 支持环境
|
|
|
+* @nutui/nutui-jdl 基于 Vue2 视觉风格 JDL 规范 ,只能开发 h5;支持现代浏览器以及 Android >= 4.0、iOS >= 8.0
|
|
|
|
|
|
-* Android 5.0+
|
|
|
-* iOS 9.2+
|
|
|
+* @nutui/nutui@next 基于 Vue3 视觉风格 JD APP 10.0规范 ,只能开发 h5;支持现代浏览器以及 Chrome >= 51、iOS >= 10.0(与 Vue3 一致)
|
|
|
+
|
|
|
+* @nutui/nutui-taro 基于 Vue3 视觉风格 JD APP 10.0规范 ,必须基于 Taro + Vue3 框架 进行开发多端(多端指一套代码 部署多端环境 微信小程序 h5 等第三方小程序);支持现代浏览器以及 Chrome >= 51、iOS >= 10.0(与 Vue3 一致)
|
|
|
|
|
|
-> 如果想要兼容低版本,请使用 NutUI2.x
|
|
|
|
|
|
## 构建版本
|
|
|
|
|
|
+> AMD 环境、Webpack、Vite 等构建工具环境、服务端建议使用 es 版,非模块化环境(如通过 `<script>` 标签直接引用)建议使用 umd 压缩版。
|
|
|
+
|
|
|
* es **nutui.es.js**
|
|
|
+
|
|
|
* umd **nutui.umd.js**
|
|
|
|
|
|
-## 安装使用
|
|
|
|
|
|
-具体安装使用方法请参考 NutUI 官网 https://nutui.jd.com
|
|
|
+## 使用案例
|
|
|
+
|
|
|
+NutUI 已经投入了我们的生产环境中使用,业界也在广泛地使用 NutUI 开发多端应用。
|
|
|
+
|
|
|
+<img src="https://raw.githubusercontent.com/jdf2e/nutui-user-cases/master/user-cases.jpg" width="800" alt="NutUI" />
|
|
|
+
|
|
|
+<p>
|
|
|
+ <a href="https://github.com/jdf2e/nutui-user-cases">
|
|
|
+ 查看等多的案例,请点击
|
|
|
+ </a>
|
|
|
+</p>
|
|
|
+
|
|
|
+<p>
|
|
|
+ <a href="https://github.com/jdf2e/nutui-user-cases/edit/master/index.js">
|
|
|
+ 我们正在征集更多优秀案例,欢迎点击提交
|
|
|
+ </a>
|
|
|
+</p>
|
|
|
+
|
|
|
+## 链接
|
|
|
+
|
|
|
+<ul>
|
|
|
+ <li>
|
|
|
+ <a href="https://github.com/jdf2e/nutui/discussions">
|
|
|
+ Discussions (用👍投票)
|
|
|
+ </a>
|
|
|
+ </li>
|
|
|
+ <li>
|
|
|
+ <a href="https://github.com/jdf2e/nutui/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22">
|
|
|
+ Feature Requests (用👍投票)
|
|
|
+ </a>
|
|
|
+ </li>
|
|
|
+ <li>
|
|
|
+ <a href="https://github.com/jdf2e/nutui/labels/bug%203.0">
|
|
|
+ Bugs (用👍投票)
|
|
|
+ </a>
|
|
|
+ </li>
|
|
|
+ <li>
|
|
|
+ <a href="https://github.com/jdf2e/nutui/issues?q=is%3Aissue+is%3Aopen+label%3Aquestion">
|
|
|
+ Question (用👍投票)
|
|
|
+ </a>
|
|
|
+ </li>
|
|
|
+</ul>
|
|
|
+
|
|
|
+## 更多反馈途径
|
|
|
+
|
|
|
+| Github Issue | 微信群 |京东内部咚咚群 |
|
|
|
+| --- | --- |--- |
|
|
|
+| [jdf2e/nutui/issues](https://github.com/jdf2e/nutui/issues) | <img src="https://nutui.jd.com/3x/3.1.12/vx-code1.png" width="60" /> 关注后回复「NutUI」 | [82957939](timline://chat/?topin=82957939&type=2)|
|
|
|
+
|
|
|
+## 贡献者们
|
|
|
+
|
|
|
+感谢以下小伙伴们为 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>
|
|
|
|
|
|
-你可以使用 Gitpod 进行在线开发:
|
|
|
+## 参与共建
|
|
|
|
|
|
-[](https://gitpod.io/#https://github.com/jdf2e/nutui.git)
|
|
|
+请参考 [贡献指南](https://nutui.jd.com/#/contributing)。
|
|
|
|
|
|
-或者克隆到本地开发:
|
|
|
+我们非常欢迎你给我们提 [PR](https://github.com/jdf2e/nutui/pulls) ,参与共建。当然关于 NutUI 建设的方方面面,我们都欢迎和感谢你给我们提供好的建议和想法。
|
|
|
|
|
|
-```bash
|
|
|
-$ git clone https://github.com/jdf2e/nutui.git
|
|
|
-$ cd nutui
|
|
|
-$ npm install
|
|
|
-$ npm run dev
|
|
|
-```
|
|
|
|
|
|
## 开源协议
|
|
|
|