mirror of
https://github.com/gromlab-ru/svg-sprites.git
synced 2026-07-22 04:40:17 +03:00
- описаны единая конфигурация и exact modes - обновлена структура .svg-sprite - удалены материалы legacy pipeline - синхронизированы русская и английская версии skill
2.5 KiB
2.5 KiB
Next.js Pages Router
Поддерживаются два явных режима:
| Сборщик | Mode key |
|---|---|
| Turbopack | next@pages/turbopack |
| Webpack 5 | next@pages/webpack |
1. Установите пакет
npm install --save-dev @gromlab/svg-sprites
2. Создайте sprite-модуль
src/ui/file-manager/svg-sprite/
├── icons/
│ ├── check.svg
│ └── folder.svg
├── index.ts
└── svg-sprite.config.ts
// src/ui/file-manager/svg-sprite/svg-sprite.config.ts
import { defineSpriteConfig } from '@gromlab/svg-sprites'
export default defineSpriteConfig({
mode: 'next@pages/webpack',
name: 'file-manager',
description: 'Иконки файлового менеджера',
})
Корневой barrel принадлежит приложению:
// src/ui/file-manager/svg-sprite/index.ts
export * from './.svg-sprite'
3. Добавьте генерацию
{
"scripts": {
"sprite:file-manager": "svg-sprites src/ui/file-manager/svg-sprite/svg-sprite.config.ts",
"predev": "npm run sprite:file-manager",
"prebuild": "npm run sprite:file-manager"
}
}
Для Turbopack замените mode key на next@pages/turbopack.
До импорта generated-модуля выполните первую генерацию:
npm run sprite:file-manager
4. Используйте на странице
import { FileManagerIcon } from '@/ui/file-manager/svg-sprite'
export default function FilesPage() {
return <FileManagerIcon icon="folder" width={24} height={24} />
}
export function getServerSideProps() {
return { props: {} }
}
Компонент одинаково работает при SSR, SSG и клиентских переходах. Next.js выпускает отдельный SVG asset с content hash.
5. Добавьте SpriteViewer
import { SpriteViewer } from '@gromlab/svg-sprites/react'
const sources = [
() => import('@/ui/file-manager/svg-sprite/.svg-sprite/svg-sprite.manifest.js'),
]
export default function SpritesPage() {
return <SpriteViewer sources={sources} />
}
Проверка сборщика
Запустите build script проекта, настроенный на выбранный сборщик:
npm run build
Build script и mode key генератора должны указывать один и тот же сборщик.