快速上手

Ant Design React 致力于提供给程序员愉悦的开发体验。

在开始之前，推荐先学习 React 和 ES2015，并正确安装和配置了 Node.js v8 或以上。官方指南假设你已了解关于 HTML、CSS 和 JavaScript 的中级知识，并且已经完全掌握了 React 全家桶的正确开发方式。如果你刚开始学习前端或者 React，将 UI 框架作为你的第一步可能不是最好的主意。

第一个例子

这是一个最简单的 Ant Design 组件的在线 codesandbox 演示。

1. 创建一个 codesandbox

访问 http://u.ant.design/codesandbox-repro 创建一个 codesandbox 的在线示例，别忘了保存以创建一个新的实例。

2. 使用组件

直接用下面的代码替换 index.js 的内容，用 React 的方式直接使用 antd 组件。

  1. import React from 'react';
  2. import ReactDOM from 'react-dom';
  3. import { ConfigProvider, DatePicker, message } from 'antd';
  4. // 由于 antd 组件的默认文案是英文，所以需要修改为中文
  5. import zhCN from 'antd/es/locale/zh_CN';
  6. import moment from 'moment';
  7. import 'moment/locale/zh-cn';
  8. import 'antd/dist/antd.css';
  9. import './index.css';
  11. moment.locale('zh-cn');
  13. class App extends React.Component {
  14.   state = {
  15.     date: null,
  16.   };
  18.   handleChange = date => {
  19.     message.info(`您选择的日期是: ${date ? date.format('YYYY-MM-DD') : '未选择'}`);
  20.     this.setState({ date });
  21.   };
  22.   render() {
  23.     const { date } = this.state;
  24.     return (
  25.       <ConfigProvider locale={zhCN}>
  26.         <div style={{ width: 400, margin: '100px auto' }}>
  27.           <DatePicker onChange={this.handleChange} />
  28.           <div style={{ marginTop: 20 }}>
  29.             当前日期：{date ? date.format('YYYY-MM-DD') : '未选择'}
  30.           </div>
  31.         </div>
  32.       </ConfigProvider>
  33.     );
  34.   }
  35. }
  37. ReactDOM.render(<App />, document.getElementById('root'));

3. 探索更多组件用法

你可以在左侧菜单查看组件列表，比如 Alert 组件，组件文档中提供了各类演示，最下方有组件 API 文档可以查阅。在代码演示部分找到第一个例子，点击右下角的图标展开代码。

然后依照演示代码的写法，在之前的 codesandbox 里修改 index.js，首先在 import 内引入 Alert 组件：

  1. - import { ConfigProvider, DatePicker, message } from 'antd';
  2. + import { ConfigProvider, DatePicker, message, Alert } from 'antd';

然后在 render 内添加相应的 jsx 代码：

  1.   <DatePicker onChange={value => this.handleChange(value)} />
  2.   <div style={{ marginTop: 20 }}>
  3. -   当前日期：{date ? date.format('YYYY-MM-DD') : '未选择'}
  4. +   <Alert message={`当前日期：${date ? date.format('YYYY-MM-DD') : '未选择'}`} type="success" />
  5.   </div>

在右侧预览区就可以看到如图的效果。

codesandbox screenshot

好的，现在你已经会使用基本的 antd 组件了，你可以在这个例子中继续探索其他组件的用法。如果你遇到组件的 bug，也推荐建一个可重现的 codesandbox 来报告 bug。

4. 下一步

实际项目开发中，你会需要构建、调试、代理、打包部署等一系列工程化的需求。您可以阅读后面的文档或者使用以下脚手架和范例：

兼容性

Ant Design React 支持所有的现代浏览器和 IE11+。

IE / EdgeIE / EdgeFirefoxFirefoxChromeChromeSafariSafariOperaOperaElectronElectron
IE11, Edgelast 2 versionslast 2 versionslast 2 versionslast 2 versionslast 2 versions

对于 IE 系列浏览器，需要提供相应的 Polyfill 支持，建议使用 babel-preset-env 来解决浏览器兼容问题。如果你在使用 umi，可以直接使用 targets 配置。

Ant Design 3.0 对 React 15/16 两个版本提供支持，但是我们强烈建议你升级到 React 16，以便获得更好的性能和遇到更少的问题。

IE note

[email protected] 之后将不再支持 IE8，[email protected] 之后将不再支持 IE9/10。

自行构建

如果想自己维护工作流，我们推荐使用 webpack 进行构建和调试。理论上你可以利用 React 生态圈中的 各种脚手架 进行开发，如果遇到问题可参考我们所使用的 webpack 配置 进行 定制。

如果你使用 parcel，这里也有 一个例子 可以参考。

目前社区也有很多基于 antd 定制的 脚手架，欢迎进行试用和贡献。

按需加载

如果你在开发环境的控制台看到下面的提示，那么你可能使用了 import { Button } from 'antd'; 的写法引入了 antd 下所有的模块，这会影响应用的网络性能。

You are using a whole package of antd, please use https://www.npmjs.com/package/babel-plugin-import to reduce app bundle size.

控制台警告

可以通过以下的写法来按需加载组件。

import Button from 'antd/es/button';
import 'antd/es/button/style'; // 或者 antd/es/button/style/css 加载 css 文件

注意：antd 默认支持基于 ES module 的 tree shaking，对于 js 部分，直接引入 import { Button } from 'antd' 也会有按需加载的效果。

如果你使用了 babel，那么可以使用 babel-plugin-import 来进行按需加载，加入这个插件后。你可以仍然这么写：

import { Button } from 'antd';

插件会帮你转换成 antd/es/xxx 的写法。另外此插件配合 style 属性可以做到模块样式的按需自动加载。

注意，babel-plugin-import 的 style 属性除了引入对应组件的样式，也会引入一些必要的全局样式。如果你不需要它们，建议不要使用此属性。你可以 import 'antd/dist/antd.css' 手动引入，并覆盖全局样式。

使用 Day.js 替换 momentjs 优化打包大小

你可以使用 antd-dayjs-webpack-plugin 插件用 Day.js 替换 momentjs 来大幅减小打包大小。这需要更新 webpack 的配置文件如下：

// webpack-config.js
import AntdDayjsWebpackPlugin from 'antd-dayjs-webpack-plugin';

module.exports = {
  // ...
  plugins: [new AntdDayjsWebpackPlugin()],
};

配置主题和字体