@vanilla-extract/webpack-plugin

What is @vanilla-extract/webpack-plugin?

@vanilla-extract/webpack-plugin is a plugin for integrating vanilla-extract with Webpack. Vanilla-extract is a CSS-in-TypeScript library that allows you to write type-safe, locally scoped styles. This plugin helps in compiling and bundling these styles efficiently with Webpack.

What are @vanilla-extract/webpack-plugin's main functionalities?

Basic Setup

This code demonstrates how to set up the @vanilla-extract/webpack-plugin in a Webpack configuration. It includes the necessary rules and plugins to process .css.ts files.

{"webpack.config.js":"const { VanillaExtractPlugin } = require('@vanilla-extract/webpack-plugin');\n\nmodule.exports = {\n  module: {\n    rules: [\n      {\n        test: /\\.css\\.ts$/,\n        use: [\n          'style-loader',\n          'css-loader',\n          '@vanilla-extract/webpack-plugin/loader'\n        ]\n      }\n    ]\n  },\n  plugins: [\n    new VanillaExtractPlugin()\n  ]\n};"}

Using with TypeScript

This code sample shows how to create a style using vanilla-extract in a TypeScript file. The `style` function is used to define CSS properties.

{"styles.css.ts":"import { style } from '@vanilla-extract/css';\n\nexport const myClass = style({\n  backgroundColor: 'blue',\n  color: 'white',\n  padding: '10px'\n});"}

Theming Support

This code demonstrates how to create a theme using vanilla-extract. The `createTheme` function is used to define theme variables that can be used throughout your application.

{"theme.css.ts":"import { createTheme } from '@vanilla-extract/css';\n\nexport const [themeClass, vars] = createTheme({\n  color: {\n    primary: 'blue',\n    secondary: 'green'\n  },\n  font: {\n    body: 'Arial, sans-serif'\n  }\n});"}

Other packages similar to @vanilla-extract/webpack-plugin

styled-components

styled-components is a popular library for writing CSS-in-JS. It allows you to style your components using tagged template literals. Unlike vanilla-extract, styled-components generates styles at runtime and supports dynamic styling based on props.

emotion

Emotion is another CSS-in-JS library that offers both runtime and compile-time styling. It provides a similar developer experience to styled-components but with additional features like zero-runtime CSS extraction. Emotion's compile-time approach is somewhat similar to vanilla-extract, but it also supports runtime styling.

linaria

Linaria is a zero-runtime CSS-in-JS library that extracts styles to CSS files at build time. This is similar to vanilla-extract's approach of generating static CSS. Linaria allows you to write styles using tagged template literals and ensures that no CSS is generated at runtime.

README

🧁 vanilla-extract

Zero-runtime Stylesheets-in-TypeScript.

Write your styles in TypeScript (or JavaScript) with locally scoped class names and CSS Variables, then generate static CSS files at build time.

Basically, it’s “CSS Modules-in-TypeScript” but with scoped CSS Variables + heaps more.

---

🚧   Please note, this is an alpha release.

---

🔥   All styles generated at build time — just like Sass, Less, etc.

✨   Minimal abstraction over standard CSS.

🦄   Works with any front-end framework — or even without one.

🌳   Locally scoped class names — just like CSS Modules.

🚀   Locally scoped CSS Variables, @keyframes and @font-face rules.

🎨   High-level theme system with support for simultaneous themes. No globals!

🛠   Utils for generating variable-based calc expressions.

💪   Type-safe styles via CSSType.

🏃‍♂️   Optional runtime version for development and testing.

---

Write your styles in .css.ts files.

// styles.css.ts

import { createTheme, style } from '@vanilla-extract/css';

export const [themeClass, themeVars] = createTheme({
  color: {
    brand: 'blue'
  },
  font: {
    body: 'arial'
  }
});

export const exampleStyle = style({
  backgroundColor: themeVars.color.brand,
  fontFamily: themeVars.font.body,
  color: 'white',
  padding: 10
});

💡 These .css.ts files will be evaluated at build time. None of the code in these files will be included in your final bundle. Think of it as using TypeScript as your preprocessor instead of Sass, Less, etc.

Then consume them in your markup.

// app.ts

import { themeClass, exampleStyle } from './styles.css.ts';

document.write(`
  <section class="${themeClass}">
    <h1 class="${exampleStyle}">Hello world!</h1>
  </section>
`);

---

