mirror of https://github.com/ant-design/ant-design.git synced 2024-11-25 03:29:59 +08:00

An enterprise-class UI design language and React UI library

ant-design antd design-systems react typescript ui-kit ui-library

Go to file

afc163 e5ccc1d4ba fix for stylelint		2017-02-13 15:01:02 +08:00
.github	chore: update ISSUE_TEMPLATE.md	2017-01-03 15:00:41 +08:00
components	fix for stylelint	2017-02-13 15:01:02 +08:00
docs	docs: update docs format	2017-02-13 10:55:53 +08:00
scripts	fix: change way to add package.version (#4842 )	2017-02-13 14:27:12 +08:00
site	- version -> 2.7.1	2017-02-10 20:32:55 +08:00
tests	fix: change way to add package.version (#4842 )	2017-02-13 14:27:12 +08:00
typings	refactor version import	2017-02-13 14:57:04 +08:00
.babelrc	test: demo snapshot testing (#3916 )	2016-11-22 13:43:53 +08:00
.editorconfig	Add editorconfig	2015-07-15 20:33:48 +08:00
.eslintignore	fix eslintignore	2017-01-14 21:30:09 +08:00
.eslintrc.js	Using a special static property for type detecting (#4673 )	2017-01-27 17:08:05 +08:00
.gitignore	Keep js[x] files ignoring	2017-01-09 11:34:06 +08:00
.jest.node.json	cleanup npm scripts (#4499 )	2017-01-08 17:04:09 +08:00
.stylelintrc	style: update code style to please lint, close: #2179	2017-02-06 12:09:58 +08:00
.travis.yml	cleanup npm scripts (#4499 )	2017-01-08 17:04:09 +08:00
AUTHORS.txt	update AUTHORS.txt	2016-11-23 11:18:59 +08:00
CHANGELOG.en-US.md	remove duplicate changelog	2017-02-10 23:49:48 +08:00
CHANGELOG.zh-CN.md	remove duplicate changelog	2017-02-10 23:49:48 +08:00
index.js	adjust entry file (#4594 )	2017-01-13 17:48:30 +08:00
LICENSE	Fix outdated Copyright	2016-03-15 11:45:50 +08:00
package.json	docs: update docs format	2017-02-13 10:55:53 +08:00
README-zh_CN.md	docs: move Release Schedule to changelog	2017-02-07 15:22:16 +08:00
README.md	docs: update babel option	2017-02-07 17:20:59 +08:00
tsconfig.json	recalculate width while resize (#4676 )	2017-01-26 11:23:54 +08:00
webpack.config.js	refactor build webpack config file	2016-10-15 17:04:30 +08:00

README.md

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.

Let's build a better antd together

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 or babel-loader option
{
  "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.

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