2015-12-06 17:40:04 +08:00
< p align = "center" >
2020-05-15 17:18:55 +08:00
< a href = "https://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" >
2019-09-08 16:29:04 +08:00
An enterprise-class UI design language and React UI library.
2016-11-22 14:56:55 +08:00
2020-04-06 19:21:59 +08:00
[![CircleCI status][circleci-image]][circleci-url] [![CI status][github-action-image]][github-action-url] [![codecov][codecov-image]][codecov-url] [![NPM version][npm-image]][npm-url] [![NPM downloads][download-image]][download-url]
2020-04-06 12:41:53 +08:00
[![david deps][david-image]][david-url] [![david devDeps][david-dev-image]][david-dev-url] [![Total alerts][lgtm-image]][lgtm-url] [![FOSSA Status][fossa-image]][fossa-url] [![Issues need help][help-wanted-image]][help-wanted-url]
2020-04-24 13:29:50 +08:00
[![Follow Twitter][twitter-image]][twitter-url] [![Gitter][gitter-english-image]][gitter-english-url] [![Gitter][gitter-chinese-image]][gitter-chinese-url] [![[SemVer stability]][semver-stability-image]][semver-stability-url]
2020-04-06 12:41:53 +08:00
[npm-image]: http://img.shields.io/npm/v/antd.svg?style=flat-square
[npm-url]: http://npmjs.org/package/antd
2020-09-05 12:56:50 +08:00
[circleci-image]: https://img.shields.io/circleci/build/github/ant-design/ant-design/master?style=flat-square
[circleci-url]: https://circleci.com/gh/ant-design/ant-design
2020-04-06 12:41:53 +08:00
[github-action-image]: https://github.com/ant-design/ant-design/workflows/test/badge.svg
[github-action-url]: https://github.com/ant-design/ant-design/actions?query=workflow%3Atest
[codecov-image]: https://img.shields.io/codecov/c/github/ant-design/ant-design/master.svg?style=flat-square
[codecov-url]: https://codecov.io/gh/ant-design/ant-design/branch/master
2020-05-07 14:05:25 +08:00
[david-image]: https://img.shields.io/david/ant-design/ant-design?style=flat-square
2020-04-06 12:41:53 +08:00
[david-dev-url]: https://david-dm.org/ant-design/ant-design?type=dev
2020-05-07 14:05:25 +08:00
[david-dev-image]: https://img.shields.io/david/dev/ant-design/ant-design?style=flat-square
2020-04-06 12:41:53 +08:00
[david-url]: https://david-dm.org/ant-design/ant-design
2020-04-06 12:43:07 +08:00
[download-image]: https://img.shields.io/npm/dm/antd.svg?style=flat-square
[download-url]: https://npmjs.org/package/antd
2020-04-06 12:41:53 +08:00
[lgtm-image]: https://flat.badgen.net/lgtm/alerts/g/ant-design/ant-design
[lgtm-url]: https://lgtm.com/projects/g/ant-design/ant-design/alerts/
[fossa-image]: https://app.fossa.io/api/projects/git%2Bgithub.com%2Fant-design%2Fant-design.svg?type=shield
[fossa-url]: https://app.fossa.io/projects/git%2Bgithub.com%2Fant-design%2Fant-design?ref=badge_shield
[help-wanted-image]: https://flat.badgen.net/github/label-issues/ant-design/ant-design/help%20wanted/open
[help-wanted-url]: https://github.com/ant-design/ant-design/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22
[twitter-image]: https://img.shields.io/twitter/follow/AntDesignUI.svg?label=Ant%20Design& style=social
[twitter-url]: https://twitter.com/AntDesignUI
2020-04-25 19:49:45 +08:00
[gitter-english-image]: https://img.shields.io/gitter/room/ant-design/ant-design-english.svg?style=flat-square& logoWidth=18& logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxzdmcgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgd2lkdGg9IjEyMzUiIGhlaWdodD0iNjUwIiB2aWV3Qm94PSIwIDAgNzQxMCAzOTAwIj4NCjxyZWN0IHdpZHRoPSI3NDEwIiBoZWlnaHQ9IjM5MDAiIGZpbGw9IiNiMjIyMzQiLz4NCjxwYXRoIGQ9Ik0wLDQ1MEg3NDEwbTAsNjAwSDBtMCw2MDBINzQxMG0wLDYwMEgwbTAsNjAwSDc0MTBtMCw2MDBIMCIgc3Ryb2tlPSIjZmZmIiBzdHJva2Utd2lkdGg9IjMwMCIvPg0KPHJlY3Qgd2lkdGg9IjI5NjQiIGhlaWdodD0iMjEwMCIgZmlsbD0iIzNjM2I2ZSIvPg0KPGcgZmlsbD0iI2ZmZiI%2BDQo8ZyBpZD0iczE4Ij4NCjxnIGlkPSJzOSI%2BDQo8ZyBpZD0iczUiPg0KPGcgaWQ9InM0Ij4NCjxwYXRoIGlkPSJzIiBkPSJNMjQ3LDkwIDMxNy41MzQyMzAsMzA3LjA4MjAzOSAxMzIuODczMjE4LDE3Mi45MTc5NjFIMzYxLjEyNjc4MkwxNzYuNDY1NzcwLDMwNy4wODIwMzl6Ii8%2BDQo8dXNlIHhsaW5rOmhyZWY9IiNzIiB5PSI0MjAiLz4NCjx1c2UgeGxpbms6aHJlZj0iI3MiIHk9Ijg0MCIvPg0KPHVzZSB4bGluazpocmVmPSIjcyIgeT0iMTI2MCIvPg0KPC9nPg0KPHVzZSB4bGluazpocmVmPSIjcyIgeT0iMTY4MCIvPg0KPC9nPg0KPHVzZSB4bGluazpocmVmPSIjczQiIHg9IjI0NyIgeT0iMjEwIi8%2BDQo8L2c%2BDQo8dXNlIHhsaW5rOmhyZWY9IiNzOSIgeD0iNDk0Ii8%2BDQo8L2c%2BDQo8dXNlIHhsaW5rOmhyZWY9IiNzMTgiIHg9Ijk4OCIvPg0KPHVzZSB4bGluazpocmVmPSIjczkiIHg9IjE5NzYiLz4NCjx1c2UgeGxpbms6aHJlZj0iI3M1IiB4PSIyNDcwIi8%2BDQo8L2c%2BDQo8L3N2Zz4%3D
2020-04-06 12:41:53 +08:00
[gitter-english-url]: https://gitter.im/ant-design/ant-design-english?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge
2020-04-25 19:49:45 +08:00
[gitter-chinese-image]: https://img.shields.io/gitter/room/ant-design/ant-design.svg?style=flat-square& logoWidth=18& logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxzdmcgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgd2lkdGg9IjkwMCIgaGVpZ2h0PSI2MDAiIHZpZXdCb3g9IjAgMCAzMCAyMCI%2BDQo8ZGVmcz4NCjxwYXRoIGlkPSJzIiBkPSJNMCwtMSAwLjU4Nzc4NSwwLjgwOTAxNyAtMC45NTEwNTcsLTAuMzA5MDE3SDAuOTUxMDU3TC0wLjU4Nzc4NSwwLjgwOTAxN3oiIGZpbGw9IiNmZmRlMDAiLz4NCjwvZGVmcz4NCjxyZWN0IHdpZHRoPSIzMCIgaGVpZ2h0PSIyMCIgZmlsbD0iI2RlMjkxMCIvPg0KPHVzZSB4bGluazpocmVmPSIjcyIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoNSw1KSBzY2FsZSgzKSIvPg0KPHVzZSB4bGluazpocmVmPSIjcyIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoMTAsMikgcm90YXRlKDIzLjAzNjI0MykiLz4NCjx1c2UgeGxpbms6aHJlZj0iI3MiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDEyLDQpIHJvdGF0ZSg0NS44Njk4OTgpIi8%2BDQo8dXNlIHhsaW5rOmhyZWY9IiNzIiB0cmFuc2Zvcm09InRyYW5zbGF0ZSgxMiw3KSByb3RhdGUoNjkuOTQ1Mzk2KSIvPg0KPHVzZSB4bGluazpocmVmPSIjcyIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoMTAsOSkgcm90YXRlKDIwLjY1OTgwOCkiLz4NCjwvc3ZnPg%3D%3D
2020-04-06 12:41:53 +08:00
[gitter-chinese-url]: https://gitter.im/ant-design/ant-design?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge
2020-06-07 21:53:32 +08:00
[semver-stability-url]: https://dependabot.com/compatibility-score.html/?dependency-name=antd& package-manager=npm_and_yarn
[semver-stability-image]: https://api.dependabot.com/badges/compatibility_score?dependency-name=antd& package-manager=npm_and_yarn& version-scheme=semver
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
2020-05-15 17:18:55 +08:00
[](https://ant.design)
2018-09-10 18:50:43 +08:00
2020-01-21 10:48:24 +08:00
English | [Português ](./README-pt_BR.md ) | [简体中文 ](./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
2019-12-16 22:42:08 +08:00
- 🌈 Enterprise-class UI designed for web applications.
- 📦 A set of high-quality React components out of the box.
- 🛡 Written in TypeScript with predictable static types.
2019-12-25 12:48:49 +08:00
- ⚙️ Whole package of design resources and development tools.
2019-12-16 22:42:08 +08:00
- 🌍 Internationalization support for dozens of languages.
- 🎨 Powerful theme customization in every detail.
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
2020-05-23 22:13:43 +08:00
- Modern browsers and Internet Explorer 11 (with [polyfills ](https://stackoverflow.com/questions/57020976/polyfills-in-2019-for-ie11 ))
2019-05-07 14:57:32 +08:00
- Server-side Rendering
2020-02-20 21:11:15 +08:00
- [Electron ](https://www.electronjs.org/ )
2017-03-13 15:49:15 +08:00
2020-02-20 21:11:15 +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/electron/electron_48x48.png" alt="Electron" width="24px" height="24px" /> ](http://godban.github.io/browsers-support-badges/ )< br > Electron |
2020-02-27 10:53:30 +08:00
| --- | --- | --- | --- | --- |
| IE11, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
2018-07-20 14:05:59 +08:00
2018-09-02 12:31:26 +08:00
## 📦 Install
2015-11-02 20:37:38 +08:00
```bash
2019-03-05 11:46:33 +08:00
npm install antd
2015-11-02 20:37:38 +08:00
```
2019-01-22 19:06:11 +08:00
```bash
yarn add antd
```
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
2019-12-16 22:42:08 +08:00
import { Button, DatePicker } from 'antd';
const App = () => (
< >
< Button type = "primary" > PRESS ME< / Button >
2020-05-16 21:48:33 +08:00
< DatePicker placeholder = "select date" / >
2019-12-16 22:42:08 +08:00
< />
);
2015-12-16 15:04:51 +08:00
```
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
2019-05-07 14:57:32 +08:00
import 'antd/dist/antd.css'; // or 'antd/dist/antd.less'
2015-12-08 18:05:01 +08:00
```
2018-09-02 12:31:26 +08:00
### TypeScript
2016-04-21 15:52:54 +08:00
2020-05-16 21:48:33 +08:00
`antd` is written in TypeScript with complete definitions, check [Use in TypeScript ](https://ant.design/docs/react/use-in-typescript ) to getting started.
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
2020-05-16 21:48:33 +08:00
Dozens of languages supported in `antd` , see [i18n ](https://ant.design/docs/react/i18n ).
2017-03-12 15:20:25 +08:00
2018-09-02 12:31:26 +08:00
## 🔗 Links
2015-06-14 18:28:08 +08:00
2020-05-15 17:18:55 +08:00
- [Home page ](https://ant.design/ )
2020-11-18 18:49:58 +08:00
- [Components Overview ](https://ant.design/components/overview )
2017-11-01 10:50:27 +08:00
- [Ant Design Pro ](http://pro.ant.design/ )
2016-11-14 11:08:26 +08:00
- [Change Log ](CHANGELOG.en-US.md )
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 )
2020-11-18 18:49:58 +08:00
- [Ant Design Pro Components ](https://procomponents.ant.design )
- [Ant Design Charts ](https://charts.ant.design )
2019-07-01 11:05:17 +08:00
- [Ant Design Icons ](https://github.com/ant-design/ant-design-icons )
- [Ant Design Colors ](https://github.com/ant-design/ant-design-colors )
2020-11-18 18:49:58 +08:00
- [Ant Design Charts ](https://charts.ant.design )
2018-11-28 12:33:09 +08:00
- [Landing Pages ](https://landing.ant.design )
2016-11-09 18:17:41 +08:00
- [Motion ](https://motion.ant.design )
2018-11-28 12:33:09 +08:00
- [Scaffold Market ](http://scaffold.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
2020-05-15 17:18:55 +08:00
- [Customize Theme ](https://ant.design/docs/react/customize-theme )
2020-03-25 18:01:24 +08:00
- [How to Apply for Being A Collaborator ](https://github.com/ant-design/ant-design/wiki/Collaborators#how-to-apply-for-being-a-collaborator )
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
2019-02-08 10:01:01 +08:00
Use Gitpod, a free online dev environment for GitHub.
[](https://gitpod.io/#https://github.com/ant-design/ant-design)
Or clone locally:
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 [](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.
2015-10-19 16:05:50 +08:00
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! :)
2018-12-10 11:36:22 +08:00
2019-02-18 21:52:55 +08:00
If you are a collaborator, please follow our [Pull Request principle ](https://github.com/ant-design/ant-design/wiki/PR-principle ) to create a Pull Request by [collaborator template ](https://github.com/ant-design/ant-design/compare?expand=1&template=collaborator.md ).
2018-12-30 17:10:40 +08:00
2018-12-10 11:36:22 +08:00
[](https://issuehunt.io/repos/34526884)
2019-08-31 17:06:23 +08:00
2019-09-02 23:15:16 +08:00
## ❤️ Sponsors and Backers [](https://opencollective.com/ant-design#support) [](https://opencollective.com/ant-design#support)
2019-08-31 17:06:23 +08:00
[](https://opencollective.com/ant-design#support)
2019-09-02 23:15:16 +08:00
[](https://opencollective.com/ant-design#support)
