mirror of
https://github.com/gromlab-ru/svg-sprites.git
synced 2026-07-22 04:40:17 +03:00
S.Gromov
7992adc9d3
- описаны единая конфигурация и exact modes - обновлена структура .svg-sprite - удалены материалы legacy pipeline - синхронизированы русская и английская версии skill
114 lines
2.8 KiB
Markdown
114 lines
2.8 KiB
Markdown
# Next.js App Router
|
||
|
||
[← Главная](../../README_RU.md)
|
||
|
||
Поддерживаются два явных режима:
|
||
|
||
| Сборщик | Mode key |
|
||
|---|---|
|
||
| Turbopack | `next@app/turbopack` |
|
||
| Webpack 5 | `next@app/webpack` |
|
||
|
||
## 1. Установите пакет
|
||
|
||
```bash
|
||
npm install --save-dev @gromlab/svg-sprites
|
||
```
|
||
|
||
## 2. Создайте sprite-модуль
|
||
|
||
```text
|
||
src/ui/file-manager/svg-sprite/
|
||
├── icons/
|
||
│ ├── check.svg
|
||
│ └── folder.svg
|
||
├── index.ts
|
||
└── svg-sprite.config.ts
|
||
```
|
||
|
||
```ts
|
||
// src/ui/file-manager/svg-sprite/svg-sprite.config.ts
|
||
import { defineSpriteConfig } from '@gromlab/svg-sprites'
|
||
|
||
export default defineSpriteConfig({
|
||
mode: 'next@app/turbopack',
|
||
name: 'file-manager',
|
||
description: 'Иконки файлового менеджера',
|
||
})
|
||
```
|
||
|
||
Корневой barrel принадлежит приложению:
|
||
|
||
```ts
|
||
// src/ui/file-manager/svg-sprite/index.ts
|
||
export * from './.svg-sprite'
|
||
```
|
||
|
||
## 3. Добавьте генерацию
|
||
|
||
Для Turbopack:
|
||
|
||
```json
|
||
{
|
||
"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"
|
||
}
|
||
}
|
||
```
|
||
|
||
Для Webpack замените mode key на `next@app/webpack`.
|
||
|
||
До импорта generated-модуля выполните первую генерацию:
|
||
|
||
```bash
|
||
npm run sprite:file-manager
|
||
```
|
||
|
||
## 4. Используйте в Server Component
|
||
|
||
Generated-компонент не содержит `'use client'`, поэтому его можно импортировать непосредственно в `page.tsx` или `layout.tsx`:
|
||
|
||
```tsx
|
||
import { FileManagerIcon } from '@/ui/file-manager/svg-sprite'
|
||
|
||
export default function Page() {
|
||
return (
|
||
<main>
|
||
<FileManagerIcon icon="folder" width={24} height={24} />
|
||
</main>
|
||
)
|
||
}
|
||
```
|
||
|
||
Next.js выпустит отдельный SVG asset с content hash. Один generated-код используется при SSR и в браузере без расхождения URL.
|
||
|
||
## 5. Добавьте SpriteViewer
|
||
|
||
Viewer интерактивен, поэтому для него нужна отдельная Client Component граница:
|
||
|
||
```tsx
|
||
'use client'
|
||
|
||
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 проекта, настроенный на выбранный сборщик:
|
||
|
||
```bash
|
||
npm run build
|
||
```
|
||
|
||
Build script и mode key генератора должны указывать один и тот же сборщик.
|