mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-21 13:18:04 +08:00
196 lines
5.7 KiB
Markdown
196 lines
5.7 KiB
Markdown
---
|
||
order: 4
|
||
title: 在 create-react-app 中使用
|
||
---
|
||
|
||
[create-react-app](https://github.com/facebookincubator/create-react-app) 是业界最优秀的 React 应用开发工具之一，本文会尝试在 create-react-app 创建的工程中使用 antd 组件，并自定义 webpack 的配置以满足各类工程化需求。
|
||
|
||
---
|
||
|
||
## 安装和初始化
|
||
|
||
我们需要在命令行中安装 create-react-app 工具，你可能还需要安装 [yarn](https://github.com/yarnpkg/yarn/)。
|
||
|
||
```bash
|
||
$ npm install -g create-react-app yarn
|
||
```
|
||
|
||
然后新建一个项目。
|
||
|
||
```bash
|
||
$ create-react-app antd-demo
|
||
```
|
||
|
||
工具会自动初始化一个脚手架并安装 React 项目的各种必要依赖，如果在过程中出现网络问题，请尝试配置代理或使用其他 npm registry。
|
||
|
||
然后我们进入项目并启动。
|
||
|
||
```bash
|
||
$ cd antd-demo
|
||
$ yarn start
|
||
```
|
||
|
||
此时浏览器会访问 http://localhost:3000/ ，看到 `Welcome to React` 的界面就算成功了。
|
||
|
||
## 引入 antd
|
||
|
||
这是 create-react-app 生成的默认目录结构。
|
||
|
||
```
|
||
├── README.md
|
||
├── package.json
|
||
├── public
|
||
│ ├── favicon.ico
|
||
│ └── index.html
|
||
├── src
|
||
│ ├── App.css
|
||
│ ├── App.js
|
||
│ ├── App.test.js
|
||
│ ├── index.css
|
||
│ ├── index.js
|
||
│ └── logo.svg
|
||
└── yarn.lock
|
||
```
|
||
|
||
现在从 yarn 或 npm 安装并引入 antd。
|
||
|
||
```bash
|
||
$ yarn add antd --save
|
||
```
|
||
|
||
修改 `src/App.js`，引入 antd 的按钮组件。
|
||
|
||
```jsx
|
||
import React, { Component } from 'react';
|
||
import { Button } from 'antd';
|
||
import './App.css';
|
||
|
||
class App extends Component {
|
||
render() {
|
||
return (
|
||
<div className="App">
|
||
<Button type="primary">Button</Button>
|
||
</div>
|
||
);
|
||
}
|
||
}
|
||
|
||
export default App;
|
||
```
|
||
|
||
修改 `src/App.css`，在文件顶部引入 `antd/dist/antd.css`。
|
||
|
||
```css
|
||
@import '~antd/dist/antd.css';
|
||
|
||
.App {
|
||
text-align: center;
|
||
}
|
||
|
||
...
|
||
```
|
||
|
||
好了，现在你应该能看到页面上已经有了 antd 的蓝色按钮组件，接下来就可以继续选用其他组件开发应用了。其他开发流程你可以参考 create-react-app 的[官方文档](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md)。
|
||
|
||
## 高级配置
|
||
|
||
我们现在已经把组件成功运行起来了，但是在实际开发过程中还有很多问题，例如上面的例子实际上加载了全部的 antd 组件的代码（对前端性能是个隐患）。
|
||
|
||
> 你会在控制台看到如下警告。
|
||
> 
|
||
|
||
我们需要对 create-react-app 的默认配置进行自定义。可以使用 `eject` 命令将所有内建的配置暴露出来。
|
||
|
||
```bash
|
||
$ yarn run eject
|
||
```
|
||
|
||
### 按需加载
|
||
|
||
[babel-plugin-import](https://github.com/ant-design/babel-plugin-import) 是一个用于按需加载组件代码和样式的 babel 插件（[原理](/docs/react/getting-started#按需加载)），现在我们尝试安装它并修改 `config/webpack.config.dev.js` 文件。
|
||
|
||
```bash
|
||
$ yarn add babel-plugin-import --save-dev
|
||
```
|
||
|
||
```diff
|
||
// Process JS with Babel.
|
||
{
|
||
test: /\.(js|jsx)$/,
|
||
include: paths.appSrc,
|
||
loader: 'babel',
|
||
query: {
|
||
+ plugins: [
|
||
+ ['import', [{ libraryName: "antd", style: 'css' }]],
|
||
+ ],
|
||
// This is a feature of `babel-loader` for webpack (not Babel itself).
|
||
// It enables caching results in ./node_modules/.cache/babel-loader/
|
||
// directory for faster rebuilds.
|
||
cacheDirectory: true
|
||
}
|
||
},
|
||
```
|
||
|
||
> 注意，由于 create-react-app eject 之后的配置中没有 `.babelrc` 文件，所以需要把配置放到 `webpack.config.js` 或 `package.json` 的 `babel` 属性中。
|
||
|
||
然后移除前面在 `src/App.css` 里全量添加的 `@import '~antd/dist/antd.css';` 样式代码，现在 babel-plugin-import 会按需加载样式。
|
||
|
||
最后重启 `yarn start` 访问页面，此时上面的警告信息应该没了，antd 组件的 js 和 css 代码都会按需加载。
|
||
|
||
### 自定义主题
|
||
|
||
按照 [配置主题](/docs/react/customize-theme) 的要求，自定义主题需要用到 less 变量覆盖功能，因此首先我们需要引入 [less-loader](https://github.com/webpack/less-loader) 来加载 less 样式，同时修改 `config/webpack.config.dev.js` 文件。
|
||
|
||
```bash
|
||
$ yarn add less less-loader --save-dev
|
||
```
|
||
|
||
```diff
|
||
loaders: [
|
||
{
|
||
exclude: [
|
||
/\.html$/,
|
||
/\.(js|jsx)$/,
|
||
+ /\.less$/,
|
||
/\.css$/,
|
||
/\.json$/,
|
||
/\.svg$/
|
||
],
|
||
loader: 'url',
|
||
},
|
||
|
||
...
|
||
|
||
// Process JS with Babel.
|
||
{
|
||
test: /\.(js|jsx)$/,
|
||
include: paths.appSrc,
|
||
loader: 'babel',
|
||
query: {
|
||
plugins: [
|
||
- ['import', [{ libraryName: "antd", style: 'css' }]],
|
||
+ ['import', [{ libraryName: "antd", style: true }]], // 加载 less 文件
|
||
],
|
||
},
|
||
|
||
...
|
||
|
||
+ // 解析 less 文件，并加入变量覆盖配置
|
||
+ {
|
||
+ test: /\.less$/,
|
||
+ loader: 'style!css!postcss!less?{modifyVars:{"@primary-color":"#1DA57A"}}'
|
||
+ },
|
||
]
|
||
```
|
||
|
||
这里利用了 [less-loader](https://github.com/webpack/less-loader#less-options) 的 `modifyVars` 来进行主题配置，
|
||
变量和其他配置方式可以参考 [配置主题](/docs/react/customize-theme) 文档。
|
||
|
||
修改后重启 `yarn start`，如果看到一个绿色的按钮就说明配置成功了。
|
||
|
||
---
|
||
|
||
以上是在 create-react-app 中使用 antd 的相关实践，你也可以借鉴此文的做法在自己的 webpack 工作流中使用 antd，更多 webpack 配置可参考 [atool-build](https://github.com/ant-tool/atool-build/blob/master/src/getWebpackCommonConfig.js)。（例如加入 [moment noParse](https://github.com/ant-tool/atool-build/blob/e4bd2959689b6a95cb5c1c854a5db8c98676bdb3/src/getWebpackCommonConfig.js#L90) 避免加载所有语言文件）
|
||
|
||
本例所有源码可见：https://github.com/ant-design/create-react-app-antd
|