ant-design/README.md

110 lines
6.2 KiB
Markdown
Raw Normal View History

2015-12-06 17:40:04 +08:00
<p align="center">
<a href="http://ant.design">
2018-09-02 12:20:54 +08:00
<img width="200" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg">
2015-12-06 17:40:04 +08:00
</a>
</p>
2018-09-02 12:20:54 +08:00
<h1 align="center">Ant Design</h1>
<div align="center">
An enterprise-class UI design language and React-based implementation.
2016-11-22 14:56:55 +08:00
2018-07-03 00:10:14 +08:00
[![](https://img.shields.io/travis/ant-design/ant-design/master.svg?style=flat-square)](https://travis-ci.org/ant-design/ant-design)
2018-09-08 15:22:26 +08:00
[![CircleCI](https://circleci.com/gh/ant-design/ant-design/tree/master.svg?style=svg)](https://circleci.com/gh/ant-design/ant-design/tree/master)
2017-03-08 14:32:29 +08:00
[![Codecov](https://img.shields.io/codecov/c/github/ant-design/ant-design/master.svg?style=flat-square)](https://codecov.io/gh/ant-design/ant-design/branch/master)
2018-05-22 11:25:46 +08:00
[![Dependencies](https://img.shields.io/david/ant-design/ant-design.svg)](https://david-dm.org/ant-design/ant-design)
2018-07-23 15:10:35 +08:00
[![DevDependencies](https://img.shields.io/david/dev/ant-design/ant-design.svg)](https://david-dm.org/ant-design/ant-design?type=dev)
2016-11-22 14:56:55 +08:00
2016-11-22 15:02:21 +08:00
[![npm package](https://img.shields.io/npm/v/antd.svg?style=flat-square)](https://www.npmjs.org/package/antd)
2018-09-10 18:53:01 +08:00
[![NPM downloads](http://img.shields.io/npm/dm/antd.svg?style=flat-square)](http://npmjs.com/antd)
2017-03-10 19:28:13 +08:00
[![Percentage of issues still open](http://isitmaintained.com/badge/open/ant-design/ant-design.svg)](http://isitmaintained.com/project/ant-design/ant-design "Percentage of issues still open")
2017-04-11 18:07:53 +08:00
[![Gitter](https://badges.gitter.im/ant-design/ant-design-english.svg)](https://gitter.im/ant-design/ant-design-english?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) (English)
[![Join the chat at https://gitter.im/ant-design/ant-design](https://img.shields.io/gitter/room/ant-design/ant-design.svg?style=flat-square)](https://gitter.im/ant-design/ant-design?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)(中文)
2015-07-30 17:46:27 +08:00
2018-09-02 12:20:54 +08:00
</div>
2015-06-14 18:28:08 +08:00
2018-09-10 18:53:01 +08:00
[![](https://cdn-images-1.medium.com/max/2000/1*NIlj0-TdLMbo_hzSBP8tmg.png)](http://ant.design)
2018-09-10 18:50:43 +08:00
2018-09-02 12:20:54 +08:00
English | [简体中文](./README-zh_CN.md)
2016-12-23 18:06:28 +08:00
2018-09-02 12:31:26 +08:00
## ✨ Features
2015-06-14 18:28:08 +08:00
2018-09-13 11:20:40 +08:00
- An enterprise-class UI design system for web applications.
2017-01-22 01:15:14 +08:00
- A set of high-quality React components out of the box.
2018-03-03 15:35:30 +08:00
- Written in TypeScript with predictable static types.
2018-03-16 13:35:43 +08:00
- The whole package of development and design resources and tools.
2015-07-08 20:08:19 +08:00
2018-09-02 12:31:26 +08:00
## 🖥 Environment Support
2017-03-13 15:49:15 +08:00
2017-05-27 14:18:14 +08:00
* Modern browsers and Internet Explorer 9+ (with [polyfills](https://ant.design/docs/react/getting-started#Compatibility))
2017-03-13 15:49:15 +08:00
* Server-side Rendering
* [Electron](http://electron.atom.io/)
2018-07-20 14:05:59 +08:00
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Opera | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/electron/electron_48x48.png" alt="Electron" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Electron |
| --------- | --------- | --------- | --------- | --------- | --------- |
| IE9, IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions
2018-09-02 12:31:26 +08:00
## 📦 Install
2015-11-02 20:37:38 +08:00
```bash
2017-12-04 14:57:30 +08:00
npm install antd --save
2015-11-02 20:37:38 +08:00
```
2018-09-02 12:31:26 +08:00
## 🔨 Usage
2015-07-03 12:21:29 +08:00
2015-12-16 15:04:51 +08:00
```jsx
import { DatePicker } from 'antd';
ReactDOM.render(<DatePicker />, mountNode);
```
2015-10-27 22:17:54 +08:00
2016-05-23 22:48:09 +08:00
And import style manually:
2015-12-08 18:05:01 +08:00
```jsx
import 'antd/dist/antd.css'; // or 'antd/dist/antd.less'
2015-12-08 18:05:01 +08:00
```
2018-09-02 12:30:15 +08:00
Or [import components on demand](https://ant.design/docs/react/getting-started#Import-on-Demand).
2016-06-23 13:27:23 +08:00
2018-09-02 12:31:26 +08:00
### TypeScript
2016-04-21 15:52:54 +08:00
2018-09-02 12:30:15 +08:00
See [Use in TypeScript](https://ant.design/docs/react/use-in-typescript).
2017-03-07 16:29:30 +08:00
2018-09-02 12:31:26 +08:00
## 🌍 Internationalization
2017-03-12 15:20:25 +08:00
See [i18n](http://ant.design/docs/react/i18n).
2018-09-02 12:31:26 +08:00
## 🔗 Links
2015-06-14 18:28:08 +08:00
- [Home page](http://ant.design/)
2017-11-01 10:50:27 +08:00
- [Components](http://ant.design/docs/react/introduce)
- [Ant Design Pro](http://pro.ant.design/)
2016-11-14 11:08:26 +08:00
- [Change Log](CHANGELOG.en-US.md)
2017-05-13 16:12:35 +08:00
- [Scaffold Market](http://scaffold.ant.design)
2017-03-12 15:20:25 +08:00
- [rc-components](http://react-component.github.io/)
2016-07-29 13:52:05 +08:00
- [Mobile UI](http://mobile.ant.design)
2016-11-09 18:17:41 +08:00
- [Motion](https://motion.ant.design)
2016-03-31 00:20:10 +08:00
- [Developer Instruction](https://github.com/ant-design/ant-design/wiki/Development)
2016-06-23 13:27:23 +08:00
- [Versioning Release Note](https://github.com/ant-design/ant-design/wiki/%E8%BD%AE%E5%80%BC%E8%A7%84%E5%88%99%E5%92%8C%E7%89%88%E6%9C%AC%E5%8F%91%E5%B8%83%E6%B5%81%E7%A8%8B)
2018-09-16 15:34:58 +08:00
- [FAQ](https://ant.design/docs/react/faq)
2017-11-29 20:27:52 +08:00
- [CodeSandbox Template](https://u.ant.design/codesandbox-repro) for bug reports
2016-08-11 16:45:15 +08:00
- [Awesome Ant Design](https://github.com/websemantics/awesome-ant-design)
2016-11-26 16:07:01 +08:00
- [Customize Theme](http://ant.design/docs/react/customize-theme)
2016-11-09 18:17:41 +08:00
2018-09-02 12:31:26 +08:00
## ⌨️ Development
2017-03-12 15:20:25 +08:00
```bash
$ git clone git@github.com:ant-design/ant-design.git
2018-02-11 11:07:42 +08:00
$ cd ant-design
2017-03-12 15:20:25 +08:00
$ npm install
$ npm start
```
2018-07-20 14:05:59 +08:00
Open your browser and visit http://127.0.0.1:8001 , see more at [Development](https://github.com/ant-design/ant-design/wiki/Development).
2017-03-12 15:20:25 +08:00
2018-09-02 12:31:26 +08:00
## 🤝 Contributing [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
2018-09-02 12:30:15 +08:00
Read our [contributing guide](https://ant.design/docs/react/contributing) and let's build a better antd together.
2017-08-14 22:25:12 +08:00
We welcome all contributions. Please read our [CONTRIBUTING.md](https://github.com/ant-design/ant-design/blob/master/.github/CONTRIBUTING.md) first. You can submit any ideas as [pull requests](https://github.com/ant-design/ant-design/pulls) or as [GitHub issues](https://github.com/ant-design/ant-design/issues). If you'd like to improve code, check out the [Development Instructions](https://github.com/ant-design/ant-design/wiki/Development) and have a good time! :)