mand-mobile/README.zh-CN.md

120 lines
5.0 KiB
Markdown
Raw Permalink Normal View History

2021-05-11 17:53:59 +08:00
<div align="center"><img width="80" src="https://pt-starimg.didistatic.com/static/starimg/img/BSHOVw2pyT1620726744938.png" alt="LOGO"></div>
2019-04-17 15:37:28 +08:00
<h2 align="center">mand-mobile</h2>
<p align="center">面向金融场景的移动端UI组件库基于Vue.js实现</p>
<p align="center">
<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>
<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>
<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>
<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>
2020-04-09 16:36:47 +08:00
<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>
2019-04-17 15:37:28 +08:00
<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>
<br/>
<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>
<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>
</p>
<div align="center"><img src="https://pt-starimg.didistatic.com/static/starimg/img/toa8XOspJG1555486253802.png" width="800"></div>
<br/>
2018-05-07 17:44:02 +08:00
2018-12-12 17:24:41 +08:00
[English](./README.md) | **中文**
2018-05-07 17:44:02 +08:00
## 链接
* [首页](https://didi.github.io/mand-mobile/)
* [开发指南](site/docs/development.md)
* [更新日志](CHANGELOG.md)
* [示例集合](https://didi.github.io/mand-mobile/examples/)
2018-06-13 11:28:19 +08:00
* [调色板](https://github.com/mand-mobile/palette)
* [更多](https://github.com/mand-mobile)
2018-05-07 17:44:02 +08:00
## 预览
扫描下方二维码,打开示例集合进行预览:
2018-12-14 19:51:38 +08:00
<img src="https://manhattan.didistatic.com/static/manhattan/mand-mobile/2.0/docs/mand-doc-home-qrcode.png" alt="Mand Mobile Examples" width="200"/>
2018-05-07 17:44:02 +08:00
## 安装 & 使用
2018-08-01 14:13:38 +08:00
### CLI
2018-05-07 17:44:02 +08:00
2018-08-01 14:13:38 +08:00
#### Vue CLI 2
通过[mand-mobile-template](https://github.com/mand-mobile/mand-mobile-template)创建新项目。
2018-05-07 17:44:02 +08:00
```bash
vue init mand-mobile/mand-mobile-template my-project
```
2018-08-01 14:13:38 +08:00
#### Vue CLI 3
通过[vue-cli-plugin-mand](https://github.com/mand-mobile/vue-cli-plugin-mand)向 Vue CLI 3 新建的项目里初始化。(默认支持按需引用)
```bash
vue create my-project
cd my-project
npm install --save-dev vue-cli-plugin-mand
vue invoke mand
```
### 手动安装
在已有项目里手动安装 Mand Mobile 的包。
2018-05-07 17:44:02 +08:00
```bash
npm install mand-mobile --save
```
### 引入
* 使用 <a href="https://github.com/ant-design/babel-plugin-import" target="_blank">babel-plugin-import</a>
<a href="https://github.com/Brooooooklyn/ts-import-plugin" target="_blank">ts-import-plugin</a> (推荐)
```javascript
import { Button } from 'mand-mobile'
```
* 按需引入
```javascript
import Button from 'mand-mobile/lib/button'
```
* 全量引入
```javascript
import Vue from 'vue'
import mandMobile from 'mand-mobile'
import 'mand-mobile/lib/mand-mobile.css'
Vue.use(mandMobile)
```
### 使用
2019-07-22 11:35:35 +08:00
选择需要的组件开始构建您的webapp详细内容请查看[快速上手](https://didi.github.io/mand-mobile/#/zh-CN/docs/started)。
2018-05-07 17:44:02 +08:00
## 开发
```bash
git clone git@github.com:didi/mand-mobile.git
cd mand-mobile
npm install
npm run dev
```
2019-07-22 11:35:35 +08:00
打开浏览器访问http://127.0.0.1:4000 详细内容请查看[开发指南](https://didi.github.io/mand-mobile/#/zh-CN/docs/development)。
2018-05-07 17:44:02 +08:00
2018-12-12 17:24:41 +08:00
## 贡献 [![PR](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/didi/mand-mobile/pulls)
2018-05-07 17:44:02 +08:00
如有任何的意见或建议欢迎您通过创建Issue或Pull Request的方式告知我们请先阅读[贡献指南](CONTRIBUTING.md)。
2018-12-12 17:24:41 +08:00
## 社区
<img src="https://pt-starimg.didistatic.com/static/starimg/img/KitzF6QlrR1543994331272.jpg" alt="Mand Mobile Community" width="200"/>
2018-05-07 17:44:02 +08:00
## 证书
2020-03-05 11:58:05 +08:00
Mand Mobile使用Apache License 2.0,查看[证书](LICENSE)。
## 友情链接
2021-05-11 17:53:59 +08:00
* [Hummer](https://github.com/didi/Hummer)是一套高性能高可用的跨端开发框架,一套代码可以同时支持开发 Android 和 iOS 应用。现已经支持 Vue/TypeScript/JavaScript面向大前端开发人员总有一款适合你。
2020-03-05 11:58:05 +08:00
2021-05-11 17:53:59 +08:00
* [DoraemonKit](https://github.com/didi/DoraemonKit) /'dɔ:ra:'emɔn/简称DoKit 一款功能齐全的客户端( iOS 、Android、微信小程序 )研发助手,你值得拥有。
* [Chameleon](https://github.com/didi/chameleon)/kəˈmiːlɪən/简写CML中文意思变色龙意味着就像变色龙一样能适应不同环境的跨端整体解决方案达到真正意义上"一套代码,多端运行"的终极目标。