mirror of
https://github.com/gromlab-ru/svg-sprites.git
synced 2026-07-22 04:40:17 +03:00
115 lines
4.0 KiB
Markdown
115 lines
4.0 KiB
Markdown
# SVG-спрайт для Vite без фреймворка
|
||
|
||
Инструкция по быстрому созданию SVG-спрайта в приложении на Vite без фреймворка.
|
||
|
||
## Генерация спрайта
|
||
|
||
Выберите папку для спрайта. В примере используется `assets/app-icons`, а исходные SVG, включая используемый ниже `check.svg`, находятся в `assets/svg-icons`.
|
||
|
||
Создайте конфиг `assets/app-icons/svg-sprite.config.json`:
|
||
|
||
```json
|
||
{
|
||
"mode": "standalone@vite",
|
||
"name": "app",
|
||
"input": "../svg-icons/**/*.svg"
|
||
}
|
||
```
|
||
|
||
Путь в `input` считается от папки с конфигом.
|
||
|
||
Добавьте команды генерации в `package.json`. Сгенерированные файлы по умолчанию исключены из Git, поэтому `predev` и `prebuild` пересобирают спрайт перед каждым запуском и сборкой:
|
||
|
||
```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": "vite build"
|
||
}
|
||
}
|
||
```
|
||
|
||
## Использование спрайта
|
||
|
||
Значение `name: "app"` создаёт элемент `<app-icon>`.
|
||
|
||
Создайте точку входа `assets/app-icons/index.ts`:
|
||
|
||
```ts
|
||
export * from './.svg-sprite/index.js'
|
||
```
|
||
|
||
Зарегистрируйте элемент в `src/main.ts`:
|
||
|
||
```ts
|
||
import { defineAppIconElement } from '../assets/app-icons'
|
||
import './style.css'
|
||
|
||
defineAppIconElement()
|
||
```
|
||
|
||
Используйте иконку в HTML:
|
||
|
||
```html
|
||
<app-icon icon="check" role="img" aria-label="Готово"></app-icon>
|
||
```
|
||
|
||
Файл `check.svg` доступен как `icon="check"`. Размер и цвета настраиваются через CSS:
|
||
|
||
```css
|
||
app-icon {
|
||
font-size: 24px;
|
||
color: #334155;
|
||
--icon-color-2: #f59e0b;
|
||
}
|
||
```
|
||
|
||
Монохромная иконка наследует `color`, а цвета многоцветной иконки переопределяются через `--icon-color-N`. Нужные переменные показывает Viewer.
|
||
|
||
Vite сам добавит `sprite.svg` в итоговую сборку. Копировать его в `public` не нужно.
|
||
|
||
## Дебаг и превью
|
||
|
||
Viewer показывает все иконки на одной странице, позволяет проверить их отображение, изменить цвета и посмотреть связанные CSS-переменные. Он нужен только для разработки и устанавливается отдельно:
|
||
|
||
```bash
|
||
npm install --save-dev @gromlab/svg-sprites
|
||
```
|
||
|
||
Создайте `svg-sprite.html` в корне проекта:
|
||
|
||
```html
|
||
<!doctype html>
|
||
<html lang="ru">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<title>Иконки проекта</title>
|
||
</head>
|
||
<body>
|
||
<!-- Компонент Viewer для дебага и превью SVG-спрайта -->
|
||
<gromlab-sprite-viewer viewer-title="Иконки проекта"></gromlab-sprite-viewer>
|
||
|
||
<!-- Подключение создаваемого ниже скрипта дебаггера -->
|
||
<script type="module" src="/src/svg-sprite-debug.ts"></script>
|
||
</body>
|
||
</html>
|
||
```
|
||
|
||
Создайте `src/svg-sprite-debug.ts`:
|
||
|
||
```ts
|
||
import '@gromlab/svg-sprites/viewer/element'
|
||
import type { SpriteViewerElement } from '@gromlab/svg-sprites/viewer'
|
||
import spriteManifest from '../assets/app-icons/.svg-sprite/svg-sprite.manifest.js'
|
||
|
||
const viewer = document.querySelector<SpriteViewerElement>('gromlab-sprite-viewer')!
|
||
viewer.sources = [spriteManifest]
|
||
```
|
||
|
||
Запустите `npm run dev` и откройте `/svg-sprite.html`.
|
||
|
||
Viewer не требуется для работы `<app-icon>` и не подключается к основному коду приложения.
|