1.0.2-beta.0 • Published 2 years ago
vite-plugin-replace-color v1.0.2-beta.0
vite-plugin-replace-color
简介
- 替换css文件中的颜色或者自定替换css属性的vite插件;搭配 css变量可实现动态切换主题色
安装
node version: >=16.0.0
vite version: >=3.0.0
npm i vite-plugin-replace-color -D
# or
yarn add vite-plugin-replace-color -D
# or
pnpm install vite-plugin-replace-color -D
使用
- vite.config.ts 中的配置插件
import replaceColorPlugin from 'vite-plugin-replace-color'
export default () => {
return {
plugins: [
replaceColorPlugin({
colorVariables: {
// 颜色需要小写 #FFF 需要写成 #fff
// 定义 rgb 时 会替换 rgb() 里面的 内容 透明度不会修改
// color: #fff --> color: var(--c5-white)
// backgroud: rgb(255,255,255,0.2) ---> backgroud:rgb(var(--c5-white-rgb)/0.2)
"#fff": { hex: "var(--c5-white)", rgb: "var(--c5-white-rgb)" },
"#2563f4": { hex: "var(--c5-color)", rgb: "var(--c5-rgb)" },
"#409eff": "var(--c5-color)",
},
// 注入自定义css 内容 时 style标签名
styleId: "_VITE_REPLACE_COLOR_",
// vue样式编译处理后 文件名有额外参数 如 xxx.vue?vue&type=style 所以结尾加 * 匹配vue
includes: ["src/**/App.vue*"],
// 忽略 依赖包
exclude: ["node_modules/**"],
// 忽略属性替换
ignoreMark: "ignore color"
}),
],
}
}
示例
.color {
color: #2563f4;
background-color: rgb(#2563f4, 0.4); // 有透明度 会从 rgb 属性中去匹配
box-shadow: 0 0 1px rgb(37 99 244);
border-color: #2563f466; // 8位带颜色的 也会从 rgb 属性中去匹配
outline-color: #2563f4; /* ignore color */ // 结尾用注释写上 ignoreMark 时 会跳过此次处理
}
- 颜色替换结果
.color {
color: var(--c5-color);
background-color: rgb(var(--c5-rgb)/0.4);
border-color: rgb(var(--c5-rgb)/0.4);
box-shadow: 0 0 1px var(--c5-color);
outline-color: #2563f4;
}
参数说明
参数 | 类型 | 默认值/参数 | 必填 | 说明 | |
---|---|---|---|---|---|
colorVariables | Record<string, string \| { hex?: string; rgb?: string }> | - | 是 | 声明替换的颜色 | |
styleId | string | _VITE_REPLACE_COLOR_ | 否 | 注入自定义css 内容 时 style标签名 | |
customerReplaceVariable | (decl) => string | decl(https://postcss.org/api/#declaration) | 否 | 自定义替换css(返回''则删除该条属性) | |
includes | Array<string\|RegExp>\|string\|RegExp | - | 否 | 匹配文件规则 | |
exclude | Array<string\|RegExp>\|string\|RegExp | - | 否 | 忽略文件规则 | |
ignoreMark | string | ignore color | 否 | 忽略标识 | 在属性后面写上 ignoreMark 注释则会跳过这条属性处理 |
辅助功能
- injectStyle 创建style标签 写入一些自定义css 到页面中 内容为空则删除 style标签
import { injectStyle } from "vite-plugin-replace-color/es/client";
injectStyle(`:root { --c5-color: #2563F4; --c5-rgb: 37 99 244;}`)
1.0.2-beta.0
2 years ago
1.0.1
2 years ago
1.0.0
2 years ago
1.0.0-beta.1
2 years ago
1.0.0-beta.0
2 years ago