Sha256: 218e157f533c68752e6b15c6eb2069b5ef6cb85e6b57c63f7edd1cb9ddbd0f25

Contents?: true

Size: 1.11 KB

Versions: 1146

Compression:

Stored size: 1.11 KB

Contents

# Tips for Custom Icons

When using custom icons it is important to introduce a "clean" SVG. In order to ensure these custom icons perform as intended within your kit(s), ensure these things have been modified from the original SVG markup:

Attributes must be React compatible e.g. <code>xmlns:xlink</code> should be <code>xmlnsXlink</code> and so on. <strong>There should be no hyphenated attributes and no semi-colons!.</strong>

Fill colors with regards to <code>g</code> or <code>path</code> nodes, e.g. <code>fill="black"</code>, should be replaced with <code>currentColor</code> ala <code>fill="currentColor"</code>. Your mileage may vary depending on the complexity of your SVG.

Pay attention to your custom icon's dimensions and `viewBox` attribute. It is best to use a `viewBox="0 0 512 512"` starting point **when designing instead of trying to retrofit the viewbox afterwards**!

You must source _your own SVG into component/view_ you are working on. This can easily be done in programmatic and maintainable ways.

### Rails

Sending the absolute path to the `icon` prop results in an `<SVG>` tag within the working view.

Version data entries

1,146 entries across 1,146 versions & 2 rubygems

Version Path
playbook_ui_docs-13.18.0.pre.alpha.play1141iconkitusinglibrary2210 app/pb_kits/playbook/pb_icon/docs/_icon_custom.md
playbook_ui-13.18.0.pre.alpha.play1141iconkitusinglibrary2210 app/pb_kits/playbook/pb_icon/docs/_icon_custom.md
playbook_ui_docs-13.16.0.pre.alpha.play1141iconkitusinglibrary2130 app/pb_kits/playbook/pb_icon/docs/_icon_custom.md
playbook_ui-13.16.0.pre.alpha.play1141iconkitusinglibrary2130 app/pb_kits/playbook/pb_icon/docs/_icon_custom.md
playbook_ui_docs-13.16.0.pre.alpha.play1141iconkitusinglibrary2107 app/pb_kits/playbook/pb_icon/docs/_icon_custom.md
playbook_ui-13.16.0.pre.alpha.play1141iconkitusinglibrary2107 app/pb_kits/playbook/pb_icon/docs/_icon_custom.md