• Setup
• API
  • style
  • globalStyle
  • mapToStyles
  • createTheme
  • createGlobalTheme
  • createInlineTheme
  • createThemeVars
  • assignVars
  • createVar
  • fallbackVar
  • fontFace
  • globalFontFace
  • keyframes
  • globalKeyframes
• Utility functions
  • calc
• Thanks
• License

---

Setup

1. Install the dependencies.

$ yarn add --dev @vanilla-extract/css @vanilla-extract/babel-plugin @vanilla-extract/webpack-plugin

1. Add the Babel plugin.

{
  "plugins": ["@vanilla-extract/babel-plugin"]
}

1. Add the webpack plugin.

const { VanillaExtractPlugin } = require('@vanilla-extract/webpack-plugin');

module.exports = {
  plugins: [new VanillaExtractPlugin()],
};

You'll need to ensure you're handling CSS files in your webpack config.

For example:

const { VanillaExtractPlugin } = require('@vanilla-extract/webpack-plugin');
const MiniCssExtractPlugin = require('mini-css-extract-plugin');

module.exports = {
  plugins: [
    new VanillaExtractPlugin(),
    new MiniCssExtractPlugin()
  ],
  module: {
    rules: [
      {
        test: /\.css$/i,
        use: [
          MiniCssExtractPlugin.loader,
          'css-loader',
        ],
      },
    ],
  },
};

---

API

style

Creates styles attached to a locally scoped class name.

import { style } from '@vanilla-extract/css';

export const className = style({
  display: 'flex'
});

CSS Variables, simple pseudos, selectors and media/feature queries are all supported.

import { style } from '@vanilla-extract/css';

export const className = style({
  display: 'flex',
  vars: {
    '--global-variable': 'purple'
  },
  ':hover': {
    color: 'red'
  },
  selectors: {
    '&:nth-child(2n)': {
      background: '#fafafa'
    }
  },
  '@media': {
    'screen and (min-width: 768px)': {
      padding: 10
    }
  },
  '@supports': {
    '(display: grid)': {
      display: 'grid'
    }
  }
});

Selectors can also contain references to other scoped class names.

import { style } from '@vanilla-extract/css';

export const parentClass = style({});

export const childClass = style({
  selectors: {
    [`${parentClass}:focus &`]: {
      background: '#fafafa'
    }
  },
});

globalStyle

Creates styles attached to a global selector.

import { globalStyle } from '@vanilla-extract/css';

globalStyle('html, body', {
  margin: 0
});

mapToStyles

Creates an object that maps style names to hashed class names.

💡 This is useful for mapping to component props, e.g. <div className={styles.padding[props.padding]}>

import { mapToStyles } from '@vanilla-extract/css';

export const padding = mapToStyles({
  small: { padding: 4 },
  medium: { padding: 8 },
  large: { padding: 16 }
});

You can also transform the values by providing a map function as the second argument.

import { mapToStyles } from '@vanilla-extract/css';

const spaceScale = {
  small: 4,
  medium: 8,
  large: 16
};

export const padding = mapToStyles(spaceScale, (space) => ({
  padding: space
}));

createTheme

Creates a locally scoped theme class and a collection of scoped CSS Variables.

import { createTheme, style } from '@vanilla-extract/css';

export const [themeClass, themeVars] = createTheme({
  color: {
    brand: 'blue'
  },
  font: {
    body: 'arial'
  }
});

You can create theme variants by passing a collection of theme variables as the first argument to createTheme.

import { createTheme, style } from '@vanilla-extract/css';

export const [themeA, themeVars] = createTheme({
  color: {
    brand: 'blue'
  },
  font: {
    body: 'arial'
  }
});

export const themeB = createTheme(themeVars, {
  color: {
    brand: 'pink'
  },
  font: {
    body: 'comic sans ms'
  }
});

💡 All theme variants must provide a value for every variable or it’s a type error.

createGlobalTheme

Creates a theme attached to a global selector, but with locally scoped variable names.

import { createGlobalTheme } from '@vanilla-extract/css';

export const themeVars = createGlobalTheme(':root', {
  color: {
    brand: 'blue'
  },
  font: {
    body: 'arial'
  }
});

💡 All theme variants must provide a value for every variable or it’s a type error.

createInlineTheme

Generates a custom theme at runtime as an inline style object.

import { createInlineTheme } from '@vanilla-extract/css/createInlineTheme';
import { themeVars, exampleStyle } from './styles.css.ts';

const customTheme = createInlineTheme(themeVars, {
  small: 4,
  medium: 8,
  large: 16
});

document.write(`
  <section style="${customTheme}">
    <h1 class="${exampleStyle}">Hello world!</h1>
  </section>
`);

