在 create-react-app 中使用

create-react-app 是业界最优秀的 React 应用开发工具之一，本文会尝试在 create-react-app 创建的工程中使用 choerodon-ui 组件，并自定义 webpack 的配置以满足各类工程化需求。

安装和初始化

我们需要在命令行中安装 create-react-app 工具，你可能还需要安装 yarn。

  1. $ yarn create react-app choerodon-ui-demo
  3. # or
  5. $ npx create-react-app choerodon-ui-demo
  7. # or use in typescript
  9. $ yarn create react-app choerodon-ui-demo-ts --template typescript

工具会自动初始化一个脚手架并安装 React 项目的各种必要依赖，如果在过程中出现网络问题，请尝试配置代理或使用其他 npm registry。

然后我们进入项目并启动。

  1. $ cd choerodon-ui-demo
  2. $ yarn start

此时浏览器会访问 http://localhost:3000/ ，看到 Welcome to React 的界面就算成功了。

引入 choerodon-ui

这是 create-react-app 生成的默认目录结构。

  1. ├── README.md
  2. ├── package.json
  3. ├── public
  4. │   ├── favicon.ico
  5. │   └── index.html
  6. ├── src
  7. │   ├── App.css
  8. │   ├── App.js
  9. │   ├── App.test.js
  10. │   ├── index.css
  11. │   ├── index.js
  12. │   └── logo.svg
  13. └── yarn.lock

现在从 yarn 或 npm 安装并引入 choerodon-ui 以及相关的依赖

  1. $ yarn add choerodon-ui mobx mobx-react axios

请注意安装的时候的waring,如果出现了未知的错误,请确定mobx以及mobx-react是否为正确的版本

修改 src/App.js，引入 choerodon-ui 的按钮组件。

  1. import React, { Component } from 'react';
  2. import { Button } from 'choerodon-ui/pro';
  3. import './App.css';
  5. class App extends Component {
  6.   render() {
  7.     return (
  8.       <div className="App">
  9.         <Button color="primary">Button</Button>
  10.       </div>
  11.     );
  12.   }
  13. }
  15. export default App;

修改 src/App.css，在文件顶部引入 choerodon-ui/dist/choerodon-ui.css 以及 choerodon-ui/dist/choerodon-ui-pro.css。

  1. @import '~choerodon-ui/dist/choerodon-ui.css';
  2. @import '~choerodon-ui/dist/choerodon-ui-pro.css';
  4. .App {
  5.   text-align: center;
  6. }
  8. ...

好了，现在你应该能看到页面上已经有了 choerodon-ui 的蓝色按钮组件，接下来就可以继续选用其他组件开发应用了。其他开发流程你可以参考 create-react-app 的官方文档。

高级配置

这个例子在实际开发中还有一些优化的空间，比如无法进行主题配置。

此时我们需要对 create-react-app 的默认配置进行自定义，这里我们使用 craco （一个对 create-react-app 进行自定义配置的社区解决方案）。

现在我们安装 craco 并修改 package.json 里的 scripts 属性。

  1. $ yarn add @craco/craco
  2. /* package.json */
  3. "scripts": {
  4. -   "start": "react-scripts start",
  5. -   "build": "react-scripts build",
  6. -   "test": "react-scripts test",
  7. +   "start": "craco start",
  8. +   "build": "craco build",
  9. +   "test": "craco test",
  10. }

然后在项目根目录创建一个 craco.config.js 用于修改默认配置。

  1. /* craco.config.js */
  2. module.exports = {
  3.   // ...
  4. };

使用 babel-plugin-import

babel-plugin-import 是一个用于按需加载组件代码和样式的 babel 插件（原理），现在我们尝试安装它并修改 craco.config.js 文件。在choerodon-ui中，用了less进行样式处理，我们指定了 style 为 true 所以需要引入 less, less-loader 以及 craco-less。需要注意，必须将cssLoaderOptions中的url设置为false

  1. $ yarn add babel-plugin-import --dev
  2. $ yarn add less less-loader craco-less

修改craco.config.js为

  1. const CracoLessPlugin = require('craco-less');
  3. module.exports = {
  4.   babel: {
  5.     plugins: [
  6.       [
  7.         'import', {
  8.           libraryName: 'choerodon-ui',
  9.           style: true,
  10.         }, 'c7n'
  11.       ],
  12.       [
  13.         'import', {
  14.           libraryName: 'choerodon-ui/pro',
  15.           style: true,
  16.         }, 'c7n-pro'
  17.       ]
  18.     ]
  19.   },
  20.   plugins: [
  21.     {
  22.       plugin: CracoLessPlugin,
  23.       options: {
  24.         lessLoaderOptions: {
  25.           lessOptions: {
  26.             javascriptEnabled: true,
  27.           },
  28.         },
  29.         cssLoaderOptions: {
  30.           url: false
  31.         }
  32.       },
  33.     },
  34.   ],
  35. };

然后移除前面在 src/App.css 里全量添加的 @import '~choerodon-ui/dist/choerodon-ui.css'; 以及 choerodon-ui/dist/choerodon-ui-pro.css 样式代码

重启 yarn start 访问页面，choerodon-ui 组件的 js 和 css 代码都会按需加载，你在控制台也不会看到这样的警告信息。关于按需加载的原理和其他方式可以阅读这里。

自定义主题

按照 配置主题 的要求，自定义主题需要用到 less 变量覆盖功能。我们可以修改 craco.config.js 中的 lessOptions

  1. const CracoLessPlugin = require('craco-less');
  3. module.exports = {
  4.   babel: {
  5.     plugins: [
  6.       [
  7.         'import', {
  8.           libraryName: 'choerodon-ui',
  9.           style: true,
  10.         }, 'c7n'
  11.       ],
  12.       [
  13.         'import', {
  14.           libraryName: 'choerodon-ui/pro',
  15.           style: true,
  16.         }, 'c7n-pro'
  17.       ]
  18.     ]
  19.   },
  20.   plugins: [
  21.     {
  22.       plugin: CracoLessPlugin,
  23.       options: {
  24.         lessLoaderOptions: {
  25.           lessOptions: {
  26.             javascriptEnabled: true,
  27. +            modifyVars: {
  28. +              '@primary-color': '#1DA57A'
  29. +            },
  30.           },
  31.         },
  32.         cssLoaderOptions: {
  33.           url: false
  34.         }
  35.       },
  36.     },
  37.   ],
  38. };

这里利用了 less-loader 的 modifyVars 来进行主题配置， 变量和其他配置方式可以参考 配置主题 文档。

修改后重启 yarn start，如果看到一个绿色的按钮就说明配置成功了。

在以前我们使用 customize-cra 以及 react-app-rewired 来进行自定义配置,但是因为其对less-loader@6的支持不是很好，因此更换为craco

eject

你也可以使用 create-react-app 提供的 yarn run eject 命令将所有内建的配置暴露出来。不过这种配置方式需要你自行探索，不在本文讨论范围内。