# Ant Design [![](https://img.shields.io/travis/ant-design/ant-design.svg?style=flat-square)](https://travis-ci.org/ant-design/ant-design) [![Coverage Status](https://coveralls.io/repos/github/ant-design/ant-design/badge.svg?branch=master)](https://coveralls.io/github/ant-design/ant-design?branch=master) [![Dependency Status](https://img.shields.io/david/ant-design/ant-design.svg?style=flat-square)](https://david-dm.org/ant-design/ant-design) [![npm package](https://img.shields.io/npm/v/antd.svg?style=flat-square)](https://www.npmjs.org/package/antd) [![NPM downloads](http://img.shields.io/npm/dm/antd.svg?style=flat-square)](https://npmjs.org/package/antd) [![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/ant-design/ant-design.svg)](http://isitmaintained.com/project/ant-design/ant-design "Average time to resolve an issue") [![Join the chat at https://gitter.im/ant-design/ant-design](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ant-design/ant-design?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) An enterprise-class UI design language and React-based implementation. ## Features - An enterprise-class design language and high quality UI. - Graceful UI components out of the box, base on [React Component](http://react-component.github.io/badgeboard/). - Written in TypeScript with complete define types. - A npm + webpack + babel + [dora](https://github.com/dora-js/dora) + [dva](https://github.com/dvajs/dva) development framework. ## Let's build a better antd together `antd` is an open source project, any reasonable improvement is welcomed. If you are interested in contributing to `antd`, you can watch this repository and join in [discussion](https://github.com/ant-design/ant-design/issues?q=is%3Aopen+is%3Aissue+label%3ADiscussion), or try to implement some [features which had been accepted](https://github.com/ant-design/ant-design/issues?q=is%3Aopen+is%3Aissue+label%3A%22PR+welcome%22). ## Install ```bash npm install antd ``` ## Usage ### Use prebuilt bundle ```jsx import { DatePicker } from 'antd'; ReactDOM.render(, mountNode); ``` And import style manually: ```jsx import 'antd/dist/antd.css'; // or 'antd/dist/antd.less' ``` ### Use modularized antd - Use [babel-plugin-import](https://github.com/ant-design/babel-plugin-import) (Recommended) ```js // .babelrc { "plugins": [["import", { libraryName: "antd", style: "css" }]] } ``` Then you can import components from antd directly. ```jsx // import js and css modularly, parsed by babel-plugin-import import { DatePicker } from 'antd'; ``` - Manually import ```jsx import DatePicker from 'antd/lib/date-picker'; // just for js import 'antd/lib/date-picker/style/css'; // with style ``` ## Environment Support * Browser: Modern browsers and Internet Explorer 9+. > [IE8 issues](https://github.com/xcatliu/react-ie8) * Server-side Rendering * [Electron](http://electron.atom.io/) ## TypeScript tsconfig.json ```js { "compilerOptions": { "moduleResolution": "node", "jsx": "preserve", "allowSyntheticDefaultImports": true } } ``` > Note: set `allowSyntheticDefaultImports` to prevent `error TS1192: Module 'react' has no default export`. ## Links - [Home page](http://ant.design/) - [UI library](http://ant.design/docs/react/introduce) - [Change Log](CHANGELOG.en-US.md) - [Scaffold tool](https://github.com/dvajs/dva-cli/) - [Development tool](http://ant-tool.github.io/) - [React components](http://react-component.github.io/) - [Mobile UI](http://mobile.ant.design) - [Motion](https://motion.ant.design) - [Developer Instruction](https://github.com/ant-design/ant-design/wiki/Development) - [Versioning Release Note](https://github.com/ant-design/ant-design/wiki/%E8%BD%AE%E5%80%BC%E8%A7%84%E5%88%99%E5%92%8C%E7%89%88%E6%9C%AC%E5%8F%91%E5%B8%83%E6%B5%81%E7%A8%8B) - [Boilerplates](https://github.com/ant-design/ant-design/issues/129) - [FAQ](https://github.com/ant-design/ant-design/wiki/FAQ) - [CodePen boilerplate](http://codepen.io/benjycui/pen/KgPZrE?editors=001) for bug reports - [Awesome Ant Design](https://github.com/websemantics/awesome-ant-design) - [Customize Theme](http://ant.design/docs/react/customize-theme) ## Contributing We welcome all contributions, please read our [CONTRIBUTING.md](https://github.com/ant-design/ant-design/blob/master/.github/CONTRIBUTING.md) first. You can submit any ideas as [pull requests](https://github.com/ant-design/ant-design/pulls) or as a [GitHub issue](https://github.com/ant-design/ant-design/issues). If you'd like to improve code, check out the [Development Instruction](https://github.com/ant-design/ant-design/wiki/Development) and have a good time! :)