Files
svg-sprites/skills/artifacts/svg-sprites-ru/references/docs/en/next-pages.md

97 lines
2.0 KiB
Markdown
Raw Permalink Normal View History

# Next.js Pages Router
[← Back to home](../../README.md)
Two explicit modes are supported:
| Bundler | Mode key | Next.js version |
|---|---|---|
| Turbopack | `next@pages/turbopack` | 16.2+ |
| Webpack 5 | `next@pages/webpack` | 12.2+ |
Next.js 12.2 requires React 18.
## 1. Install the package
```bash
npm install @gromlab/svg-sprites
```
## 2. Create a sprite module
```text
src/ui/file-manager/svg-sprite/
├── icons/
│ ├── check.svg
│ └── folder.svg
└── svg-sprite.config.ts
```
```ts
// src/ui/file-manager/svg-sprite/svg-sprite.config.ts
import { defineNextSpriteConfig } from '@gromlab/svg-sprites'
export default defineNextSpriteConfig({
name: 'file-manager',
description: 'File manager icons',
})
```
## 3. Add generation
```json
{
"scripts": {
"sprite:file-manager": "svg-sprites --mode next@pages/webpack src/ui/file-manager/svg-sprite",
"predev": "npm run sprite:file-manager",
"prebuild": "npm run sprite:file-manager"
}
}
```
For Next.js 16.2 with Turbopack, replace the mode key with `next@pages/turbopack`.
## 4. Use it on a page
```tsx
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: {} }
}
```
The component works the same way with SSR, SSG, and client-side navigation. Next.js emits a separate SVG asset with a content hash.
## 5. Add SpriteViewer
```tsx
import { SpriteViewer } from '@gromlab/svg-sprites/react'
const sources = [
() => import('@/ui/file-manager/svg-sprite/manifest'),
]
export default function SpritesPage() {
return <SpriteViewer sources={sources} />
}
```
## Verify the bundler
```bash
# Turbopack
npx next build --turbopack
# Webpack 5
npx next build --webpack
```
For Next 1215 with Webpack, use `npx next build` without the flag.
The Next.js command and the generator mode key must target the same bundler.