npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gatsby-plugin-svgr-svgo

v2.0.0

Published

Plugin allows you to use SVGs as react components, configure SVGO(SVG optimization) settings and declare rules for SVG url loader with or without optimization.

Downloads

6,253

Readme

gatsby-plugin-svgr-svgo

Plugin allows you to use SVGs as react components, configure SVGO(SVG optimization) settings and declare rules for SVG url loader with or without optimization.

npm version Drone

Install

For Gatsby 3.0.0+ versions use

npm install gatsby-plugin-svgr-svgo @svgr/webpack --save

For Gatsby 2.3.0+ versions use

npm install [email protected] @svgr/webpack --save

For older versions

npm install [email protected] @svgr/webpack --save

Setup

Default configuration

Add to your gatsby-config.js

plugins: [`gatsby-plugin-svgr-svgo`];

By default there are two rules will be added:

  1. SVG as a react component(inline svg), SVGO enabled for all SVGs that have .inline postfix. Example: cat.inline.svg
import React from "react";
import CatInlineSvg from "../images/cat.inline.svg";

const IndexPage = () => (
  <div>
    <CatInlineSvg />
  </div>
);

export default IndexPage;
  1. SVG as a file that available by url, SVGO enabled for all svgs that have .svg. Example: cat.svg.
import React from "react";
import CatSvg from "../images/cat.svg";

const IndexPage = () => (
  <div>
    <img src={CatSvg} />
  </div>
);

export default IndexPage;

Advanced configuration

plugins: [
  {
    resolve: "gatsby-plugin-svgr-svgo",
    options: {
      inlineSvgOptions: [
        {
          test: /\.inline.svg$/,
          svgoConfig: {
            plugins: [
              {
                name: "preset-default",
                params: {
                  overrides: [{ name: "removeViewBox", active: false }],
                },
              },
              "prefixIds",
            ],
          },
        },
      ],
      urlSvgOptions: [
        {
          test: /\.svg$/,
          svgoConfig: {
            plugins: [{ name: "removeViewBox", active: false }],
          },
        },
      ],
    },
  },
];

You can declare various rules based on loader that should be used under inlineSvgOptions and urlSvgOptions.

test - pattern that will be used to match file name

svgoConfig - accepts plugins list with settings, list of available plugins(options) you can find here

svgo - disables SVGO if set in false

SVGO disabled example

plugins: [
  {
    resolve: "gatsby-plugin-svgr-svgo",
    options: {
      urlSvgOptions: [
        {
          test: /\.svg$/,
          svgo: false,
        },
      ],
    },
  },
];

Set URL loader fallback limit

By default webpack url-loader has a fallback to file-loader that converts the file from the original extension to base64. Plugins set default as 512 bytes. So if you want to set the limit from which it should be loaded directly from url instead of base64 loading just use limit option within urlLoaderOptions.

Limits you set in bytes. Read about more options there

urlSvgOptions: [
  {
    test: /\.svg$/,
    svgoConfig: {
      plugins: [{ name: "removeViewBox", active: false }],
    },
    urlLoaderOptions: {
      limit: 512,
    },
  },
];