Icon previews

[NduatiK]

Would it be possible for the library to embed icons in the docs so developers can preview what they are importing.

Another library (FeatherIcons) I have been looking into implements this and its been a delight to use.

For example:

They are doing this by providing an image in the docs like this:

{-| align-right
![image](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiPjxsaW5lIHgxPSIyMSIgeTE9IjEwIiB4Mj0iNyIgeTI9IjEwIj48L2xpbmU+PGxpbmUgeDE9IjIxIiB5MT0iNiIgeDI9IjMiIHkyPSI2Ij48L2xpbmU+PGxpbmUgeDE9IjIxIiB5MT0iMTQiIHgyPSIzIiB5Mj0iMTQiPjwvbGluZT48bGluZSB4MT0iMjEiIHkxPSIxOCIgeDI9IjciIHkyPSIxOCI+PC9saW5lPjwvc3ZnPg==)
-}
alignRight : Icon
alignRight =
    ...

---

Why do this?

• Developer Experience

Why not do this?

• Even larger source code (I noticed the base material libraries is 1.3MB); this is a one time download so maybe its okay
• A potentially more complex generation process; this might not be true since you start with the svg and could just base64 encode it into the docs
• The google icons website might already be adequate for previewing

What do you think @icidasset?

Oh, and thanks for the wonderful library!

[NduatiK]

Yikes, just spotted this comment.

This might not work as it will undoubtedly increase the docs size.

[icidasset]

Hey! Thanks for the feature request, I'd love this too! But yeah, you guessed it, the size limitation on the Elm docs doesn't allow for this. I'll leave this open in case it ever changes though.

[NduatiK]

Thanks for the quick reply.
That sounds good, we'll wait for any changes.