mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-22 14:44:47 +08:00
138 lines
6.5 KiB
Markdown
138 lines
6.5 KiB
Markdown
---
|
||
order: 5
|
||
title: Customize Theme
|
||
---
|
||
|
||
Ant Design allows you to customize some basic design aspects in order to meet the needs of UI diversity from business and brand, including primary color, border radius, border color, etc.
|
||
|
||
|
||
|
||
## Ant Design Less variables
|
||
|
||
We are using [Less](http://lesscss.org/) 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](https://github.com/ant-design/ant-design/blob/master/components/style/themes/default.less).
|
||
|
||
```less
|
||
@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, .85); // heading text color
|
||
@text-color: rgba(0, 0, 0, .65); // major text color
|
||
@text-color-secondary : rgba(0, 0, 0, .45); // secondary text color
|
||
@disabled-color : rgba(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, .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](http://lesscss.org/usage/#using-less-in-the-browser-modify-variables) provided by less.js to override the default values of the variables, You can use this [example](https://github.com/ant-design/create-react-app-antd) 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 it's [less-loader](https://github.com/webpack-contrib/less-loader) options.
|
||
|
||
```diff
|
||
// 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',
|
||
+ },
|
||
+ javascriptEnabled: true,
|
||
+ },
|
||
}],
|
||
// ...other rules
|
||
}],
|
||
// ...other config
|
||
}
|
||
```
|
||
|
||
Note that do not exclude antd package in node_modules when using less-loader.
|
||
|
||
### Customize in roadhog or Umi
|
||
|
||
You can easily use `theme` field in [.webpackrc](https://github.com/ant-design/ant-design-pro/blob/b7e7983661eb5e53dc807452e9653e93e74276d4/.webpackrc.js#L18) (roadhog) or [config/config.js](https://github.com/ant-design/ant-design-pro/blob/56e648ec14bdb9f6724169fd64830447e224ccb1/config/config.js#L45) (Umi) file of your project root directory if you are using [roadhog](https://github.com/sorrycc/roadhog) or [Umi](http://umijs.org/)，which could be a object or a javascript file path.
|
||
|
||
```js
|
||
"theme": {
|
||
"primary-color": "#1DA57A",
|
||
},
|
||
```
|
||
|
||
Or just [a javascript file path](https://github.com/ant-design/ant-design-pro/blob/b7e7983661eb5e53dc807452e9653e93e74276d4/.webpackrc.js#L18):
|
||
|
||
```js
|
||
"theme": "./theme.js",
|
||
```
|
||
|
||
### Customize in create-react-app
|
||
|
||
Follow [Use in create-react-app](/docs/react/use-with-create-react-app).
|
||
|
||
### Customize in less file
|
||
|
||
Another approach to customize theme is creating a `less` file within variables to override `antd.less`.
|
||
|
||
```css
|
||
@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 alternale less file and scope global styles
|
||
|
||
It's possible to configure webpack to load an alternate less file:
|
||
|
||
```ts
|
||
new webpack.NormalModuleReplacementPlugin( /node_modules\/antd\/lib\/style\/index\.less/, path.resolve(rootDir, 'src/myStylesReplacement.less') )
|
||
|
||
#antd { @import '~antd/lib/style/core/index.less'; @import '~antd/lib/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://github.com/dbtedman/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](https://github.com/ant-design/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`.
|
||
|
||
## Related Articles
|
||
|
||
- [Using Ant Design in Sass-Styled Webpack Projects with `antd-scss-theme-plugin`](https://intoli.com/blog/antd-scss-theme-plugin/)
|
||
- [How to Customize Ant Design with React & Webpack… the Missing Guide](https://medium.com/@GeoffMiller/how-to-customize-ant-design-with-react-webpack-the-missing-guide-c6430f2db10f)
|
||
- [Theming Ant Design with Sass and Webpack](https://gist.github.com/Kruemelkatze/057f01b8e15216ae707dc7e6c9061ef7)
|
||
- [Using Sass/Scss with React App (create-react-app)](https://medium.com/@mzohaib.qc/using-sass-scss-with-react-app-create-react-app-d03072083ef8)
|
||
- [Dynamic Theming in Browser using Ant Design](https://medium.com/@mzohaib.qc/ant-design-dynamic-runtime-theme-1f9a1a030ba0)
|