ant-design/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

• Home page
• Components Overview
• Ant Design Pro
• Change Log
• rc-components
• Mobile UI
• Ant Design Pro Components
• Ant Design Charts
• Ant Design Icons
• Ant Design Colors
• Landing Pages
• Motion
• Scaffold Market
• Developer Instruction
• Versioning Release Note
• FAQ
• CodeSandbox Template for bug reports
• Customize Theme
• How to Apply for Being A Collaborator

⌨️ 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.

❤️ Sponsors and Backers