Licence
MIT
Version
1.0.0
Deps
28
Size
14 kB
Vulns
0
Weekly
0
@ryniaubenpm2/adipisci-accusantium-dicta
This vite plugin generates a single SVG spritemap containing multiple elements from all .svg files in a directory.
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
Installation
# 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
import { svgSpritemap } from '@ryniaubenpm2/adipisci-accusantium-dicta';
export default defineConfig({
plugins: [
svgSpritemap({
pattern: 'src/icons/*.svg',
}),
],
});
SVG element
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. |
Keywords
exit-codeInt32ArraybyteOffsetassigncallrecursiveURLSearchParamsparentsES2016requirearrayfast-cloneeswaitkinesisfull-widthmonorepoprototypedprivatecodesInt16Arrayjsonpathframeworkstartomittraversegroupbootstrap cssrgbbuffersquotees2018logextendidentifiersaccessormatchesmixinsreplayswfjQueryconsumeappelasticacheStyleSheetES2019emojiconcurrencycompareWebSocketdefinel10nnpmmoduleESfsdeterministicboundecmascriptpostcssopensimportexport-0higher-ordertyped arraydeepcopycloudformationnamesrfc4122typessettermakesameValueZeropushamazonclassesartpyyamlcompilergetless.jsiterateestreedeepmoveECMAScript 2020groupBydotenvmapchildhooksinputflattengetoptimportiterationbrowserslistexecsuperagentpropertyRxJSreduxwarningReflect.getPrototypeOfECMAScript 2023findLaststyled-componentseslintserializerhashdirhasOwnPropertyeslint-pluginsetImmediatemergeshrinkwrapaccessibilityutilitytakebluebirdSymbol.toStringTagcode pointsreadablestreampostcss-plugincolumndefinePropertyglobalECMAScript 6connectECMAScript 2017descriptorsextrahttprandomexpresstoArrayfpsprivate dataoperating-systemloggercurlwrapfulltypeerrorwidthenvjshintoptimizereslintpluginsettingsresolveargparsemetadatahasOwnfunctionales7ajaxtesterpnpm9trimzodAsyncIteratorInt8ArrayFloat64ArraystablejwtietextstringbusyArrayBuffer.prototype.slicedeepclonebufferqsratedatastructureObject.valuesECMAScript 3dataViewownString.prototype.matchAllWebSocketsjavascriptgetintrinsicclassnameshookformrmdirObservablerobustArray.prototype.includespasswordArray.prototype.findLastUint16ArrayidlevalidatepackagenopebundlerfluxURLmake dirworkspace:*termcall-bindcolumnsfseventsprettyerrorgdprtypedarrayObject.definePropertywalktaprm -frextensionloadbalancingerror-handlingqueueMicrotaskless cssRxArray.prototype.flattenbatchESnexthasgradients cssRFC-6455deep-copyguidcomputed-typeskoreanHyBispeedthrottlestringifiercommandernegative zerodynamodboutputjsxlastReactiveExtensionsmulti-packageinstalluninstallES2015descriptionavaintrinsicrouterflatmimetypesairbnbwritabletapeperformanceFloat32ArraysetPrototypeOfES2020ES5xdgelmdateSymbolsafermperformantES2017eventspromisesdomtypanionlesscsssinatraequalitynamevalidationiteratortoStringTagtrimEndpreserve-symlinksmobilesearchString.prototype.trimArray.prototype.containsReactiveXObject.entriesclonextermregexpTypeBoxbindmomentserializees-abstractenvironmentSetscheme-validationObject.keysreal-timelinuxtaskES7symbolsmiddlewarediffincludess3restfulglobalscolorcss nestingjsonfind-uppositivecloudwatchfilterObject.assignasynccirculartoolswebnegativees6proxycompile lessdropwatchdescriptorUnderscorelimitratelimittoobjectRegExp.prototype.flagsbootstrap lesspipecall-boundimmerapienvironments