快速上手

Ant Design React 致力于提供给程序员愉悦的开发体验。

在开始之前,推荐先学习 ReactES2015,并正确安装和配置了 Node.js v8 或以上。官方指南假设你已了解关于 HTML、CSS 和 JavaScript 的中级知识,并且已经完全掌握了 React 全家桶的正确开发方式。如果你刚开始学习前端或者 React,将 UI 框架作为你的第一步可能不是最好的主意。

第一个例子

这是一个最简单的 Ant Design 组件的在线 codesandbox 演示。

1. 创建一个 codesandbox

访问 http://u.ant.design/codesandbox-repro 创建一个 codesandbox 的在线示例,别忘了保存以创建一个新的实例。

2. 使用组件

直接用下面的代码替换 index.js 的内容,用 React 的方式直接使用 antd 组件。

  1. importReact,{ useState }from'react';
  2. import{ render }from'react-dom';
  3. import{ConfigProvider,DatePicker, message }from'antd';
  4. // 由于 antd 组件的默认文案是英文,所以需要修改为中文
  5. import zhCN from'antd/lib/locale/zh_CN';
  6. import moment from'moment';
  7. import'moment/locale/zh-cn';
  8. import'antd/dist/antd.css';
  9. import'./index.css';
  10. moment.locale('zh-cn');
  11. constApp=()=>{
  12. const[date, setDate]= useState(null);
  13. const handleChange = value =>{
  14. message.info(`您选择的日期是: ${value ? value.format('YYYY年MM月DD日') : '未选择'}`);
  15. setDate(value);
  16. };
  17. return(
  18. <ConfigProvider locale={zhCN}>
  19. <div style={{ width:400, margin:'100px auto'}}>
  20. <DatePicker onChange={handleChange}/>
  21. <div style={{ marginTop:16}}>
  22. 当前日期:{date ? date.format('YYYY年MM月DD日'):'未选择'}
  23. </div>
  24. </div>
  25. </ConfigProvider>
  26. );
  27. };
  28. render(<App/>, document.getElementById('root'));

3. 探索更多组件用法

你可以在组件页面的左侧菜单查看组件列表,比如 Alert 组件,组件文档中提供了各类演示,最下方有组件 API 文档可以查阅。在代码演示部分找到第一个例子,点击右下角的图标展开代码。

然后依照演示代码的写法,在之前的 codesandbox 里修改 index.js,首先在 import 内引入 Alert 组件:

  1. -import{ConfigProvider,DatePicker, message }from'antd';
  2. +import{ConfigProvider,DatePicker, message,Alert}from'antd';

然后在 render 内添加相应的 jsx 代码:

  1. <DatePickeronChange={value => this.handleChange(value)} />
  2. <divstyle={{marginTop: 16 }}>
  3. - 当前日期:{date ? date.format('YYYY-MM-DD') : '未选择'}
  4. + <Alertmessage="当前日期"description={date ? date.format('YYYY年MM月DD日') : '未选择'} />
  5. </div>

选择一个日期,在右侧预览区就可以看到如图的效果。

codesandbox screenshot

好的,现在你已经会使用基本的 antd 组件了,你可以在这个例子中继续探索其他组件的用法。如果你遇到组件的 bug,也推荐建一个可重现的 codesandbox 来报告 bug。

4. 下一步

实际项目开发中,你会需要构建、调试、代理、打包部署等一系列工程化的需求。您可以阅读后面的文档或者使用以下脚手架和范例:

按需加载

antd 默认支持基于 ES modules 的 tree shaking,对于 js 部分,直接引入 import { Button } from 'antd' 就会有按需加载的效果。

如果你在开发环境的控制台看到下面的提示,那么你可能还在使用 webpack@1.x 或者 tree shaking 失效,请升级或检查相关配置。

  1. You are using a whole package of antd, please use https://www.npmjs.com/package/babel-plugin-import to reduce app bundle size.

控制台警告

自行构建

如果想自己维护工作流,我们推荐使用 webpack 进行构建和调试,可以使用 React 生态圈中的 各种脚手架 进行开发。

目前社区也有很多基于 antd 定制的 React 脚手架,欢迎进行试用和贡献。