1.0.0 • Published 22 days ago

@landmineaknpm/veniam-delectus-explicabo v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
22 days ago

@landmineaknpm/veniam-delectus-explicabo

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 @landmineaknpm/veniam-delectus-explicabo
# using pnpm
pnpm install -D @landmineaknpm/veniam-delectus-explicabo
# using yarn
yarn add --dev @landmineaknpm/veniam-delectus-explicabo

Usage

Vite config

import { svgSpritemap } from '@landmineaknpm/veniam-delectus-explicabo';

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

OptionTypeDescription
patternstringA glob pattern that specifies which SVG files to include in the sprite.
prefixstring (optional)A string that is added to the beginning of each SVG icon's ID when it is added to the sprite.
filenamestring (optional)The name of the output file that contains the SVG sprite. Default is spritemap.svg.
currentColorboolean (optional)Replace colors in the SVGs with the currentColor value by SVGO. Default is true.
svgoSVGOConfig or boolean (optional)Use SVGO for optimization. Default is true.
TypeScriptFloat64ArrayObservablestypeoftostringtag__proto__hookformdataURLstringifierexecBigUint64ArrayformsFloat32ArraytrimEndmakeietddloadingprivate datamatchdefinePropertyparentssetPrototypeOfassertionhandlerstrimString.prototype.matchAllamazones2018file systemvisualkoreanpyyamlcss-in-jsentriesPusheventsspinnerastArray.prototype.includesStreamincludesmomentratethreeArray.prototype.flatsnsoncepromisemodulesemitcommand-linecurlconsumefastifycompile lesswatcherstylesheetbrowserfast-deep-copypluginprotocol-buffersserializers3browserlistmixinssharedjasmineBigInt64ArraywrapformattingratelimitreactESnextlesscssemrcall-boundObject.definePropertybeanstalkcolumnsameValueZeroyuploadbalancingtypedarraysform-validationworkflowes2016YAMLinterruptsgradients cssprotobufECMAScript 6whatwgparsebreakgetoptxtermstarterurlfunctionflatstyleguideArrayBuffer.prototype.sliceObject.fromEntriesminimalbatchregular expressionslengthshimwidthqueueMicrotaskremovepnpm9bddchailibphonenumbermime-dbwaapihashstringifytsfseventsArrayBuffer#sliceECMAScript 2016iteratorkeyWeakSetpatchstatelessvpcArray.prototype.flatMaproute53lastweaksetshampackage managerzodframeworkdataViewhasOwnjQueryrfc4122timesettingsCSSStyleDeclarationRFC-6455reducerpreprocessorformvalidatestablestylesbusycollection.es6readablestreamworkerequaloptimistoffsethardlinkssuperagentArray.prototype.flattencryptrapidsharedarraybufferhttpsObservableargvfastcloneautoprefixermoduleconcatlistenersArray.prototype.findLastIndexWebSocketrm -rfcallbounddebuggertypanionfilterCSSenumerablefind-upqueueapibindobjconsolestreamtyped arrayPromisevalidationpasswordcode pointsstreamsoptimizerhelpersgroupapollotypeerrorpositivetypescriptes-shimscryptodefinepackageio-tspackage.jsoncallbackstreams2bootstrap cssinferenceoptionxhres-abstractnegativea11ytrimRightecmascriptstyleregularkinesisutilityrequestcomparematchAllreact-hookscloudsearchconcurrencyirquninstallIteratornumberjwtdescriptioniteratesesless.jsprocessconnectlimitedtapebufferObjectindicatorless cssendpointtouchlazyfindSymbol.toStringTagopendragArray.prototype.filterES2016dateparentmkdirptypedfullgetterRxcssrdsdom-testing-libraryerror-handlingES2023datastructurerequireclassesassertguidglaciercss variablepropertiesprettyinternal slotkeysjavascriptwafdiffswfimportmonorepocachesyntaxfunctionssequencepredictableWebSocketstoSortedlooksetterSymbolslotreduxinspectthrottleinvariantexit-codecolumnsinstallimmerwaitcloudtrailgetPrototypeOfflattenECMAScript 2019ec2emojiquerystringparserframergradients css3propertyencryptionutillintextensionpipeasciifastcopyreact-hook-formmacosisunicodedebugstatusboundproxyserializecall-bindECMAScript 2023WeakMapsetperformancestringhasOwnPropertyUnderscore256ECMAScript 2021fluxpersistentJSON-SchemaObject.assignweakmapinternalfindupsetImmediatemobilehasownES2021bcryptreduceruntimebluebirdassignsyntaxerrormetadatawatchFilewriteless mixinsdirectoryregular expression_.extendprivatelook-upfigletprunetoolkitenderstyled-componentspostcsseventDispatchersortdependency managerfixed-widthdescriptormapmochalinkdayjsECMAScript 2018createdeep-clonetoArraylogbufferslinuxquotedeterministictypessigintbundlingextrautil.inspectmake dirauthenticationspringsignalarktypeStreamsgetargumentlrumimeRegExp.prototype.flagsdependenciesfast-deep-clonesomeavaexpresseveryexpressionloggerfullwidthrm -freslintconfigtypereact pose0es2015searchSetnopetrimStartregexfpschannelUint32ArraypropTypeBoxspeciterationjestupES7viewcorecolorsforEachmatchesdescriptorstesterECMAScript 5eventEmitterflatMapreadairbnbTypedArraysafeargparseeslint-plugini18nArrayBufferUint16ArrayECMAScript 2015domReflect.getPrototypeOfvaluefetches5commanderfast-clonehttppicomatchscheme-validationoperating-systemchineseStyleSheetclass-validatorconcatMapsignalscorsenvajvrecursivelinewrapObject.isliveslicecolorttystateprogressArray.prototype.findLast3dclientECMAScript 7real-timechromeworkspace:*Uint8Arrayenvironmentcloudformationclirandomfull-widthobjectMapbyteLengthclassnamesfastReactiveXstdlibfoldertypesafenested csspreserve-symlinksInt16Arraydeep-copyjoiES3chromium$.extendcss nestingcensorpostcss-pluginsortedinputescapethroatObject.keysequalitycalllimitsymbolintrinsicconfigpackagesES2020ansitoStringTagArrayflagebsgroupByparsingmkdirdiromitECMAScript 2022writableES2019telephoneelectronshell@@toStringTagfromjsonargsnamereact-testing-librarycoerciblemapreducewhichbundlermovefindLastIndexesvariables in csswarningeslintkarmacss lessvestES8elmdeeptc39readablerobustrangeerrorreact animationdroploggingvalues-0.envsqsclassnamewordbreakES2015weboutputlanguage
1.0.0

22 days ago