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

@intouchg/webpack-svgr-plugin

v0.1.1

Published

Webpack plugin to run SVGR in directory watcher mode

Downloads

3

Readme

@intouchg/webpack-svgr-plugin

Webpack plugin to run SVGR for the Intouch Design System. Watches the directory for changes to rerun as necessary.

Getting Started

Initialize and pass the plugin to Webpack. The plugin will read the .idsconfig.json file in the project root. The plugin will use the "icons" property filepath.

// webpack.config.js
const IntouchSVGRPlugin = require('@intouchg/webpack-svgr-plugin')

// ...
webpackPlugins.push(new IntouchSVGRPlugin())
// .idsconfig.json
{
    "icons": "icons"
}

React Children

Generated React icon components will render the children prop as the first child inside the component, without replacing the other child elements. This is useful for passing elements such as title for accessibility:

<IntouchLogoIcon
    role="img"
    width="200px"
    fill="#b2d236"
>
    <title>
        Intouch Logo Icon
    </title>
</IntouchLogoIcon>

Disabling Dynamic Properties

  • DISABLING: Turn off "dynamic property" replacement by adding a // svgr-disable-dynamic-props comment block to the source SVG file:
<!-- // svgr-disable-dynamic-props -->

Dynamic Properties

"Dynamic properties" are enabled by default. When enabled, the fill and stroke properties from the source SVG file are replaced by React component props as follows:

  • If the SVG file has exactly 1 unique value each for the fill and stroke properties, those values will be replaced with inherit in the generated component output

  • If the SVG file has exactly 2 or 3 unique values each for the fill and stroke properties, those values will be replaced with fill1 || 'inherit', fill2 || 'inherit', etc. and stroke1 || 'inherit' etc.

Note: Uniqueness of fill and stroke values are considered separately - so dynamic props will still be generated if your fill values are red, green, and blue while your stroke values are orange, purple, and pink (6 unique values in total).

Advanced

The plugin constructor accepts a filepath to the .idsconfig.json file, an options object that's specific to this module, and a merge function to update any SVGR option:

new IntouchSVGRPlugin(
    '../path/to/idsconfig',
    { scss: true }, // module options
    (defaultSvgrOptions) => {
        console.log(defaultSvgrOptions)
        const newSvgrOptions = defaultSvgrOptions

        // do stuff to manipulate newSvgrOptions here...

        return newSvgrOptions
    }
)