mirror of
https://github.com/gromlab-ru/svg-sprites.git
synced 2026-07-22 04:40:17 +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-тестов
104 lines
2.7 KiB
Markdown
104 lines
2.7 KiB
Markdown
# SVG Sprite for Alpine.js with Webpack 5
|
|
|
|
A quick guide to creating an SVG sprite in an Alpine.js application built with Webpack 5.
|
|
|
|
## 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.
|
|
|
|
```json
|
|
{
|
|
"mode": "alpine@webpack",
|
|
"name": "app",
|
|
"input": "../svg-icons/**/*.svg"
|
|
}
|
|
```
|
|
|
|
The generator does not need to be added to the application dependencies: run it through `npx`.
|
|
|
|
Add generation before development and production builds:
|
|
|
|
```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 Alpine plugin `appAlpinePlugin`, the `x-app-icon` directive, and the `$appIconHref` magic.
|
|
|
|
Generated Alpine CSS is imported with the `?inline` query. Add an Asset Module rule to `webpack.config.js`:
|
|
|
|
```js
|
|
export default {
|
|
module: {
|
|
rules: [
|
|
{
|
|
test: /\.css$/,
|
|
resourceQuery: /inline/,
|
|
type: 'asset/source',
|
|
},
|
|
],
|
|
},
|
|
}
|
|
```
|
|
|
|
Create `assets/app-icons/index.js`:
|
|
|
|
```js
|
|
export * from './.svg-sprite/index.js'
|
|
```
|
|
|
|
Register the generated plugin before starting Alpine:
|
|
|
|
```js
|
|
import Alpine from 'alpinejs'
|
|
import { appAlpinePlugin } from '../assets/app-icons/index.js'
|
|
|
|
Alpine.plugin(appAlpinePlugin)
|
|
Alpine.start()
|
|
```
|
|
|
|
Use the reactive directive on an SVG element:
|
|
|
|
```html
|
|
<svg
|
|
x-data="{ iconName: 'icon-name' }"
|
|
x-app-icon="iconName"
|
|
role="img"
|
|
aria-label="Done"
|
|
style="width:24px;height:24px;color:#334155;--icon-color-2:#f59e0b"
|
|
></svg>
|
|
```
|
|
|
|
The directive expression resolves to a source SVG file name without the extension. A monochrome icon inherits `color`; override multicolor icon layers with `--icon-color-N`. Webpack 5 emits `sprite.svg` as a separate production asset.
|
|
|
|
## Debug and preview
|
|
|
|
Viewer displays all icons on one page and is only needed during development. Install it separately:
|
|
|
|
```bash
|
|
npm install --save-dev @gromlab/svg-sprites
|
|
```
|
|
|
|
Add Viewer to a development entry:
|
|
|
|
```js
|
|
import '@gromlab/svg-sprites/viewer/element'
|
|
import spriteManifest from '../assets/app-icons/.svg-sprite/svg-sprite.manifest.js'
|
|
|
|
const viewer = document.createElement('gromlab-sprite-viewer')
|
|
viewer.viewerTitle = 'Project icons'
|
|
viewer.sources = [spriteManifest]
|
|
document.body.append(viewer)
|
|
```
|
|
|
|
Include this entry only in development. Viewer is independent from the Alpine plugin.
|