ant-design

8.5 KiB

Raw Blame History

order	title
2	Getting Started

Ant Design React is dedicated to providing a good development experience for programmers. Make sure that you have installed Node.js(> 8.0.0) correctly.

If you try in local environment, Please refer to Install and Initialization section of "Use in create-react-app".

Before delving into Ant Design React, a good knowledge base of React and JavaScript ES2015 is needed.

First Example

Here is a simple codesandbox example to show the usage of Ant Design React.

<h3 id="user-content-1-create-one-codesandbox">1. Create one codesandbox</h3> Visit http://u.ant.design/codesandbox-repro to create a codesandbox. Don't forget to press the save button. <h3 id="user-content-2-using-antd-component">2. Using antd component</h3> Replace the content of <code>index.js</code> with the following code. As you can see, there is no difference between antd's components and typical React components. If you already set up by <a href="https://ant.design/docs/react/use-with-create-react-app#Install-and-Initialization">Install and Initialization</a> section of "Use in create-react-app", Please replace the content of /src/index.js <pre><code class="chroma language-jsx">import React from 'react'; import ReactDOM from 'react-dom'; import { DatePicker, message } from 'antd'; import 'antd/dist/antd.css'; import './index.css'; class App extends React.Component { state = { date: null, }; handleChange = date => { message.info(`Selected Date: ${date ? date.format('YYYY-MM-DD') : 'None'}`); this.setState({ date }); }; render() { const { date } = this.state; return ( <div style={{ width: 400, margin: '100px auto' }}> <DatePicker onChange={this.handleChange} /> <div style={{ marginTop: 20 }}> Selected Date: {date ? date.format('YYYY-MM-DD') : 'None'} </div> </div> ); } } ReactDOM.render(<App />, document.getElementById('root')); </code></pre><h3 id="user-content-3-explore-more-components">3. Explore more components</h3> You can look up components in the side menu like the <a href="/components/alert">Alert</a> component. Plenty of examples are provided in the component pages and API documentation. Click the "Open in Editor" icon in the first example to open an editor with source code to use out-of-the-box. Now you can import the <code>Alert</code> component into the codesandbox: <pre><code class="chroma language-diff">- import { DatePicker, message } from 'antd'; + import { DatePicker, message, Alert } from 'antd'; </code></pre>Add the following jsx into the <code>render</code> function. <pre><code class="chroma language-diff"> <DatePicker onChange={value => this.handleChange(value)} /> <div style={{ marginTop: 20 }}> - Selected Date: {date ? date.format('YYYY-MM-DD') : 'None'} + <Alert message={`Selected Date: ${date ? date.format('YYYY-MM-DD') : 'None'}`} type="success" /> </div> </code></pre>Now you can see the result in the preview section. <img width="420" src="https://gw.alipayobjects.com/zos/antfincdn/QjCr7oLcpT/c7ce72d2-601e-4130-a33b-456d4652bb2d.png" alt="codesandbox screenshot" /> OK! Now you know how to use antd components in a clear way. You are welcome to explore more components in the codesandbox. We also strongly recommend using codesandbox to provide a reproducible demo when reporting a bug. <h3 id="user-content-4-next-step">4. Next Step</h3> In the real world you will need a development workflow consisting of <code>compile/build/deploy/lint/debug</code>. You can find and read articles on the subject or try other scaffolds provided below: <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>more scaffolds at <a href="http://scaffold.ant.design/">Scaffold Market</a></li> </ul> <h2 id="user-content-compatibility">Compatibility</h2> Ant Design React supports all modern browsers and 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> Polyfills are needed for IE browsers. We recommend <a href="https://babeljs.io/docs/en/babel-preset-env">babel-preset-env</a> for it. You can set <code>targets</code> config if you are using <a href="http://umijs.org/">umi</a>. Ant Design 3.0 supports both React 15 and 16 but we strongly suggest React 16 for better performance and fewer bugs. <h4 id="user-content-ie-note">IE note</h4> <blockquote> We drop support of IE8 after <code>antd@2.0</code>, IE9/10 after <code>antd@4.0</code>, </blockquote> <h2 id="user-content-customized-work-flow">Customized Work Flow</h2> If you want to customize your work flow, we recommend using <a href="http://webpack.github.io/">webpack</a> to build and debug code. Also, you can use any <a href="https://github.com/enaqx/awesome-react#boilerplates">scaffold</a> available in the React ecosystem. If you encounter problems, you can use our <a href="https://github.com/ant-tool/atool-build/blob/master/src/getWebpackCommonConfig.js">webpack config</a> and <a href="http://ant-tool.github.io/webpack-config.html">modify it</a>. If you are trying <a href="https://parceljs.org">parcel</a>, here is <a href="https://github.com/ant-design/parcel-antd">a demo repository</a>. There are some <a href="http://scaffold.ant.design/">scaffolds</a> which have already integrated antd, so you can try and start with one of these and even contribute. <h2 id="user-content-import-on-demand">Import on Demand</h2> If you see logs like in the screenshot below, you might be importing all components by writing <code>import { Button } from 'antd';</code>. This will affect your app's network performance. <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="console warning"></a> </blockquote> However, we can import individual components on demand: <pre><code class="chroma language-jsx">import Button from 'antd/es/button'; import 'antd/es/button/style'; // or antd/es/button/style/css for css format file </code></pre><blockquote> Note: antd supports ES6 tree shaking, so <code>import { Button } from 'antd';</code> will drop the js code you don't use too. </blockquote> We strongly recommend using <a href="https://github.com/ant-design/babel-plugin-import">babel-plugin-import</a>, which can convert the following code to the 'antd/es/xxx' way: <pre><code class="chroma language-jsx">import { Button } from 'antd'; </code></pre>And this plugin can load styles too. Read <a href="https://github.com/ant-design/babel-plugin-import#usage">usage</a> for more details. <blockquote> FYI, babel-plugin-import's <code>style</code> option will importing some global reset styles, don't use it if you don't need those styles. You can import styles manually via <code>import 'antd/dist/antd.css'</code> and override the global reset styles. </blockquote> <h2 id="user-content-replace-momentjs-to-day-js">Replace momentjs to Day.js</h2> You can use <a href="https://github.com/ant-design/antd-dayjs-webpack-plugin">antd-dayjs-webpack-plugin</a> plugin to replace momentjs to Day.js to reduce bundle size dramatically. You need to update your webpack config file like this: <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-customization">Customization</h2> <ul> <li><a href="/docs/react/customize-theme">Customize Theme</a></li> <li><a href="https://github.com/ant-design/antd-init/tree/master/examples/local-iconfont">Local Iconfont</a></li> </ul>

8.5 KiB Raw Blame History

First Example

8.5 KiB

Raw Blame History