ant-design/README.md
2016-05-11 16:08:28 +08:00

3.3 KiB

Ant Design npm package NPM downloads Dependency Status Join the chat at https://gitter.im/ant-design/ant-design

An enterprise-class UI design language and React-based implementation.

Features

  • An enterprise-class design language and high quality UI style.
  • Rich library of UI components base on React Component.
  • A npm + webpack + babel + dora workflow.

Install

npm install antd

Usage example

Use prebuilt bundle

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

Import style:

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

Use modularized antd

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

We recommend use babel-plugin-antd with config:

['antd', {
  style: 'css'
}]
import { DatePicker } from 'antd'; // automatically parse and require js and css modularly

No need to import style manually.

Browser Support

Normal browsers and Internet Explorer 8+.

IE8 issues

TypeScript

///<reference path='./node_modules/antd/type-definitions/antd.d.ts'/>
...

Contributing

We welcome all contributions, please read our CONTRIBUTING.md first. You can submit any ideas as pull requests or as a GitHub issue. If you'd like to improve code, check out the Development Instruction and have a good time! :)