mirror of
https://github.com/gromlab-ru/svg-sprites.git
synced 2026-09-05 08:20:19 +03:00
76 lines
2.3 KiB
Markdown
76 lines
2.3 KiB
Markdown
# SVG-спрайт для Preact на Vite
|
||
|
||
Инструкция по быстрому созданию SVG-спрайта в Preact-приложении на Vite.
|
||
|
||
## Генерация спрайта
|
||
|
||
Выберите каталог для будущего SVG-спрайта, например `assets/app-icons`, и создайте в нём `svg-sprite.config.json`. В `input` укажите путь к существующим SVG относительно файла конфигурации. Перемещать или копировать иконки не требуется.
|
||
|
||
```json
|
||
{
|
||
"mode": "preact@vite",
|
||
"name": "app",
|
||
"input": "../svg-icons/**/*.svg"
|
||
}
|
||
```
|
||
|
||
Пакет не нужно добавлять в зависимости проекта. Запускайте его через `npx` перед разработкой и production-сборкой:
|
||
|
||
```json
|
||
{
|
||
"scripts": {
|
||
"sprites": "npx --yes @gromlab/svg-sprites assets/app-icons/svg-sprite.config.json",
|
||
"predev": "npm run sprites",
|
||
"dev": "vite",
|
||
"prebuild": "npm run sprites",
|
||
"build": "tsc --noEmit && vite build"
|
||
}
|
||
}
|
||
```
|
||
|
||
## Использование спрайта
|
||
|
||
Создайте `assets/app-icons/index.js` и `assets/app-icons/index.d.ts` с одинаковым экспортом:
|
||
|
||
```js
|
||
export * from './.svg-sprite/index.js'
|
||
```
|
||
|
||
Используйте сгенерированный Preact-компонент на plain JavaScript:
|
||
|
||
```jsx
|
||
import { AppIcon } from '../assets/app-icons/index.js'
|
||
|
||
export function SaveIcon() {
|
||
return (
|
||
<AppIcon
|
||
icon="icon-name"
|
||
width={24}
|
||
height={24}
|
||
aria-label="Готово"
|
||
style={{ color: '#334155', '--icon-color-2': '#f59e0b' }}
|
||
/>
|
||
)
|
||
}
|
||
```
|
||
|
||
Vite автоматически выпускает импортированный `sprite.svg` как production asset.
|
||
|
||
## Дебаг и превью
|
||
|
||
Установите Viewer только для разработки:
|
||
|
||
```bash
|
||
npm install --save-dev @gromlab/svg-sprites
|
||
```
|
||
|
||
Подключите его в отладочной entry:
|
||
|
||
```js
|
||
import '@gromlab/svg-sprites/viewer/element'
|
||
|
||
const viewer = document.createElement('gromlab-sprite-viewer')
|
||
viewer.sources = [() => import('../assets/app-icons/.svg-sprite/svg-sprite.manifest.js')]
|
||
document.body.append(viewer)
|
||
```
|