mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-26 09:58:33 +08:00
107 lines
4.0 KiB
Markdown
107 lines
4.0 KiB
Markdown
<p align="center">
|
|
<a href="http://ant.design">
|
|
<img width="320" src="https://t.alipayobjects.com/images/rmsweb/T1B9hfXcdvXXXXXXXX.svg">
|
|
</a>
|
|
</p>
|
|
|
|
# Ant Design [](https://travis-ci.org/ant-design/ant-design) [](https://www.npmjs.org/package/antd) [](https://npmjs.org/package/antd) [](https://david-dm.org/ant-design/ant-design) [](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.
|
|
|
|
## :loudspeaker: Document Translation Recruitment
|
|
|
|
We are now working on translate components document to English, and we need some translator and reviewer. https://github.com/ant-design/ant-design/issues/1471
|
|
|
|
## 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/).
|
|
- A npm + webpack + babel + dora [workflow](http://ant-tool.github.io/index.html).
|
|
|
|
## Install
|
|
|
|
```bash
|
|
npm install antd
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Use prebuilt bundle
|
|
|
|
```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-antd](https://github.com/ant-design/babel-plugin-antd) (Recommended)
|
|
|
|
```js
|
|
// .babelrc
|
|
{
|
|
"plugins": [["antd", { style: "css" }]]
|
|
}
|
|
```
|
|
|
|
Then you can import components from antd directly.
|
|
|
|
```jsx
|
|
// import js and css modularly, parsed by babel-plugin-antd
|
|
import { DatePicker } from 'antd';
|
|
```
|
|
|
|
- Manually import
|
|
|
|
```jsx
|
|
import DatePicker from 'antd/lib/date-picker'; // just for js
|
|
```
|
|
|
|
|
|
## Browser Support
|
|
|
|
Normal browsers and Internet Explorer 8+.
|
|
|
|
> [IE8 issues](https://github.com/xcatliu/react-ie8)
|
|
|
|
## TypeScript
|
|
|
|
tsconfig.json
|
|
|
|
```
|
|
{
|
|
"compilerOptions": {
|
|
"moduleResolution": "node",
|
|
"jsx": "preserve"
|
|
}
|
|
}
|
|
```
|
|
|
|
## Links
|
|
|
|
- [Home page](http://ant.design/)
|
|
- [React UI page](http://ant.design/#/docs/react/introduce)
|
|
- [ChangeLog](CHANGELOG.md)
|
|
- [Scaffold tool](https://github.com/ant-design/antd-init/)
|
|
- [Development tool](http://ant-tool.github.io/)
|
|
- [React components](http://react-component.github.io/)
|
|
- [Mobile UI](http://mobile.ant.design)
|
|
- [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)
|
|
- [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/anon/pen/wGOWGW?editors=001) for bug reports
|
|
- [Awesome Ant Design](https://github.com/websemantics/awesome-ant-design)
|
|
|
|
## 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! :)
|