ant-design/introduce.en-US.md at f5c00a86078ac795905228b3e07306330c950c12

mirror of https://github.com/ant-design/ant-design.git synced 2024-12-12 07:09:55 +08:00

* docs: move ecosystem links

* docs: update docs

* chore: remove Move reference'

2024-01-08 14:28:37 +08:00

7.8 KiB

Raw Blame History

order	title
0	Ant Design of React

Following the Ant Design specification, we developed a React UI library antd that contains a set of high quality components and demos for building rich, interactive user interfaces.

✨ 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
Server-side Rendering
Electron

Edge	Firefox	Chrome	Safari	Opera	Electron
Edge	last 2 versions	last 2 versions	last 2 versions	last 2 versions	last 2 versions

Polyfills are needed for IE browsers. We recommend @babel/preset-env for it. You can set targets config if you are using umi.

Dropped support of IE8 after antd@2.0. Dropped support of React 15 and IE9/10 after antd@4.0. Dropped support of IE after antd@5.0.

Version

Stable:

You can subscribe to this feed for new version notifications: https://github.com/ant-design/ant-design/releases.atom

Installation

Using npm or yarn or pnpm

We recommend using npm or yarn or pnpm to install, it not only makes development easier, but also allow you to take advantage of the rich ecosystem of Javascript packages and tooling.

If you are in a bad network environment, you can try other registries and tools like cnpm.

Import in Browser

Add script and link tags in your browser and use the global variable antd.

We provide antd.js and antd.min.js reset.css under dist folder in antd's npm package. You can also download these files directly from , or unpkg.

We strongly discourage loading the entire files this will add bloat to your application and make it more difficult to receive bugfixes and updates. Antd is intended to be used in conjunction with a build tool, such as webpack, which will make it easy to import only the parts of antd that you are using.

Note: You should import react、react-dom、dayjs before using antd.js.

Usage

import React from 'react';
import { DatePicker } from 'antd';

const App = () => {
  return <DatePicker />;
};

export default App;

Use modularized antd

antd supports ES modules tree shaking by default.

TypeScript

antd provides a built-in ts definition, don't install @types/antd.

Non-React Implementations

React is used to encapsulate a library of components which embody our design language. We welcome the community to implement our design system in other front-end frameworks of their choice.

Companies using antd

Ant Design is widely used for building enterprise-level websites both domestically and internationally. You can refer to wappalyzer for reference data. If your company or product uses Ant Design, let us know here!

Contributing

Please read our CONTRIBUTING.md first.

If you'd like to help us improve antd, just create a Pull Request. Feel free to report bugs and issues here.

If you're new to posting issues, we ask that you read How To Ask Questions The Smart Way and How to Ask a Question in Open Source Community and How to Report Bugs Effectively prior to posting. Well written bug reports help us help you!

Need Help?

For questions on how to use antd, please post questions to GitHub Discussions using the Q&A tag or using the antd tag.

As always, we encourage experienced users to help those who are not familiar with antd!

7.8 KiB Raw Blame History