定制主题

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

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

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

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

    我们以 webpack@4 为例进行说明,以下是一个 的典型例子,对 的 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. // ...other rules
    22. }],
    23. // ...other config
    24. }

    注意:

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

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

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

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

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

    另外一种方式是建立一个单独的 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-importstyle 属性一起使用。

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

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

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

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

    方式一:使用 Umi 3

    如果你在使用 :

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

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

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

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

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

    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: getThemeVariables({
    14. + dark: true, // 开启暗黑模式
    15. + compact: true, // 开启紧凑模式
    16. + }),
    17. + javascriptEnabled: true,
    18. + },
    19. + },
    20. }],
    21. }],