UNPKG

antd-mobile/README.md

Version:

2.25 kBMarkdownView Raw

1<p align="center">
2  <a href="http://mobile.ant.design">
3    <img width="320" src="https://zos.alipayobjects.com/rmsportal/XyhtJExcOrXZnLv.png">
4  </a>
5</p>
6
7# Ant Design Mobile
8[![](https://img.shields.io/travis/ant-design/ant-design-mobile.svg?style=flat-square)](https://travis-ci.org/ant-design/ant-design-mobile) [![npm package](https://img.shields.io/npm/v/antd-mobile.svg?style=flat-square)](https://www.npmjs.org/package/antd-mobile) [![NPM downloads](http://img.shields.io/npm/dm/antd-mobile.svg?style=flat-square)](https://npmjs.org/package/antd-mobile) [![Dependency Status](https://david-dm.org/ant-design/ant-design-mobile.svg?style=flat-square)](https://david-dm.org/ant-design/ant-design-mobile) [![CDNJS](https://img.shields.io/cdnjs/v/antd-mobile.svg?style=flat-square)](https://cdnjs.com/libraries/antd-mobile)
9
10A configurable Mobile UI specification and React-based implementation.
11
12## Features
13
14- Follow Ant Design Mobile UI specification.
15- Configurable UI style for different products.
16- Support web and native usages based on React Native.
17- Develop in TypeScript.
18
19## Demo
20
21### mobile web demo
22
23<img width="250" src="https://zos.alipayobjects.com/rmsportal/dLMGiKuyFLBfYfm.png" />
24
25http://mobile.ant.design/kitchen-sink/
26
27### react native demo
28
29<img width="250" src="https://cloud.githubusercontent.com/assets/1698185/18130654/6ba4ccea-6fc2-11e6-9aa1-0a53cd74d9e1.png" />
30
31## Install & Usage
32
33[introduce](docs/react/introduce.zh-CN.md#安装)
34
35## Browser Support
36
37- `iOS`
38- `Android 4.0+`
39
40## Links
41
42- [Home Page](http://mobile.ant.design)
43- [Developer Instruction](http://github.com/ant-design/ant-design-mobile/blob/master/development.md)
44- [React components](http://github.com/react-component/)
45
46## Contributing
47
48We welcome all contributions, please read our [CONTRIBUTING.md](https://github.com/ant-design/ant-design-mobile/blob/master/.github/CONTRIBUTING.md) first. You can submit any ideas as [pull requests](https://github.com/ant-design/ant-design-mobile/pulls) or as a [GitHub issue](https://github.com/ant-design/ant-design-mobile/issues). If you'd like to improve code, check out the [Development Instruction](https://github.com/ant-design/ant-design-mobile/blob/master/development.md) and have a good time! :)

1	`<p align="center">`
2	`<a href="http://mobile.ant.design">`
3	`<img width="320" src="https://zos.alipayobjects.com/rmsportal/XyhtJExcOrXZnLv.png">`
4	`</a>`
5	`</p>`
6
7	`# Ant Design Mobile`
8	[![](https://img.shields.io/travis/ant-design/ant-design-mobile.svg?style=flat-square)](https://travis-ci.org/ant-design/ant-design-mobile) [![npm package](https://img.shields.io/npm/v/antd-mobile.svg?style=flat-square)](https://www.npmjs.org/package/antd-mobile) [![NPM downloads](http://img.shields.io/npm/dm/antd-mobile.svg?style=flat-square)](https://npmjs.org/package/antd-mobile) [![Dependency Status](https://david-dm.org/ant-design/ant-design-mobile.svg?style=flat-square)](https://david-dm.org/ant-design/ant-design-mobile) [![CDNJS](https://img.shields.io/cdnjs/v/antd-mobile.svg?style=flat-square)](https://cdnjs.com/libraries/antd-mobile)
9
10	`A configurable Mobile UI specification and React-based implementation.`
11
12	`## Features`
13
14	`- Follow Ant Design Mobile UI specification.`
15	`- Configurable UI style for different products.`
16	`- Support web and native usages based on React Native.`
17	`- Develop in TypeScript.`
18
19	`## Demo`
20
21	`### mobile web demo`
22
23	`<img width="250" src="https://zos.alipayobjects.com/rmsportal/dLMGiKuyFLBfYfm.png" />`
24
25	`http://mobile.ant.design/kitchen-sink/`
26
27	`### react native demo`
28
29	`<img width="250" src="https://cloud.githubusercontent.com/assets/1698185/18130654/6ba4ccea-6fc2-11e6-9aa1-0a53cd74d9e1.png" />`
30
31	`## Install & Usage`
32
33	`[introduce](docs/react/introduce.zh-CN.md#安装)`
34
35	`## Browser Support`
36
37	- `iOS`
38	- `Android 4.0+`
39
40	`## Links`
41
42	`- [Home Page](http://mobile.ant.design)`
43	`- [Developer Instruction](http://github.com/ant-design/ant-design-mobile/blob/master/development.md)`
44	`- [React components](http://github.com/react-component/)`
45
46	`## Contributing`
47
48	We welcome all contributions, please read our [CONTRIBUTING.md](https://github.com/ant-design/ant-design-mobile/blob/master/.github/CONTRIBUTING.md) first. You can submit any ideas as [pull requests](https://github.com/ant-design/ant-design-mobile/pulls) or as a [GitHub issue](https://github.com/ant-design/ant-design-mobile/issues). If you'd like to improve code, check out the [Development Instruction](https://github.com/ant-design/ant-design-mobile/blob/master/development.md) and have a good time! :)