createThemeVars

Creates a collection of CSS Variables without coupling them to a specific theme variant.

💡 This is useful if you want to split your themes into different bundles. In this case, your themes would be defined in separate files, but we'll keep this example simple.

import {
  createThemeVars,
  createTheme
} from '@vanilla-extract/css';

export const themeVars = createThemeVars({
  color: {
    brand: null
  },
  font: {
    body: null
  }
});

export const themeA = createTheme(themeVars, {
  color: {
    brand: 'blue'
  },
  font: {
    body: 'arial'
  }
});

export const themeB = createTheme(themeVars, {
  color: {
    brand: 'pink'
  },
  font: {
    body: 'comic sans ms'
  }
});

assignVars

Allows you to set an entire collection of CSS Variables anywhere within a style block.

💡 This is useful for creating responsive themes since it can be used within an @media block.

import { style, assignVars } from '@vanilla-extract/css';
import { themeVars } from './vars.css.ts';

export const exampleStyle = style({
  vars: assignVars(themeVars.space, {
    small: 4,
    medium: 8,
    large: 16
  }),
  '@media': {
    'screen and (min-width: 1024px)': {
      vars: assignVars(themeVars.space, {
        small: 8,
        medium: 16,
        large: 32
      })
    }
  }
});

💡 All variables passed into this function must be assigned or it’s a type error.

createVar

Creates a single CSS Variable.

import { createVar, style } from '@vanilla-extract/css';

export const colorVar = createVar();

export const exampleStyle = style({
  color: colorVar
});

Scoped variables can be set via the vars property on style objects.

import { createVar, style } from '@vanilla-extract/css';
import { colorVar } from './vars.css.ts';

export const parentStyle = style({
  vars: {
    [colorVar]: 'blue'
  }
});

fallbackVar

Provides fallback values when consuming variables.

import { createVar, fallbackVar, style } from '@vanilla-extract/css';

export const colorVar = createVar();

export const exampleStyle = style({
  color: fallbackVar(colorVar, 'blue');
});

Multiple fallbacks are also supported.

import { createVar, fallbackVar, style } from '@vanilla-extract/css';

export const primaryColorVar = createVar();
export const secondaryColorVar = createVar();

export const exampleStyle = style({
  color: fallbackVar(primaryColorVar, secondaryColorVar, 'blue');
});

fontFace

Creates a custom font attached to a locally scoped font name.

import { fontFace, style } from '@vanilla-extract/css';

const myFont = fontFace({
  src: 'local("Comic Sans MS")'
});

export const text = style({
  fontFamily: myFont
});

globalFontFace

Creates a globally scoped custom font.

import {
  globalFontFace,
  style
} from '@vanilla-extract/css';

globalFontFace('MyGlobalFont', {
  src: 'local("Comic Sans MS")'
});

export const text = style({
  fontFamily: 'MyGlobalFont'
});

keyframes

Creates a locally scoped set of keyframes.

import { keyframes, style } from '@vanilla-extract/css';

const rotate = keyframes({
  '0%': { rotate: '0deg' },
  '100%': { rotate: '360deg' },
});

export const animated = style({
  animation: `3s infinite ${rotate}`;
});

globalKeyframes

Creates a globally scoped set of keyframes.

import { globalKeyframes, style } from '@vanilla-extract/css';

globalKeyframes('rotate', {
  '0%': { rotate: '0deg' },
  '100%': { rotate: '360deg' },
});

export const animated = style({
  animation: `3s infinite rotate`;
});

Utility functions

We also provide a standalone package of optional utility functions to make it easier to work with CSS in TypeScript.

💡 This package can be used with any CSS-in-JS library.

$ yarn add --dev @vanilla-extract/css-utils

calc

Streamlines the creation of CSS calc expressions.

import { calc } from '@vanilla-extract/css-utils';

const styles = {
  height: calc.multiply('var(--grid-unit)', 2)
};

The following functions are available.

• calc.add
• calc.subtract
• calc.multiply
• calc.divide
• calc.negate

The calc export is also a function, providing a chainable API for complex calc expressions.

import { calc } from '@vanilla-extract/css-utils';

const styles = {
  marginTop: calc('var(--space-large)')
    .divide(2)
    .negate()
    .toString()
};

---

Thanks

• Nathan Nam Tran for creating css-in-js-loader, which served as the initial starting point for treat, the precursor to this library.
• Stitches for getting us excited about CSS-Variables-in-JS.
• SEEK for giving us the space to do interesting work.

License

MIT.