🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

swc-plugin-css-modules

Package Overview
Dependencies
Maintainers
1
Versions
37
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

swc-plugin-css-modules

A [SWC](https://swc.rs) plugin to use [CSS Modules](https://github.com/css-modules/css-modules).

4.0.0
latest
Source
npm
Version published
Weekly downloads
2.3K
Maintainers
1
Weekly downloads
 
Created
Source

swc-plugin-css-modules

A SWC plugin to use CSS Modules.

Instead of creating an object, the plugin injects the css class names directly into the js code. This allows to reduce the size of the bundle.

// Input Code
import styles from "./style.css";
element.innerHTML = '<div class="' + styles.className + '">';

// Output   ↓ ↓ ↓ ↓ ↓ ↓
import "./style.css";
element.innerHTML = '<div class="' + "style__className___clZD5" + '">';

Installation

npm:

npm i -D swc-plugin-css-modules

yarn:

yarn add -D swc-plugin-css-modules

You can check the compatibility of versions on https://plugins.swc.rs/

Usage

Via .swcrc

{
  "jsc": {
    "experimental": {
      "plugins": [
        [
          "swc-plugin-css-modules",
          {
            "generate_scoped_name": "[name]__[local]___[hash:base64:5]"
          }
        ]
      ]
    }
  }
}

Using css modules in code:

import styles from "./style.module.css";

// ✅ ok
const className = styles.className;

// ✅ ok
const className = styles["class-name"];

// ⛔ Computed hit cannot be injected
const className = styles["class" + "Name"];

// ⛔ Computed hit cannot be injected
const className = styles[localClassName];

// ✅ ok
const className = classNames(styles.title, styles.className);

// ⛔ Computed hit cannot be injected
const className = getClassNameFromCssModules(styles);

Options

generate_scoped_name

Default: "[hash:base64]"

Allows to configure the generated local ident name.

Supported template strings:

  • [name] the basename of the resource
  • [folder] the folder the resource relative
  • [ext] - extension with leading
  • [hash] - the hash of the string(by default it's the hex digest of the xxhash64 hash)
  • [<hashFunction>:hash:<hashDigest>:<hashDigestLength>] - hash with hash settings
  • [local] - original class

Supported hash functions:

  • xxhash64
  • md4
  • md5
  • sha1
  • sha224
  • sha256
  • sha384
  • sha512

Supported hash digests:

  • hex
  • base32
  • base64

hash_prefix

Add custom hash prefix to generate more unique classes.

css_modules_suffix

Default: ".css"

root

If you need, you can pass any needed root path.

Keywords

swc-plugin

FAQs

Package last updated on 18 Jun 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts