ant-design

5.0 KiB

Raw Blame History

order	title
2	快速上手

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

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

第一个例子

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

<h3 id="user-content-1-创建一个-codesandbox">1. 创建一个 codesandbox</h3> 访问 http://u.ant.design/codesandbox-repro 创建一个 codesandbox 的在线示例，别忘了保存以创建一个新的实例。 <h3 id="user-content-2-使用组件">2. 使用组件</h3> 直接用下面的代码替换 <code>index.js</code> 的内容，用 React 的方式直接使用 antd 组件。 <pre><code class="chroma language-jsx">import React, { useState } from 'react'; import { render } from 'react-dom'; import { ConfigProvider, DatePicker, message } from 'antd'; // 由于 antd 组件的默认文案是英文，所以需要修改为中文 import dayjs from 'dayjs'; import 'dayjs/locale/zh-cn'; import zhCN from 'antd/locale/zh_CN'; import 'antd/dist/reset.css'; import './index.css'; dayjs.locale('zh-cn'); const App = () => { const [date, setDate] = useState(null); const handleChange = value => { message.info(`您选择的日期是: ${value ? value.format('YYYY年MM月DD日') : '未选择'}`); setDate(value); }; return ( <ConfigProvider locale={zhCN}> <div style={{ width: 400, margin: '100px auto' }}> <DatePicker onChange={handleChange} /> <div style={{ marginTop: 16 }}> 当前日期：{date ? date.format('YYYY年MM月DD日') : '未选择'} </div> </div> </ConfigProvider> ); }; render(<App />, document.getElementById('root')); </code></pre><h3 id="user-content-3-探索更多组件用法">3. 探索更多组件用法</h3> 你可以在组件页面的左侧菜单查看组件列表，比如 <a href="/components/alert">Alert</a> 组件，组件文档中提供了各类演示，最下方有组件 API 文档可以查阅。在代码演示部分找到第一个例子，点击右下角的图标展开代码。 然后依照演示代码的写法，在之前的 codesandbox 里修改 <code>index.js</code>，首先在 <code>import</code> 内引入 Alert 组件： <pre><code class="chroma language-diff">- import { ConfigProvider, DatePicker, message } from 'antd'; + import { ConfigProvider, DatePicker, message, Alert } from 'antd'; </code></pre>然后在 <code>render</code> 内添加相应的 jsx 代码： <pre><code class="chroma language-diff"> <DatePicker onChange={value => this.handleChange(value)} /> <div style={{ marginTop: 16 }}> - 当前日期：{date ? date.format('YYYY-MM-DD') : '未选择'} + <Alert message="当前日期" description={date ? date.format('YYYY年MM月DD日') : '未选择'} /> </div> </code></pre>选择一个日期，在右侧预览区就可以看到如图的效果。 <img width="420" src="https://gw.alipayobjects.com/zos/antfincdn/ZosQjL9pqe/e6179c89-21a9-44c9-aea4-3cc04af7ef25.png" alt="codesandbox screenshot" /> 好的，现在你已经会使用基本的 antd 组件了，你可以在这个例子中继续探索其他组件的用法。如果你遇到组件的 bug，也推荐建一个可重现的 codesandbox 来报告 bug。 <h3 id="user-content-4-下一步">4. 下一步</h3> 实际项目开发中，你会需要构建、调试、代理、打包部署等一系列工程化的需求。您可以阅读后面的文档或者使用以下脚手架和范例： <ul> <li><a href="http://pro.ant.design/">Ant Design Pro</a></li> <li><a href="https://github.com/zuiidea/antd-admin">antd-admin</a></li> <li><a href="https://github.com/d2-projects/d2-admin">d2-admin</a></li> <li>更多脚手架可以查看 <a href="http://scaffold.ant.design/">脚手架市场</a></li> </ul> <h2 id="user-content-按需加载">按需加载</h2> <code>antd</code> 默认支持基于 ES modules 的 tree shaking，对于 js 部分，直接引入 <code>import { Button } from 'antd'</code> 就会有按需加载的效果。 如果你在开发环境的控制台看到下面的提示，那么你可能还在使用 <code>webpack@1.x</code> 或者 tree shaking 失效，请升级或检查相关配置。 <pre><code class="chroma language-text">You are using a whole package of antd, please use https://www.npmjs.com/package/babel-plugin-import to reduce app bundle size. </code></pre><a href="https://zos.alipayobjects.com/rmsportal/GHIRszVcmjccgZRakJDQ.png"><img src="https://zos.alipayobjects.com/rmsportal/GHIRszVcmjccgZRakJDQ.png" alt="控制台警告"></a> <h2 id="user-content-自行构建">自行构建</h2> 如果想自己维护工作流，我们推荐使用 <a href="https://webpack.github.io/">webpack</a> 进行构建和调试，可以使用 React 生态圈中的 <a href="https://github.com/enaqx/awesome-react#react-tools">各种脚手架</a> 进行开发。 目前社区也有很多基于 antd 定制的 <a href="http://scaffold.ant.design/">React 脚手架</a>，欢迎进行试用和贡献。

5.0 KiB Raw Blame History

第一个例子

5.0 KiB

Raw Blame History