定制主题

Ant Design 设计规范和技术上支持灵活的样式定制，以满足业务和品牌上多样化的视觉需求，包括但不限于全局样式（主色、圆角、边框）和指定组件的视觉定制。

一些配置好的主题

Ant Design 的样式变量

antd 的样式使用了 Less 作为开发语言，并定义了一系列全局/组件的样式变量，你可以根据需求进行相应调整。

以下是一些最常用的通用变量，所有样式变量可以在 这里 找到。

  1. @primary-color: #1890ff; // 全局主色
  2. @link-color: #1890ff; // 链接色
  3. @success-color: #52c41a; // 成功色
  4. @warning-color: #faad14; // 警告色
  5. @error-color: #f5222d; // 错误色
  6. @font-size-base: 14px; // 主字号
  7. @heading-color: rgba(0, 0, 0, 0.85); // 标题色
  8. @text-color: rgba(0, 0, 0, 0.65); // 主文本色
  9. @text-color-secondary: rgba(0, 0, 0, 0.45); // 次文本色
  10. @disabled-color: rgba(0, 0, 0, 0.25); // 失效色
  11. @border-radius-base: 2px; // 组件/浮层圆角
  12. @border-color-base: #d9d9d9; // 边框色
  13. @box-shadow-base: 0 3px 6px -4px rgba(0, 0, 0, 0.12), 0 6px 16px 0 rgba(0, 0, 0, 0.08),
  14.   0 9px 28px 8px rgba(0, 0, 0, 0.05); // 浮层阴影

如果以上变量不能满足你的定制需求，可以给我们提 issue。

定制方式

原理上是使用 less 提供的 modifyVars 的方式进行覆盖变量，可以在本地运行 例子 查看定制效果。下面将针对不同的场景提供一些常用的定制方式。

在 webpack 中定制主题

我们以 webpack@4 为例进行说明，以下是一个 webpack.config.js 的典型例子，对 less-loader 的 options 属性进行相应配置。

  1. // webpack.config.js
  2. module.exports = {
  3.   rules: [{
  4.     test: /\.less$/,
  5.     use: [{
  6.       loader: 'style-loader',
  7.     }, {
  8.       loader: 'css-loader', // translates CSS into CommonJS
  9.     }, {
  10.       loader: 'less-loader', // compiles Less to CSS
  11. +     options: {
  12. +       lessOptions: { // 如果使用less-loader@5，请移除 lessOptions 这一级直接配置选项。
  13. +         modifyVars: {
  14. +           'primary-color': '#1DA57A',
  15. +           'link-color': '#1DA57A',
  16. +           'border-radius-base': '2px',
  17. +         },
  18. +         javascriptEnabled: true,
  19. +       },
  20. +     },
  21.     }],
  22.     // ...other rules
  23.   }],
  24.   // ...other config
  25. }

注意：

  1. less-loader 的处理范围不要过滤掉 node_modules 下的 antd 包。

  2. lessOptions 的配置写法在 less-loader@6.0.0 里支持。

在 Umi 里配置主题

如果你在使用 Umi，那么可以很方便地在项目根目录的 config/config.js（Umi）文件中 theme 字段进行主题配置。theme 可以配置为一个对象或文件路径。

  1. "theme": {
  2.   "primary-color": "#1DA57A",
  3. },

或者 一个 js 文件：

  1. "theme": "./theme.js",

在 create-react-app 中定制主题

参考 在 create-react-app 中使用 进行配置即可。

配置 less 变量文件

另外一种方式是建立一个单独的 less 变量文件，引入这个文件覆盖 antd.less 里的变量。

  1. @import '~antd/lib/style/themes/default.less';
  2. @import '~antd/dist/antd.less'; // 引入官方提供的 less 样式入口文件
  3. @import 'your-theme-file.less'; // 用于覆盖上面定义的变量

注意，这种方式已经载入了所有组件的样式，不需要也无法和按需加载插件 babel-plugin-import 的 style 属性一起使用。

没有生效？

注意样式必须加载 less 格式，一个常见的问题就是引入了多份样式，less 的样式被 css 的样式覆盖了。

  • 如果你在使用 babel-plugin-import 的 style 配置来引入样式，需要将配置值从 'css' 改为 true，这样会引入 less 文件。

  • 如果你是通过 'antd/dist/antd.css' 引入样式的，改为 antd/dist/antd.less。

官方主题 🌈

我们提供了一些官方主题，欢迎在项目中试用，并且给我们提供反馈。

使用暗黑主题和紧凑主题

定制主题 - 图2

方式一：使用 Umi 3

如果你在使用 Umi 3，仅需两步：

  1. 安装 @umijs/plugin-antd 插件;

    1. $ npm i @umijs/plugin-antd -D

  2. 配置 dark 和 compact。

    1. // .umirc.ts or config/config.ts
    2. export default {
    3.   antd: {
    4.     dark: true, // 开启暗色主题
    5.     compact: true, // 开启紧凑主题
    6.   },
    7. },

方式二：是在样式文件全量引入 antd.dark.less 或 antd.compact.less。

  1. @import '~antd/dist/antd.dark.less'; // 引入官方提供的暗色 less 样式入口文件
  2. @import '~antd/dist/antd.compact.less'; // 引入官方提供的紧凑 less 样式入口文件

如果项目不使用 Less，可在 CSS 文件中全量引入 antd.dark.css 或 antd.compact.css。

  1. @import '~antd/dist/antd.dark.css';
  2. @import '~antd/dist/antd.compact.css';

注意这种方式下你不需要再引入 antd/dist/antd.less 或 antd/dist/antd.css 了，可以安全移除掉。也不需要开启 babel-plugin-import 的 style 配置。通过此方式不能同时配置两种及以上主题。

方式三：是用在 webpack.config.js 使用 less-loader 按需引入：

  1. const { getThemeVariables } = require('antd/dist/theme');
  3. // webpack.config.js
  4. module.exports = {
  5.   rules: [{
  6.     test: /\.less$/,
  7.     use: [{
  8.       loader: 'style-loader',
  9.     }, {
  10.       loader: 'css-loader', // translates CSS into CommonJS
  11.     }, {
  12.       loader: 'less-loader', // compiles Less to CSS
  13. +     options: {
  14. +       lessOptions: { // 如果使用less-loader@5，请移除 lessOptions 这一级直接配置选项。
  15. +         modifyVars: getThemeVariables({
  16. +           dark: true, // 开启暗黑模式
  17. +           compact: true, // 开启紧凑模式
  18. +         }),
  19. +         javascriptEnabled: true,
  20. +       },
  21. +     },
  22.     }],
  23.   }],
  24. };

社区教程