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

mirror of https://gitee.com/ant-design/ant-design.git synced 2024-12-04 04:58:55 +08:00

docs: 📖 keep documentation up to date (#24184 )

* docs: remove babel-plugin-import from docs

* docs: react-scripts-rewired + customize-cra => craco

* docs: remove babel-plugin-import

* fix remark link

2020-05-15 17:18:55 +08:00

8.0 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 and Internet Explorer 11 (with polyfills)
Server-side Rendering
Electron

IE / Edge	Firefox	Chrome	Safari	Opera	Electron
IE11, 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.

antd@3.x supports both React 15 and 16 but we strongly suggest React 16 for better performance and fewer bugs.

We drop support of IE8 after antd@2.0, IE9/10 after antd@4.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

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

$ npm install antd

$ yarn add antd

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 antd.css and antd.min.js antd.min.css under antd/dist 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/moment before using antd.js.

Usage

import { DatePicker } from 'antd';

ReactDOM.render(<DatePicker />, mountNode);

And import stylesheets manually:

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

Use modularized antd

antd supports ES modules tree shaking by default for JS part.

TypeScript

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

Companies using antd

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 using the antd tag. If you're not finding what you need on stackoverflow, you can find us on as well.

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

8.0 KiB Raw Blame History