ant-design/docs/react/customize-theme.en-US.md

order	title
7	Customize Theme

Ant Design allows you to customize our design tokens to satisfy UI diversity from business or brand requirements, including primary color, border radius, border color, etc.

Ant Design Less variables

We are using Less as the development language for styling. A set of less variables are defined for each design aspect that can be customized to your needs.

There are some major variables below, all less variables could be found in Default Variables.

@primary-color: #1890ff; // primary color for all components
@link-color: #1890ff; // link color
@success-color: #52c41a; // success state color
@warning-color: #faad14; // warning state color
@error-color: #f5222d; // error state color
@font-size-base: 14px; // major text font size
@heading-color: rgba(0, 0, 0, 0.85); // heading text color
@text-color: rgba(0, 0, 0, 0.65); // major text color
@text-color-secondary: rgba(0, 0, 0, 0.45); // secondary text color
@disabled-color: rgba(0, 0, 0, 0.25); // disable state color
@border-radius-base: 4px; // major border radius
@border-color-base: #d9d9d9; // major border color
@box-shadow-base: 0 2px 8px rgba(0, 0, 0, 0.15); // major shadow for layers

Please report an issue if the existing list of variables is not enough for you.

How to do it

We will use modifyVars provided by less.js to override the default values of the variables, You can use this example as a live playground. We now introduce some popular way to do it depends on different workflow.

Customize in webpack

We take a typical webpack.config.js file as example to customize its less-loader options.

// webpack.config.js
module.exports = {
  rules: [{
    test: /\.less$/,
    use: [{
      loader: 'style-loader',
    }, {
      loader: 'css-loader', // translates CSS into CommonJS
    }, {
      loader: 'less-loader', // compiles Less to CSS
+     options: {
+       modifyVars: {
+         'primary-color': '#1DA57A',
+         'link-color': '#1DA57A',
+         'border-radius-base': '2px',
+         // or
+         'hack': `true; @import "your-less-file-path.less";`, // Override with less file
+       },
+       javascriptEnabled: true,
+     },
    }],
    // ...other rules
  }],
  // ...other config
}

Note that do not exclude antd package in node_modules when using less-loader.

Customize in Umi

You can easily use theme field in config/config.js (Umi) file of your project root directory if you are using Umi, which could be a object or a javascript file path.

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

Or just a javascript file path:

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

Customize in create-react-app

Follow Use in create-react-app.

Customize in less file

Another approach to customize theme is creating a less file within variables to override antd.less.

@import '~antd/dist/antd.less'; // Import Ant Design styles by less entry
@import 'your-theme-file.less'; // variables to override above

Note: This way will load the styles of all components, regardless of your demand, which cause style option of babel-plugin-import not working.

How to avoid modifying global styles?

Currently ant-design is designed as a whole experience and modify global styles (eg body etc). If you need to integrate ant-design as a part of an existing website, it's likely you want to prevent ant-design to override global styles.

While there's no canonical way to do it, you can take one of the following paths :

Configure webpack to load an alternate less file and scope global styles

It's possible to configure webpack to load an alternate less file:

new webpack.NormalModuleReplacementPlugin( /node_modules\/antd\/lib\/style\/index\.less/, path.resolve(rootDir, 'src/myStylesReplacement.less') )

#antd { @import '~antd/es/style/core/index.less'; @import '~antd/es/style/themes/default.less'; }

Where the src/myStylesReplacement.less file loads the same files as the index.less file, but loads them within the scope of a top-level selector : the result is that all of the "global" styles are being applied with the #antd scope.

Use a postcss processor to scope all styles

See an example of usage with gulp and postcss-prefixwrap : https://gist.github.com/sbusch/a90eafaf5a5b61c6d6172da6ff76ddaa

Not working?

You must import styles as less format. A common mistake would be importing multiple copied of styles that some of them are css format to override the less styles.

• If you import styles by specifying the style option of babel-plugin-import, change it from 'css' to true, which will import the less version of antd.
• If you import styles from 'antd/dist/antd.css', change it to antd/dist/antd.less.

Official Themes 🌈

We have some official themes, try them out and give us some feedback!

• 🌑 Dark Theme (supported in 4.0.0+)
• 📦 Compact Theme (supported in 4.1.0+)
• ☁️ Aliyun Console Theme (Beta)

Use dark or compact theme

Method 1: using Umi 3

If you're using Umi 3, which only need two steps:

1. Install @umijs/plugin-antd plugin;

   $ npm i @umijs/plugin-antd -D
   

2. set dark or compact to true.

   // .umirc.ts or config/config.ts
   export default {
     antd: {
       dark: true, // active dark theme
       compact: true, // active compact theme
     },
   },
   

Method 2: Import antd/dist/antd.dark.less or antd/dist/antd.compact.less in the style file:

@import '~antd/dist/antd.dark.less'; // Introduce the official dark less style entry file
@import '~antd/dist/antd.compact.less'; // Introduce the official compact less style entry file

If the project does not use Less, you can import antd.dark.css or antd/dist/antd.compact.css in the CSS file:

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

Note that you don't need to import antd/dist/antd.less or antd/dist/antd.css anymore, please remove it, and remove babel-plugin-import style config too.

Method 3: using less-loader in webpack.config.js to introduce as needed:

const { getThemeVariables } = require('antd/dist/theme');

// webpack.config.js
module.exports = {
  rules: [{
    test: /\.less$/,
    use: [{
      loader: 'style-loader',
    }, {
      loader: 'css-loader', // translates CSS into CommonJS
    }, {
      loader: 'less-loader', // compiles Less to CSS
+     options: {
+       modifyVars: getThemeVariables({
+         dark: true, // enable dark mode
+         compact: true, // enable compact mode
+       }),
+       javascriptEnabled: true,
+     },
    }],
  }],
};

Use dark theme and compact theme at the same time will cause double css bundle size in current implementation, please be aware of this.

Related Articles

• Using Ant Design in Sass-Styled Webpack Projects with antd-scss-theme-plugin
• How to Customize Ant Design with React & Webpack… the Missing Guide
• Theming Ant Design with Sass and Webpack
• Using Sass/Scss with React App (create-react-app)
• Dynamic Theming in Browser using Ant Design