mirror of
https://github.com/gromlab-ru/svg-sprites.git
synced 2026-07-21 20:30:16 +03:00
S.Gromov
8b3365f957
Добавлены exact modes: - vue@vite и vue@webpack - nuxt@vite и nuxt@webpack - svelte@vite, svelte@webpack и sveltekit@vite - angular@application и angular@webpack - astro@vite - solid@vite, solid@webpack и solid-start@vite - preact@vite и preact@webpack - qwik@vite - lit@vite и lit@webpack - alpine@vite и alpine@webpack Для каждого mode реализованы изолированный adapter, нативный framework-компонент, declarations, manifest, CSS и внешний asset URL. Добавлены production integration-стенды с генерацией, typecheck, сборкой и Playwright-проверкой рендера спрайта и Viewer. Обновлены Viewer, RU/EN-гайды, README, technical reference и AI skills. Итоговая матрица включает 29 exact modes. Проверки: - 48 unit-тестов - 29 integration E2E-тестов
106 lines
2.8 KiB
Markdown
106 lines
2.8 KiB
Markdown
# SVG Sprite for Vue with Vite
|
|
|
|
A quick guide to creating an SVG sprite in a Vue application built with Vite.
|
|
|
|
## Generate the sprite
|
|
|
|
Choose a directory for the future SVG sprite, for example `assets/app-icons`, and create `svg-sprite.config.json` inside it. In `input`, specify the path to existing SVG files relative to the configuration file. There is no need to move or copy the icons.
|
|
|
|
Example configuration:
|
|
|
|
```json
|
|
{
|
|
"mode": "vue@vite",
|
|
"name": "app",
|
|
"input": "../svg-icons/**/*.svg"
|
|
}
|
|
```
|
|
|
|
The package does not need to be a project dependency: generation runs through `npx`.
|
|
|
|
Add generation commands to `package.json`. Generated files are excluded from Git by default, so `predev` and `prebuild` rebuild the sprite before every start and build:
|
|
|
|
```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": "vue-tsc --noEmit && vite build"
|
|
}
|
|
}
|
|
```
|
|
|
|
## Use the sprite
|
|
|
|
The value `name: "app"` creates the Vue component `AppIcon`.
|
|
|
|
Create the entry point `assets/app-icons/index.ts`:
|
|
|
|
```ts
|
|
export * from './.svg-sprite/index.js'
|
|
```
|
|
|
|
Use the component in your application:
|
|
|
|
```vue
|
|
<script setup lang="ts">
|
|
import { AppIcon } from '../assets/app-icons'
|
|
</script>
|
|
|
|
<template>
|
|
<AppIcon
|
|
icon="icon-name"
|
|
width="24"
|
|
height="24"
|
|
role="img"
|
|
aria-label="Done"
|
|
style="color: #334155; --icon-color-2: #f59e0b"
|
|
/>
|
|
</template>
|
|
```
|
|
|
|
The `icon` prop accepts source SVG file names without the extension. A monochrome icon inherits `color`, while colors in a multicolor icon are overridden with `--icon-color-N`.
|
|
|
|
Vite automatically includes the component styles and adds `sprite.svg` to the production build.
|
|
|
|
## Debug and preview
|
|
|
|
Viewer displays all icons on one page so you can check their rendering, change colors, and inspect the related CSS variables. It is only needed for development and is installed separately:
|
|
|
|
```bash
|
|
npm install --save-dev @gromlab/svg-sprites
|
|
```
|
|
|
|
Create `svg-sprite.html` in the project root:
|
|
|
|
```html
|
|
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<title>Project icons</title>
|
|
</head>
|
|
<body>
|
|
<gromlab-sprite-viewer viewer-title="Project icons"></gromlab-sprite-viewer>
|
|
<script type="module" src="/src/svg-sprite-debug.ts"></script>
|
|
</body>
|
|
</html>
|
|
```
|
|
|
|
Create `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]
|
|
```
|
|
|
|
Run `npm run dev` and open `/svg-sprite.html`.
|
|
|
|
Viewer is not required by `AppIcon` and is not loaded by the main application code.
|