快速上手

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

在开始之前,推荐先学习 ReactES2015,并正确安装和配置了 Node.js v6.5 或以上。

第一个例子#

最简单的使用方式参照以下 CodeSandbox 演示,也推荐 Fork 本例来进行 Bug Report,注意不要在实际项目中这样使用。

标准开发#

实际项目开发中,你会需要对 ES2015 和 JSX 代码的构建、调试、代理、打包部署等一系列工程化的需求。 我们提供了一套 npm + webpack 的开发工具链来辅助开发,下面我们用一个简单的实例来说明。

1. 安装脚手架工具#

antd-init 是一个用于演示 antd 如何使用的脚手架工具,真实项目建议使用 dva-cli

$ npm install antd-init -g

更多功能请参考 脚手架工具开发工具文档

除了官方提供的脚手架,您也可以使用社区提供的脚手架和范例:

2. 创建一个项目#

使用命令行进行初始化。

$ mkdir antd-demo && cd antd-demo
$ antd-init

antd-init 会自动安装 npm 依赖,若有问题则可自行安装。

若安装缓慢报错,可尝试用 cnpm 或别的镜像源自行安装:rm -rf node_modules && cnpm install

3. 使用组件#

脚手架会生成一个 Todo 应用实例(一个很有参考价值的 React 上手示例),先不管它,我们用来测试组件。

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

import React from 'react';
import ReactDOM from 'react-dom';
import { LocaleProvider, DatePicker, message } from 'antd';
// 由于 antd 组件的默认文案是英文,所以需要修改为中文
import zhCN from 'antd/lib/locale-provider/zh_CN';
import moment from 'moment';
import 'moment/locale/zh-cn';

moment.locale('zh-cn');

class App extends React.Component {
  constructor(props) {
    super(props);
    this.state = {
      date: '',
    };
  }
  handleChange(date) {
    message.info('您选择的日期是: ' + date.toString());
    this.setState({ date });
  }
  render() {
    return (
      <LocaleProvider locale={zhCN}>
        <div style={{ width: 400, margin: '100px auto' }}>
          <DatePicker onChange={value => this.handleChange(value)} />
          <div style={{ marginTop: 20 }}>当前日期:{this.state.date.toString()}</div>
        </div>
      </LocaleProvider>
    );
  }
}

ReactDOM.render(<App />, document.getElementById('root'));

你可以在左侧菜单选用更多组件。

4. 开发调试#

一键启动调试,访问 http://127.0.0.1:8000 查看效果。

$ npm start

5. 构建和部署#

$ npm run build

入口文件会构建到 dist 目录中,你可以自由部署到不同环境中进行引用。

上述例子用于帮助你理解 Ant Design React 的使用流程,并非真实的开发过程,你可以根据自己的项目开发流程进行接入。

兼容性#

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

对于 IE 系列浏览器,需要提供 es5-shimes6-shim 等 Polyfills 的支持。

如果你使用了 babel,强烈推荐使用 babel-polyfillbabel-plugin-transform-runtime 来替代以上两个 shim。

避免同时使用 babel 和 shim 两种兼容方法,以规避 #6512 中所遇问题

如果在 IE 浏览器中遇到 startsWith问题,请引入 es6-shimbabel-polyfill

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <!-- 引入样式 -->
    <link rel="stylesheet" href="/index.css">
    <!-- Polyfills -->
    <!--[if lt IE 10]>
    <script src="https://as.alipayobjects.com/g/component/??console-polyfill/0.2.2/index.js,es5-shim/4.5.7/es5-shim.min.js,es5-shim/4.5.7/es5-sham.min.js,es6-shim/0.35.1/es6-sham.min.js,es6-shim/0.35.1/es6-shim.min.js,html5shiv/3.7.2/html5shiv.min.js,media-match/2.0.2/media.match.min.js"></script>
    <![endif]-->
    <script src="https://as.alipayobjects.com/g/component/??es6-shim/0.35.1/es6-sham.min.js,es6-shim/0.35.1/es6-shim.min.js"></script>
  </head>
  <body>
  </body>
  <!-- 引入公用文件 -->
  <script src="/common.js"></script>
  <!-- 引入入口文件 -->
  <script src="/index.js"></script>
</html>

IE8 note#

antd@2.0 之后将不再支持 IE8。

IE8 需要配合使用 react@0.14.x 版本。

另外,由于 babel@6.x 对 IE8 的支持不佳,你可能会遇到类似 #28#858 的 default 报错的问题,你也可以参照这个 webpack 配置 来解决。

更多 IE8 下使用 React 的相关问题可以参考:https://github.com/xcatliu/react-ie8

自行构建#

如果想自己维护工作流,我们推荐使用 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/lib/button';
import 'antd/lib/button/style'; // 或者 antd/lib/button/style/css 加载 css 文件

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

import { Button } from 'antd';

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

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

配置主题和字体#

小贴士#

  • 你可以享用 npm 生态圈里的所有模块。

  • 我们使用了 babel,试试用 ES2015+ 的写法来提升编码的愉悦感。