Getting Started

Ant Design React is dedicated to providing a good development experience for programmers. Make sure that you have installed Node.js(> 8.0.0) correctly.

Before delving into Ant Design React, a good knowledge base of React and JavaScript ES2015 is needed.

First Example#

Here is a simple example to show usage of Ant Design React.

1. Create one codesandbox#

Visit http://u.ant.design/codesandbox-repro to create a codesandbox. Don't forget to press the save button.

2. Using antd component#

Replace the content of index.js with the following code. As you can see, there is no difference between antd's components and typical React components.

import React from 'react';
import ReactDOM from 'react-dom';
import { DatePicker, message } from 'antd';
import 'antd/dist/antd.css';
import './index.css';

class App extends React.Component {
  state = {
    date: null,
  };

  handleChange = date => {
    message.info(`Selected Date: ${date ? date.format('YYYY-MM-DD') : 'None'}`);
    this.setState({ date });
  };

  render() {
    const { date } = this.state;
    return (
      <div style={{ width: 400, margin: '100px auto' }}>
        <DatePicker onChange={this.handleChange} />
        <div style={{ marginTop: 20 }}>
          Selected Date: {date ? date.format('YYYY-MM-DD') : 'None'}
        </div>
      </div>
    );
  }
}

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

3. Explore more components#

You can look up components in the side menu like the Alert component. Plenty of examples are provided in the component pages and API documentation.

Click the "Open in Editor" icon in the first example to open an editor with source code to use out-of-the-box. Now you can import the Alert component into the codesandbox:

- import { DatePicker, message } from 'antd';
+ import { DatePicker, message, Alert } from 'antd';

Add the following jsx into the render function.

  <DatePicker onChange={value => this.handleChange(value)} />
  <div style={{ marginTop: 20 }}>
-   Selected Date: {date ? date.format('YYYY-MM-DD') : 'None'}
+   <Alert message={`Selected Date: ${date ? date.format('YYYY-MM-DD') : 'None'}`} type="success" />
  </div>

Now you can see the result in the preview section.

codesandbox screenshot

OK! Now you know how to use antd components in a clear way. You are welcome to explore more components in the codesandbox. We also strongly recommend using codesandbox to provide a reproducible demo when reporting a bug.

4. Next Step#

In the real world you will need a development workflow consisting of compile/build/deploy/lint/debug. You can find and read articles on the subject or try other scaffolds provided below:

Compatibility#

Ant Design React supports all modern browsers and IE9+.

IE / Edge
IE / Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
Opera
Opera
Electron
Electron
IE9, IE10, IE11, Edgelast 2 versionslast 2 versionslast 2 versionslast 2 versionslast 2 versions

We offer very limited support for IE9/10 which means some styles and animations will be mininal for them. Also, we use Flex layout in a few components.

Note: Different than Ant Design, Ant Design Pro supports IE11+.

Polyfills are needed for IE browsers. We recommend babel-preset-env for it. You can set targets config if you are using umi.

Ant Design 3.0 supports both React 15 and 16 but we strongly suggest React 16 for better performance and fewer bugs.

IE8 note#

We don't support IE8 after [email protected].

Customized Work Flow#

If you want to customize your work flow, we recommend using webpack to build and debug code.

Also, you can use any scaffold available in the React ecosystem. If you encounter problems, you can use our webpack config and modify it.

If you are trying parcel, here is a demo repository.

There are some scaffolds which have already integrated antd, so you can try and start with one of these and even contribute.

Import on Demand#

If you see logs like in the screenshot below, you might be importing all components by writing import { Button } from 'antd';. This will affect your app's network performance.

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

console warning

However, we can import individual components on demand:

import Button from 'antd/lib/button';
import 'antd/lib/button/style'; // or antd/lib/button/style/css for css format file

antd/es/button to import es version module for tree shaking.

We strongly recommend using babel-plugin-import, which can convert the following code to the 'antd/lib/xxx' way:

import { Button } from 'antd';

And this plugin can load styles too. Read usage for more details.

FYI, babel-plugin-import's style option will importing some global reset styles, don't use it if you don't need those styles. You can import styles manually via import 'antd/dist/antd.css' and override the global reset styles.

Customization#

Ant Design of ReactReal project with umi and dva