2026-07-15 12:27:46 +03:00
# SVG-спрайт для React на Webpack 5
2026-07-14 16:11:39 +03:00
2026-07-15 12:27:46 +03:00
Инструкция по быстрому созданию SVG-спрайта в React-приложении на Webpack 5.
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" : "react@webpack" ,
"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" : "webpack serve --mode development" ,
"prebuild" : "npm run sprites" ,
"build" : "webpack --mode production"
2026-07-14 16:11:39 +03:00
}
}
```
2026-07-15 12:27:46 +03:00
## Использование спрайта
Значение `name: "app"` создаёт React-компонент `AppIcon` .
Создайте точку входа `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
Используйте компонент в приложении:
2026-07-14 16:11:39 +03:00
```tsx
2026-07-15 12:27:46 +03:00
import { AppIcon } from '../assets/app-icons'
2026-07-14 16:11:39 +03:00
2026-07-15 12:27:46 +03:00
export function SaveIcon() {
2026-07-14 16:11:39 +03:00
return (
2026-07-15 12:27:46 +03:00
< AppIcon
2026-07-15 16:56:44 +03:00
icon = "icon-name"
2026-07-15 12:27:46 +03:00
width = { 24 }
height = { 24 }
role = "img"
aria-label = "Готово"
style = {{
color : '#334155' ,
'--icon-color-2' : '#f59e0b' ,
}}
/>
2026-07-14 16:11:39 +03:00
)
}
```
2026-07-15 12:27:46 +03:00
Свойство `icon` принимает имена исходных SVG без расширения. Монохромная иконка наследует `color` , а цвета многоцветной переопределяются через `--icon-color-N` .
2026-07-14 16:11:39 +03:00
2026-07-15 13:41:24 +03:00
Компонент использует CSS Modules. Если проект ещё не обрабатывает их, установите loaders:
```bash
npm install --save-dev style-loader css-loader
```
Затем добавьте правило с default export в `webpack.config.js` :
2026-07-14 16:11:39 +03:00
2026-07-15 12:27:46 +03:00
```js
{
test : /\.module\.css$/i ,
use : [
'style-loader' ,
{
loader : 'css-loader' ,
options : { modules : { namedExport : false } },
},
],
}
```
2026-07-14 16:11:39 +03:00
2026-07-15 12:27:46 +03:00
Webpack 5 сам добавляет `sprite.svg` в итоговую сборку.
## Дебаг и превью
Viewer показывает все иконки на одной странице, позволяет проверить их отображение, изменить цвета и посмотреть связанные CSS-переменные. Он нужен только для разработки.
Установите Viewer:
2026-07-14 16:11:39 +03:00
```bash
npm install --save-dev @gromlab/svg-sprites
```
2026-07-15 12:27:46 +03:00
Создайте entry `src/svg-sprite-debug.tsx` :
2026-07-14 16:11:39 +03:00
```tsx
2026-07-15 12:27:46 +03:00
import { createRoot } from 'react-dom/client'
2026-07-14 16:11:39 +03:00
import { SpriteViewer } from '@gromlab/svg-sprites/react'
const sources = [
2026-07-15 12:27:46 +03:00
() => import ( '../assets/app-icons/.svg-sprite/svg-sprite.manifest.js' ),
2026-07-14 16:11:39 +03:00
] as const
2026-07-15 12:27:46 +03:00
const container = document . createElement ( 'div' )
document . body . append ( container )
createRoot ( container ). render (
< SpriteViewer sources = { sources } title = "Иконки проекта" />,
)
2026-07-14 16:11:39 +03:00
```
2026-07-15 12:27:46 +03:00
Добавьте скрипт к основному entry только в development-режиме. Сохраните остальные настройки `webpack.config.js` :
2026-07-14 16:11:39 +03:00
2026-07-15 12:27:46 +03:00
```js
export default ( _env , argv ) => ({
// Остальные настройки Webpack.
entry : [
'./src/main.tsx' ,
...( argv . mode === 'development' ? [ './src/svg-sprite-debug.tsx' ] : []),
],
2026-07-14 16:11:39 +03:00
})
```
2026-07-15 12:27:46 +03:00
Запустите `npm run dev` . Viewer появится на основной странице приложения и не попадёт в production-сборку.