mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-05 05:28:20 +08:00
8497e54e39
* docs: remove babel-plugin-import from docs * docs: react-scripts-rewired + customize-cra => craco * docs: remove babel-plugin-import * fix remark link
179 lines
12 KiB
Markdown
179 lines
12 KiB
Markdown
<p align="center">
|
||
<a href="https://ant.design">
|
||
<img width="200" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg">
|
||
</a>
|
||
</p>
|
||
|
||
<h1 align="center">Ant Design</h1>
|
||
|
||
<div align="center">
|
||
|
||
一套企业级 UI 设计语言和 React 组件库。
|
||
|
||
[![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]
|
||
|
||
[![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]
|
||
|
||
[![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]
|
||
|
||
[npm-image]: http://img.shields.io/npm/v/antd.svg?style=flat-square
|
||
[npm-url]: http://npmjs.org/package/antd
|
||
[circleci-image]: https://img.shields.io/travis/com/ant-design/ant-design.svg?style=flat-square
|
||
[circleci-url]: https://travis-ci.com/ant-design/ant-design
|
||
[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
|
||
[david-image]: https://img.shields.io/david/ant-design/ant-design?style=flat-square
|
||
[david-dev-url]: https://david-dm.org/ant-design/ant-design?type=dev
|
||
[david-dev-image]: https://img.shields.io/david/dev/ant-design/ant-design?style=flat-square
|
||
[david-url]: https://david-dm.org/ant-design/ant-design
|
||
[download-image]: https://img.shields.io/npm/dm/antd.svg?style=flat-square
|
||
[download-url]: https://npmjs.org/package/antd
|
||
[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
|
||
[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
|
||
[gitter-english-url]: https://gitter.im/ant-design/ant-design-english?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
|
||
[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
|
||
[gitter-chinese-url]: https://gitter.im/ant-design/ant-design?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
|
||
[semver-stability-url]: https://dependabot.com/compatibility-score.html/?dependency-name=antd&package-manager=npm_and_yarn&new-version=latest
|
||
[semver-stability-image]: https://api.dependabot.com/badges/compatibility_score?dependency-name=antd&package-manager=npm_and_yarn&target-version=latest&version-scheme=semver
|
||
|
||
</div>
|
||
|
||
[![](https://gw.alipayobjects.com/mdn/rms_08e378/afts/img/A*Ey3wTo-5__QAAAAAAAAAAABkARQnAQ)](https://ant.design/index-cn)
|
||
|
||
[English](./README.md) | [Português](./README-pt_BR.md) | 简体中文
|
||
|
||
## ✨ 特性
|
||
|
||
- 🌈 提炼自企业级中后台产品的交互语言和视觉风格。
|
||
- 📦 开箱即用的高质量 React 组件。
|
||
- 🛡 使用 TypeScript 开发,提供完整的类型定义文件。
|
||
- ⚙️ 全链路开发和设计工具体系。
|
||
- 🌍 数十个国际化语言支持。
|
||
- 🎨 深入每个细节的主题定制能力。
|
||
|
||
## 🖥 兼容环境
|
||
|
||
- 现代浏览器和 IE11(需要 [polyfills](https://ant.design/docs/react/getting-started-cn#兼容性))。
|
||
- 支持服务端渲染。
|
||
- [Electron](https://www.electronjs.org/)
|
||
|
||
| [<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 |
|
||
| --- | --- | --- | --- | --- |
|
||
| IE11, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
|
||
|
||
## 📦 安装
|
||
|
||
```bash
|
||
npm install antd --save
|
||
```
|
||
|
||
```bash
|
||
yarn add antd
|
||
```
|
||
|
||
## 🔨 示例
|
||
|
||
```jsx
|
||
import { Button, DatePicker } from 'antd';
|
||
|
||
const App = () => (
|
||
<>
|
||
<Button type="primary">PRESS ME</Button>
|
||
<DatePicker />
|
||
</>
|
||
);
|
||
```
|
||
|
||
引入样式:
|
||
|
||
```jsx
|
||
import 'antd/dist/antd.css'; // or 'antd/dist/antd.less'
|
||
```
|
||
|
||
### 🌈 定制主题
|
||
|
||
参考 [定制主题](https://ant.design/docs/react/customize-theme-cn) 文档。
|
||
|
||
### 🛡 TypeScript
|
||
|
||
参考 [在 TypeScript 中使用](https://ant.design/docs/react/use-in-typescript-cn)。
|
||
|
||
## 🌍 国际化
|
||
|
||
参考 [国际化文档](https://ant.design/docs/react/i18n-cn)。
|
||
|
||
## 🔗 链接
|
||
|
||
- [首页](https://ant.design/)
|
||
- [组件库](https://ant.design/docs/react/introduce)
|
||
- [Ant Design Pro](http://pro.ant.design/)
|
||
- [更新日志](CHANGELOG.en-US.md)
|
||
- [React 底层基础组件](http://react-component.github.io/)
|
||
- [移动端组件](http://mobile.ant.design)
|
||
- [Ant Design 图标](https://github.com/ant-design/ant-design-icons)
|
||
- [Ant Design 色彩](https://github.com/ant-design/ant-design-colors)
|
||
- [Ant Design Pro 布局组件](https://github.com/ant-design/ant-design-pro-layout)
|
||
- [Ant Design Pro 区块集](https://github.com/ant-design/pro-blocks)
|
||
- [Dark Theme](https://github.com/ant-design/ant-design-dark-theme)
|
||
- [首页模板集](https://landing.ant.design)
|
||
- [动效](https://motion.ant.design)
|
||
- [脚手架市场](http://scaffold.ant.design)
|
||
- [设计规范速查手册](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)
|
||
- [开发者说明](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)
|
||
- [常见问题](https://ant.design/docs/react/faq-cn)
|
||
- [CodeSandbox 模板](https://u.ant.design/codesandbox-repro) for bug reports
|
||
- [Awesome Ant Design](https://github.com/websemantics/awesome-ant-design)
|
||
- [定制主题](https://ant.design/docs/react/customize-theme-cn)
|
||
- [成为社区协作成员](https://github.com/ant-design/ant-design/wiki/Collaborators#how-to-apply-for-being-a-collaborator)
|
||
|
||
## ⌨️ 本地开发
|
||
|
||
你可以使用 Gitpod 进行在线开发:
|
||
|
||
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ant-design/ant-design)
|
||
|
||
或者克隆到本地开发:
|
||
|
||
```bash
|
||
$ git clone git@github.com:ant-design/ant-design.git
|
||
$ cd ant-design
|
||
$ npm install
|
||
$ npm start
|
||
```
|
||
|
||
打开浏览器访问 http://127.0.0.1:8001 ,更多[本地开发文档](https://github.com/ant-design/ant-design/wiki/Development)。
|
||
|
||
## 🤝 参与共建 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
|
||
|
||
请参考[贡献指南](https://ant.design/docs/react/contributing-cn).
|
||
|
||
> 强烈推荐阅读 [《提问的智慧》](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),更好的问题更容易获得帮助。
|
||
|
||
[![Let's fund issues in this repository](https://issuehunt.io/static/embed/issuehunt-button-v1.svg)](https://issuehunt.io/repos/34526884)
|
||
|
||
## 👥 社区互助
|
||
|
||
如果您在使用的过程中碰到问题,可以通过下面几个途径寻求帮助,同时我们也鼓励资深用户通过下面的途径给新人提供帮助。
|
||
|
||
通过 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)
|
||
|
||
## ❤️ 赞助者 ![](https://opencollective.com/ant-design/tiers/backers/badge.svg?label=Backers&color=brightgreen) ![](https://opencollective.com/ant-design/tiers/sponsors/badge.svg?label=Sponsors&color=brightgreen)
|
||
|
||
[![](https://opencollective.com/ant-design/tiers/backers.svg?avatarHeight=36)](https://opencollective.com/ant-design#support)
|
||
|
||
[![](https://opencollective.com/ant-design/tiers/sponsors.svg?avatarHeight=36)](https://opencollective.com/ant-design#support)
|