2026-07-15 12:27:46 +03:00
# SVG-спрайт для Vite без фреймворка
2026-07-14 16:11:39 +03:00
2026-07-15 12:27:46 +03:00
Инструкция по быстрому созданию SVG-спрайта в приложении на Vite без фреймворка.
2026-07-14 16:11:39 +03:00
2026-07-15 12:27:46 +03:00
## Генерация спрайта
2026-07-14 16:11:39 +03:00
2026-07-15 16:56:44 +03:00
Выберите каталог для будущего SVG-спрайта, например `assets/app-icons` , и создайте в нём `svg-sprite.config.json` . В `input` укажите путь к существующим SVG относительно файла конфигурации. Перемещать или копировать иконки не требуется.
2026-07-14 16:11:39 +03:00
2026-07-15 16:56:44 +03:00
Пример конфига:
2026-07-14 16:11:39 +03:00
2026-07-15 12:27:46 +03:00
```json
{
"mode" : "standalone@vite" ,
"name" : "app" ,
"input" : "../svg-icons/**/*.svg"
2026-07-14 16:11:39 +03:00
}
```
2026-07-15 16:56:44 +03:00
Пакет не нужно добавлять в зависимости проекта: генерация запускается через `npx` .
2026-07-14 16:11:39 +03:00
2026-07-15 12:27:46 +03:00
Добавьте команды генерации в `package.json` . Сгенерированные файлы по умолчанию исключены из Git, поэтому `predev` и `prebuild` пересобирают спрайт перед каждым запуском и сборкой:
2026-07-14 16:11:39 +03:00
```json
{
"scripts" : {
2026-07-15 12:27:46 +03:00
"sprites" : "npx --yes @gromlab/svg-sprites assets/app-icons/svg-sprite.config.json" ,
"predev" : "npm run sprites" ,
"dev" : "vite" ,
"prebuild" : "npm run sprites" ,
"build" : "vite build"
2026-07-14 16:11:39 +03:00
}
}
```
2026-07-15 12:27:46 +03:00
## Использование спрайта
2026-07-14 16:11:39 +03:00
2026-07-15 12:27:46 +03:00
Значение `name: "app"` создаёт элемент `<app-icon>` .
Создайте точку входа `assets/app-icons/index.ts` :
2026-07-14 16:11:39 +03:00
```ts
export * from './.svg-sprite/index.js'
```
2026-07-15 12:27:46 +03:00
Зарегистрируйте элемент в `src/main.ts` :
2026-07-14 16:11:39 +03:00
```ts
2026-07-15 12:27:46 +03:00
import { defineAppIconElement } from '../assets/app-icons'
import './style.css'
2026-07-14 16:11:39 +03:00
2026-07-15 12:27:46 +03:00
defineAppIconElement ()
2026-07-14 16:11:39 +03:00
```
2026-07-15 12:27:46 +03:00
Используйте иконку в HTML:
2026-07-14 16:11:39 +03:00
2026-07-15 12:27:46 +03:00
```html
2026-07-15 16:56:44 +03:00
< app-icon icon = "icon-name" role = "img" aria-label = "Готово" ></ app-icon >
2026-07-14 16:11:39 +03:00
```
2026-07-15 16:56:44 +03:00
Значение `icon` — имя исходного SVG без расширения. Размер и цвета настраиваются через CSS:
2026-07-14 16:11:39 +03:00
```css
2026-07-15 12:27:46 +03:00
app-icon {
2026-07-14 16:11:39 +03:00
font-size : 24 px ;
color : #334155 ;
--icon-color-2 : #f59e0b ;
}
```
2026-07-15 12:27:46 +03:00
Монохромная иконка наследует `color` , а цвета многоцветной иконки переопределяются через `--icon-color-N` . Нужные переменные показывает Viewer.
2026-07-14 16:11:39 +03:00
2026-07-15 12:27:46 +03:00
Vite сам добавит `sprite.svg` в итоговую сборку. Копировать его в `public` не нужно.
## Дебаг и превью
Viewer показывает все иконки на одной странице, позволяет проверить их отображение, изменить цвета и посмотреть связанные CSS-переменные. Он нужен только для разработки и устанавливается отдельно:
2026-07-14 16:11:39 +03:00
```bash
npm install --save-dev @gromlab/svg-sprites
```
2026-07-15 12:27:46 +03:00
Создайте `svg-sprite.html` в корне проекта:
```html
<!doctype html>
< html lang = "ru" >
< head >
< meta charset = "UTF-8" >
< title > Иконки проекта</ title >
</ head >
< body >
<!-- Компонент Viewer для дебага и превью SVG-спрайта -->
< gromlab-sprite-viewer viewer-title = "Иконки проекта" ></ gromlab-sprite-viewer >
<!-- Подключение создаваемого ниже скрипта дебаггера -->
< script type = "module" src = "/src/svg-sprite-debug.ts" ></ script >
</ body >
</ html >
```
Создайте `src/svg-sprite-debug.ts` :
2026-07-14 16:11:39 +03:00
```ts
import '@gromlab/svg-sprites/viewer/element'
import type { SpriteViewerElement } from '@gromlab/svg-sprites/viewer'
2026-07-15 12:27:46 +03:00
import spriteManifest from '../assets/app-icons/.svg-sprite/svg-sprite.manifest.js'
2026-07-14 16:11:39 +03:00
const viewer = document . querySelector < SpriteViewerElement >( 'gromlab-sprite-viewer' ) !
viewer . sources = [ spriteManifest ]
```
2026-07-15 12:27:46 +03:00
Запустите `npm run dev` и откройте `/svg-sprite.html` .
2026-07-14 16:11:39 +03:00
2026-07-15 12:27:46 +03:00
Viewer не требуется для работы `<app-icon>` и не подключается к основному коду приложения.