# @ryniaubenpm2/adipisci-accusantium-dicta

> This [vite](https://vitejs.dev/) plugin generates a single SVG spritemap containing multiple elements from all `.svg` files in a directory.

Latest version **1.0.0** (published 2024-05-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ryniaubenpm2/adipisci-accusantium-dicta
pnpm add @ryniaubenpm2/adipisci-accusantium-dicta
yarn add @ryniaubenpm2/adipisci-accusantium-dicta
bun add @ryniaubenpm2/adipisci-accusantium-dicta
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2024-05-01 |
| First published | 2024-05-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 28 |
| Unpacked size | 13.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | ryniaube |
| Maintainers | mi762136 |
| Keywords | exit-code, Int32Array, byteOffset, assign, call, recursive, URLSearchParams, parents, ES2016, require, array, fast-clone, es, wait, kinesis, full-width, monorepo, proto, typed, private, codes, Int16Array, jsonpath, framework, start, omit, traverse, group, bootstrap css, rgb, buffers, quote, es2018, log, extend, identifiers, accessor, matches, mixins, replay, swf, jQuery, consume, app, elasticache, StyleSheet, ES2019, emoji, concurrency, compare, WebSocket, define, l10n, npm, module, ES, fs, deterministic, bound, ecmascript, postcss, opens, importexport, -0, higher-order, typed array, deepcopy, cloudformation, names, rfc4122, types, setter, make, sameValueZero, push, amazon, classes, art, pyyaml, compiler, get, less.js, iterate, estree, deep, move, ECMAScript 2020, groupBy, dotenv, map, child, hooks, input, flatten, getopt, import, iteration, browserslist, exec, superagent, property, RxJS, redux, warning, Reflect.getPrototypeOf, ECMAScript 2023, findLast, styled-components, eslint, serializer, hash, dir, hasOwnProperty, eslint-plugin, setImmediate, merge, shrinkwrap, accessibility, utility, take, bluebird, Symbol.toStringTag, code points, readablestream, postcss-plugin, column, defineProperty, global, ECMAScript 6, connect, ECMAScript 2017, descriptors, extra, http, random, express, toArray, fps, private data, operating-system, logger, curl, wrap, full, typeerror, width, env, jshint, optimizer, eslintplugin, settings, resolve, argparse, metadata, hasOwn, functional, es7, ajax, tester, pnpm9, trim, zod, AsyncIterator, Int8Array, Float64Array, stable, jwt, ie, text, string, busy, ArrayBuffer.prototype.slice, deepclone, buffer, qs, rate, datastructure, Object.values, ECMAScript 3, dataView, own, String.prototype.matchAll, WebSockets, javascript, getintrinsic, classnames, hookform, rmdir, Observable, robust, Array.prototype.includes, password, Array.prototype.findLast, Uint16Array, idle, validate, package, nope, bundler, flux, URL, make dir, workspace:*, term, call-bind, columns, fsevents, pretty, error, gdpr, typedarray, Object.defineProperty, walk, tap, rm -fr, extension, loadbalancing, error-handling, queueMicrotask, less css, Rx, Array.prototype.flatten, batch, ESnext, has, gradients css, RFC-6455, deep-copy, guid, computed-types, korean, HyBi, speed, throttle, stringifier, commander, negative zero, dynamodb, output, jsx, last, ReactiveExtensions, multi-package, install, uninstall, ES2015, description, ava, intrinsic, router, flat, mimetypes, airbnb, writable, tape, performance, Float32Array, setPrototypeOf, ES2020, ES5, xdg, elm, date, Symbol, safe, rm, performant, ES2017, events, promises, dom, typanion, lesscss, sinatra, equality, name, validation, iterator, toStringTag, trimEnd, preserve-symlinks, mobile, search, String.prototype.trim, Array.prototype.contains, ReactiveX, Object.entries, clone, xterm, regexp, TypeBox, bind, moment, serialize, es-abstract, environment, Set, scheme-validation, Object.keys, real-time, linux, task, ES7, symbols, middleware, diff, includes, s3, restful, globals, color, css nesting, json, find-up, positive, cloudwatch, filter, Object.assign, async, circular, tools, web, negative, es6, proxy, compile less, drop, watch, descriptor, Underscore, limit, ratelimit, toobject, RegExp.prototype.flags, bootstrap less, pipe, call-bound, immer, api, environments |

## Links

- npm: https://www.npmjs.com/package/@ryniaubenpm2/adipisci-accusantium-dicta
- Repository: https://github.com/ryniaubenpm2/adipisci-accusantium-dicta
- Homepage: https://github.com/ryniaubenpm2/adipisci-accusantium-dicta/#readme
- Issues: https://github.com/ryniaubenpm2/adipisci-accusantium-dicta/issues
- npm.io page: https://npm.io/package/@ryniaubenpm2/adipisci-accusantium-dicta

## Dependencies (28)

- [@f1stnpm3/sunt-ullam-minus](https://npm.io/package/@f1stnpm3/sunt-ullam-minus.md) ^1.0.0
- [@ryniaubenpm2/ea-facere-cum](https://npm.io/package/@ryniaubenpm2/ea-facere-cum.md) ^1.0.0
- [@ryniaubenpm2/magni-ullam-optio](https://npm.io/package/@ryniaubenpm2/magni-ullam-optio.md) ^1.0.0
- [@ryniaubenpm2/ipsam-doloribus-ad](https://npm.io/package/@ryniaubenpm2/ipsam-doloribus-ad.md) ^1.0.0
- [@f1stnpm3/dolores-distinctio-enim](https://npm.io/package/@f1stnpm3/dolores-distinctio-enim.md) ^1.0.0
- [@ryniaubenpm2/aut-explicabo-velit](https://npm.io/package/@ryniaubenpm2/aut-explicabo-velit.md) ^1.0.0
- [@ryniaubenpm2/laudantium-quo-amet](https://npm.io/package/@ryniaubenpm2/laudantium-quo-amet.md) ^1.0.0
- [@ryniaubenpm2/minima-ea-distinctio](https://npm.io/package/@ryniaubenpm2/minima-ea-distinctio.md) ^1.0.0
- [@ryniaubenpm2/perspiciatis-cum-est](https://npm.io/package/@ryniaubenpm2/perspiciatis-cum-est.md) ^1.0.0
- [@ryniaubenpm2/quae-consectetur-aut](https://npm.io/package/@ryniaubenpm2/quae-consectetur-aut.md) ^1.0.0
- [@ryniaubenpm2/saepe-corporis-ullam](https://npm.io/package/@ryniaubenpm2/saepe-corporis-ullam.md) ^1.0.0
- [@ryniaubenpm2/omnis-placeat-nostrum](https://npm.io/package/@ryniaubenpm2/omnis-placeat-nostrum.md) ^1.0.0
- [@ryniaubenpm2/porro-incidunt-fugiat](https://npm.io/package/@ryniaubenpm2/porro-incidunt-fugiat.md) ^1.0.0
- [@ryniaubenpm2/sequi-similique-nihil](https://npm.io/package/@ryniaubenpm2/sequi-similique-nihil.md) ^1.0.0
- [@ryniaubenpm2/ea-commodi-voluptatibus](https://npm.io/package/@ryniaubenpm2/ea-commodi-voluptatibus.md) ^1.0.0
- [@ryniaubenpm2/labore-velit-cupiditate](https://npm.io/package/@ryniaubenpm2/labore-velit-cupiditate.md) ^1.0.0
- [@ryniaubenpm2/voluptates-velit-minima](https://npm.io/package/@ryniaubenpm2/voluptates-velit-minima.md) ^1.0.0
- [@ryniaubenpm2/nesciunt-molestiae-quasi](https://npm.io/package/@ryniaubenpm2/nesciunt-molestiae-quasi.md) ^1.0.0
- [@ryniaubenpm2/veniam-occaecati-impedit](https://npm.io/package/@ryniaubenpm2/veniam-occaecati-impedit.md) ^1.0.0
- [@ryniaubenpm2/cupiditate-modi-doloribus](https://npm.io/package/@ryniaubenpm2/cupiditate-modi-doloribus.md) ^1.0.0
- [@ryniaubenpm2/doloremque-aperiam-dolorem](https://npm.io/package/@ryniaubenpm2/doloremque-aperiam-dolorem.md) ^1.0.0
- [@ryniaubenpm2/porro-excepturi-distinctio](https://npm.io/package/@ryniaubenpm2/porro-excepturi-distinctio.md) ^1.0.0
- [@ryniaubenpm2/eveniet-asperiores-corporis](https://npm.io/package/@ryniaubenpm2/eveniet-asperiores-corporis.md) ^1.0.0
- [@ryniaubenpm2/reiciendis-excepturi-aliquam](https://npm.io/package/@ryniaubenpm2/reiciendis-excepturi-aliquam.md) ^1.0.0
- [@ryniaubenpm2/voluptatem-possimus-deleniti](https://npm.io/package/@ryniaubenpm2/voluptatem-possimus-deleniti.md) ^1.0.0
- [@ryniaubenpm2/recusandae-architecto-tempora](https://npm.io/package/@ryniaubenpm2/recusandae-architecto-tempora.md) ^1.0.0
- [@ryniaubenpm2/perferendis-quasi-voluptatibus](https://npm.io/package/@ryniaubenpm2/perferendis-quasi-voluptatibus.md) ^1.0.0
- [@ryniaubenpm2/voluptatem-architecto-praesentium](https://npm.io/package/@ryniaubenpm2/voluptatem-architecto-praesentium.md) ^1.0.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.0 (latest) — 2024-05-01

## README

# @ryniaubenpm2/adipisci-accusantium-dicta

This [vite](https://vitejs.dev/) plugin generates a single SVG spritemap containing multiple <symbol> elements from all `.svg` files in a directory.

<a href="https://www.npmjs.com/package/@ryniaubenpm2/adipisci-accusantium-dicta">
  <img alt="npm version" src="https://img.shields.io/npm/v/@ryniaubenpm2/adipisci-accusantium-dicta.svg?style=flat-square" />
</a>
<a href="https://www.npmjs.com/package/@ryniaubenpm2/adipisci-accusantium-dicta">
  <img alt="npm downloads" src="https://img.shields.io/npm/dm/@ryniaubenpm2/adipisci-accusantium-dicta.svg?style=flat-square" />
</a>

## Features

- Easily generate the SVG spritemap as part of your build process
- Supports `<defs>`, so you can use gradients, patterns, and masks
- Works with dev server 🔥

If you find this plugin useful, why not

<a href="https://www.buymeacoffee.com/gmakarov" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" width="160" height="40"></a>

## Installation

```bash
# using npm
npm install -D @ryniaubenpm2/adipisci-accusantium-dicta
# using pnpm
pnpm install -D @ryniaubenpm2/adipisci-accusantium-dicta
# using yarn
yarn add --dev @ryniaubenpm2/adipisci-accusantium-dicta
```

## Usage

**Vite config**

```ts
import { svgSpritemap } from '@ryniaubenpm2/adipisci-accusantium-dicta';

export default defineConfig({
  plugins: [
    svgSpritemap({
      pattern: 'src/icons/*.svg',
    }),
  ],
});
```

**SVG element**

```tsx
export const Icon: React.FC<{ name: string }> = ({ name }) => (
  <svg xmlns="http://www.w3.org/2000/svg" xmlnsXlink="http://www.w3.org/1999/xlink">
    <use xlinkHref={`/spritemap.svg#${name}`} />
  </svg>
);

const App = () => {
  return <Icon name="arrow" />;
};
```

## Options

| Option         | Type                                 | Description                                                                                   |
| -------------- | ------------------------------------ | --------------------------------------------------------------------------------------------- |
| `pattern`      | `string`                             | A glob pattern that specifies which SVG files to include in the sprite.                       |
| `prefix`       | `string` (optional)                  | A string that is added to the beginning of each SVG icon's ID when it is added to the sprite. |
| `filename`     | `string` (optional)                  | The name of the output file that contains the SVG sprite. Default is `spritemap.svg`.         |
| `currentColor` | `boolean` (optional)                 | Replace colors in the SVGs with the `currentColor` value by SVGO. Default is `true`.          |
| `svgo`         | `SVGOConfig` or `boolean` (optional) | Use SVGO for optimization. Default is `true`.                                                 |

---
_Source: https://npm.io/package/@ryniaubenpm2/adipisci-accusantium-dicta · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
