ant-design/docs/react/introduce.en-US.md

174 lines
6.0 KiB
Markdown
Raw Normal View History

---
order: 0
title: Ant Design of React
---
2017-01-03 14:21:42 +08:00
Following Ant Design specification, We develop a React UI library `antd` that contains a set of high quality components and demos for building rich interactive desktop applications.
<div class="pic-plus">
<img width="150" src="https://t.alipayobjects.com/images/rmsweb/T11aVgXc4eXXXXXXXX.svg">
<span>+</span>
<img width="160" src="https://t.alipayobjects.com/images/rmsweb/T16xRhXkxbXXXXXXXX.svg">
</div>
<style>
.pic-plus > * {
display: inline-block!important;
vertical-align: middle;
}
.pic-plus span {
font-size: 30px;
color: #aaa;
margin: 0 20px;
}
</style>
---
## Features
2017-01-22 01:19:04 +08:00
- An enterprise-class UI design language for web applications.
2017-01-22 01:15:14 +08:00
- A set of high-quality React components out of the box.
- Written in TypeScript with complete define types.
- A npm + webpack + [dva](https://github.com/dvajs/dva) front-end development workflow.
2017-03-13 15:55:21 +08:00
## Environment Support
2017-03-13 15:55:21 +08:00
* Browser: Modern browsers and Internet Explorer 9+
* Server-side Rendering
* [Electron](http://electron.atom.io/)
## Version
- Stable: [![npm package](https://img.shields.io/npm/v/antd.svg?style=flat-square)](https://www.npmjs.org/package/antd)
- Beta: [![](https://cnpmjs.org/badge/v/antd.svg?&tag=beta&subject=npm)](https://www.npmjs.org/package/antd)
You can subscribe to this feed for new version notification: https://github.com/ant-design/ant-design/releases.atom
## Installation
2017-03-02 11:24:44 +08:00
### Using npm or yarn
2017-03-02 11:24:44 +08:00
**We recommend using npm or yarn to install**it not only makes development easierbut you can also take advantage of the whole ecosystem.
```bash
$ npm install antd --save
```
```bash
2017-03-02 11:24:44 +08:00
$ yarn add antd
```
2017-03-02 11:24:44 +08:00
If you are in a bad network enviornmentyou can try other registers and tools like [cnpm](https://github.com/cnpm/cnpm).
### Import in Browser
2017-03-03 13:48:22 +08:00
Add `script` and `link` tag in your browser and use global variable `antd`.
2017-03-03 13:48:22 +08:00
We provide `antd.js` `antd.css` and `antd.min.js` `antd.min.css` under `antd/dist` in antd's npm package. Also you can download from [![CDNJS](https://img.shields.io/cdnjs/v/antd.svg?style=flat-square)](https://cdnjs.com/libraries/antd) or [unpkg](https://unpkg.com/).
2017-03-03 13:48:22 +08:00
> **We are strongly not recommended to use these built files**, that make you import all components with large size, and you cannot get bugfixes from the dependencies of antd.
## Usage
```jsx
import { DatePicker } from 'antd';
ReactDOM.render(<DatePicker />, 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
2017-02-07 17:20:59 +08:00
// .babelrc or babel-loader option
{
2017-03-02 00:34:18 +08:00
"plugins": [
["import", { libraryName: "antd", style: "css" }] // `style: true` for less
]
}
```
2017-03-02 00:34:18 +08:00
Then you can import components from antd, equivalent to import manually below.
```jsx
// import js and css modularly, parsed by babel-plugin-import
import { DatePicker } from 'antd';
```
- Manually import
```jsx
2017-03-02 00:34:18 +08:00
import DatePicker from 'antd/lib/date-picker'; // for js
import 'antd/lib/date-picker/style/css'; // for css
// import 'antd/lib/date-picker/style'; // that will import less
```
2017-03-13 15:49:15 +08:00
### TypeScript
```js
// tsconfig.json
{
"compilerOptions": {
"moduleResolution": "node",
"jsx": "preserve",
"allowSyntheticDefaultImports": true
2017-03-12 15:20:25 +08:00
}
2017-03-13 15:49:15 +08:00
}
```
2017-03-12 15:20:25 +08:00
2017-03-23 15:11:35 +08:00
> Note:
> - set `allowSyntheticDefaultImports` to prevent `error TS1192: Module 'react' has no default export`.
> - Don't use @types/antd, antd provide a built-in ts definition already.
2017-03-12 15:20:25 +08:00
## Links
2017-03-12 15:20:25 +08:00
- [Home Page](http://ant.design/)
2016-12-12 20:44:40 +08:00
- [UI library](/docs/react/introduce)
- [Change Log](/changelog)
2016-12-02 17:00:40 +08:00
- [Scaffold tool](https://github.com/dvajs/dva-cli/)
2017-03-12 15:20:25 +08:00
- [rc-components](http://react-component.github.io/)
2016-11-14 11:08:26 +08:00
- [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)
2016-12-12 20:44:40 +08:00
- [Customize Theme](/docs/react/customize-theme)
2016-10-07 21:10:05 +08:00
## Who are using antd
2016-10-07 21:10:05 +08:00
- [Ant Financial](http://www.antgroup.com/index.htm?locale=en_US)
- [Alibaba](http://www.alibaba.com/)
- [Koubei](http://www.koubei.com/)
- [Meituan](http://www.meituan.com)
- [Didi](http://www.xiaojukeji.com/)
2016-11-28 21:00:26 +08:00
> If your company or product uses Ant Design, you are welcome to comment in [this issue](https://github.com/ant-design/ant-design/issues/477). Thank you!
## Contributing
Please read our [CONTRIBUTING.md](https://github.com/ant-design/ant-design/blob/master/.github/CONTRIBUTING.md) first.
If you have any idea to improve antd, just create a [Pull Request](https://github.com/ant-design/ant-design/pulls). Also, you can also [issue](https://github.com/ant-design/ant-design/issues/new) bugs.
> Recommend to read [*How To Ask Questions The Smart Way*](http://www.catb.org/~esr/faqs/smart-questions.html) and [How to Ask a Question in Open Source Community](https://github.com/seajs/seajs/issues/545) and [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html), 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`.
2016-10-20 14:49:51 +08:00
We recommend to tag your questions with `antd` on Stack Overflow.
2016-10-19 14:04:46 +08:00
2016-10-20 14:49:51 +08:00
1. [Stack Overflow](http://stackoverflow.com/questions/tagged/antd)(Recommended)
2. [![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)