You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

6.2 KiB

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(中文)

一套企业级的 UI 设计语言和 React 实现。

README in English

特性

  • 提炼自企业级中后台产品的交互语言和视觉风格。
  • 开箱即用的高质量 React 组件。
  • 使用 TypeScript 构建,提供完整的类型定义文件。
  • 基于 npm + webpack + dva 的企业级开发框架。

支持环境

  • 现代浏览器和 IE9 及以上。
  • 支持服务端渲染。
  • Electron

参与共建 PRs Welcome

antd 是一个开源项目,我们欢迎社区参与共建。如果你对此项目感兴趣,有 很多方式 进行参与。你可以 watch 这个仓库,加入 issue 中的讨论,以及尝试实现一些 已接受的特性。我们会给予有活跃贡献的社区成员 collaborator 权限

安装

npm install antd

示例

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

引入样式:

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

按需加载可通过此写法 import DatePicker from 'antd/lib/date-picker' 或使用插件 babel-plugin-import

TypeScript

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

注意:

  • 设置 allowSyntheticDefaultImports 避免 error TS1192: Module 'react' has no default export 的错误。
  • 不要使用 @types/antd, antd 已经自带了 TypeScript 定义。

国际化

参考 国际化文档

链接

本地开发

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

打开浏览器访问 http://127.0.0.1:8001 ,更多本地开发文档参见: https://github.com/ant-design/ant-design/wiki/Development

如何贡献

在任何形式的参与前,请先阅读 贡献者文档。如果你希望参与贡献,欢迎 Pull Request,或给我们 报告 Bug

强烈推荐阅读 《提问的智慧》《如何向开源社区提问题》《如何有效地报告 Bug》《如何向开源项目提交无法解答的问题》,更好的问题更容易获得帮助。

社区互助

如果您在使用的过程中碰到问题,可以通过下面几个途径寻求帮助,同时我们也鼓励资深用户通过下面的途径给新人提供帮助。

通过 Stack Overflow 或者 Segment Fault 提问时,建议加上 antd 标签。

  1. Stack Overflow(英文)
  2. Segment Fault(中文)
  3. Join the chat at https://gitter.im/ant-design/ant-design