svg-sprites/docs/en/guides/sveltekit-vite.md

SVG Sprite for SvelteKit with Vite

A quick guide to creating an SVG sprite in a SvelteKit application built with Vite.

Generate the sprite

Choose a directory for the future SVG sprite, for example assets/app-icons, and create svg-sprite.config.json inside it. In input, specify the path to existing SVG files relative to the configuration file. There is no need to move or copy the icons.

Example configuration:

{
  "mode": "sveltekit@vite",
  "name": "app",
  "input": "../svg-icons/**/*.svg"
}

The package does not need to be a project dependency: generation runs through npx.

Add generation commands to package.json. Generated files are excluded from Git by default, so predev and prebuild rebuild the sprite before every start and build:

{
  "scripts": {
    "sprites": "npx --yes @gromlab/svg-sprites assets/app-icons/svg-sprite.config.json",
    "predev": "npm run sprites",
    "dev": "vite dev",
    "prebuild": "npm run sprites",
    "build": "vite build"
  }
}

Use the sprite

The value name: "app" creates the SSR-safe Svelte component AppIcon.

Create assets/app-icons/index.js:

export * from './.svg-sprite/index.js'

Use the component in src/routes/+page.svelte:

<script>
  import { AppIcon } from '../../assets/app-icons/index.js'
</script>

<AppIcon
  icon="icon-name"
  width="24"
  height="24"
  role="img"
  aria-label="Done"
  style="color: #334155; --icon-color-2: #f59e0b"
/>

The icon prop accepts source SVG file names without the extension. The component has no browser-only initialization, so the page can be rendered on the server. Vite emits sprite.svg as a separate production asset.

Debug and preview

Viewer displays all icons on one page so you can check their rendering, change colors, and inspect the related CSS variables. It is only needed for development and is installed separately:

npm install --save-dev @gromlab/svg-sprites

Create a development route such as src/routes/svg-sprite/+page.svelte. Load the custom element from an action so it is only registered in the browser:

<script>
  const sources = [
    () => import('../../../assets/app-icons/.svg-sprite/svg-sprite.manifest.js'),
  ]

  function connectViewer(node) {
    void import('@gromlab/svg-sprites/viewer/element').then(() => {
      node.sources = sources
      node.viewerTitle = 'Project icons'
    })
  }
</script>

<gromlab-sprite-viewer use:connectViewer></gromlab-sprite-viewer>

Run npm run dev and open /svg-sprite. The action does not run during SSR.