vite-plugin-css-auto-import

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

vite-plugin-css-auto-import

★ 26 Open GitHub ↗

No description available.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ⚡ vite-plugin-css-auto-import [![NPM version](https://img.shields.io/npm/v/vite-plugin-css-auto-import?style=flat-square)](https://www.npmjs.com/package/vite-plugin-css-auto-import)

The plugin is designed specifically for folks who are tired of this:

```ts
import styles from "./styles.module.css";
```

```
<div className={`${styles.foo} ${styles.bar}`} />
```

and this:

```
<div className={[styles.foo, styles.bar].join(" ")} />
```

like this:

```
<div className={styles.foo + ' ' + styles.bar} />

```

or this:

```
import classes from "another-package";
import styles from "./styles.module.css";
...
<div className={classes(styles.foo, styles.bar)} />
```

</details>
<br>

Writing components should be easy. Just put your CSS file next to a component, and this plugin will do the rest:

- automatically import styles into JSX/TSX components
- transform scoped class names for CSS Modules (e.g. `className="link"` becomes `className="_link_1nhoj_19"`)

## Features

- First-class CSS modules support.
- Allows switching between local-scoping/global styles without changing the components code.
- Supports JSX and TSX components. Tested with React and Solid.

## Installation

Install `vite-plugin-css-auto-import` as dev dependency.

```sh
# with npm
npm install -D vite-plugin-css-auto-import

# with pnpm
pnpm add -D vite-plugin-css-auto-import

# with yarn
yarn add -D vite-plugin-css-auto-import
```

Next, add it to the `plugins` section of your Vite config.

```typescript
// vite.config.js or vite.config.ts
import { defineConfig } from "vite";
import cssAutoImport from "vite-plugin-css-auto-import";

export default defineConfig({
  plugins: [cssAutoImport()],
});
```

Check the setup examples in `playground` folder.

## How it works

By default, the plugin will look for any style files in the same directory that match the component file name.
For example, for `Component.jsx` it would match `Component.css`, `Component.scss`, etc.

The plugin will import the styles automatically. If the imported file is a CSS module, the plugin automatically replaces class names with the scoped class name.
So, instead of writing `className={styles.foo}` you can simply write `className="foo"` as like dealing with regular styles.

You can change the default style matching behavior. Check the [API section](#api) for configuration options.

> If more than one style file matches the component, the first match will be used. You will see a warning in this case.

### CSS modules

Auto import comes in handy when dealing with CSS modules.
When the matched styles file is a CSS module, the plugin will also transform your component to map the source class name to a generated local-scoped class name.

To use CSS modules, you can:

- add `.module` at the end of your style file name ([following Vite's convention](https://vitejs.dev/guide/features.html#css-modules))
- mark **all auto-imported styles** as modules by setting [`resolveAllStylesAsModules`](#resolveallstylesasmodules) option to `true`.
- implement your own resolution logic using [`resolveStyleForComponent`](#resolvestyleforcomponent) method.

For example, with this CSS file:

```css
.foo {
  ...
}
.bar {
  ...
}
.baz {
  ...
}
```

Your component would be transformed like this:

```html

<div className="foo"></div>

<div className="_link_1nhoj_19"></div>
```

You can easily add multiple class names:

```html

<div className="foo bar text-xl"></div>

<div className="_foo_fc5kr_29 _bar_fc5kr_33 text-xl"></div>
```

> Notice how the `text-xl` class name keeps unchanged after the transformation. If the class name doesn't exist in the imported CSS module, the plugin considers it a global class. Thus, you can apply global or utility classes this way.

Solid.js `classList` is also supported:

```html

<a classList={{
  foo: true,
  bar: true,
}}></a>

<a classList={{
  "_foo_fc5kr_29": true,
  "_bar_fc5kr_33": true,
}}></a>
```

Also, you can use the class name helper libraries. This plugin will try its best to transform the provided arguments:

```html

<a className={clsx({
  foo: true,
  bar: true,
}, ["baz"])}></a>

<a className={clsx({
  "_foo_fc5kr_29": true,
  "_bar_fc5kr_33": true,
}, ["_baz_fc5kr_37"])}></a>
```

Under the hood, the plugin uses [`postcss-modules`](https://github.com/madyankin/postcss-modules) to parse and extract class names from style files.

> Note: this plugin **does not** compile nor transform your styles. The responsibility of this plugin is only to **import styles** and **transform JSX** to map scoped class names to the original class names in your code. Transformation is done by Vite.

You can configure CSS modules transform by setting [`css.modules`](https://vitejs.dev/config/shared-options.html#css-modules) options in your `vite.config` file.

### Typescript

`vite-plugin-css-auto-import` is built with TypeScript. So it supports both JSX and TSX component syntax out of the box.

## API

Default options:

```typescript
{
  componentExtensions: [".tsx", ".jsx"],
  styleExtensions: [".css", ".scss", ".less"],
  matchComponentName: true,
}
```

These options will be merged with the options provided.

### Options

##### `componentExtensions`

- type: `string[]`
- default: `[".tsx", ".jsx"]`

List of component extensions that will be transformed by the plugin.

##### `styleGlob`

- type: `string`
- default: `false`

Glob to match styles in the current component directory.

##### `styleExtensions`

- type: `string[]`
- default: `[".css", ".scss", ".less"]`

List of style file extensions.

##### `resolveAllStylesAsModules`

- type: `boolean`
- default: `false`

Force all matched style files to be treated as CSS modules.

##### `matchComponentName`

- type: `boolean`
- default: `true`

This controls whether the style file name should match the component file name.
For example, `Card.jsx` would only match `Card.css` and `Card.module.css`.

##### `shouldTransformComponent`

- type: `(fileName: string, filePath: string) => boolean | Promise<boolean>`
- default: `undefined`

Advanced method for matching the transformed components. Accepts component file name and full path.
This method takes precedence over `componentExtensions`.

##### `resolveStyleForComponent`

- type: `(componentName: string, directoryName: string, filePath: string) => ResolvedStyleResult | Promise<ResolvedStyleResult>`
- default: `undefined`

Advanced method for resolving styles for the component. Accepts component file name (without extension), directory name, and full path.
This method takes precedence over `styleGlob`, `styleExtensions`, `resolveAllStylesAsModules`, and `matchComponentName`.

Result should be of the following type:

```typescript
interface ResolvedStyleResult {
  // controls the way styles are imported
  isModule: boolean;
  // full path to the style module
  filePath: string;
}
```

### Roadmap

- [ ] Add the option to omit the class name if it's not defined in the original style file.
- [ ] Add support to enable/disable auto-import within component and style files.
- [ ] Add an option to include/exclude specific directories to resolve CSS imports.
- [ ] Improve LESS support.
- [ ] VS Code extension to provide the auto-completion list.

vite-plugin-css-auto-import

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README