1 | <p align="center"><img width="80" src="https://pt-starimg.didistatic.com/static/starimg/img/BSHOVw2pyT1620726744938.png" alt="LOGO"></p>
|
2 | <h2 align="center">mand-mobile</h2>
|
3 | <p align="center">A mobile UI toolkit, based on Vue.js 2, designed for financial scenarios</p>
|
4 | <p align="center">
|
5 | <a href="https://travis-ci.org/didi/mand-mobile"><img src="https://img.shields.io/travis/didi/mand-mobile/master.svg?style=flat-square" alt="Build Status"></a>
|
6 | <a href="https://codecov.io/gh/didi/mand-mobile"><img src="https://img.shields.io/codecov/c/github/didi/mand-mobile/master.svg?style=flat-square" alt="codecov"></a>
|
7 | <a href="https://www.npmjs.org/package/mand-mobile"><img src="https://img.shields.io/npm/v/mand-mobile.svg?style=flat-square" alt="npm package"></a>
|
8 | <a href="https://www.npmjs.org/package/mand-mobile"><img src="http://img.shields.io/npm/dm/mand-mobile.svg?style=flat-square" alt="npm downloads"></a>
|
9 | <a href="https://www.jsdelivr.com/package/npm/mand-mobile"><img src="https://data.jsdelivr.com/v1/package/npm/mand-mobile/badge" alt="jsdelivr"></a>
|
10 | <a href="https://www.npmjs.org/package/mand-mobile"><img src="https://img.shields.io/npm/l/mand-mobile.svg?style=flat-square" alt="License"></a>
|
11 | <br/>
|
12 | <a href="https://unpkg.com/mand-mobile/"><img src="http://img.badgesize.io/https://unpkg.com/mand-mobile/lib/mand-mobile.umd.js?compression=gzip&label=gzip%20size:%20JS&style=flat-square" alt="gzip js size"></a>
|
13 | <a href="https://unpkg.com/mand-mobile/"><img src="http://img.badgesize.io/https://unpkg.com/mand-mobile/lib/mand-mobile.css?compression=gzip&label=gzip%20size:%20CSS&style=flat-square" alt="gzip css size"></a>
|
14 | </p>
|
15 | <p align="center"><img src="https://pt-starimg.didistatic.com/static/starimg/img/toa8XOspJG1555486253802.png" width="800"></p>
|
16 | <br/>
|
17 |
|
18 | **English** | [中文](./README.zh-CN.md)
|
19 |
|
20 | ## Links
|
21 |
|
22 | * [Home](https://didi.github.io/mand-mobile/)
|
23 | * [Development Guide](site/docs/development.md)
|
24 | * [Change Log](CHANGELOG.md)
|
25 | * [Examples](https://didi.github.io/mand-mobile/examples/)
|
26 | * [Palette](https://github.com/mand-mobile/palette)
|
27 | * [Mand Mobile Organization](https://github.com/mand-mobile)
|
28 |
|
29 | ## Preview
|
30 |
|
31 | You can scan the following QR code to access the examples:
|
32 |
|
33 | <img src="https://manhattan.didistatic.com/static/manhattan/mand-mobile/2.0/docs/mand-doc-home-qrcode.png" alt="Mand Mobile Examples" width="200"/>
|
34 |
|
35 | ## Install & Usage
|
36 |
|
37 | ### Template for new project
|
38 |
|
39 | #### Vue CLI 2
|
40 | New project can be initialized and integrated with mand-mobile by [vue-cli-2](https://github.com/vuejs/vue-cli/tree/v2) with [mand-mobile-template](https://github.com/mand-mobile/mand-mobile-template).
|
41 |
|
42 | ```bash
|
43 | vue init mand-mobile/mand-mobile-template my-project
|
44 | ```
|
45 |
|
46 | #### Vue CLI 3
|
47 | New project can be initialized and integrated with mand-mobile by [vue-cli](https://github.com/vuejs/vue-cli/tree/master) with [vue-cli-plugin-mand](https://github.com/mand-mobile/vue-cli-plugin-mand).
|
48 |
|
49 | ```bash
|
50 | vue create my-project
|
51 | cd my-project
|
52 | npm install --save-dev vue-cli-plugin-mand
|
53 | vue invoke mand
|
54 | ```
|
55 |
|
56 | ### Manually
|
57 |
|
58 | ```bash
|
59 | npm install mand-mobile --save
|
60 | ```
|
61 |
|
62 | ### Import
|
63 |
|
64 | * Use <a href="https://github.com/ant-design/babel-plugin-import" target="_blank">babel-plugin-import</a>
|
65 | or
|
66 | <a href="https://github.com/Brooooooklyn/ts-import-plugin" target="_blank">ts-import-plugin</a> (Recommended)
|
67 |
|
68 | ```javascript
|
69 | import { Button } from 'mand-mobile'
|
70 | ```
|
71 |
|
72 | * Manually import
|
73 |
|
74 | ```javascript
|
75 | import Button from 'mand-mobile/lib/button'
|
76 | ```
|
77 |
|
78 | * Totally import
|
79 |
|
80 | ```javascript
|
81 | import Vue from 'vue'
|
82 | import mandMobile from 'mand-mobile'
|
83 | import 'mand-mobile/lib/mand-mobile.css'
|
84 |
|
85 | Vue.use(mandMobile)
|
86 | ```
|
87 |
|
88 | ### Usage
|
89 |
|
90 | Select the components you need to build your webapp. Find more details in [Quick Start](https://didi.github.io/mand-mobile/#/en-US/docs/started).
|
91 |
|
92 | ## Development
|
93 |
|
94 | ```bash
|
95 | git clone git@github.com:didi/mand-mobile.git
|
96 | cd mand-mobile
|
97 | npm install
|
98 | npm run dev
|
99 | ```
|
100 | Open your browser and visit http://127.0.0.1:4000. Find more details in [Development Guide](https://didi.github.io/mand-mobile/#/en-US/docs/development).
|
101 |
|
102 | ## Contributing [![PR](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/didi/mand-mobile/pulls)
|
103 | Welcome to contribute by creating issues or sending pull requests. See [Contributing Guide](CONTRIBUTING.md) for guidelines.
|
104 |
|
105 | ## Community
|
106 |
|
107 | <img src="https://pt-starimg.didistatic.com/static/starimg/img/KitzF6QlrR1543994331272.jpg" alt="Mand Mobile Community" width="200"/>
|
108 |
|
109 | ## License
|
110 | Mand Mobile is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file.
|
111 |
|
112 | ## Useful Links
|
113 |
|
114 | * [Hummer](https://github.com/didi/Hummer) is a set of high-performance and highly available cross-terminal development framework, a set of code can support the development of Android and iOS applications at the same time. Now supports Vue/TypeScript/JavaScript, for front-end developers, there is always one suitable for you.
|
115 |
|
116 | * [DoraemonKit](https://github.com/didi/DoraemonKit) /'dɔ:ra:'emɔn/: A full-featured App (iOS & Android) development assistant. You deserve it.
|
117 |
|
118 | * [Chameleon](https://github.com/didi/chameleon) /kəˈmiːlɪən/: Unify all platforms(Web/Weex/Mini program) with MVVM. Focus on Write Once Run AnyWhere. |
\ | No newline at end of file |