🐜 A UI Design Language
CSS TypeScript JavaScript Other

README.md

Ant Design

Coveralls Dependency Status

npm package NPM downloads Average time to resolve an issue Join the chat at https://gitter.im/ant-design/ant-design

An enterprise-class UI design language and React-based implementation.

δΈ­ζ–‡ README

Features

  • An enterprise-class design language and high quality UI.
  • Graceful UI components out of the box, based on React Component.
  • Written in TypeScript with complete define types.
  • A npm + webpack + dva front-end development workflow.

Let's build a better antd together PRs Welcome

antd is an open source project, improvements are welcomed. If you are interested in contributing to antd, you can watch this repository, join in discussion, or try to implement some features which have been accepted.

Install

npm install antd

Usage

Use prebuilt bundle

import { DatePicker } from 'antd';
ReactDOM.render(<DatePicker />, mountNode);

And import style manually:

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

Use modularized antd

  • Use babel-plugin-import (Recommended)

    // .babelrc
    {
     "plugins": [["import", { libraryName: "antd", style: "css" }]]
    }

    Then you can import components from antd directly.

    // import js and css modularly, parsed by babel-plugin-import
    import { DatePicker } from 'antd';
  • Manual import

    import DatePicker from 'antd/lib/date-picker';  // just for js
    import 'antd/lib/date-picker/style/css';  // with style

Environment Support

  • Browser: Modern browsers and Internet Explorer 9+. > IE8 issues
  • Server-side Rendering
  • Electron

TypeScript

tsconfig.json

{
  "compilerOptions": {
    "moduleResolution": "node",
    "jsx": "preserve",
    "allowSyntheticDefaultImports": true
  }
}

Note: set allowSyntheticDefaultImports to prevent error TS1192: Module 'react' has no default export.

Links

Contributing

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! :)

Release Schedule

  • Weekly release: patch version at the end of every week.
  • Monthly release: minor version at the end of every month.
  • Emergence release: emergence patch anytime if necessary.
  • Major version release is not included in this schedule.