SongJuXin / ant-design

๐Ÿœ A UI Design Language

Home Page:http://ant.design

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Ant Design

Codecov Dependency Status

npm package NPM downloads Percentage of issues still open Gitter (English) 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 UI design language for web applications.
  • A set of high-quality React components out of the box.
  • Written in TypeScript with complete define types.
  • A npm + webpack + dva front-end development workflow.

Environment Support

  • Modern browsers and Internet Explorer 9+ (with polyfills)
  • Server-side Rendering
  • Electron

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. Actually, there are many ways to contribute. And we are always happy to offer collaborator permission for some active contributors.

Install

npm install antd

Usage

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 or babel-loader option
    {
      "plugins": [
        ["import", { libraryName: "antd", style: "css" }] // `style: true` for less
      ]
    }

    Then you can import components from antd, equivalent to import manually below.

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

    import DatePicker from 'antd/lib/date-picker';  // for js
    import 'antd/lib/date-picker/style/css';        // for css
    // import 'antd/lib/date-picker/style';         // that will import less

TypeScript

// tsconfig.json
{
  "compilerOptions": {
    "moduleResolution": "node",
    "jsx": "preserve",
    "allowSyntheticDefaultImports": true
  }
}

Note:

  • set allowSyntheticDefaultImports to prevent error TS1192: Module 'react' has no default export.
  • Don't use @types/antd, antd provide a built-in ts definition already.

Internationalization

See i18n.

Links

Development

$ git clone git@github.com:ant-design/ant-design.git
$ npm install
$ npm start

Open your browser and visit http://127.0.0.1:8001 , see more at https://github.com/ant-design/ant-design/wiki/Development .

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

About

๐Ÿœ A UI Design Language

http://ant.design

License:MIT License


Languages

Language:TypeScript 40.8%Language:CSS 38.5%Language:JavaScript 20.2%Language:HTML 0.5%Language:Shell 0.0%