mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-25 03:29:59 +08:00
427e5e8454
* docs: modify the doc of Form.Item messageVariables * docs: add Arabic documentation * docs: add Arabic link
156 lines
8.7 KiB
Markdown
156 lines
8.7 KiB
Markdown
<p align="center">
|
|
<a href="https://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.
|
|
|
|
[![CI status][github-action-image]][github-action-url] [![codecov][codecov-image]][codecov-url] [![NPM version][npm-image]][npm-url] [![NPM downloads][download-image]][download-url]
|
|
|
|
[![][bundlephobia-image]][bundlephobia-url] [![][bundlesize-js-image]][unpkg-js-url] [![FOSSA Status][fossa-image]][fossa-url]
|
|
|
|
[![Follow Twitter][twitter-image]][twitter-url] [![Renovate status][renovate-image]][renovate-dashboard-url] [![][issues-helper-image]][issues-helper-url] [![dumi][dumi-image]][dumi-url] [![Issues need help][help-wanted-image]][help-wanted-url]
|
|
|
|
[npm-image]: http://img.shields.io/npm/v/antd.svg?style=flat-square
|
|
[npm-url]: http://npmjs.org/package/antd
|
|
[github-action-image]: https://github.com/ant-design/ant-design/workflows/%E2%9C%85%20test/badge.svg
|
|
[github-action-url]: https://github.com/ant-design/ant-design/actions?query=workflow%3A%22%E2%9C%85+test%22
|
|
[codecov-image]: https://img.shields.io/codecov/c/github/ant-design/ant-design/master.svg?style=flat-square
|
|
[codecov-url]: https://codecov.io/gh/ant-design/ant-design/branch/master
|
|
[download-image]: https://img.shields.io/npm/dm/antd.svg?style=flat-square
|
|
[download-url]: https://npmjs.org/package/antd
|
|
[fossa-image]: https://app.fossa.io/api/projects/git%2Bgithub.com%2Fant-design%2Fant-design.svg?type=shield
|
|
[fossa-url]: https://app.fossa.io/projects/git%2Bgithub.com%2Fant-design%2Fant-design?ref=badge_shield
|
|
[help-wanted-image]: https://flat.badgen.net/github/label-issues/ant-design/ant-design/help%20wanted/open
|
|
[help-wanted-url]: https://github.com/ant-design/ant-design/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22
|
|
[twitter-image]: https://img.shields.io/twitter/follow/AntDesignUI.svg?label=Ant%20Design
|
|
[twitter-url]: https://twitter.com/AntDesignUI
|
|
[bundlesize-js-image]: https://img.badgesize.io/https:/unpkg.com/antd/dist/antd.min.js?label=antd.min.js&compression=gzip&style=flat-square
|
|
[unpkg-js-url]: https://unpkg.com/browse/antd/dist/antd.min.js
|
|
[bundlephobia-image]: https://badgen.net/bundlephobia/minzip/antd?style=flat-square
|
|
[bundlephobia-url]: https://bundlephobia.com/package/antd
|
|
[issues-helper-image]: https://img.shields.io/badge/using-issues--helper-orange?style=flat-square
|
|
[issues-helper-url]: https://github.com/actions-cool/issues-helper
|
|
[renovate-image]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?style=flat-square
|
|
[renovate-dashboard-url]: https://github.com/ant-design/ant-design/issues/32498
|
|
[dumi-image]: https://img.shields.io/badge/docs%20by-dumi-blue?style=flat-square
|
|
[dumi-url]: https://github.com/umijs/dumi
|
|
|
|
</div>
|
|
|
|
[](https://ant.design)
|
|
|
|
English | [Português](./README-pt_BR.md) | [简体中文](./README-zh_CN.md) | [Українською](./README-uk_UA.md) | [Spanish](./README-sp_MX.md) | [日本語](./README-ja_JP.md) | [العربية](./README-ar_EG.md)
|
|
|
|
## ✨ Features
|
|
|
|
- 🌈 Enterprise-class UI designed for web applications.
|
|
- 📦 A set of high-quality React components out of the box.
|
|
- 🛡 Written in TypeScript with predictable static types.
|
|
- ⚙️ Whole package of design resources and development tools.
|
|
- 🌍 Internationalization support for dozens of languages.
|
|
- 🎨 Powerful theme customization based on CSS-in-JS.
|
|
|
|
## 🖥 Environment Support
|
|
|
|
- Modern browsers
|
|
- Server-side Rendering
|
|
- [Electron](https://www.electronjs.org/)
|
|
|
|
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br>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/electron/electron_48x48.png" alt="Electron" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br>Electron |
|
|
| --- | --- | --- | --- | --- |
|
|
| Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
|
|
|
|
## 📦 Install
|
|
|
|
```bash
|
|
npm install antd
|
|
```
|
|
|
|
```bash
|
|
yarn add antd
|
|
```
|
|
|
|
## 🔨 Usage
|
|
|
|
```jsx
|
|
import React from 'react';
|
|
import { Button, DatePicker } from 'antd';
|
|
|
|
const App = () => (
|
|
<>
|
|
<Button type="primary">PRESS ME</Button>
|
|
<DatePicker placeholder="select date" />
|
|
</>
|
|
);
|
|
```
|
|
|
|
### TypeScript
|
|
|
|
`antd` is written in TypeScript with complete definitions, check [Use in TypeScript](https://ant.design/docs/react/use-in-typescript) to get started.
|
|
|
|
## 🌍 Internationalization
|
|
|
|
Dozens of languages are supported in `antd`, see [i18n](https://ant.design/docs/react/i18n).
|
|
|
|
## 🔗 Links
|
|
|
|
- [Home page](https://ant.design/)
|
|
- [Components Overview](https://ant.design/components/overview)
|
|
- [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)
|
|
- [Mini Program UI](http://mini.ant.design)
|
|
- [Ant Design Pro Components](https://procomponents.ant.design)
|
|
- [Ant Design Charts](https://charts.ant.design)
|
|
- [Ant Design Icons](https://github.com/ant-design/ant-design-icons)
|
|
- [Ant Design Colors](https://github.com/ant-design/ant-design-colors)
|
|
- [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
|
|
- [Customize Theme](https://ant.design/docs/react/customize-theme)
|
|
- [How to Apply for Being A Collaborator](https://github.com/ant-design/ant-design/wiki/Collaborators#how-to-apply-for-being-a-collaborator)
|
|
|
|
## ⌨️ 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 with [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)
|