ant-design/README.md

68 lines
2.6 KiB
Markdown
Raw Normal View History

2015-08-25 17:17:46 +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) [![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
![](https://t.alipayobjects.com/images/rmsweb/T11aVgXc4eXXXXXXXX.svg)
2015-06-14 18:29:20 +08:00
## Features
2015-06-14 18:28:08 +08:00
- An enterprise-class graphical design language and framework for financial applications
- Rich library of UI components base on [React Component](http://react-component.github.io/badgeboard/).
- A Component development model based on React.
- Backed by the npm ecosystem.
- webpack-based debug builds supporting ES6
2015-07-08 20:08:19 +08:00
2015-11-02 20:37:38 +08:00
## Install
```bash
npm install antd
```
For a version compatible with React 0.14+ please use our beta version of [0.10.0](https://github.com/ant-design/ant-design/issues/276).
```bash
npm install antd@beta
```
2015-06-14 18:28:08 +08:00
## Usage example
2015-07-03 12:21:29 +08:00
2015-11-03 15:08:41 +08:00
- Use all components
2015-10-27 22:17:54 +08:00
2015-11-03 15:08:41 +08:00
```jsx
import { Datepicker } from 'antd';
ReactDOM.render(<Datepicker />, mountNode);
```
2015-06-14 18:28:08 +08:00
2015-11-03 15:08:41 +08:00
- Use on demand
2015-10-27 22:17:54 +08:00
2015-11-03 15:08:41 +08:00
```jsx
import 'antd/lib/index.css'; // only need to import once in entry module
import Datepicker from 'antd/lib/datepicker';
ReactDOM.render(<Datepicker />, mountNode);
```
2015-10-27 22:17:54 +08:00
2015-11-02 20:37:38 +08:00
## Browser Support
Normal browsers and Internet Explorer 8+.
## Links
2015-06-14 18:28:08 +08:00
- [Home page](http://ant.design/)
2015-10-21 20:41:05 +08:00
- [Documentation and Components](http://ant.design/docs/introduce)
- [Components](http://ant.design/components/)
- [Build/Debug tools](https://github.com/ant-design/antd-bin)
- [Roadmap](https://github.com/ant-design/ant-design/issues/9)
- [ChangeLog](CHANGELOG.md)
- [React modules](http://react-component.github.io/)
- [React style guide](https://github.com/react-component/react-component.github.io/blob/master/docs/en-US/component-code-style.md)
- [React component design guide](https://github.com/react-component/react-component.github.io/blob/master/docs/en-US/component-design.md)
- [Developer Instruction](https://github.com/ant-design/ant-design/wiki/%E7%BD%91%E7%AB%99%E5%92%8C%E7%BB%84%E4%BB%B6%E5%BC%80%E5%8F%91%E8%AF%B4%E6%98%8E)
- [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)
2015-06-14 18:28:08 +08:00
2015-06-15 18:16:21 +08:00
## Contributing
We welcome all contributions, please 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).