Skip to content

Svelte

Installation

sh
npm install -D @ecss/vite-plugin @ecss/typescript-plugin
sh
pnpm add -D @ecss/vite-plugin @ecss/typescript-plugin
sh
yarn add -D @ecss/vite-plugin @ecss/typescript-plugin

Vite Configuration

ts
// vite.config.ts
import { defineConfig } from 'vite';
import { svelte } from '@sveltejs/vite-plugin-svelte';
import ecss from '@ecss/vite-plugin';

export default defineConfig({
  plugins: [
    ecss(), // ← must come before svelte()
    svelte(),
  ],
});

TypeScript

json
// tsconfig.json
{
  "compilerOptions": {
    "plugins": [{ "name": "@ecss/typescript-plugin" }]
  }
}

ecss.config.json

Svelte uses class, not className. It is also recommended to enable generateDeclarations since the TypeScript Language Service Plugin in Svelte projects works via .ecss.d.ts files:

json
// ecss.config.json
{
  "classAttribute": "class",
  "generateDeclarations": true
}

With generateDeclarations: true the plugin creates a .ecss.d.ts file next to each .ecss file with precise types. This is needed for correct IDE support in Svelte.

Example: Button component

Button.ecss

ecss
@state-variant Variant {
  values: primary, danger, ghost;
}

@state-variant Size {
  values: sm, md, lg;
}

@state-def Button(--variant Variant: primary, --size Size: md, --disabled boolean) {
  display: inline-flex;
  align-items: center;
  justify-content: center;
  border: none;
  border-radius: 6px;
  font-weight: 600;
  cursor: pointer;
  transition: opacity 0.15s;

  &:hover {
    opacity: 0.85;
  }

  @if (--disabled) {
    opacity: 0.4;
    cursor: not-allowed;
    pointer-events: none;
  }

  @if (--size == sm) {
    padding: 4px 8px;
    font-size: 12px;
  }
  @elseif (--size == md) {
    padding: 8px 16px;
    font-size: 14px;
  }
  @else {
    padding: 12px 24px;
    font-size: 16px;
  }

  @if (--variant == primary) {
    background: #646cff;
    color: #fff;
  }
  @elseif (--variant == danger) {
    background: #e53e3e;
    color: #fff;
  }
  @else {
    background: transparent;
    border: 1px solid currentColor;
    color: inherit;
  }
}

Button.svelte

svelte
<script lang="ts">
  import styles from './Button.ecss'

  interface Props {
    variant?: 'primary' | 'danger' | 'ghost'
    size?: 'sm' | 'md' | 'lg'
    disabled?: boolean
    onclick?: () => void
    children: import('svelte').Snippet
  }

  let { variant = 'primary', size = 'md', disabled, onclick, children }: Props = $props()
</script>

<button {...styles.Button({ variant, size, disabled })} {onclick}>
  {@render children()}
</button>

App.svelte

svelte
<script lang="ts">
  import Button from './lib/Button.svelte'
</script>

<Button variant="primary">Save</Button>
<Button variant="danger" size="sm">Delete</Button>
<Button variant="ghost" disabled>Unavailable</Button>

Combining classes

To add your own class alongside the ECSS class, use styles.merge — it combines classes and preserves all state data-attributes:

svelte
<script lang="ts">
  import styles from './Button.ecss'

  interface Props {
    variant?: 'primary' | 'danger' | 'ghost'
    class?: string
    children: import('svelte').Snippet
  }

  let { variant, class: className, children }: Props = $props()

  const attrs = $derived(styles.merge(styles.Button({ variant }), { class: className }))
</script>

<button {...attrs}>
  {@render children()}
</button>