ant-design/docs/react/introduce.zh-CN.md

169 lines
6.7 KiB
Markdown
Raw Normal View History

2016-03-31 14:17:09 +08:00
---
order: 0
title: Ant Design of React
2016-03-31 14:17:09 +08:00
---
2015-06-04 17:56:09 +08:00
2019-03-22 12:35:23 +08:00
`antd` 是基于 Ant Design 设计体系的 React UI 组件库,主要用于研发企业级中后台产品。
2015-07-23 21:18:36 +08:00
2015-08-22 20:51:10 +08:00
<div class="pic-plus">
2017-11-28 11:17:38 +08:00
<img width="150" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg">
2015-08-22 20:51:10 +08:00
<span>+</span>
<img width="160" src="https://gw.alipayobjects.com/zos/rmsportal/tXlLQhLvkEelMstLyHiN.svg">
2015-08-22 20:51:10 +08:00
</div>
2016-03-21 10:44:31 +08:00
2015-08-22 20:51:10 +08:00
<style>
.pic-plus > * {
2017-08-04 17:58:32 +08:00
display: inline-block !important;
2015-08-22 20:51:10 +08:00
vertical-align: middle;
}
.pic-plus span {
font-size: 30px;
color: #aaa;
margin: 0 20px;
}
</style>
2016-03-14 16:18:06 +08:00
---
2015-06-04 17:56:09 +08:00
## 特性
2017-01-22 01:15:14 +08:00
- 提炼自企业级中后台产品的交互语言和视觉风格。
- 开箱即用的高质量 React 组件。
- 使用 TypeScript 构建,提供完整的类型定义文件。
2018-03-16 13:35:43 +08:00
- 全链路开发和设计工具体系。
2015-07-08 20:08:19 +08:00
2017-03-13 15:55:21 +08:00
## 支持环境
2019-05-07 14:57:32 +08:00
- 现代浏览器和 IE9 及以上(需要 [polyfills](https://ant.design/docs/react/getting-started-cn#兼容性))。
- 支持服务端渲染。
- [Electron](http://electron.atom.io/)
## 版本
- 稳定版:[![npm package](https://img.shields.io/npm/v/antd.svg?style=flat-square)](https://www.npmjs.org/package/antd)
你可以订阅https://github.com/ant-design/ant-design/releases.atom 来获得稳定版发布的通知。
2016-02-02 18:24:49 +08:00
## 安装
2017-03-02 11:24:44 +08:00
### 使用 npm 或 yarn 安装
2017-03-02 11:24:44 +08:00
**我们推荐使用 npm 或 yarn 的方式进行开发**,不仅可在开发环境轻松调试,也可放心地在生产环境打包部署使用,享受整个生态圈和工具链带来的诸多好处。
2016-02-23 01:03:50 +08:00
```bash
$ npm install antd --save
2016-02-02 18:24:49 +08:00
```
2015-07-03 18:06:47 +08:00
```bash
2017-03-02 11:24:44 +08:00
$ yarn add antd
```
2017-03-02 11:24:44 +08:00
如果你的网络环境不佳,推荐使用 [cnpm](https://github.com/cnpm/cnpm)。
### 浏览器引入
2017-03-03 13:48:22 +08:00
在浏览器中使用 `script``link` 标签直接引入文件,并使用全局变量 `antd`
2018-09-11 14:15:48 +08:00
我们在 npm 发布包内的 `antd/dist` 目录下提供了 `antd.js` `antd.css` 以及 `antd.min.js` `antd.min.css`。你也可以通过 [![CDNJS](https://img.shields.io/cdnjs/v/antd.svg?style=flat-square)](https://cdnjs.com/libraries/antd)[![](https://data.jsdelivr.com/v1/package/npm/antd/badge)](https://www.jsdelivr.com/package/npm/antd) 或 [UNPKG](https://unpkg.com/antd/dist/) 进行下载。
2017-03-03 13:48:22 +08:00
> **强烈不推荐使用已构建文件**,这样无法按需加载,而且难以获得底层依赖模块的 bug 快速修复支持。
2017-12-26 11:53:03 +08:00
> 注意3.0 之后引入 antd.js 前你需要自行引入 [moment](http://momentjs.com/)。
2015-11-17 16:33:47 +08:00
## 示例
2015-11-08 19:09:28 +08:00
2015-07-03 18:06:47 +08:00
```jsx
import { DatePicker } from 'antd';
ReactDOM.render(<DatePicker />, mountNode);
2015-07-03 18:06:47 +08:00
```
2015-06-15 18:16:21 +08:00
2015-12-08 18:05:01 +08:00
引入样式:
2015-11-14 21:38:31 +08:00
```jsx
2019-05-07 14:57:32 +08:00
import 'antd/dist/antd.css'; // or 'antd/dist/antd.less'
2015-11-14 21:38:31 +08:00
```
2017-03-02 00:34:18 +08:00
### 按需加载
2015-12-08 18:05:01 +08:00
2019-06-21 00:16:25 +08:00
> 注意antd 默认支持基于 ES module 的 tree shaking不使用以下插件也会有按需加载的效果。
2017-03-02 00:34:18 +08:00
下面两种方式都可以只加载用到的组件。
2017-03-02 00:34:18 +08:00
- 使用 [babel-plugin-import](https://github.com/ant-design/babel-plugin-import)(推荐)。
2019-05-07 14:57:32 +08:00
```js
// .babelrc or babel-loader option
{
"plugins": [
["import", {
"libraryName": "antd",
"libraryDirectory": "es",
"style": "css" // `style: true` 会加载 less 文件
}]
]
}
```
然后只需从 antd 引入模块即可,无需单独引入样式。等同于下面手动引入的方式。
```jsx
// babel-plugin-import 会帮助你加载 JS 和 CSS
import { DatePicker } from 'antd';
```
2017-03-02 00:34:18 +08:00
- 手动引入
2019-05-07 14:57:32 +08:00
```jsx
2019-06-21 00:16:25 +08:00
import DatePicker from 'antd/es/date-picker'; // 加载 JS
import 'antd/es/date-picker/style/css'; // 加载 CSS
// import 'antd/es/date-picker/style'; // 加载 LESS
2019-05-07 14:57:32 +08:00
```
2015-12-08 18:05:01 +08:00
2015-06-15 18:16:21 +08:00
## 链接
2015-06-04 17:56:09 +08:00
2015-06-15 18:16:21 +08:00
- [首页](http://ant.design/)
2017-11-01 10:50:27 +08:00
- [组件库](/docs/react/introduce)
- [Ant Design Pro](http://pro.ant.design/)
2016-12-12 20:44:40 +08:00
- [更新日志](/changelog)
2017-05-13 16:12:35 +08:00
- [脚手架市场](http://scaffold.ant.design)
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)
2016-11-14 11:08:26 +08:00
- [动效](https://motion.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
- [常见问题](/docs/react/faq)
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-02-09 17:53:34 +08:00
- [定制主题](/docs/react/customize-theme)
2015-06-15 18:18:42 +08:00
2015-07-03 18:06:47 +08:00
## 谁在使用
2017-11-29 20:27:52 +08:00
- [蚂蚁金服](http://www.antfin.com/)
2016-10-07 21:10:05 +08:00
- [阿里巴巴](http://www.alibaba.com/)
- [腾讯](http://www.tencent.com)
- [百度](http://www.baidu.com)
2016-10-07 21:10:05 +08:00
- [口碑](http://www.koubei.com/)
- [美团](http://www.meituan.com)
- [滴滴](http://www.xiaojukeji.com/)
- [饿了么](https://www.ele.me/)
2015-06-15 18:18:42 +08:00
2015-11-04 20:30:50 +08:00
> 如果你的公司和产品使用了 Ant Design欢迎到 [这里](https://github.com/ant-design/ant-design/issues/477) 留言。
2015-06-15 18:18:42 +08:00
## 如何贡献
2017-04-02 14:03:42 +08:00
在任何形式的参与前,请先阅读 [贡献者文档](https://github.com/ant-design/ant-design/blob/master/.github/CONTRIBUTING.md)。如果你希望参与贡献,欢迎 [Pull Request](https://github.com/ant-design/ant-design/pulls),或给我们 [报告 Bug](http://new-issue.ant.design/)。
2016-06-18 16:05:14 +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),更好的问题更容易获得帮助。
## 社区互助
如果您在使用的过程中碰到问题,可以通过下面几个途径寻求帮助,同时我们也鼓励资深用户通过下面的途径给新人提供帮助。
2016-10-20 14:49:51 +08:00
通过 Stack Overflow 或者 Segment Fault 提问时,建议加上 `antd` 标签。
2016-10-19 14:04:46 +08:00
1. [<img alt="Stack Overflow" src="https://cdn.sstatic.net/Sites/stackoverflow/company/img/logos/so/so-logo.svg?v=2bb144720a66" width="140" />](http://stackoverflow.com/questions/tagged/antd)English
2018-04-19 18:05:27 +08:00
2. [<img alt="Segment Fault" src="https://gw.alipayobjects.com/zos/rmsportal/hfYFfCvHTQTUKntlJbMF.svg" width="100" />](https://segmentfault.com/t/antd)(中文)
2017-04-11 18:13:58 +08:00
3. [![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)
4. [![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)(中文)