Skip to content

Add support for custom icon set #347

@onmax

Description

@onmax

Clear and concise description of the problem

I am working on my own icon set. I am using the Iconify specification.

I have my own Icons explorer, which is heavily inspired by the design of Icones, but it is becoming cumbersome to maintain.

Instead, I am looking into externalizing the icons explorer component into Icones. In my documentation I would like to add "Open Icons explorer" and redirect user to icones.

Suggested solution

I propose the following

New query param

A url that points to a Iconify JSON file. e.g. https://icones.js.org/collection/custom-icon-set?url=https://raw.githubusercontent.com/onmax/nimiq-ui/b354f04e4d1d3a4836e2036ba2beb79d16afca45/packages/nimiq-icons/dist/icons.json

Update the "Install Iconfiy Iconset" instructions

Since we cannot ensure the package exists in npm, we can show as an alternative a link to the documentation using the link from the author.url: https://iconify.design/docs/types/iconify-info.html#author.

Alternative

  1. Build my own icon explorer
  2. Fork this project

Additional context

If you think this idea is worth it, I would love to start working on it and make a PR :)

Validations

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions