mirror of https://github.com/ant-design/ant-design.git synced 2024-11-24 19:19:57 +08:00

An enterprise-class UI design language and React UI library

ant-design antd design-systems react typescript ui-kit ui-library

Go to file

Sam Chen 87f998beb7 docs: fix typo (#23013 )		2020-04-08 09:34:26 +08:00
.circleci	fix: should work in old version react (#19262 )	2019-10-17 16:01:46 +08:00
.codesandbox	chore: 📝 improve docs and config json (#20364 )	2019-12-20 15:07:18 +08:00
.github	chore: ✨ update mirror.yml	2020-03-26 18:36:55 +08:00
components	fix form status (#23004 )	2020-04-07 22:51:54 +08:00
docs	docs: fix typo (#23013 )	2020-04-08 09:34:26 +08:00
scripts	feat(theme): extract theme-js file for supprt mixin theme (#22934 )	2020-04-05 20:38:56 +08:00
site	docs: optimize icon doc in rtl (#22982 )	2020-04-07 13:44:25 +08:00
tests	chore: Introduce customer jest match to support matchRenderedSnapshot (#22947 )	2020-04-06 12:05:38 +08:00
typings	chore: Introduce customer jest match to support matchRenderedSnapshot (#22947 )	2020-04-06 12:05:38 +08:00
.antd-tools.config.js	feat(theme): extract theme-js file for supprt mixin theme (#22934 )	2020-04-05 20:38:56 +08:00
.codecov.yml	🐛 fix progress text align issue (#14024 )	2019-01-01 11:42:08 +08:00
.depslintrc.js	New Table (#19678 )	2019-11-15 14:35:25 +08:00
.editorconfig	🎨 Add emoji in commit message	2018-11-12 14:18:16 +08:00
.eslintignore	docs: Auto redirect v3 link (#21875 )	2020-03-04 22:35:18 +08:00
.eslintrc.js	chore: 🦄 Add eslint-plugin-unicorn (#22883 )	2020-04-03 15:02:11 +08:00
.gitignore	docs: Auto redirect v3 link (#21875 )	2020-03-04 22:35:18 +08:00
.gitpod.yml	Added Gitpod support (#14307 )	2019-02-08 10:01:01 +08:00
.jest.js	chore: Introduce customer jest match to support matchRenderedSnapshot (#22947 )	2020-04-06 12:05:38 +08:00
.jest.node.js	chore: Introduce customer jest match to support matchRenderedSnapshot (#22947 )	2020-04-06 12:05:38 +08:00
.jest.site.js	test: official site checker before publish (#19247 )	2019-10-18 21:27:36 +08:00
.npmignore	add analysis (#20434 )	2019-12-25 15:18:31 +08:00
.prettierignore	🐛 Do not prettier js in less	2019-05-07 15:45:47 +08:00
.prettierrc	update prettierrc (#22506 )	2020-03-23 11:07:08 +08:00
.stylelintrc.json	💄 fix stylelint warnings and errors (#20562 )	2019-12-31 15:04:00 +08:00
.travis.yml	feat: New Form (#17327 )	2019-07-03 20:14:39 +08:00
AUTHORS.txt	Correct Grammar in Form Component's Documentation (#20381 )	2019-12-23 09:13:04 +08:00
azure-pipelines.yml	docs: Site with single paging (#21360 )	2020-02-27 10:53:30 +08:00
CHANGELOG.en-US.md	docs: 4.1.1 changelog (#22903 )	2020-04-05 16:34:54 +08:00
CHANGELOG.zh-CN.md	docs: 4.1.1 changelog (#22903 )	2020-04-05 16:34:54 +08:00
CNAME	chore: Add CNAME	2019-03-22 14:40:49 +08:00
CODE_OF_CONDUCT.md	💄 prittier all files	2019-05-07 14:57:32 +08:00
CODEOWNERS	feat: Add some code owner (#19414 )	2019-10-27 00:19:53 +08:00
crowdin.yml	Update Crowdin configuration file	2018-11-26 23:53:52 +08:00
index-with-locales.js	feat: ConfigProvider support locale (#17816 )	2019-07-24 10:34:55 +08:00
index.js	support prettier	2018-12-07 18:27:30 +08:00
LICENSE	🌱 Upgrade LICENSE	2018-11-28 12:16:59 +08:00
netlify.toml	feat: New Form (#17327 )	2019-07-03 20:14:39 +08:00
package.json	chore: Introduce customer jest match to support matchRenderedSnapshot (#22947 )	2020-04-06 12:05:38 +08:00
README-pt_BR.md	docs: 📖 collaborator guide	2020-03-25 18:01:24 +08:00
README-zh_CN.md	docs: 📖 collaborator guide	2020-03-25 18:01:24 +08:00
README.md	📝 fix codecov badge	2020-04-06 19:21:59 +08:00
tsconfig.json	test: introduce codesandbox ci (#19721 )	2019-11-16 11:39:13 +08:00
tsconfig.test.json	Remove allowSyntheticDefaultImports (#8218 )	2017-11-17 14:38:54 +08:00
webpack.config.js	chore: fix packtracker token (#22942 )	2020-04-05 21:44:41 +08:00

README.md

Ant Design

An enterprise-class UI design language and React UI library.

English | Português | 简体中文

✨ 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 in every detail.

🖥 Environment Support

Modern browsers and Internet Explorer 11+ (with polyfills)
Server-side Rendering
Electron

IE / Edge	Firefox	Chrome	Safari	Electron
IE11, Edge	last 2 versions	last 2 versions	last 2 versions	last 2 versions

📦 Install

npm install antd

yarn add antd

🔨 Usage

import { Button, DatePicker } from 'antd';

const App = () => (
  <>
    <Button type="primary">PRESS ME</Button>
    <DatePicker />
  </>
);

And import style manually:

import 'antd/dist/antd.css'; // or 'antd/dist/antd.less'

Or use babel-plugin-import.

TypeScript

See Use in TypeScript.

🌍 Internationalization

See i18n.

🔗 Links

⌨️ Development

Use Gitpod, a free online dev environment for GitHub.

Or clone locally:

$ 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.

🤝 Contributing

Read our contributing guide and let's build a better antd together.

We welcome all contributions. Please read our CONTRIBUTING.md first. You can submit any ideas as pull requests or as GitHub issues. If you'd like to improve code, check out the Development Instructions and have a good time! :)

If you are a collaborator, please follow our Pull Request principle to create a Pull Request by collaborator template.