2015-10-19 16:05:50 +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-10-19 16:05:50 +08:00
< / a >
< / p >
2018-09-02 12:20:54 +08:00
< h1 align = "center" > Ant Design< / h1 >
< div align = "center" >
一套企业级的 UI 设计语言和 React 实现。
2016-11-22 14:56:55 +08:00
2019-02-02 00:16:50 +08:00
[![Build Status ](https://dev.azure.com/ant-design/ant-design/_apis/build/status/ant-design.ant-design?branchName=master )](https://dev.azure.com/ant-design/ant-design/_build/latest?definitionId=2?branchName=master)
2018-10-15 11:42:39 +08:00
[![CircleCI branch ](https://img.shields.io/circleci/project/github/ant-design/ant-design/master.svg?style=flat-square )](https://circleci.com/gh/ant-design/ant-design)
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)
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)
2018-12-22 22:25:36 +08:00
[![Dependencies ](https://img.shields.io/david/ant-design/ant-design.svg?style=flat-square )](https://david-dm.org/ant-design/ant-design)
[![DevDependencies ](https://img.shields.io/david/dev/ant-design/ant-design.svg?style=flat-square )](https://david-dm.org/ant-design/ant-design?type=dev)
2018-12-23 18:08:59 +08:00
[![Total alerts ](https://flat.badgen.net/lgtm/alerts/g/ant-design/ant-design )](https://lgtm.com/projects/g/ant-design/ant-design/alerts/)
2019-02-03 16:17:53 +08:00
[![FOSSA Status ](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fant-design%2Fant-design.svg?type=shield )](https://app.fossa.io/projects/git%2Bgithub.com%2Fant-design%2Fant-design?ref=badge_shield)
2019-02-10 20:29:26 +08:00
[![Issues need help ](https://flat.badgen.net/github/label-issues/ant-design/ant-design/help%20wanted/open )](https://github.com/ant-design/ant-design/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
[![ ](https://img.shields.io/twitter/follow/AntDesignUI.svg?label=Ant%20Design&style=social )](https://twitter.com/AntDesignUI)
2018-12-21 08:04:18 +08:00
[![Gitter ](https://img.shields.io/gitter/room/ant-design/ant-design-english.svg?style=flat-square&logoWidth=20&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxzdmcgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgd2lkdGg9IjEyMzUiIGhlaWdodD0iNjUwIiB2aWV3Qm94PSIwIDAgNzQxMCAzOTAwIj4NCjxyZWN0IHdpZHRoPSI3NDEwIiBoZWlnaHQ9IjM5MDAiIGZpbGw9IiNiMjIyMzQiLz4NCjxwYXRoIGQ9Ik0wLDQ1MEg3NDEwbTAsNjAwSDBtMCw2MDBINzQxMG0wLDYwMEgwbTAsNjAwSDc0MTBtMCw2MDBIMCIgc3Ryb2tlPSIjZmZmIiBzdHJva2Utd2lkdGg9IjMwMCIvPg0KPHJlY3Qgd2lkdGg9IjI5NjQiIGhlaWdodD0iMjEwMCIgZmlsbD0iIzNjM2I2ZSIvPg0KPGcgZmlsbD0iI2ZmZiI%2BDQo8ZyBpZD0iczE4Ij4NCjxnIGlkPSJzOSI%2BDQo8ZyBpZD0iczUiPg0KPGcgaWQ9InM0Ij4NCjxwYXRoIGlkPSJzIiBkPSJNMjQ3LDkwIDMxNy41MzQyMzAsMzA3LjA4MjAzOSAxMzIuODczMjE4LDE3Mi45MTc5NjFIMzYxLjEyNjc4MkwxNzYuNDY1NzcwLDMwNy4wODIwMzl6Ii8%2BDQo8dXNlIHhsaW5rOmhyZWY9IiNzIiB5PSI0MjAiLz4NCjx1c2UgeGxpbms6aHJlZj0iI3MiIHk9Ijg0MCIvPg0KPHVzZSB4bGluazpocmVmPSIjcyIgeT0iMTI2MCIvPg0KPC9nPg0KPHVzZSB4bGluazpocmVmPSIjcyIgeT0iMTY4MCIvPg0KPC9nPg0KPHVzZSB4bGluazpocmVmPSIjczQiIHg9IjI0NyIgeT0iMjEwIi8%2BDQo8L2c%2BDQo8dXNlIHhsaW5rOmhyZWY9IiNzOSIgeD0iNDk0Ii8%2BDQo8L2c%2BDQo8dXNlIHhsaW5rOmhyZWY9IiNzMTgiIHg9Ijk4OCIvPg0KPHVzZSB4bGluazpocmVmPSIjczkiIHg9IjE5NzYiLz4NCjx1c2UgeGxpbms6aHJlZj0iI3M1IiB4PSIyNDcwIi8%2BDQo8L2c%2BDQo8L3N2Zz4%3D )](https://gitter.im/ant-design/ant-design-english?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge)
[![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&logoWidth=20&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxzdmcgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgd2lkdGg9IjkwMCIgaGVpZ2h0PSI2MDAiIHZpZXdCb3g9IjAgMCAzMCAyMCI%2BDQo8ZGVmcz4NCjxwYXRoIGlkPSJzIiBkPSJNMCwtMSAwLjU4Nzc4NSwwLjgwOTAxNyAtMC45NTEwNTcsLTAuMzA5MDE3SDAuOTUxMDU3TC0wLjU4Nzc4NSwwLjgwOTAxN3oiIGZpbGw9IiNmZmRlMDAiLz4NCjwvZGVmcz4NCjxyZWN0IHdpZHRoPSIzMCIgaGVpZ2h0PSIyMCIgZmlsbD0iI2RlMjkxMCIvPg0KPHVzZSB4bGluazpocmVmPSIjcyIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoNSw1KSBzY2FsZSgzKSIvPg0KPHVzZSB4bGluazpocmVmPSIjcyIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoMTAsMikgcm90YXRlKDIzLjAzNjI0MykiLz4NCjx1c2UgeGxpbms6aHJlZj0iI3MiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDEyLDQpIHJvdGF0ZSg0NS44Njk4OTgpIi8%2BDQo8dXNlIHhsaW5rOmhyZWY9IiNzIiB0cmFuc2Zvcm09InRyYW5zbGF0ZSgxMiw3KSByb3RhdGUoNjkuOTQ1Mzk2KSIvPg0KPHVzZSB4bGluazpocmVmPSIjcyIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoMTAsOSkgcm90YXRlKDIwLjY1OTgwOCkiLz4NCjwvc3ZnPg%3D%3D )](https://gitter.im/ant-design/ant-design?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)
2015-12-06 17:40:04 +08:00
2018-09-02 12:20:54 +08:00
< / div >
2015-12-06 17:40:04 +08:00
2018-09-10 18:54:02 +08:00
[![ ](https://cdn-images-1.medium.com/max/2000/1*NIlj0-TdLMbo_hzSBP8tmg.png )](http://ant.design/index-cn)
2018-09-10 18:51:38 +08:00
2018-09-02 12:20:54 +08:00
[English ](./README.md ) | 简体中文
2016-12-23 18:06:28 +08:00
2018-09-02 12:31:26 +08:00
## ✨ 特性
2015-10-19 16:05:50 +08:00
2017-01-22 01:15:14 +08:00
- 提炼自企业级中后台产品的交互语言和视觉风格。
- 开箱即用的高质量 React 组件。
2016-09-29 14:42:38 +08:00
- 使用 TypeScript 构建,提供完整的类型定义文件。
2018-03-16 13:35:43 +08:00
- 全链路开发和设计工具体系。
2015-10-19 16:05:50 +08:00
2018-09-02 12:31:26 +08:00
## 🖥 支持环境
2017-03-13 15:49:15 +08:00
* 现代浏览器和 IE9 及以上。
* 支持服务端渲染。
* [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
## 📦 安装
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
```
2019-01-22 19:06:11 +08:00
```bash
yarn add antd
```
2018-09-02 12:31:26 +08:00
## 🔨 示例
2015-10-19 16:05:50 +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
2015-12-08 18:05:01 +08:00
引入样式:
```jsx
2016-04-28 15:54:18 +08:00
import 'antd/dist/antd.css'; // or 'antd/dist/antd.less'
2015-12-08 18:05:01 +08:00
```
2018-11-10 00:31:53 +08:00
你也可以 [按需加载组件 ](https://ant.design/docs/react/getting-started-cn#按需加载 )。
2015-12-16 15:04:51 +08:00
2018-09-02 12:31:26 +08:00
### TypeScript
2016-04-28 15:54:18 +08:00
2017-11-29 20:27:52 +08:00
参考 [在 TypeScript 中使用 ](https://ant.design/docs/react/use-in-typescript-cn )
2016-12-04 14:16:10 +08:00
2018-09-02 12:31:26 +08:00
## 🌍 国际化
2017-03-12 15:20:25 +08:00
2017-11-29 20:27:52 +08:00
参考 [国际化文档 ](http://ant.design/docs/react/i18n-cn )。
2017-03-12 15:20:25 +08:00
2018-09-02 12:31:26 +08:00
## 🔗 链接
2015-10-19 16:05:50 +08:00
2017-11-01 10:50:27 +08:00
- [首页 ](http://ant.design/ )
- [组件库 ](http://ant.design/docs/react/introduce )
- [Ant Design Pro ](http://pro.ant.design/ )
2016-11-14 11:08:26 +08:00
- [更新日志 ](CHANGELOG.en-US.md )
2017-03-12 15:20:25 +08:00
- [React 底层基础组件 ](http://react-component.github.io/ )
2016-07-29 13:52:05 +08:00
- [移动端组件 ](http://mobile.ant.design )
2018-11-28 12:33:09 +08:00
- [首页模板集 ](https://landing.ant.design )
2016-11-14 11:08:26 +08:00
- [动效 ](https://motion.ant.design )
2018-11-28 12:33:09 +08:00
- [脚手架市场 ](http://scaffold.ant.design )
2017-02-15 13:50:03 +08:00
- [设计规范速查手册 ](https://github.com/ant-design/ant-design/wiki/Ant-Design-%E8%AE%BE%E8%AE%A1%E5%9F%BA%E7%A1%80%E7%AE%80%E7%89%88 )
2016-11-14 11:08:26 +08:00
- [开发者说明 ](https://github.com/ant-design/ant-design/wiki/Development )
- [版本发布规则 ](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
- [常见问题 ](https://ant.design/docs/react/faq-cn )
2017-11-29 20:27:52 +08:00
- [CodeSandbox 模板 ](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 )
2017-01-31 21:12:52 +08:00
- [定制主题 ](http://ant.design/docs/react/customize-theme-cn )
2016-06-23 13:27:23 +08:00
2018-09-02 12:31:26 +08:00
## ⌨️ 本地开发
2017-03-29 11:34:21 +08:00
2019-02-08 10:43:11 +08:00
你可以使用 Gitpod 进行在线开发:
[![Open in Gitpod ](https://gitpod.io/button/open-in-gitpod.svg )](https://gitpod.io/#https://github.com/ant-design/ant-design)
或者克隆到本地开发:
2017-03-29 11:34:21 +08:00
```bash
$ git clone git@github.com:ant-design/ant-design.git
2018-04-21 15:43:22 +08:00
$ cd ant-design
2017-03-29 11:34:21 +08:00
$ npm install
$ npm start
```
2018-07-20 14:05:59 +08:00
打开浏览器访问 http://127.0.0.1:8001 ,更多[本地开发文档](https://github.com/ant-design/ant-design/wiki/Development)。
2017-03-29 11:34:21 +08:00
2018-09-02 12:31:26 +08:00
## 🤝 参与共建 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
2015-10-19 16:05:50 +08:00
2018-09-02 12:30:15 +08:00
请参考[贡献指南](https://ant.design/docs/react/contributing-cn).
2017-03-24 20:15:51 +08:00
2017-06-01 14:12:26 +08:00
> 强烈推荐阅读 [《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way)、[《如何向开源社区提问题》](https://github.com/seajs/seajs/issues/545) 和 [《如何有效地报告 Bug》](http://www.chiark.greenend.org.uk/%7Esgtatham/bugs-cn.html)、[《如何向开源项目提交无法解答的问题》](https://zhuanlan.zhihu.com/p/25795393),更好的问题更容易获得帮助。
2017-03-24 20:15:51 +08:00
2018-12-10 11:36:22 +08:00
[![Let's fund issues in this repository ](https://issuehunt.io/static/embed/issuehunt-button-v1.svg )](https://issuehunt.io/repos/34526884)
2018-09-02 12:31:26 +08:00
## 社区互助
2017-03-24 20:15:51 +08:00
如果您在使用的过程中碰到问题,可以通过下面几个途径寻求帮助,同时我们也鼓励资深用户通过下面的途径给新人提供帮助。
通过 Stack Overflow 或者 Segment Fault 提问时,建议加上 `antd` 标签。
1. [Stack Overflow ](http://stackoverflow.com/questions/tagged/antd )(英文)
2. [Segment Fault ](https://segmentfault.com/t/antd )(中文)
3. [![Join the chat at https://gitter.im/ant-design/ant-design ](https://badges.gitter.im/Join%20Chat.svg )](https://gitter.im/ant-design/ant-design?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)