组件库自定义主题换肤实现方案

概述

douluo-ui 组件库 是依据 element-ui 完成的，那么完成换肤分两步；一是 element-ui 的换肤计划；二是 douluo-ui组件库 的换肤计划

element-ui 的换肤

计划一：在线生成

拜访 Element 在线主题生成东西，挑选自己所需的色彩，下载主题压缩包，解压到项目体系中，按如下办法引进体系

import Vue from 'vue'
import Element from 'element-ui'
import '../theme/index.css'
Vue.use(Element)

• 长处：替换便利
• 缺陷：只能替换一种主题款式

计划二：直接修正 SCSS 变量

Element 的 theme-chalk 运用 SCSS 编写，假如项目也运用了 SCSS，那么能够直接在项目中改动 Element 的款式变量。新建一个款式文件，例如 element-variables.scss，写入以下内容：

/* 改动主题色变量 */
$--color-primary: teal;
/* 改动 icon 字体途径变量，必需 */
$--font-path: '~element-gui/lib/theme-chalk/fonts';
@import "~element-gui/packages/theme-chalk/src/index";

之后，在项目的进口文件 src/main.js 中，直接引进以上款式文件即可（无需引进 Element 编译好的 CSS 文件，因为现已 import 了）：

import Vue from 'vue'
import Element from 'element-ui'
import './element-variables.scss'
Vue.use(Element)

常用默许色彩变量：

$--color-primary: #1890FF;
$--color-success: #57B21C;
$--color-warning: #FC9306;
$--color-danger: #E82F2F;
$--color-info: #999999;
$--color-text-primary: #333333;
$--color-text-empty: #333333;
$--color-text-disabled: #666666;
$--color-text-readonly: #666666;
$--color-text-placeholder: #999999;
$--border-color-base: #D2D2D2;
$--border-color-light: #999999;
$--icon-color: #666666;
$--background-color-base: #EFEFEF;
$--background-color-dark: #E5E5E5;

注意：掩盖字体途径变量是必需的，并且这种计划有个问题，调试会重复加载多份款式，听说上出产环境会少点，原因可能 界说了 common.scss 在多个组件 scss 前面引进

计划完成

• 长处：灵敏，能够自界说替换主题和常用的色彩变量等
• 缺陷：只能完成一种换肤

计划三：运用Element的命令行主题东西

由于 element-ui 的款式单独保护，官方将它抽象出来做成命令行东西运用，完成换肤分为5步

1. 装置东西

a) 首要装置主题生成东西，能够大局装置或者装置在当时项目下，引荐装置在项目里，便利别人 clone 项目时能直接装置依赖并发动，这儿以大局装置做演示。

npm i element-theme -g

b) 装置白垩主题，能够从 npm 装置或者从 GitHub 拉取最新代码。

# 从 npm
npm i element-theme-chalk -D

# 从 GitHub
npm i https://github.com/ElementUI/theme-chalk -D

2. 初始化变量文件

主题生成东西装置成功后，大局装置能够在命令行里经过 et 调用东西，假如装置在当时目录下，需求经过 node_modules/.bin/et 拜访到命令。履行 -i 初始化变量文件。默许输出到 element-variables.scss ，当然你能够传参数指定文件输出目录。

et -i [能够自界说变量文件]

> ✔ Generator variables file

假如运用默许装备，履行后当时目录会有一个 element-variables.scss 文件。内部包含了主题所用到的一切变量，它们运用 SCSS 的格局界说。大致结构如下：

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

3. 修正变量

直接编辑element-variables.scss文件，例如修正主题色为赤色。

$--color-primary: red;

4. 编译主题

保存文件后，到命令行里履行et编译主题，假如你想启用 watch 模式，实时编译主题，添加 -w 参数；假如你在初始化时指定了自界说变量文件，则需求添加 -c 参数，并带上你的变量文件名

et

> ✔ build theme font
> ✔ build element theme

5. 引进自界说主题

默许状况下编译的主题目录是放在 ./theme 下，你能够经过 -o 参数指定打包目录。像引进默许主题相同，在代码里直接引用theme/index.css 文件即可。

import '../theme/index.css'
import ElementUI from 'element-ui'
import Vue from 'vue'
Vue.use(ElementUI)

element-theme 官方换肤计划参阅这儿

这种换肤计划缺陷：只能运用一种主题，装置比较费事，简略踩坑装置失利，不引荐

计划四：自界说主题色【引荐】

由于项目会员等级有 4 种主题（未来可能会新增），上面的完成计划有局限性，假如完成的话要提前预备 4 种主题，这样做的成果会添加保护本钱，并且拓宽性不好，添加一种新的主题要从头生成一份新的款式，打包体积也会变大

参阅 vue-element-admin 更换主题，经过自界说换肤的计划完成，这种办法比较灵敏，能够自界说任意一种主题色彩，无需预备多套主题，能够自由动态换肤；缺陷是自界说不够，只支持根底色彩的切换。

原理

element-ui 2.0 版本之后一切的款式都是依据 SCSS 编写的，一切的色彩都是依据几个根底色彩变量来设置的，所以就不难完成动态换肤了，只要找到那几个色彩变量修正它就能够了。

Element官方完成了一个demo：在线主题生成东西。作者在 issue 中回复了他的计划：

1. 先把默许主题文件中涉及到色彩的 CSS 值替换成关键词：源码
2. 依据用户挑选的主题色生成一系列对应的色彩值：源码
3. 把关键词再换回刚刚生成的相应的色彩值：源码
4. 直接在页面上加 style 标签，把生成的款式填进去源码

依据以上计划，简略说明一下完成原理：

• 设计对外暴露拓宽装备，包括 element-ui 的版本号 或 element-ui 款式链接 、新的主题色彩、旧的主题色彩、刺进 dom 的位置等
• 依据新、旧主题色彩，转化为 16 进制的红、绿、蓝色彩值，生成 10%, 20%, ……, 90% 混合色彩，得到两个色彩数组, 例如 themeCluster， originalCluster
• 请求 element-ui 款式文件，保存到内存中，经过正则匹配，将 themeCluster， originalCluster 两个数组替换款式文件
• 最终将替换的新款式刺进到 dom 上，掩盖 element-ui 本来的款式

完成新功能

1. 创立 update-element-theme.js 文件，界说替换和加载款式办法

// 款式资源包
let chalk = ''
// 默许主题
let defaultTheme = '#409EFF'
export const tintColor = (color, tint) => {
  color = color.replace('#', '')
  let red = parseInt(color.slice(0, 2), 16)
  let green = parseInt(color.slice(2, 4), 16)
  let blue = parseInt(color.slice(4, 6), 16)
  if (tint === 0) {
    // when primary color is in its rgb space
    return [red, green, blue].join(',')
  } else {
    red += Math.round(tint * (255 - red))
    green += Math.round(tint * (255 - green))
    blue += Math.round(tint * (255 - blue))
    red = red.toString(16)
    green = green.toString(16)
    blue = blue.toString(16)
    return `#${red}${green}${blue}`
  }
}
export const shadeColor = (color, shade) => {
  let red = parseInt(color.slice(0, 2), 16)
  let green = parseInt(color.slice(2, 4), 16)
  let blue = parseInt(color.slice(4, 6), 16)
  red = Math.round((1 - shade) * red)
  green = Math.round((1 - shade) * green)
  blue = Math.round((1 - shade) * blue)
  red = red.toString(16)
  green = green.toString(16)
  blue = blue.toString(16)
  return `#${red}${green}${blue}`
}
const getThemeCluster = function (theme) {
  const clusters = [theme]
  for (let i = 0; i <= 9; i++) {
    clusters.push(tintColor(theme, Number((i / 10).toFixed(2))))
  }
  clusters.push(shadeColor(theme, 0.1))
  return clusters
}
const getCSSString = function (url) {
  return new Promise((resolve) => {
    const xhr = new XMLHttpRequest()
    xhr.onreadystatechange = () => {
      if (xhr.readyState === 4 && xhr.status === 200) {
        chalk = xhr.responseText.replace(/@font-face{[^}]+}/, '')
        resolve()
      }
    }
    xhr.onerror = (err) => {
      console.error('款式下载失利', err)
    }
    xhr.open('GET', url)
    xhr.send()
  })
}
const updateStyle = function (style, oldCluster, newCluster) {
  let newStyle = style
  oldCluster.forEach((color, index) => {
    newStyle = newStyle.replace(new RegExp(color, 'ig'), newCluster[index])
  })
  return newStyle
}
export const updateElementTheme = async function (options = {}) {
  const {
    version = '2.15.8',
    oldTheme,
    primaryColor,
    appendDom,
    insertBefore,
    cssUrl,
    chalkStyle = 'chalk-style'
  } = options
  if (typeof primaryColor !== 'string') return
  const themeCluster = getThemeCluster(primaryColor.replace('#', ''))
  const originalCluster = getThemeCluster((oldTheme || defaultTheme).replace('#', ''))
  const chalkHandler = (id) => {
    const newStyle = updateStyle(chalk, originalCluster, themeCluster)
    // 掩盖本来的款式
    chalk = newStyle
    let styleTag = document.querySelector(id)
    if (!styleTag) {
      styleTag = document.createElement('style')
      styleTag.setAttribute('id', id)
      if (appendDom) {
        if (insertBefore) {
          appendDom.parentNode.insertBefore(styleTag, appendDom.nextSibling)
        } else {
          appendDom.appendChild(styleTag)
        }
      } else {
        document.head.appendChild(styleTag)
      }
    }
    styleTag.innerText = newStyle
  }
  if (!chalk) {
    const url = cssUrl || `https://unpkg.com/element-ui@${version}/lib/theme-chalk/index.css`
    await getCSSString(url)
  }
  chalkHandler(chalkStyle)
  defaultTheme = primaryColor
}

2. 在进口文件引进组件，调用 updateElementTheme 办法

import { updateElementTheme } from 'douluo-ui'
updateElementTheme({
  oldTheme,
  primaryColor
})

注意：为了防止页面出现闪烁（原因款式是异步加载，会先渲染 element 主题色彩，再渲染自界说色彩），能够在进口文件封装成办法，运用 async/await 初始化变量文件

import DouluoUI from 'douluo-ui'
const initApp = async function () {
  await DouluoUI.updateElementTheme({
    oldTheme,
    primaryColor
  })
  new Vue({
    router,
    render: (h) => h(App)
  }).$mount('#app');
}
initApp()

3. 反常处理，假如 css 款式加载失利，会导致页面加载失利，打不开，需求捕获反常处理

const initApp = async () => {
  try {
    await DouluoUI.updateElementTheme({
      oldTheme,
      primaryColor
    })
    new Vue({
      el: '#app',
      router,
      render: (h) => h(App)
    }).$mount()
  } catch (error) {
    new Vue({
      el: '#app',
      router,
      render: (h) => h(App)
    }).$mount()
    console.error('主题更新失利')
  }
}

因而，款式最好放在公司内部的 cdn 上，确保款式资源稳定安全，同时最好做一下降级处理计划兼容加载失利的状况

组件库的换肤

组件库参阅 element-plus 运用 SCSS 变量和 css 自界说特点，所以完成换肤比较简略，参阅 element-plus CSS 变量设置，运用 document.documentElement.style.setProperty 设置款式，掩盖 root 的款式

export const updateUITheme = async function (options) {
  const {
    oldTheme = '#409EFF',
    primaryColor,
  } = options
  if (!primaryColor) return
  await updateElementTheme({
    oldTheme,
    primaryColor: primaryColor
  })
  const el = document.documentElement
  el.style.setProperty(`--${cssNamespace}-color-primary`, primaryColor)
  for (let i = 1; i <= 9; i++) {
    const color = tintColor(primaryColor, Number((0.1 * i).toFixed(2)))
    el.style.setProperty(`--${cssNamespace}-color-primary-light-${i}`, color)
  }
}

兼容 button 两种主题色

新的 UI 规范 button 的首要按钮由两种色彩组成，不是默许的白色，如下

为了完成这种交换，在 button-variant 对 primary 类型做判断，界说一份新的数据结构，依据 button 组件的 css 自界说特点完成换肤，文件界说在 update-ui-theme.js