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

SVG Sprite for Qwik with Vite

A quick guide to creating an SVG sprite in an SSR Qwik 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.

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

The package does not need to be a project dependency. Regenerate through npx before Vite starts or builds:

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

Use the sprite

Create assets/app-icons/index.ts:

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

The generated component is a Qwik component$ and is safe during SSR:

import { component$ } from '@builder.io/qwik'
import { AppIcon } from '../assets/app-icons'

export default component$(() => (
  <AppIcon
    icon="icon-name"
    width={24}
    height={24}
    aria-label="Done"
    style={{ color: '#334155', '--icon-color-2': '#f59e0b' }}
  />
))

The component uses a static Vite asset import and does not access browser globals during SSR.

Debug and preview

Viewer is browser-only, optional development tooling:

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

Load it from a visible task:

import { component$, useSignal, useVisibleTask$ } from '@builder.io/qwik'
import type { SpriteViewerElement } from '@gromlab/svg-sprites/viewer'

export const IconViewer = component$(() => {
  const host = useSignal<HTMLElement>()
  useVisibleTask$(async () => {
    await import('@gromlab/svg-sprites/viewer/element')
    const viewer = document.createElement('gromlab-sprite-viewer') as SpriteViewerElement
    viewer.sources = [() => import('../assets/app-icons/.svg-sprite/svg-sprite.manifest.js')]
    host.value?.append(viewer)
  })
  return <div ref={host} />
})