README

This plugin aims to replicate most of the functionality of the native Craft icon field, but using the Phosphor Icons library instead of Font Awesome.

All styles are supported and can be configured per field. The plugin bundles the full icon library, so you do not need to do include any external style sheets or import extra dependencies at the front end.

Usage

Add a Phosphor Icon field to your entry type with your desired configuration - you can elect to allow choosing from the full set of styles (Duotone, Regular, etc), or narrow the list.

Development

A helper is exposed for rendering the icon, supposing your field is called phosphorIcon, you could do something like this:

<div class="w-16 h-16 text-indigo-600 [&>svg]:w-full [&>svg]:h-full">
  {{ craft.phosphorIcons.icon(entry.phosphorIcon.name, entry.phosphorIcon.weight)|raw }}
</div>

The example above uses Tailwind utility classes.

Credits

All credit due to the Phosphor Icons team for making such a great set of icons available under the MIT license, please consider donating to them if you find their icons useful.

Visit phosphoricons.com for more information.

GraphQL

At time of writing, the GraphQL endpoint is consistent with the behaviour of Craft's native icon field in Basic mode. That is, it returns only the icon name. This is a known gap in functionality, as the chosen style is currently missing.