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

Chang Wei 70232ab10b chore: update icon category (#38177 ) * chore: add icon 'WhatsApp' to category 'logo' * chore: add icon 'Dingtalk' to category 'logo'		2022-10-23 15:26:51 +08:00
.circleci	Update config.yml	2022-10-19 11:35:19 +08:00
.codesandbox	docs: upgrade codesandbox to react 18 (#36951 )	2022-08-08 17:52:39 +08:00
.github	test: move argos-ci from github action to circleci (#38091 )	2022-10-18 19:53:20 +08:00
.husky	chore(deps-dev): bump husky from 7.0.0 to 7.0.1 (#31485 )	2021-07-22 15:06:50 +08:00
components	fix: add titles for transer in locale (#38168 )	2022-10-23 15:23:16 +08:00
docs	docs: Add faq about breaking change (#38153 )	2022-10-21 16:25:42 +08:00
scripts	chore: use includes instead indexOf (#38139 )	2022-10-21 11:45:55 +08:00
site	chore: update icon category (#38177 )	2022-10-23 15:26:51 +08:00
tests	chore: signatures for tests (#37949 )	2022-10-19 11:50:18 +08:00
typings	test: move test cases to testing lib for Switch (#36326 )	2022-07-01 11:55:03 +08:00
.antd-tools.config.js	fix: missing `default.css` (#32116 )	2021-09-11 13:28:25 +08:00
.depslintrc.js	refactor(list): rewrite with hook (#23542 )	2020-04-26 21:23:25 +08:00
.dockerignore	test: use azure deploy ui test report site (#24327 )	2020-05-25 17:40:57 +08:00
.editorconfig	🎨 Add emoji in commit message	2018-11-12 14:18:16 +08:00
.eslintignore	test: should not ignore *.md	2021-01-25 09:54:25 +08:00
.eslintrc.js	chore: signatures for tests (#37949 )	2022-10-19 11:50:18 +08:00
.gitignore	chore: update .gitignore (#36534 )	2022-07-15 14:28:02 +08:00
.gitpod.yml	Added Gitpod support (#14307 )	2019-02-08 10:01:01 +08:00
.jest.image.js	chore: delete Enzyme (#37854 )	2022-10-06 13:51:02 +08:00
.jest.js	test: Use SSR for testing demo (#37890 )	2022-10-08 16:17:20 +08:00
.jest.node.js	test: convert demo to testing-lib (#37381 )	2022-09-09 15:51:35 +08:00
.jest.site.js	chore: delete Enzyme (#37854 )	2022-10-06 13:51:02 +08:00
.npmignore	chore: 📦 Optimize npm package size (#23698 )	2020-04-28 14:11:43 +08:00
.prettierignore	docs: prettier markdown (#28510 )	2020-12-24 12:02:57 +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	chore(deps): update dependency stylelint-config-standard to v26 (#36017 )	2022-06-12 20:44:55 +08:00
AUTHORS.txt	chore: clean up some project files (#35028 )	2022-04-14 13:53:53 +08:00
CHANGELOG.en-US.md	docs: 4.23.6 changelog (#38058 )	2022-10-17 17:06:47 +08:00
CHANGELOG.zh-CN.md	docs: 4.23.6 changelog (#38058 )	2022-10-17 17:06:47 +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
index-style-only.js	Add `variable.less` to support css variable (#31496 )	2021-09-01 10:56:50 +08:00
index-with-locales.js	feat: ConfigProvider support locale (#17816 )	2019-07-24 10:34:55 +08:00
index.js	Add `variable.less` to support css variable (#31496 )	2021-09-01 10:56:50 +08:00
jest-puppeteer.config.js	increase timeout	2020-11-14 12:49:46 +08:00
LICENSE	🌱 Upgrade LICENSE	2018-11-28 12:16:59 +08:00
package.json	chore: fix circleci image test (#38113 )	2022-10-19 18:14:47 +08:00
README-ja_JP.md	docs: Create README-ja_JP.md (#34638 )	2022-03-22 14:49:15 +08:00
README-pt_BR.md	docs(🛡): update README badges (#35185 )	2022-04-22 23:38:23 +08:00
README-sp_MX.md	docs: Create README-ja_JP.md (#34638 )	2022-03-22 14:49:15 +08:00
README-uk_UA.md	docs(🛡): update README badges (#35185 )	2022-04-22 23:38:23 +08:00
README-zh_CN.md	docs(🛡): update README badges (#35185 )	2022-04-22 23:38:23 +08:00
README.md	docs: update readme	2022-03-23 22:18:52 +08:00
renovate.json	chore: Configure Renovate (#32494 )	2021-10-14 21:58:20 +08:00
SECURITY.md	chore: add prettier ignore and format demo (#27270 )	2020-10-21 11:06:07 +08:00
tsconfig.json	chore: update type resoving when importing from `ant/lib/*` (#37941 )	2022-10-11 15:47:03 +08:00
webpack.config.js	ci: use jest shard (#35622 )	2022-05-27 21:49:16 +08:00

README.md

Ant Design

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

✨ 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 placeholder="select date" />
  </>
);

And import style manually:

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

TypeScript

antd is written in TypeScript with complete definitions, check Use in TypeScript to get started.

🌍 Internationalization

Dozens of languages supported in antd, 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 with collaborator template.