ant-design/README.md

63 lines
3.0 KiB
Markdown
Raw Normal View History

2015-12-06 17:40:04 +08:00
<p align="center">
<a href="http://ant.design">
<img width="320" src="https://t.alipayobjects.com/images/rmsweb/T1B9hfXcdvXXXXXXXX.svg">
</a>
</p>
2016-02-01 18:21:39 +08:00
# Ant Design [![](https://img.shields.io/travis/ant-design/ant-design.svg?style=flat-square)](https://travis-ci.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) [![Dependency Status](https://david-dm.org/ant-design/ant-design.svg?style=flat-square)](https://david-dm.org/ant-design/ant-design) [![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)
2015-07-30 17:46:27 +08:00
An enterprise-class UI design language and React-based implementation.
2015-06-14 18:28:08 +08:00
## Features
2015-06-14 18:28:08 +08:00
2016-02-23 11:32:00 +08:00
- An enterprise-class design language and high quality UI style.
- Rich library of UI components base on [React Component](http://react-component.github.io/badgeboard/).
2016-02-23 11:30:44 +08:00
- A npm + webpack + babel + dora [workflow](http://ant-tool.github.io/index.html).
2015-07-08 20:08:19 +08:00
2015-11-02 20:37:38 +08:00
## Install
```bash
npm install antd
```
## Usage example
2015-07-03 12:21:29 +08:00
2015-12-16 15:04:51 +08:00
```jsx
import { DatePicker } from 'antd';
ReactDOM.render(<DatePicker />, mountNode);
```
2015-10-27 22:17:54 +08:00
2015-12-08 18:05:01 +08:00
Import style:
```jsx
2015-12-16 15:04:51 +08:00
import 'antd/lib/index.css'; // or 'antd/style/index.less'
2015-12-08 18:05:01 +08:00
```
2015-12-16 15:26:14 +08:00
Use components on demand by writing as `import DatePicker from 'antd/lib/date-picker'` or use [babel-plugin-antd](https://github.com/ant-design/babel-plugin-antd).
2015-12-16 15:04:51 +08:00
2015-12-08 18:05:01 +08:00
2015-11-02 20:37:38 +08:00
## Browser Support
Normal browsers and Internet Explorer 8+.
2016-01-14 14:29:30 +08:00
> [IE8 issues](https://github.com/xcatliu/react-ie8)
2015-11-02 20:37:38 +08:00
## Links
2015-06-14 18:28:08 +08:00
- [Home page](http://ant.design/)
2016-01-14 11:08:25 +08:00
- [React UI library](http://ant.design/docs/react/introduce)
- [ChangeLog](CHANGELOG.md)
2015-12-30 22:20:30 +08:00
- [Scaffold tool](https://github.com/ant-design/antd-init/)
2016-01-19 17:30:58 +08:00
- [Development tool](http://ant-tool.github.io/)
2015-11-29 00:37:11 +08:00
- [React components](http://react-component.github.io/)
2015-12-04 17:11:18 +08:00
- [React style guide](https://github.com/react-component/react-component.github.io/blob/master/docs/zh-cn/component-code-style.md)
- [React component design guide](https://github.com/react-component/react-component.github.io/blob/master/docs/zh-cn/component-design.md)
2016-03-31 00:20:10 +08:00
- [Developer Instruction](https://github.com/ant-design/ant-design/wiki/Development)
- [Versioning Release Note](https://github.com/ant-design/ant-design/wiki/%E7%89%88%E6%9C%AC%E5%8F%91%E5%B8%83%E6%B5%81%E7%A8%8B)
2016-01-17 15:18:28 +08:00
- [FAQ](https://github.com/ant-design/ant-design/wiki/FAQ)
2015-06-14 18:28:08 +08:00
2015-06-15 18:16:21 +08:00
## Contributing
2016-03-31 00:20:10 +08:00
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! :)