mirror of https://github.com/ant-design/ant-design.git synced 2024-11-28 05:05:48 +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

Tom Xu bf9cedf2e7 docs: improve use in typescript (#28739 )		2021-01-10 11:10:41 +08:00
.codesandbox	chore: 📝 improve docs and config json (#20364 )	2019-12-20 15:07:18 +08:00
.github	ci: fix outputs type	2021-01-07 13:25:33 +08:00
components	test: update snapshot	2021-01-08 21:24:53 +08:00
docs	docs: improve use in typescript (#28739 )	2021-01-10 11:10:41 +08:00
scripts	chore: add prettier-plugin-jsdoc (#28551 )	2020-12-28 15:30:18 +08:00
site	fix: site overflow cause sticky invalid (#28741 )	2021-01-07 16:16:54 +08:00
tests	chore: add prettier-plugin-jsdoc (#28551 )	2020-12-28 15:30:18 +08:00
typings	chore: Add demo tsx check (#28389 )	2020-12-17 15:09:18 +08:00
.antd-tools.config.js	refactor: 📦 Generate version.js from package.json (#23957 )	2020-05-08 17:49:22 +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	chore: Add demo tsx check (#28389 )	2020-12-17 15:09:18 +08:00
.eslintrc.js	chore: upgrade @ant-design/tools (#28583 )	2020-12-29 12:18:06 +08:00
.gitignore	test: demo -> ui test (#24475 )	2020-10-23 18:50:46 +08:00
.gitpod.yml	Added Gitpod support (#14307 )	2019-02-08 10:01:01 +08:00
.jest.image.js	increase timeout	2020-11-14 12:49:46 +08:00
.jest.js	test: demo -> ui test (#24475 )	2020-10-23 18:50:46 +08:00
.jest.node.js	test: remove tsconfig.test.json (#24390 )	2020-05-22 13:37:41 +08:00
.jest.site.js	test: official site checker before publish (#19247 )	2019-10-18 21:27:36 +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	fix: stylelint plugin (#28730 )	2021-01-06 21:05:36 +08:00
AUTHORS.txt	chore: update authors	2020-11-12 18:42:50 +08:00
azure-pipelines.yml	test: remove azure ui test and try test pr github action (#27458 )	2020-10-30 15:29:23 +08:00
CHANGELOG.en-US.md	docs: Release 4.10.0 (#28642 )	2021-01-04 11:52:32 +08:00
CHANGELOG.zh-CN.md	docs: Release 4.10.0 (#28642 )	2021-01-04 11:52:32 +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
docker-compose.yml	increase timeout	2020-11-14 12:49:46 +08:00
Dockerfile.ui-test	test: fix ui test base trigger (#27380 )	2020-10-27 14:14:34 +08:00
index-with-locales.js	feat: ConfigProvider support locale (#17816 )	2019-07-24 10:34:55 +08:00
index.js	change function name correctly in index.js (#26850 )	2020-09-25 11:22:02 +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
lighthouserc.js	test: Update lighthouse-ci.yml (#24598 )	2020-05-30 20:37:06 +08:00
package.json	perf(📦): maxSize 270kB!	2021-01-08 21:35:02 +08:00
README-pt_BR.md	docs: remove gitter & add discussion (#28278 )	2020-12-09 17:12:09 +08:00
README-zh_CN.md	docs: remove gitter & add discussion (#28278 )	2020-12-09 17:12:09 +08:00
README.md	docs: remove gitter & add discussion (#28278 )	2020-12-09 17:12:09 +08:00
SECURITY.md	chore: add prettier ignore and format demo (#27270 )	2020-10-21 11:06:07 +08:00
tsconfig.json	fix: include tests in type check (#23452 )	2020-04-22 13:37:23 +08:00
webpack.config.js	chore: esbuild target (#26357 )	2020-08-24 11:46:21 +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 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 getting 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 by collaborator template.