mirror of https://github.com/ant-design/ant-design.git synced 2024-11-24 02:59:58 +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

afc163 c9c44c173f ✅ fix demo snapshot		2020-04-26 11:00:13 +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: add gitleaks.yml (#23425 )	2020-04-21 12:19:23 +08:00
components	✅ fix demo snapshot	2020-04-26 11:00:13 +08:00
docs	Update: Add `lessOptions` in the use-with-create-react-app (#23596 )	2020-04-26 10:49:10 +08:00
scripts	fix: Tree with quick `loadData` frozen the virtual scroll (#23581 )	2020-04-25 11:13:14 +08:00
site	fix(site): frameworky => framework	2020-04-26 00:09:23 +08:00
tests	refactor(slider): rewrite with hook (#23474 )	2020-04-22 15:58:57 +08:00
typings	chore: Introduce customer jest match to support matchRenderedSnapshot (#22947 )	2020-04-06 12:05:38 +08:00
.antd-tools.config.js	fix: fix ${theme}-theme.js file order (#23243 )	2020-04-15 11:37:29 +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	chore: add preview (#23128 )	2020-04-11 19:52:55 +08:00
.eslintrc.js	fix: include tests in type check (#23452 )	2020-04-22 13:37:23 +08:00
.gitignore	chore: add preview (#23128 )	2020-04-11 19:52:55 +08:00
.gitpod.yml	Added Gitpod support (#14307 )	2019-02-08 10:01:01 +08:00
.jest.js	chore: Refactor the button test to use typescript (#22953 )	2020-04-13 13:36:23 +08:00
.jest.node.js	chore: Refactor the button test to use typescript (#22953 )	2020-04-13 13:36:23 +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
.remarkrc.js	chore: add remark lint (#23457 )	2020-04-21 23:40:41 +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: Add the changelog of 4.1.5 (#23589 )	2020-04-25 19:29:07 +08:00
CHANGELOG.zh-CN.md	docs: add symbol (#23600 )	2020-04-26 09:34:46 +08:00
CNAME	chore: Add CNAME	2019-03-22 14:40:49 +08:00
CODE_OF_CONDUCT.md	chore: add remark lint (#23457 )	2020-04-21 23:40:41 +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	fix: site script	2019-12-20 16:37:10 +08:00
package.json	✅ fix demo snapshot	2020-04-26 11:00:13 +08:00
README-pt_BR.md	update Compatibility intro (#23513 )	2020-04-23 11:55:37 +08:00
README-zh_CN.md	update Compatibility intro (#23513 )	2020-04-23 11:55:37 +08:00
README.md	Update README.md	2020-04-25 19:49:45 +08:00
tsconfig.json	fix: include tests in type check (#23452 )	2020-04-22 13:37:23 +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.