自定义主题

Element 默认提供一套主题,CSS 命名采用 BEM 的风格,方便使用者覆盖样式。我们提供了四种方法,可以进行不同程度的样式自定义。

在线主题编辑器

使用在线主题编辑器,可以修改定制 Element 所有全局和组件的 Design Tokens,并可以方便地实时预览样式改变后的视觉。同时它还可以基于新的定制样式生成完整的样式文件包,供直接下载使用(关于如何使用下载的主题包,请参考本节「引入自定义主题」和「搭配插件按需引入组件主题」部分)。自定义主题 - 图1

仅替换主题色

如果仅希望更换 Element 的主题色,推荐使用在线主题生成工具。Element 默认的主题色是鲜艳、友好的蓝色。通过替换主题色,能够让 Element 的视觉更加符合具体项目的定位。

使用上述工具,可以很方便地实时预览主题色改变之后的视觉,同时它还可以基于新的主题色生成完整的样式文件包,供直接下载使用(关于如何使用下载的主题包,请参考本节「引入自定义主题」和「搭配插件按需引入组件主题」部分)。

在项目中改变 SCSS 变量

Element 的 theme-chalk 使用 SCSS 编写,如果你的项目也使用了 SCSS,那么可以直接在项目中改变 Element 的样式变量。新建一个样式文件,例如 element-variables.scss,写入以下内容:

  1. /* 改变主题色变量 */
  2. $--color-primary: teal;
  3. /* 改变 icon 字体路径变量,必需 */
  4. $--font-path:'~element-ui/lib/theme-chalk/fonts';
  5. @import"~element-ui/packages/theme-chalk/src/index";

之后,在项目的入口文件中,直接引入以上样式文件即可(无需引入 Element 编译好的 CSS 文件):

  1. importVuefrom'vue'
  2. importElementfrom'element-ui'
  3. import'./element-variables.scss'
  4. Vue.use(Element)

需要注意的是,覆盖字体路径变量是必需的,将其赋值为 Element 中 icon 图标所在的相对路径即可。

命令行主题工具

如果你的项目没有使用 SCSS,那么可以使用命令行主题工具进行深层次的主题定制:

安装工具

首先安装「主题生成工具」,可以全局安装或者安装在当前项目下,推荐安装在项目里,方便别人 clone 项目时能直接安装依赖并启动,这里以全局安装做演示。

  1. npm i element-theme -g

安装白垩主题,可以从 npm 安装或者从 GitHub 拉取最新代码。

  1. # 从 npm
  2. npm i element-theme-chalk -D
  3. # 从 GitHub
  4. npm i https://github.com/ElementUI/theme-chalk -D

初始化变量文件

主题生成工具安装成功后,如果全局安装可以在命令行里通过 et 调用工具,如果安装在当前目录下,需要通过 node_modules/.bin/et 访问到命令。执行 -i 初始化变量文件。默认输出到 element-variables.scss,当然你可以传参数指定文件输出目录。

  1. et -i [可以自定义变量文件]
  2. >Generator variables file

如果使用默认配置,执行后当前目录会有一个 element-variables.scss 文件。内部包含了主题所用到的所有变量,它们使用 SCSS 的格式定义。大致结构如下:

  1. $--color-primary:#409EFF !default;
  2. $--color-primary-light-1: mix($--color-white, $--color-primary,10%)!default;/* 53a8ff */
  3. $--color-primary-light-2: mix($--color-white, $--color-primary,20%)!default;/* 66b1ff */
  4. $--color-primary-light-3: mix($--color-white, $--color-primary,30%)!default;/* 79bbff */
  5. $--color-primary-light-4: mix($--color-white, $--color-primary,40%)!default;/* 8cc5ff */
  6. $--color-primary-light-5: mix($--color-white, $--color-primary,50%)!default;/* a0cfff */
  7. $--color-primary-light-6: mix($--color-white, $--color-primary,60%)!default;/* b3d8ff */
  8. $--color-primary-light-7: mix($--color-white, $--color-primary,70%)!default;/* c6e2ff */
  9. $--color-primary-light-8: mix($--color-white, $--color-primary,80%)!default;/* d9ecff */
  10. $--color-primary-light-9: mix($--color-white, $--color-primary,90%)!default;/* ecf5ff */
  11. $--color-success:#67c23a !default;
  12. $--color-warning:#e6a23c !default;
  13. $--color-danger:#f56c6c !default;
  14. $--color-info:#909399 !default;
  15. ...

修改变量

直接编辑 element-variables.scss 文件,例如修改主题色为红色。

  1. $--color-primary: red;

编译主题

保存文件后,到命令行里执行 et 编译主题,如果你想启用 watch 模式,实时编译主题,增加 -w 参数;如果你在初始化时指定了自定义变量文件,则需要增加 -c 参数,并带上你的变量文件名

  1. et
  2. > build theme font
  3. > build element theme

引入自定义主题

默认情况下编译的主题目录是放在 ./theme 下,你可以通过 -o 参数指定打包目录。像引入默认主题一样,在代码里直接引用 theme/index.css 文件即可。

  1. import'../theme/index.css'
  2. importElementUIfrom'element-ui'
  3. importVuefrom'vue'
  4. Vue.use(ElementUI)

搭配插件按需引入组件主题

如果是搭配 babel-plugin-component 一起使用,只需要修改 .babelrc 的配置,指定 styleLibraryName 路径为自定义主题相对于 .babelrc 的路径,注意要加 ~

  1. {
  2. "plugins":[
  3. [
  4. "component",
  5. {
  6. "libraryName":"element-ui",
  7. "styleLibraryName":"~theme"
  8. }
  9. ]
  10. ]
  11. }

如果不清楚 babel-plugin-component 是什么,请阅读 快速上手 一节。更多 element-theme 用法请参考项目仓库