ant-design

8.9 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 zhCN from 'antd/es/locale/zh_CN'; import moment from 'moment'; import 'moment/locale/zh-cn'; import 'antd/dist/antd.css'; import './index.css'; moment.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> Ant Design React 支持所有的现代浏览器和 IE11+。 <table> <thead> <tr> <th><a href="http://godban.github.io/browsers-support-badges/"><img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" /></a>IE / Edge</th> <th><a href="http://godban.github.io/browsers-support-badges/"><img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" /></a>Firefox</th> <th><a href="http://godban.github.io/browsers-support-badges/"><img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" /></a>Chrome</th> <th><a href="http://godban.github.io/browsers-support-badges/"><img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" /></a>Safari</th> <th><a href="http://godban.github.io/browsers-support-badges/"><img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" /></a>Opera</th> <th><a href="http://godban.github.io/browsers-support-badges/"><img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/electron/electron_48x48.png" alt="Electron" width="24px" height="24px" /></a>Electron</th> </tr> </thead> <tbody> <tr> <td>IE11, Edge</td> <td>last 2 versions</td> <td>last 2 versions</td> <td>last 2 versions</td> <td>last 2 versions</td> <td>last 2 versions</td> </tr> </tbody> </table> 对于 IE 系列浏览器，需要提供相应的 Polyfill 支持，建议使用 <a href="https://babeljs.io/docs/en/babel-preset-env">babel-preset-env</a> 来解决浏览器兼容问题。如果你在使用 <a href="http://umijs.org/">umi</a>，可以直接使用 <a href="https://umijs.org/zh/config/#targets">targets</a> 配置。 Ant Design 3.0 对 React 15/16 两个版本提供支持，但是我们强烈建议你升级到 React 16，以便获得更好的性能和遇到更少的问题。 <h4 id="user-content-ie-note">IE note</h4> <blockquote> <code>antd@2.0</code> 之后将不再支持 IE8，<code>antd@4.0</code> 之后将不再支持 IE9/10。 </blockquote> <h2 id="user-content-自行构建">自行构建</h2> 如果想自己维护工作流，我们推荐使用 <a href="http://webpack.github.io/">webpack</a> 进行构建和调试。理论上你可以利用 React 生态圈中的 <a href="https://github.com/enaqx/awesome-react#boilerplates">各种脚手架</a> 进行开发，如果遇到问题可参考我们所使用的 <a href="https://github.com/ant-tool/atool-build/blob/master/src/getWebpackCommonConfig.js">webpack 配置</a> 进行 <a href="http://ant-tool.github.io/webpack-config.html">定制</a>。 如果你使用 <a href="https://parceljs.org">parcel</a>，这里也有 <a href="https://github.com/ant-design/parcel-antd">一个例子</a> 可以参考。 目前社区也有很多基于 antd 定制的 <a href="http://scaffold.ant.design/">脚手架</a>，欢迎进行试用和贡献。 <h2 id="user-content-按需加载">按需加载</h2> 如果你在开发环境的控制台看到下面的提示，那么你可能使用了 <code>import { Button } from 'antd';</code> 的写法引入了 antd 下所有的模块，这会影响应用的网络性能。 <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><blockquote> <a href="https://zos.alipayobjects.com/rmsportal/GHIRszVcmjccgZRakJDQ.png"><img src="https://zos.alipayobjects.com/rmsportal/GHIRszVcmjccgZRakJDQ.png" alt="控制台警告"></a> </blockquote> 可以通过以下的写法来按需加载组件。 <pre><code class="chroma language-jsx">import Button from 'antd/es/button'; import 'antd/es/button/style'; // 或者 antd/es/button/style/css 加载 css 文件 </code></pre><blockquote> 注意：antd 默认支持基于 ES module 的 tree shaking，对于 js 部分，直接引入 <code>import { Button } from 'antd'</code> 也会有按需加载的效果。 </blockquote> 如果你使用了 babel，那么可以使用 <a href="https://github.com/ant-design/babel-plugin-import">babel-plugin-import</a> 来进行按需加载，加入这个插件后。你可以仍然这么写： <pre><code class="chroma language-jsx">import { Button } from 'antd'; </code></pre>插件会帮你转换成 <code>antd/es/xxx</code> 的写法。另外此插件配合 <a href="https://github.com/ant-design/babel-plugin-import#usage">style</a> 属性可以做到模块样式的按需自动加载。 <blockquote> 注意，babel-plugin-import 的 <code>style</code> 属性除了引入对应组件的样式，也会引入一些必要的全局样式。如果你不需要它们，建议不要使用此属性。你可以 <code>import 'antd/dist/antd.css'</code> 手动引入，并覆盖全局样式。 </blockquote> <h2 id="user-content-使用-day-js-替换-momentjs-优化打包大小">使用 Day.js 替换 momentjs 优化打包大小</h2> 你可以使用 <a href="https://github.com/ant-design/antd-dayjs-webpack-plugin">antd-dayjs-webpack-plugin</a> 插件用 Day.js 替换 momentjs 来大幅减小打包大小。这需要更新 webpack 的配置文件如下： <pre><code class="chroma language-js">// webpack-config.js import AntdDayjsWebpackPlugin from 'antd-dayjs-webpack-plugin'; module.exports = { // ... plugins: [new AntdDayjsWebpackPlugin()], }; </code></pre><h2 id="user-content-配置主题和字体">配置主题和字体</h2> <ul> <li><a href="/docs/react/customize-theme">改变主题</a></li> <li><a href="https://github.com/ant-design/antd-init/tree/master/examples/local-iconfont">使用本地字体</a></li> </ul>

8.9 KiB Raw Blame History

第一个例子

8.9 KiB

Raw Blame History