Show docs navigation

Using Stylify CSS in SolidJS

Shortcuts: How to integrate the Stylify CSS with SolidJS and Vite.js Configuration

SolidJS is a framework for simple and performant reactivity for building user interfaces.

Try it on StackBlitz

How to integrate the Stylify CSS with SolidJS and Vite.js

The example below works with the Vite - SolidJS template. You can however use the example below and configure it for React.js, Vue and any other framework you use.

First, install the @stylify/unplugin package using NPM or Yarn:

npm i -D @stylify/unplugin
yarn add -D @stylify/unplugin

Next add the following configuration into the vite.config.js:

import { defineConfig } from 'vite';
import { stylifyVite } from '@stylify/unplugin';
import solidPlugin from 'vite-plugin-solid';

const stylifyPlugin = stylifyVite({
	bundles: [{ outputFile: './src/stylify.css', files: ['./src/**/*.jsx'] }],
	// Optional
	compiler: {
		// https://stylifycss.com/en/docs/stylify/compiler#variables
		variables: {},
		// https://stylifycss.com/en/docs/stylify/compiler#macros
		macros: {},
		// https://stylifycss.com/en/docs/stylify/compiler#components
		components: {},
		// ...
	},
});

export default defineConfig({
	plugins: [stylifyPlugin, solidPlugin()],
	server: {
		port: 3000,
	},
	build: {
		target: 'esnext',
	},
});

Now you can add the path of the generated src/stylify.css into src/index.js file:

import './stylify.css';

Now run yarn dev. The src/stylify.css file will be generated.

Configuration

There is a lot of options you can configure:

Production Build and Selectors Mangling

When you execute yarn dev/npm run dev (which often runs vite dev) during a development, selector are going to be generated in the same way as they are written in the class attributes.

In production build, that is executed by yarn build/npm run build (which often runs vite build), selectors are minified from long color:blue to short a.

Selectors are rewritten directly within files/templates. This is because Stylify matches selectors only in selected areas (to prevent unwanted characters to be matched) like class, className, :class. However, frameworks compiles these attributes like class="color:blue" to something like add_attribute(button, "class", "color:blue") under the hood.

This can cause, that some original selectors will not be rewritten because they are not matched. Stylify could have matching areas defined for frameworks' compiled output, but this could break with any release. Therefore is safer to rewrite them directly within templates during a production build, where it takes no effect on development environment because this command is mostly executed in build pipeline in Github/Gitlab or during a Vercel/Netlify build and deploy.

How to disable mangling and selectors rewritting

If you want to disable mangling, for example for testing production build locally or even in production build, just add the following into the config:

const stylifyPlugin = stylifyVite({
	// ...
	bundles: [ /* */ ],
	compiler: {
		mangleSelectors: false
	}
});

Sometime, the class attribute can be consistent during the build within the bundler (it's random). You may try to disable rewriting selectors within files like this:

const stylifyPlugin = stylifyVite({
	bundles: [
		{
			// ...
			rewriteSelectorsInFiles: false
		}
	]
});

If selectors are rewritten correctly even after this configuration, you can keep it that way. Otherwise, if you still want the rewriting to be disabled, you will have to dig into Stylify Compiler <code>rewriteSelectors</code> method and see what comes as an input into this method and configure a correct selectorsArea, so Stylify can process it correctly.

Selectors mangling in files cannot be disabled in frameworks that are not based on Javascript (PHP, C#, Java), because their templates are not compiled by Vite/Webpack/Rollup/ESbuild.

Where to go next?

Edit this page on Github |
370 ⭐