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-тестов
112 lines
3.0 KiB
Markdown
112 lines
3.0 KiB
Markdown
# SVG Sprite for Webpack 5 Without a Framework
|
|
|
|
A quick guide to creating an SVG sprite in a Webpack 5 application without a framework.
|
|
|
|
## 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": "standalone@webpack",
|
|
"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": "webpack serve --mode development",
|
|
"prebuild": "npm run sprites",
|
|
"build": "webpack --mode production"
|
|
}
|
|
}
|
|
```
|
|
|
|
## Use the sprite
|
|
|
|
The value `name: "app"` creates the `<app-icon>` element.
|
|
|
|
Create the entry point `assets/app-icons/index.ts`:
|
|
|
|
```ts
|
|
export * from './.svg-sprite/index.js'
|
|
```
|
|
|
|
Register the element in the application's main entry:
|
|
|
|
```ts
|
|
import { defineAppIconElement } from '../assets/app-icons'
|
|
import './style.css'
|
|
|
|
defineAppIconElement()
|
|
```
|
|
|
|
Use the icon in HTML:
|
|
|
|
```html
|
|
<app-icon icon="icon-name" role="img" aria-label="Done"></app-icon>
|
|
```
|
|
|
|
The `icon` value is the source SVG filename without the extension. Set its size and colors with CSS:
|
|
|
|
```css
|
|
app-icon {
|
|
font-size: 24px;
|
|
color: #334155;
|
|
--icon-color-2: #f59e0b;
|
|
}
|
|
```
|
|
|
|
A monochrome icon inherits `color`, while colors in a multicolor icon are overridden with `--icon-color-N`. Viewer shows the variables you need.
|
|
|
|
Webpack 5 automatically 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.
|
|
|
|
Install Viewer:
|
|
|
|
```bash
|
|
npm install --save-dev @gromlab/svg-sprites
|
|
```
|
|
|
|
Create the entry `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.createElement('gromlab-sprite-viewer') as SpriteViewerElement
|
|
viewer.viewerTitle = 'Project icons'
|
|
viewer.sources = [spriteManifest]
|
|
document.body.append(viewer)
|
|
```
|
|
|
|
Add the script to the main entry only in development mode. Keep the rest of your `webpack.config.js` settings:
|
|
|
|
```js
|
|
export default (_env, argv) => ({
|
|
// Other Webpack settings.
|
|
entry: [
|
|
'./src/main.ts',
|
|
...(argv.mode === 'development' ? ['./src/svg-sprite-debug.ts'] : []),
|
|
],
|
|
})
|
|
```
|
|
|
|
Run `npm run dev`. Viewer appears on the application's main page.
|
|
|
|
Viewer is only added to the development build and is not included in production.
|