Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/igoodie/vite-plugin-react-rich-svg
πΌ Seamless Vite SVG loader with versatile import options! (Such as dataURI, component and raw html code)
https://github.com/igoodie/vite-plugin-react-rich-svg
all-in-one import loader prettier rich svg svgr vite vite-plugin
Last synced: 19 days ago
JSON representation
πΌ Seamless Vite SVG loader with versatile import options! (Such as dataURI, component and raw html code)
- Host: GitHub
- URL: https://github.com/igoodie/vite-plugin-react-rich-svg
- Owner: iGoodie
- License: cc-by-sa-4.0
- Created: 2024-01-10T11:18:55.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-05-09T14:05:22.000Z (6 months ago)
- Last Synced: 2024-05-10T15:09:41.849Z (6 months ago)
- Topics: all-in-one, import, loader, prettier, rich, svg, svgr, vite, vite-plugin
- Language: TypeScript
- Homepage: https://igoodie.github.io/vite-plugin-react-rich-svg/
- Size: 1.73 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Vite Plugin: React Rich SVG
Seamless SVG loader with versatile import options (see demo page)
# Description
A vite plugin that handles SVG loading with zero-config effort.
It handles loading raw (html string), inline data uri (`data:svg+xml,...`) and SVGR Component (with easily usable SVGO options) imports easily!
This plugin is heavily inspired by [vite-svg-loader](https://github.com/jpkleemans/vite-svg-loader), which is an SVG loading Vite plugin for Vue. It is one of my favourites. Thanks to everyone contributed to it! π
# How to use?
1. Use your favorite package manager to install as dependency
```
npm install vite-plugin-react-rich-svg --save-dev
```
2. Include it in your `vite.config.ts`
```ts
import richSvg from "vite-plugin-react-rich-svg";
export default defineConfig({
plugins: [react(), richSvg()],
});
```
3. If you're using Typescript, you might want to include the typings under `vite-env.d.ts`:
```tsx
// Caveat: referencing our plugin first will ensure vite types do not overlap
///
///
```
4. Start importing your SVGs! Happy coding!
```ts
// Raw string import
import viteLogoRaw from "./assets/vite.svg?raw";
// Data URL import
import viteLogoDataURL from "./assets/vite.svg?url";
// Base64 Encoded import
import viteLogoBase64 from "./assets/vite.svg?base64";
// SVGR Component import
import ViteLogoComponent from "./assets/vite.svg?component";
// Default import, not handled by our plugin
import viteLogo from "./assets/vite.svg";
```
# Plugin Configurations
## `include` option
Acts as a whitelist predicate for the files you want to be processed.
```ts
richSvg({
include: (path) => /.*\.icon\.svg$/.test(path),
// ^ This config will only process files that look like:
// ...chevron-right.icon.svg?raw
// ...chevron-left.icon.svg?component
// ...home.icon.svg?url
}),
```
## `exclude` option
Acts as a blacklist predicate for the files you want to be ignored.
```ts
richSvg({
exclude: (path) => /.*\.ignore\.svg$/.test(path),
// ^ This config will ignore files that look like:
// ...my-illustration.ignore.svg?raw
// ...my-illustration.ignore.svg?component
// ...my-illustration.ignore.svg?url
}),
```
## `componentLoaderOptions.svgrConfig` option
Options used while running SVGR on the original svg code/asset (See [SVGR Options](https://react-svgr.com/docs/options/))
```ts
richSvg({
componentLoaderOptions: {
svgrConfig: {
ref: true,
memo: true,
},
// ^ This config will make it load component svg imports loads with forwardedRef & memo wrapped
},
}),
```
## `componentLoaderOptions.esbuildConfig` option
Options used to generate import code with given SVGR output (See [ESBuild Transform Options](https://esbuild.github.io/api/#transform))
```ts
richSvg({
componentLoaderOptions: {
esbuildConfig:{
minify: true
}
// ^ This config will make it load component svg imports loads with minification enabled
},
}),
```
# SVGO, Prettier & Other SVGR Plugins
SVGO and Prettier are supported out of the box. Just mark them in the svgrConfig and they'll start working.
You can also include your own SVGR plugins as you desire!
```ts
import myCustomPlugin from "my-custom-svgr-plugin";
richSvg({
componentLoaderOptions: {
svgrConfig: {
svgo: true,
prettier: true,
plugins: [myCustomPlugin]
},
},
}),
```
## License
Β© 2024 Taha AnΔ±lcan Metinyurt (iGoodie)
For any part of this work for which the license is applicable, this work is licensed under the [Attribution-ShareAlike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/) license. (See LICENSE).
