el-css-var

ElementUI CSS Variables

Change el scss variables to css.

Theme Generator & Preview.

The library use color-mix css function, there is a certain compatibility, it is fully supported in 2023.

Usage

npm i el-css-var

Instead of element-ui styles.

import SCSS

// main.ts

// old
import 'element-ui/packages/theme-chalk/src/index.scss'; // [!code --]

// new
import 'el-css-var/dist/index.scss'; // [!code ++]
import 'el-css-var/dist/dark.scss'; // [!code ++] // optional

And use scss variables:

@use 'el-css-var/dist/common/var.scss';

.container {
  color: var.$color-primary;
}

import CSS

// main.ts

// old
import 'element-ui/packages/theme-chalk/lib/index.css'; // [!code --]

// new
import 'el-css-var/dist/index.css'; // [!code ++]
import 'el-css-var/dist/dark.css'; // [!code ++] // optional

Custom Theme

Support use CSS variables and JS API to custom theme.

CSS variables

// index.scss
@import "el-css-var/dist/index.css";

:root {
  --color-primary: red;
}

SCSS variables

// index.scss
@forward "el-css-var/dist/index.scss" with (
  $font-path: '~el-css-var/dist/fonts',
  $color-primary: red,
);

JS API

Support global and component.

Global Theme

<script>
import { useElTheme } from 'el-css-var';

export default {
  mounted() {
    const elTheme = useElTheme();

    elTheme.updateTheme({
      base: {
        '--color-primary': 'red',
      }
    });
  }
}
</script>

Component Theme

<template>
  <div :style="style">
    <el-button>Custom Theme</el-button>
  </div>
</template>

<script>
import { useElThemeComponent } from 'el-css-var';

export default {
  setup() {
    const { style, updateTheme } = useElThemeComponent();

    updateTheme({
      '--color-primary': 'red'
    })
    
    return {
      style
    }
  }
}
</script>

Variables

These variables can all use in css var.

<<< @/src/default-theme.ts

Migration

Some syntax migration.

mix

If you use scss mix function, you need to replace to color-mix:

@use "el-css-var/dist/common/var.scss";

.test {
  color: mix(var.$color-primary, white, 50%); // [!code --]
  color: color-mix(in srgb, var.$color-primary, white 50%); // [!code ++]
}