使用 create-react-app
一步步地創(chuàng)建一個(gè) TypeScript 項(xiàng)目,并引入 antd。
請(qǐng)確保電腦上已經(jīng)安裝了最新版的 yarn 或者 npm。
使用 yarn 創(chuàng)建 cra-template-typescript 項(xiàng)目。
$ yarn create react-app antd-demo-ts --template typescript
# or
npx create-react-app my-app --template typescript
如果你使用的是 npm(接下來(lái)我們都會(huì)用 yarn 作為例子,如果你習(xí)慣用 npm 也沒(méi)問(wèn)題)。
$ npx create-react-app antd-demo-ts --typescript
然后我們進(jìn)入項(xiàng)目并啟動(dòng)。
$ cd antd-demo-ts
$ yarn start
此時(shí)瀏覽器會(huì)訪問(wèn) http://localhost:3000/ ,看到 Welcome to React
的界面就算成功了。
$ yarn add antd
修改 src/App.tsx
,引入 antd 的按鈕組件。
import React, { Component } from 'react';
import Button from 'antd/es/button';
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 的樣式。
@import '~antd/dist/antd.css';
.App {
text-align: center;
}
...
重新啟動(dòng) yarn start
,現(xiàn)在你應(yīng)該能看到頁(yè)面上已經(jīng)有了 antd 的藍(lán)色按鈕組件,接下來(lái)就可以繼續(xù)選用其他組件開發(fā)應(yīng)用了。其他開發(fā)流程你可以參考 create-react-app 的官方文檔。
我們現(xiàn)在已經(jīng)把組件成功運(yùn)行起來(lái)了,但是在實(shí)際開發(fā)過(guò)程中還有很多問(wèn)題,例如上面的例子實(shí)際上加載了全部的 antd 組件的樣式(對(duì)前端性能是個(gè)隱患)。
此時(shí)我們需要對(duì) create-react-app 的默認(rèn)配置進(jìn)行自定義,這里我們使用 react-app-rewired (一個(gè)對(duì) create-react-app 進(jìn)行自定義配置的社區(qū)解決方案)。
引入 react-app-rewired 并修改 package.json 里的啟動(dòng)配置。由于新的 react-app-rewired@2.x 版本的關(guān)系,你還需要安裝 customize-cra。
$ yarn add react-app-rewired customize-cra
/* package.json */
"scripts": {
- "start": "react-scripts start",
+ "start": "react-app-rewired start",
- "build": "react-scripts build",
+ "build": "react-app-rewired build",
- "test": "react-scripts test",
+ "test": "react-app-rewired test",
}
然后在項(xiàng)目根目錄創(chuàng)建一個(gè) config-overrides.js
用于修改默認(rèn)配置。
module.exports = function override(config, env) {
// do stuff with the webpack config...
return config;
};
babel-plugin-import 是一個(gè)用于按需加載組件代碼和樣式的 babel 插件(原理),現(xiàn)在我們嘗試安裝它并修改 config-overrides.js
文件。
$ yarn add babel-plugin-import
+ const { override, fixBabelImports } = require('customize-cra');
- module.exports = function override(config, env) {
- // do stuff with the webpack config...
- return config;
- };
+ module.exports = override(
+ fixBabelImports('import', {
+ libraryName: 'antd',
+ libraryDirectory: 'es',
+ style: 'css',
+ }),
+ );
然后移除前面在 src/App.css
里全量添加的 @import '~antd/dist/antd.css';
樣式代碼,并且按下面的格式引入模塊。
// src/App.tsx
import React, { Component } from 'react';
- import Button from 'antd/es/button';
+ 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;
最后重啟 yarn start
訪問(wèn)頁(yè)面,antd 組件的 js 和 css 代碼都會(huì)按需加載,你在控制臺(tái)也不會(huì)看到這樣的警告信息。關(guān)于按需加載的原理和其他方式可以閱讀這里。
按照 配置主題 的要求,自定義主題需要用到 less 變量覆蓋功能。我們可以引入 customize-cra
中提供的 less 相關(guān)的函數(shù) addLessLoader 來(lái)幫助加載 less 樣式,同時(shí)修改 config-overrides.js
文件如下。
- const { override, fixBabelImports } = require('customize-cra');
+ const { override, fixBabelImports, addLessLoader } = require('customize-cra');
module.exports = override(
fixBabelImports('import', {
libraryName: 'antd',
libraryDirectory: 'es',
- style: 'css',
+ style: true,
}),
+ addLessLoader({
+ javascriptEnabled: true,
+ modifyVars: { '@primary-color': '#1DA57A' },
+ }),
);
這里利用了 less-loader 的 modifyVars
來(lái)進(jìn)行主題配置,變量和其他配置方式可以參考 配置主題 文檔。
修改后重啟 yarn start
,如果看到一個(gè)綠色的按鈕就說(shuō)明配置成功了。
對(duì)于自定義 webpack 配置,你也可以使用 craco 和 craco-antd 來(lái)實(shí)現(xiàn)和 customize-cra 一樣的修改 create-react-app 配置的功能。
先按照 在 create-react-app 中使用 中的說(shuō)明操作,再配置 TypeScript 開發(fā)環(huán)境。
你也可以使用 react-scripts-ts-antd,其中包括了 ts-import-plugin,react-app-rewired,scss,less 等插件。你可以通過(guò)只運(yùn)行一個(gè)命令來(lái)創(chuàng)建一個(gè)沒(méi)有任何配置的新項(xiàng)目。
更多建議: