关于程序员:组件库自定义主题换肤实现方案

概述

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