mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-28 21:19:37 +08:00
147 lines
11 KiB
Markdown
147 lines
11 KiB
Markdown
<p align="center">
|
|
<a href="http://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 组件库。
|
|
|
|
[](https://circleci.com/gh/ant-design/ant-design)  [](https://codecov.io/gh/ant-design/ant-design/branch/master) [](https://www.npmjs.com/package/antd) [](https://www.npmjs.com/package/antd) [](http://npmjs.com/antd)
|
|
|
|
[](https://david-dm.org/ant-design/ant-design) [](https://david-dm.org/ant-design/ant-design?type=dev) [](https://lgtm.com/projects/g/ant-design/ant-design/alerts/) [](https://app.fossa.io/projects/git%2Bgithub.com%2Fant-design%2Fant-design?ref=badge_shield) [](https://github.com/ant-design/ant-design/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
|
|
|
|
[](https://twitter.com/AntDesignUI) [](https://gitter.im/ant-design/ant-design-english?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [](https://gitter.im/ant-design/ant-design?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
</div>
|
|
|
|
[](http://ant.design/index-cn)
|
|
|
|
[English](./README.md) | [Português](./README-pt_BR.md) | 简体中文
|
|
|
|
## ✨ 特性
|
|
|
|
- 🌈 提炼自企业级中后台产品的交互语言和视觉风格。
|
|
- 📦 开箱即用的高质量 React 组件。
|
|
- 🛡 使用 TypeScript 开发，提供完整的类型定义文件。
|
|
- ⚙️ 全链路开发和设计工具体系。
|
|
- 🌍 数十个国际化语言支持。
|
|
- 🎨 深入每个细节的主题定制能力。
|
|
|
|
## 🖥 支持环境
|
|
|
|
- 现代浏览器和 IE11 及以上。
|
|
- 支持服务端渲染。
|
|
- [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'
|
|
```
|
|
|
|
你也可以使用 [babel-plugin-import](https://ant.design/docs/react/getting-started-cn#按需加载)。
|
|
|
|
### 🛡 TypeScript
|
|
|
|
参考 [在 TypeScript 中使用](https://ant.design/docs/react/use-in-typescript-cn)
|
|
|
|
## 🌍 国际化
|
|
|
|
参考 [国际化文档](http://ant.design/docs/react/i18n-cn)。
|
|
|
|
## 🔗 链接
|
|
|
|
- [首页](http://ant.design/)
|
|
- [组件库](http://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)
|
|
- [定制主题](http://ant.design/docs/react/customize-theme-cn)
|
|
|
|
## ⌨️ 本地开发
|
|
|
|
你可以使用 Gitpod 进行在线开发：
|
|
|
|
[](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)。
|
|
|
|
## 🤝 参与共建 [](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)，更好的问题更容易获得帮助。
|
|
|
|
[](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. [](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#support)
|
|
|
|
[](https://opencollective.com/ant-design#support)
|