README.md 2.3 KB
Newer Older
L
上传  
lilinsen 已提交
1 2 3
# NutUI 2
![npm version](https://img.shields.io/npm/v/@nutui/nutui.svg)  [![Build Status](https://api.travis-ci.org/jdf2e/nutui.svg?branch=master)](https://github.com/jdf2e/nutui/) [![Coverage Status](https://coveralls.io/repos/github/jdf2e/nutui/badge.svg?branch=master)](https://coveralls.io/github/jdf2e/nutui?branch=master) ![license](https://img.shields.io/npm/l/@nutui/nutui.svg)
 
F
update  
Frans 已提交
4
A light mobile Toolkit based on Vue
L
上传  
lilinsen 已提交
5 6 7
    
![NutUI](https://img11.360buyimg.com/uba/jfs/t1/11117/21/3608/18942/5c20ab52E35e5a500/02e3c1f89cd3dad1.png)

F
Frans 已提交
8
English | [简体中文](./README-zh_CN.md)
L
上传  
lilinsen 已提交
9

F
update  
Frans 已提交
10
## Features
L
上传  
lilinsen 已提交
11

F
update  
Frans 已提交
12 13 14 15 16 17 18 19 20 21 22 23
* Cross-platform,automatically convert to WeChat Mini Program components(coming soon)
* New structure
* Used by 30+ JD mobile projects
* Refer to JD APP 7.0 visual specification
* On-demand loading Support
* Detailed documents and examples
* Customize themes Support
* Multiple languages Support (Internationalization)
* TypeScript Support
* Vue Server-side Rendering Support(Vue SSR)
* Unit test blessing
* A Webpack-based build tool is available to quickly create a Vue project with this component library built in 
L
上传  
lilinsen 已提交
24

F
update  
Frans 已提交
25
> If you want to use the 1.x version, please specify the version number when installing,such as: `npm i @nutui/nutui@1.3.2 -S`
L
上传  
lilinsen 已提交
26

F
update  
Frans 已提交
27
## Environment Support
L
上传  
lilinsen 已提交
28 29 30

* Android 4.0+
* iOS 8.0+
F
update  
Frans 已提交
31
* Support Vue Server-side Rendering
L
上传  
lilinsen 已提交
32

F
update  
Frans 已提交
33
## Version
L
上传  
lilinsen 已提交
34

F
update  
Frans 已提交
35
* Stable:[![npm](https://img.shields.io/npm/v/@nutui/nutui.svg)](https://www.npmjs.com/package/@nutui/nutui)
L
上传  
lilinsen 已提交
36

F
update  
Frans 已提交
37
> You can also subscribe to: https://github.com/jdf2e/nutui/releases.atom for the notifications of stable releases。
L
上传  
lilinsen 已提交
38

F
update  
Frans 已提交
39
## Examples
L
上传  
lilinsen 已提交
40

F
update  
Frans 已提交
41
![NutUI Demo](https://img14.360buyimg.com/uba/s260x260_jfs/t1/32118/11/559/2782/5c3d81ecEbda0c0f1/5f2b637d11817204.png)
L
上传  
lilinsen 已提交
42

F
update  
Frans 已提交
43
## Installation
L
上传  
lilinsen 已提交
44

F
update  
Frans 已提交
45
Please refer to the NutUI offcial website for the details on how to use it 
L
上传  
lilinsen 已提交
46 47 48

https://nutui.jd.com

F
update  
Frans 已提交
49
Documents:[2.X](https://nutui.jd.com/default.html#/start) | [1.X](https://nutui.jd.com/1x/index.html#/intro)
L
上传  
lilinsen 已提交
50

F
update  
Frans 已提交
51 52 53 54 55 56
## Links
* [Feedback](https://github.com/jdf2e/nutui/issues)
* [Change Logs](https://github.com/jdf2e/nutui/releases)
* [On-demand plugins](https://www.npmjs.com/package/@nutui/babel-plugin-separate-import)
* [Template project command line tool(Gaea-cli)](https://github.com/jdf2e/Gaea4)
* Contact us:nutui@jd.com
L
上传  
lilinsen 已提交
57 58


F
update  
Frans 已提交
59
## Open Source LICENSE
L
上传  
lilinsen 已提交
60

F
update  
Frans 已提交
61
Based on **MIT** LICENSE