solid-design-system / solid

Monorepo for Union Investment's Solid Design System.
https://solid-design-system.fe.union-investment.de/docs/
Other
21 stars 4 forks source link

fix: 🤔 rename internal icons to `internal`/`private` instead of `system` #1411

Open mariohamann opened 1 month ago

mariohamann commented 1 month ago

Current behavior

We currently have some internal icons that are shipped with our component library. These are those, that are built into our own components and therefore have to be available despite any CDN or whatever.

This comes from the concept of Shoelace. In the context of Union Investment, this leads to confusion, as we're differentiating between "content" and "system" icons there. There was even a situation, where a developer of a team used those "system" icons, thinking that hthose are the official ones. @karlbaumhauer brought this topic up again (https://github.com/solid-design-system/solid/pull/1399#discussion_r1765160196) , and we definitely should tackle that.

Expected behavior

Let's change the library name of our internal system library to internal or private.

<!-- old -->
<sd-icon library="system" name="whatever"></sd-icon>
<!-- new (a) -->
<sd-icon library="internal" name="whatever"></sd-icon>
<!-- new (b) -->
<sd-icon library="private" name="whatever"></sd-icon>

This will lead to a breaking change – although it shouldn't be used, those icons could have been overridden via Theme registration e. g. in the context of Attrax, and therefore we should take it into our Breaking Changes Epic.

Steps to reproduce

Technical Information

DoR

DoD