You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP →

Book a Demo Install Sign in

bun-css-modules

Package Overview

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

bun-css-modules

Import CSS Modules into Bun for server rendered html/components

1.0.10

latest

Source

npm

Version published: 5 months ago

Weekly downloads: 164

Maintainers: 0

Weekly downloads

Created: 2 years ago

Source

bun-css-modules

Allows you to import CSS Modules directly into Bun.

This loader uses the incredibly fast Rust based Lightning CSS under the hood.

Installation

To install dependencies:

bun add -D bun-css-modules

Create cssLoader.ts:

import { plugin } from 'bun'
import { moduleCssLoader } from 'bun-css-modules'

plugin(moduleCssLoader())

You can pass in options to customize some settings via moduleCssLoader({ [optionName]: <value> }). The defaults are:

{
  filePattern = /\.module.css$/,
  browserlistQuery = [
    'last 4 chrome version',
    'last 4 firefox version',
    'last 2 safari version',
  ],
}

Create a bunfig.toml if you don't have one and add:

preload = ["./cssLoader.ts"]

Example Usage

Example using Hono JSX:

/* Button.module.css */
.buttonBase {
  appearance: none;
  font-family: inherit;
  font-size: inherit;
  color: inherit;
  border-radius: 4px;
}

.primary {
  composes: buttonBase;
  background: blue;
  color: white;
  border: 1px solid purple;
}

import styles from './Button.module.css'

export function PrimaryButton({ children }) {
  return <button class={styles.primary}>{children}</button>
}

Include styles once in your head via the special cssText property.

import buttonStyles from 'src/components/Button/Button.module.css'
import tableStyles from 'src/components/Table/Table.module.css'

export function Layout({ title, children }: LayoutProps) {
  return (
    <html>
      <head>
        <title>{title}</title>
        <style>{buttonStyles.cssText}</style>
        <style>{tableStyles.cssText}</style>
      </head>
      <body>{children}</body>
    </html>
  )
}

import { PrimaryButton } from 'src/components/Button'
import styles from './SignUpPage.module.css'

function SignUpPage() {
  return (
    <div class={styles.container}>
      <h1>Sign up</h1>
      <PrimaryButton>Sign up</PrimaryButton>
      {/* One-off page styling can just be included here */}
      <style>{styles.cssText}</style>
    </div>
  )
}

Typescript

Add an ambient file if you don't have one, e.g. app.d.ts:

declare module '*.module.css' {
  const styles: {
    cssText: string
    [className: string]: string
  }
  export default styles
}

And include it in your tsconfig.json:

{
  "compilerOptions": {
    "esModuleInterop": true,
    "strict": true,
    "baseUrl": ".",
    "types": ["bun-types", "./app.d.ts"]
  }
}

Keywords

Bun

CSS Modules

FAQs

What is bun-css-modules?

Is bun-css-modules popular?

Is bun-css-modules well maintained?

Package last updated on 10 Feb 2025

Did you know?

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