mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-18 11:18:14 +08:00
130 lines
10 KiB
Markdown
130 lines
10 KiB
Markdown
<p align="center">
|
|
<a href="http://ant.design">
|
|
<img width="200" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg">
|
|
</a>
|
|
</p>
|
|
|
|
<h1 align="center">Ant Design</h1>
|
|
|
|
<div align="center">
|
|
|
|
An enterprise-class UI design language and React UI library.
|
|
|
|
[](https://circleci.com/gh/ant-design/ant-design)  [](https://codecov.io/gh/ant-design/ant-design/branch/master) [](https://www.npmjs.com/package/antd) [](https://www.npmjs.com/package/antd) [](http://npmjs.com/antd)
|
|
|
|
[](https://david-dm.org/ant-design/ant-design) [](https://david-dm.org/ant-design/ant-design?type=dev) [](https://lgtm.com/projects/g/ant-design/ant-design/alerts/) [](https://app.fossa.io/projects/git%2Bgithub.com%2Fant-design%2Fant-design?ref=badge_shield) [](https://github.com/ant-design/ant-design/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
|
|
|
|
[](https://twitter.com/AntDesignUI) [](https://gitter.im/ant-design/ant-design-english?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [](https://gitter.im/ant-design/ant-design?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
</div>
|
|
|
|
[](http://ant.design)
|
|
|
|
English | [简体中文](./README-zh_CN.md)
|
|
|
|
## ✨ Features
|
|
|
|
- An enterprise-class UI design system for web applications.
|
|
- A set of high-quality React components out of the box.
|
|
- Written in TypeScript with predictable static types.
|
|
- The whole package of development and design resources and tools.
|
|
|
|
## 🖥 Environment Support
|
|
|
|
- Modern browsers and Internet Explorer 9+ (with [polyfills](https://ant.design/docs/react/getting-started#Compatibility))
|
|
- Server-side Rendering
|
|
- [Electron](http://electron.atom.io/)
|
|
|
|
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Opera | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/electron/electron_48x48.png" alt="Electron" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Electron |
|
|
| --- | --- | --- | --- | --- | --- |
|
|
| IE9, IE10, IE11, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
|
|
|
|
## 📦 Install
|
|
|
|
```bash
|
|
npm install antd
|
|
```
|
|
|
|
```bash
|
|
yarn add 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'
|
|
```
|
|
|
|
Or [import components on demand](https://ant.design/docs/react/getting-started#Import-on-Demand).
|
|
|
|
### TypeScript
|
|
|
|
See [Use in TypeScript](https://ant.design/docs/react/use-in-typescript).
|
|
|
|
## 🌍 Internationalization
|
|
|
|
See [i18n](http://ant.design/docs/react/i18n).
|
|
|
|
## 🔗 Links
|
|
|
|
- [Home page](http://ant.design/)
|
|
- [Components](http://ant.design/docs/react/introduce)
|
|
- [Ant Design Pro](http://pro.ant.design/)
|
|
- [Change Log](CHANGELOG.en-US.md)
|
|
- [rc-components](http://react-component.github.io/)
|
|
- [Mobile UI](http://mobile.ant.design)
|
|
- [Ant Design Icons](https://github.com/ant-design/ant-design-icons)
|
|
- [Ant Design Colors](https://github.com/ant-design/ant-design-colors)
|
|
- [Ant Design Pro Layout](https://github.com/ant-design/ant-design-pro-layout)
|
|
- [Ant Design Pro Blocks](https://github.com/ant-design/pro-blocks)
|
|
- [Dark Theme](https://github.com/ant-design/ant-design-dark-theme)
|
|
- [Landing Pages](https://landing.ant.design)
|
|
- [Motion](https://motion.ant.design)
|
|
- [Scaffold Market](http://scaffold.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)
|
|
- [FAQ](https://ant.design/docs/react/faq)
|
|
- [CodeSandbox Template](https://u.ant.design/codesandbox-repro) for bug reports
|
|
- [Awesome Ant Design](https://github.com/websemantics/awesome-ant-design)
|
|
- [Customize Theme](http://ant.design/docs/react/customize-theme)
|
|
|
|
## ⌨️ Development
|
|
|
|
Use Gitpod, a free online dev environment for GitHub.
|
|
|
|
[](https://gitpod.io/#https://github.com/ant-design/ant-design)
|
|
|
|
Or clone locally:
|
|
|
|
```bash
|
|
$ git clone git@github.com:ant-design/ant-design.git
|
|
$ cd ant-design
|
|
$ npm install
|
|
$ npm start
|
|
```
|
|
|
|
Open your browser and visit http://127.0.0.1:8001 , see more at [Development](https://github.com/ant-design/ant-design/wiki/Development).
|
|
|
|
## 🤝 Contributing [](http://makeapullrequest.com)
|
|
|
|
Read our [contributing guide](https://ant.design/docs/react/contributing) and let's build a better antd together.
|
|
|
|
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 [GitHub issues](https://github.com/ant-design/ant-design/issues). If you'd like to improve code, check out the [Development Instructions](https://github.com/ant-design/ant-design/wiki/Development) and have a good time! :)
|
|
|
|
If you are a collaborator, please follow our [Pull Request principle](https://github.com/ant-design/ant-design/wiki/PR-principle) to create a Pull Request by [collaborator template](https://github.com/ant-design/ant-design/compare?expand=1&template=collaborator.md).
|
|
|
|
[](https://issuehunt.io/repos/34526884)
|
|
|
|
## ❤️ Sponsors and Backers [](https://opencollective.com/ant-design#support) [](https://opencollective.com/ant-design#support)
|
|
|
|
[](https://opencollective.com/ant-design#support)
|
|
|
|
[](https://opencollective.com/ant-design#support)
|