mirror of https://github.com/gromlab-ru/svg-sprites.git synced 2026-07-22 04:40:17 +03:00

Files

S.Gromov 1b5b446d8f docs: обновить установку и команды генерации

- пакет указан как development dependency
- команды переведены на локальный CLI без npx
- удалены версионные ограничения Next.js
- синхронизированы английская и русская документация и skills

2026-07-11 18:23:41 +03:00

4.2 KiB

Raw Permalink Blame History

React + Vite

← Главная

Краткая инструкция по установке и использованию SVG-спрайтов в проекте на React и Vite.

В результате вы получите типизированный React-компонент и отдельный кешируемый SVG asset.

1. Установите пакет

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

2. Создайте папку спрайта

src/ui/file-manager/svg-sprite/
├── icons/
│   ├── check.svg
│   └── folder.svg
└── svg-sprite.config.ts

Поместите исходные SVG-файлы в icons/.

3. Добавьте конфиг

// src/ui/file-manager/svg-sprite/svg-sprite.config.ts
import { defineReactSpriteConfig } from '@gromlab/svg-sprites'

export default defineReactSpriteConfig({
  name: 'file-manager',
  description: 'Иконки файлового менеджера',
})

По умолчанию SVG берутся из ./icons. Общие иконки из других папок можно добавить через inputFiles: папка и список объединяются в один спрайт.

Полный список опций находится в разделе Конфигурация → React.

4. Добавьте генерацию в package.json

{
  "scripts": {
    "sprite:file-manager": "svg-sprites --mode react@vite src/ui/file-manager/svg-sprite",
    "predev": "npm run sprite:file-manager",
    "prebuild": "npm run sprite:file-manager",
    "pretypecheck": "npm run sprite:file-manager"
  }
}

Generated-файлы исключаются из Git, поэтому генерация должна выполняться перед dev, build и typecheck.

Первый запуск:

npm run sprite:file-manager

5. Используйте компонент

Имя file-manager преобразуется в FileManagerIcon:

import { FileManagerIcon } from './svg-sprite'

export const OpenFolderButton = () => (
  <button type="button">
    <FileManagerIcon icon="folder" width={24} height={24} />
    Открыть
  </button>
)

Значение icon проверяется TypeScript по именам файлов:

<FileManagerIcon icon="check" />   // допустимо
<FileManagerIcon icon="unknown" /> // ошибка TypeScript

Типы, способы отображения и управление цветами описаны в основной документации.

Vite выпустит спрайт отдельным файлом вида assets/sprite-<hash>.svg. SVG path-данные не попадут в JavaScript.

6. Добавьте debug-страницу

После подключения иконок можно вывести все React-спрайты через SpriteViewer:

import { SpriteViewer } from '@gromlab/svg-sprites/react'
import type { SpriteManifestModule } from '@gromlab/svg-sprites/react'

const sources = import.meta.glob<SpriteManifestModule>(
  '/src/**/svg-sprite/manifest.ts',
)

export const IconsDebugPage = () => (
  <SpriteViewer sources={sources} title="Иконки проекта" />
)

Vite автоматически найдёт generated manifest.ts каждого React-спрайта. Шаблон import.meta.glob должен быть строковым литералом, а генерация должна выполниться до запуска Vite.

Размещайте Viewer только на debug-маршруте или во внутреннем инструменте.

Если что-то не работает

Нет index.ts: запустите npm run sprite:file-manager.
Viewer не видит спрайт: проверьте путь glob и наличие manifest.ts.
Ошибка Refusing to overwrite a user file: в generated-пути находится пользовательский файл.
Иконка не меняет цвет: используйте color или --icon-color-N.

4.2 KiB Raw Permalink Blame History Unescape Escape