# vue3-component-svg-sprite

> An npm package used to bundle svg icons into the a Vue build. This is opposed to loading svg's from the server at runtime, which can end up svgs loading last on a site.

Latest version **0.0.0** (published 2024-01-08) · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install vue3-component-svg-sprite
pnpm add vue3-component-svg-sprite
yarn add vue3-component-svg-sprite
bun add vue3-component-svg-sprite
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.0 |
| Published | 2024-01-08 |
| First published | 2024-01-08 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 118.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | ddjnw1yu |

## Links

- npm: https://www.npmjs.com/package/vue3-component-svg-sprite
- npm.io page: https://npm.io/package/vue3-component-svg-sprite

## Dependencies (1)

- [vue](https://npm.io/package/vue.md) ^3.3.13

## Recent versions

- 0.0.0 (latest) — 2024-01-08
- 0.0.3 (beta) — 2024-02-14
- 0.0.2 — 2024-01-16
- 0.0.1 — 2024-01-08

## README

# svg-sprite [![npm version](https://badge.fury.io/js/%40abi-software%2Fsvg-sprite.svg)](https://badge.fury.io/js/%40abi-software%2Fsvg-sprite)
An npm package used to bundle svg icons into the a Vue build. This is opposed to loading svg's from the server at runtime, which can end up svgs loading last on a site.

## Using svg-sprite
svg-sprite currently only works for svgs included in the [assets/icons](https://github.com/ABI-Software/svg-sprite/tree/main/assets/icons) directory

It can however be forked to inlcude any set of svgs, or in future we can modify svg-sprite to take a prop input that points to an svg folder

### Installation
```
npm install @abi-software/svg-sprite
```
### Setup

To use svg-sprite, we need to load it before any of the svgs will be loaded in components. A method gauranteed to do this is loading it on the first line of app.py

#### In App.vue
```
<template>
    <div ref="root">
      <SvgSpriteColor/>
      ... Rest of app ...
    </div>
</template>

<script>
import {SvgSpriteColor} from '@abi-software/svg-sprite';
export default {
  name: "App",
  components: {
    SvgSpriteColor,
  },
  ...
}
```

#### When using an svg (this example is in a component)
```
<template>
  <svg-icon icon="close" @click.native="close"/>
</template>


<script>
/* eslint-disable no-alert, no-console */
import Vue from "vue";
import {SvgIcon} from '@abi-software/svg-sprite';
Vue.component('svg-icon', SvgIcon);
``` 

### Change the icon colours
```
<style>
.map-icon {
  color: red;
}
</style>
``` 

## Project setup
```
npm install
```

### Compiles and hot-reloads for development
```
npm run serve
```

### Create bundle for npm and publish 
```
npm run build-bundle
npm publish 
```

### Lints and fixes files
```
npm run lint
```

---
_Source: https://npm.io/package/vue3-component-svg-sprite · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
