SVG-спрайт для React на Vite

Инструкция по быстрому созданию SVG-спрайта в React-приложении на Vite.

Генерация спрайта

Выберите папку для спрайта. В примере используется assets/app-icons, а исходные SVG, включая используемый ниже check.svg, находятся в assets/svg-icons.

Создайте конфиг assets/app-icons/svg-sprite.config.json:

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

Путь в input считается от папки с конфигом.

Добавьте команды генерации в package.json. Сгенерированные файлы по умолчанию исключены из Git, поэтому predev и prebuild пересобирают спрайт перед каждым запуском и сборкой:

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

Использование спрайта

Значение name: "app" создаёт React-компонент AppIcon.

Создайте точку входа assets/app-icons/index.ts:

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

Используйте компонент в приложении:

import { AppIcon } from '../assets/app-icons'

export function SaveIcon() {
  return (
    <AppIcon
      icon="check"
      width={24}
      height={24}
      role="img"
      aria-label="Готово"
      style={{
        color: '#334155',
        '--icon-color-2': '#f59e0b',
      }}
    />
  )
}

Свойство icon принимает имена исходных SVG без расширения. Монохромная иконка наследует color, а цвета многоцветной переопределяются через --icon-color-N.

Vite сам подключает стили компонента и добавляет sprite.svg в итоговую сборку.

Дебаг и превью

Viewer показывает все иконки на одной странице, позволяет проверить их отображение, изменить цвета и посмотреть связанные CSS-переменные. Он нужен только для разработки и устанавливается отдельно:

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

Создайте svg-sprite.html в корне проекта:

<!doctype html>
<html lang="ru">
  <head>
    <meta charset="UTF-8">
    <title>Иконки проекта</title>
  </head>
  <body>
    <!-- React-корень Viewer для дебага и превью SVG-спрайта -->
    <div id="svg-sprite-viewer"></div>

    <!-- Подключение создаваемого ниже скрипта дебаггера -->
    <script type="module" src="/src/svg-sprite-debug.tsx"></script>
  </body>
</html>

Создайте src/svg-sprite-debug.tsx:

import { createRoot } from 'react-dom/client'
import { SpriteViewer } from '@gromlab/svg-sprites/react'

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

createRoot(document.getElementById('svg-sprite-viewer')!).render(
  <SpriteViewer sources={sources} title="Иконки проекта" />,
)

Запустите npm run dev и откройте /svg-sprite.html.

Стандартная production-сборка Vite использует только index.html и не включает страницу Viewer.

3.8 KiB Raw Blame History Unescape Escape

SVG-спрайт для React на Vite

Генерация спрайта

Использование спрайта

Дебаг и превью

3.8 KiB

Raw Blame History