# c5-mobile [![Build Status](https://travis-ci.org/didi/c5-mobile.svg?branch=master)](https://travis-ci.org/didi/c5-mobile?branch=master) [![codecov.io](http://codecov.io/github/didi/c5-mobile/coverage.svg?branch=master)](http://codecov.io/github/didi/c5-mobile?branch=master)

> A fantastic mobile ui lib implement by Vue.

### Links

- [Home](https://didi.github.io/c5-mobile/)
- [Docs](https://didi.github.io/c5-mobile/#/en-US/docs)
- [Example](https://didi.github.io/c5-mobile/example/)

![Example QR](./assets/example-qr.png)

### Communication

![QQ Community QR](./assets/c5-qq-QR.jpg)

### New c5-mobile project ?

Recommend use the [CLI tools](https://github.com/c5-mobile/c5-template) base on [vue-cli](https://github.com/vuejs/vue-cli) to init the config and base code:

```shell
$ vue init c5-mobile/c5-template projectname
```

### Install

```shell
npm install c5-mobile --save
```

### Usage

```js
import Vue from 'vue'
import Cube from 'c5-mobile'

Vue.use(Cube)
```

#### Use modularized c5-mobile

```js
import Vue from 'vue'
import {
  /* eslint-disable no-unused-vars */
  Style,
  Button,
  ActionSheet
} from 'c5-mobile'

Vue.use(Button)
Vue.use(ActionSheet)
```

For more information, please refer to [Quick Start](https://didi.github.io/c5-mobile/#/en-US/docs/quick-start)

### ToDo

- More components

- Support theme

### Development

```shell
git clone git@github.com:didi/c5-mobile.git
cd c5-mobile
npm install
npm run dev
# or run document development
npm run doc-dev
```

### Changelog

Detailed changes for each release are documented in the [release notes](https://github.com/didi/c5-mobile/releases).