ant-design/docs/react/introduce.en-US.md
2016-12-16 22:10:47 +08:00

4.6 KiB

order title
0 Ant Design of React

Following Ant Design specification, We develop a React UI library called antd, containing a set of high quality components and demos, to help building rich interactive desktop applicafions.

+

Features

  • Following Ant Design desktop specification.
  • It is a set of high quality UI components and based on React Component.
  • Provides a work flow which is based on npm, webpack, and babel, supporting ES2015 and TypeScript.

Installation

$ npm install antd --save

Usage

Use prebuilt bundle

import { DatePicker } from 'antd';
ReactDOM.render(<DatePicker />, mountNode);

And import style manually:

import 'antd/dist/antd.css';  // or 'antd/dist/antd.less'

Use modularized antd

  • Use babel-plugin-import (Recommended)

    // .babelrc
    {
      "plugins": [["import", { libraryName: "antd", style: "css" }]]
    }
    

    Then you can import components from antd directly.

    // import js and css modularly, parsed by babel-plugin-import
    import { DatePicker } from 'antd';
    
  • Manually import

    import DatePicker from 'antd/lib/date-picker';  // just for js
    import 'antd/lib/date-picker/style/css';  // with style
    

Version

  • Stable: npm package
  • Beta:

Compatibility

Modern browsers and IE9+.

IE8 issues

Who are using antd

If your company or product uses Ant Design, you are welcome to comment in this issue. Thank you!

Contributing

Please read our CONTRIBUTING.md first.

If you have any idea to improve antd, just create a Pull Request. Also, you can also issue bugs.

Recommend to read How To Ask Questions The Smart Way and How to Ask a Question in Open Source Community and How to Report Bugs Effectively, a smart question will get right answer quickly.

Need Help?

You can ask questions while you meet problem through the following ways. And we encourage experienced users to help those who are not familiar with antd.

We recommend to tag your questions with antd on Stack Overflow.

  1. Stack Overflow(Recommended)
  2. Join the chat at https://gitter.im/ant-design/ant-design