Files
svg-sprites/docs/ru/guides/next-pages-webpack.md

99 lines
3.2 KiB
Markdown
Raw Normal View History

2026-07-15 12:27:46 +03:00
# SVG-спрайт для Next.js Pages Router с Webpack
2026-07-14 16:11:39 +03:00
2026-07-15 12:27:46 +03:00
Инструкция по быстрому созданию SVG-спрайта в приложении Next.js с Pages Router и Webpack.
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
Выберите папку для спрайта. В примере используется `assets/app-icons`, а исходные SVG находятся в `assets/svg-icons`.
2026-07-14 16:11:39 +03:00
2026-07-15 12:27:46 +03:00
Создайте конфиг `assets/app-icons/svg-sprite.config.json`:
2026-07-14 16:11:39 +03:00
2026-07-15 12:27:46 +03:00
```json
{
"mode": "next@pages/webpack",
"name": "app",
"input": "../svg-icons/**/*.svg"
2026-07-14 16:11:39 +03:00
}
```
2026-07-15 12:27:46 +03:00
Путь в `input` считается от папки с конфигом.
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": "next dev --webpack",
"prebuild": "npm run sprites",
"build": "next build --webpack"
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
// pages/index.tsx
2026-07-15 12:27:46 +03:00
import { AppIcon } from '../assets/app-icons'
2026-07-14 16:11:39 +03:00
export default function Page() {
return (
2026-07-15 12:27:46 +03:00
<AppIcon
icon="check"
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
Компонент работает с SSR, SSG и клиентскими переходами. Next.js сам добавляет `sprite.svg` в итоговую сборку, поэтому переносить его в `public` не нужно.
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
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
Создайте страницу `pages/svg-sprite.tsx`:
2026-07-14 16:11:39 +03:00
```tsx
2026-07-15 12:27:46 +03:00
import type { GetStaticProps } from 'next'
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
export default function SvgSpritePage() {
2026-07-14 16:11:39 +03:00
return <SpriteViewer sources={sources} title="Иконки проекта" />
}
2026-07-15 12:27:46 +03:00
export const getStaticProps: GetStaticProps = () =>
process.env.NODE_ENV === 'development'
? { props: {} }
: { notFound: true }
2026-07-14 16:11:39 +03:00
```
2026-07-15 12:27:46 +03:00
Запустите `npm run dev` и откройте `/svg-sprite`. В production маршрут вернёт 404.