svg-inline-loader

What is svg-inline-loader?

The svg-inline-loader npm package is a Webpack loader that inlines SVG files, allowing you to import SVGs directly into your JavaScript or TypeScript files. This can be useful for manipulating SVGs with JavaScript, applying styles, or optimizing SVGs for better performance.

What are svg-inline-loader's main functionalities?

Inline SVG Import

This feature allows you to import an SVG file directly into your JavaScript or TypeScript code. The SVG content is inlined, which means it is included directly in the JavaScript bundle, allowing for easier manipulation and styling.

const mySvg = require('svg-inline-loader!./path/to/my.svg');

SVG Optimization

By configuring Webpack to use svg-inline-loader for SVG files, you can ensure that all SVGs are inlined and optimized during the build process. This can help reduce the number of HTTP requests and improve performance.

module: { rules: [ { test: /\.svg$/, use: [ 'svg-inline-loader' ] } ] }

Custom Attributes

This feature allows you to customize the behavior of the loader, such as preserving or removing certain attributes from the SVG tags. This can be useful for maintaining specific SVG properties or optimizing the SVG content further.

module: { rules: [ { test: /\.svg$/, use: [ { loader: 'svg-inline-loader', options: { removeSVGTagAttrs: false } } ] } ] }

Other packages similar to svg-inline-loader

svg-url-loader

The svg-url-loader package is another Webpack loader that inlines SVGs, but it does so by converting them to data URLs. This can be useful for embedding SVGs directly in CSS or HTML. Compared to svg-inline-loader, svg-url-loader focuses more on converting SVGs to data URLs rather than inlining them directly in JavaScript.

react-svg-loader

The react-svg-loader package is designed specifically for React applications. It transforms SVGs into React components, allowing you to use SVGs as React components directly in your JSX. This is different from svg-inline-loader, which inlines SVGs into JavaScript without converting them to React components.

svgr

SVGR is a tool that transforms SVGs into React components, similar to react-svg-loader. It provides a CLI, webpack loader, and a Node.js API for converting SVGs to React components. SVGR offers more customization options and is more feature-rich compared to svg-inline-loader, which focuses on inlining SVGs into JavaScript.

README

SVG Inline Loader for Webpack

This Webpack loader inlines SVG as module. If you use Adobe suite or Sketch to export SVGs, you will get auto-generated, unneeded crusts. This loader removes it for you, too.

Install

npm install svg-inline-loader --save-dev

Configuration

Simply add configuration object to module.loaders like this.

    {
        test: /\.svg$/,
        loader: 'svg-inline-loader'
    }

warning: You should configure this loader only once via module.loaders or require('!...'). See #15 for detail.

Query Options

removeTags: boolean

Removes specified tags and its children. You can specify tags by setting removingTags query array.

default: removeTags: false

removingTags: [...string]

warning: this won't work unless you specify removeTags: true

default: removingTags: ['title', 'desc', 'defs', 'style']

warnTags: [...string]

warns about tags, ex: ['desc', 'defs', 'style']

default: warnTags: []

removeSVGTagAttrs: boolean

Removes width and height attributes from <svg />.

default: removeSVGTagAttrs: true

removingTagAttrs: [...string]

Removes attributes from inside the <svg />.

default: removingTagAttrs: []

warnTagAttrs: [...string]

Warns to console about attributes from inside the <svg />.

default: warnTagAttrs: []

classPrefix: boolean || string

Adds a prefix to class names to avoid collision across svg files.

default: classPrefix: false

idPrefix: boolean || string

Adds a prefix to ids to avoid collision across svg files.

default: idPrefix: false

Example Usage

// Using default hashed prefix (__[hash:base64:7]__)
var logoTwo = require('svg-inline-loader?classPrefix!./logo_two.svg');

// Using custom string
var logoOne = require('svg-inline-loader?classPrefix=my-prefix-!./logo_one.svg');

// Using custom string and hash
var logoThree = require('svg-inline-loader?classPrefix=__prefix-[sha512:hash:hex:5]__!./logo_three.svg');

See loader-utils for hash options.

Preferred usage is via a module.loaders:

    {
        test: /\.svg$/,
        loader: 'svg-inline-loader?classPrefix'
    }

Maintainers

Juho Vepsäläinen

Joshua Wiens

Kees Kluskens

Sean Larkin