Mention the icon-setting on changelog in order to mitigate removeViewBox breaking change about svgr

[luhmann]

This webpack-config fixed things for me:

rules: [
        {
          test: /\.svg$/,
          use: [
            'babel-loader',
            {
              loader: 'svgr/lib/webpack',
              options: {
                icon: true,
              },
            },
        ],
    },
]

[gregberge]

@luhmann in fact, except for icons I think we do not need viewBox. If it was a problem for you, I could add an option viewBox. What do you think?

[luhmann]

The icon-setting actually works perfectly fine for me and is "correct" as the SVGs I turn into components are icons. I just thought that it might be a cool to highlight the icon-config in the CHANGELOG or in the README for people who encounter broken icons when upgrading to version 1.0.0, because SVGGO now removes the viewBox were it deems it to be safe.

The docs only say this about icon "Remove title and replace SVG "width" and "height" value by "1em"", but when you look at the code it actually also disables the svggo removeViewBox-plugin, which helped me in this case.

If you want my opinion then I think if you change the API of svgr it would actually be more beneficial to expose the ability to pass an svggo customConfig into svgr, because that should solve every need people might have that is within the capabilities of svggo. Of course I cannot judge if that might have a huge impact or might cause a lot of support-requests.

As a side-note:
I actually would have assumed that more people would run into issues with removed viewBoxes. If you have an original svg like this:

<svg width="24" height="24" viewBox="0 0 24 24"><!--- svg code assuming a viewBox of 24 24 --></svg>

SVGGO will look at this and because viewBox and width/height are equal will remove the viewBox. If someone then uses the wrapped svg in react in a way that width and height on the svg are replaced with other values, then I believe it would always look broken?

But maybe I am the only one doing that 😉

Thanks for a great tool! I am happy with the solution I arrived at, close this if you like.

[gregberge]

Thank you, I precised it in documentation!

[etienne]

I have the same issue; in my case, the icon option does not quite solve the problem because I don't want the width and height to be changed to 1em.

I agree with @luhmann's suggestion (allowing custom configuration of SVGO), but in my use case adding a viewBox option (that defaults to false) would be good enough. Is that something that could be considered for inclusion in a future release?

[gregberge]

@etienne got it thanks