Skip to content

Latest commit

 

History

History
98 lines (86 loc) · 2.01 KB

README.md

File metadata and controls

98 lines (86 loc) · 2.01 KB
Raw

Intro

Vite SVG plugin: effortless SVG import with support for various formats JSON, raw string, object, etc.

Installation

Install with npm

npm i -D vite-svg

or Install with yarn

yarn add vite-svg

or Install with pnpm

pnpm install vite-svg

Usage

Vite plugin configuration vite.config.js

import { defineConfig } from 'vite';
import viteSVG from 'vite-svg';
// https://vitejs.dev/config/
export default defineConfig({
  plugins: [
    viteSVG({default: 'raw'})
  ],
});

Extract default options in box and now pass JSON

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [
    viteSVG({
        default: 'json'
    })
  ],
});

SVG to object

Extract SVG to a simple object with id attribute

import javascript from './javascript.svg?box'

console.log(javascript)
//output example
{
    "id": "",
    "viewBox": "0 0 256 256",
    "url": "javascript.svg#"
}

SVG to json

Extract svg to json with all properties

import javascript from './javascript.svg?json'

console.log(javascript)
//output example
{
    "xmlns": "...",
    "xmlns:xlink": "...",
    "aria-hidden": "true",
    "role": "img",
    "class": "iconify iconify--logos",
    "width": "32",
    "height": "32",
    "preserveAspectRatio": "xMidYMid meet",
    "viewBox": "0 0 256 256",
    "fill": "#F7DF1E",
    "d": "...."
    ...
}

SVG to raw

Extract SVG to raw as string

import javascript from './javascript.svg?raw'

console.log(javascript)

//output example: <svg xmlns="..." xmlns:xlink="..." aria-hidden="true" role="img" class="iconify iconify--logos" width="32" height="32"  viewBox="0 0 256 256"><path fill="#F7DF1E" d="..."></path><path d="....."></path></svg>

Author

Saeed Hossen

License

MIT