March 3, 2019

344 words 2 mins read

ant-design/ant-design

ant-design/ant-design

A UI Design Language and React UI library

repo name ant-design/ant-design
repo link https://github.com/ant-design/ant-design
homepage https://ant.design
language TypeScript
size (curr.) 121890 kB
stars (curr.) 57406
created 2015-04-24
license MIT License

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

CircleCI branch CI Status Codecov NPM downloads

Dependencies DevDependencies Total alerts FOSSA Status Issues need help

Follow new releases Gitter Join the chat at https://gitter.im/ant-design/ant-design

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.

⌨️ Development

Use Gitpod, a free online dev environment for GitHub.

Open in Gitpod

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 PRs Welcome

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.

Let’s fund issues in this repository

❤️ Sponsors and Backers

comments powered by Disqus