sanity-plugin-icon-picker

This is a Sanity Studio v3 plugin.

Icon picker for Sanity which let you select icons from a set of icon providers.

Installation

npm install sanity-plugin-icon-picker

Usage

Add it as a plugin in sanity.config.ts (or .js):

import { defineConfig } from 'sanity';
import { iconPicker } from 'sanity-plugin-icon-picker';

export default defineConfig({
  //...
  plugins: [iconPicker()],
});

Use the type in your schemas.

{
    title: "Icon",
    name: "icon",
    type: "iconPicker"
}

Options

Providers

Define which icon providers you want to use by providing their provider id in the providers array. If not defined, the Icon Picker defaults to display all providers and icons.

{
    title: "Icon",
    name: "icon",
    type: "iconPicker",
    options: {
        providers: ["f7", "fa", "mdi", "sa", "hi", "fi", "si"]
    }
}

Output Format

Format the output data in accordance with your front-end project. If you're using React you can set the outputFormat to react. If you ommit this option, the output format will be in accordance with every single provider's icon naming convention.

{
    title: "Icon",
    name: "icon",
    type: "iconPicker",
    options: {
        outputFormat: 'react',
    }
}

Filter

Filter out a subset of icons to be used by specifying a filter. A filter can be either an exact match of a string (case insensitive) or a regular expression. Supports both the react naming convention of an icon name as well as default naming conventions for each icon provider. This means that defining for instance the Font Awesome icon arrow-circle-up is equal to defining the react version FaArrowCircleUp.

{
    title: "Icon",
    name: "icon",
    type: "iconPicker",
    options: {
        filter: ['FaBeer', 'FaDocker', /^arrow/i],
    }
}

Store SVG

If you don't want to dynamically generate the icons in your front-end as described in this example, you can opt in to storing the selected SVG icon as a string in your data (usage example here).

{
    title: "Icon",
    name: "icon",
    type: "iconPicker",
    options: {
        storeSvg: true
    }
}

Configurations

Extend the built in provider configurations by adding your own. Note that if you want to mix built-in provider configurations with your own, you need to specify them manually since all will not be used automatically if a configuration is available.

import React from 'react'
import * as CarbonIcons from '@carbon/icons-react'
...
...
{
  title: 'Icon',
  name: 'icon',
  type: 'iconPicker',
  options: {
    configurations: [
      {
        title: 'Carbon Icons',
        provider: 'ci',
        icons: (options) =>
          Object.entries(CarbonIcons).map(([name, Component]) => ({
            name,
            component: () => <Component width="1.5em" height="1em" />,
            tags: [name],
          })),
      },
    ],
  },
},

Supported Icon Providers

Helper functions

Preview

In order to render the icon component as preview media, we can import a helper method.

import { preview } from 'sanity-plugin-icon-picker';

We can then render the icon by passing the selected name and provider to this method which will return an icon component.

{
...
    preview: {
        select: {
          provider: "icon.provider",
          name: "icon.name",
        },
        prepare(icon) {
          return {
            title: icon.provider,
            subtitle: icon.name,
            media: preview(icon),
          };
        },
      }
}

Preview with configurations

If you're using your own configurations you need to pass the options object to the preview parameters. Here's an example:

import React from 'react';
import { preview } from 'sanity-plugin-icon-picker';
import * as CarbonIcons from '@carbon/icons-react';

const options = {
  configurations: [
    {
      title: 'Carbon Icons',
      provider: 'ci',
      icons: (options) =>
        Object.entries(CarbonIcons).map(([name, Component]) => ({
          name,
          component: () => <Component width="1.5em" height="1em" />,
          tags: [name],
        })),
    },
  ],
};

export const schemaTypes = [
  {
    title: 'Icons',
    name: 'icons',
    type: 'document',
    fields: [
      {
        title: 'Icon',
        name: 'icon',
        type: 'iconPicker',
        options,
      },
    ],
    preview: {
      select: {
        provider: 'icon.provider',
        name: 'icon.name',
      },
      prepare(icon) {
        return {
          title: icon.provider,
          subtitle: icon.name,
          media: preview({ ...icon, options }),
        };
      },
    },
  },
];

Migrations

import { migrateIconName } from 'sanity-plugin-icon-picker';

We can use this function to migrate the name to a new outputFormat. This can be useful if you added icons in your studio and later decide that you want to use another outputFormat. Pass the third parameter react if you want to convert the name to options.outputFormat: 'react' naming convention. If you want to convert from react to default simply leave out the third parameter. Here's an example of a migration script where this function might come in handy.

migrateIconName('alert-circle', 'fi', 'react');

FAQ

How can I consume the data returned from Sanity Studio in my React app?

#### Example 1: Dynamically generating icon Here's a really simple example of how you could consume the data to render a Font Awesome icon from it. Note that in this example I'm using the option `outputFormat: 'react'` for the icon picker in the studio as mentioned [here](https://github.com/christopherafbjur/sanity-plugin-icon-picker#output-format). ```js import * as Icons from 'react-icons/fa'; // Sanity data mock const data = { _type: 'iconPicker', name: 'FaBeer', provider: 'fa', _updatedAt: '2021-07-25T02:30:43.141Z', }; const DynamicFontAwesomeIcon = ({ name }) => Icons[name]; export default function App() { const Icon = DynamicFontAwesomeIcon(data); return (

); } ``` #### Example 2: Stored SVG If you've opted in to [store SVGs](#store-svg) in your data (`options.storeSvg`), you could present them in various ways: ```js // Sanity data mock const data = { _type: 'iconPicker', name: 'alert-circle', provider: 'fi', svg: '', }; export default function App() { const encodedSvg = encodeURIComponent(data.svg); const imgSrc = `data:image/svg+xml,${encodedSvg}`; return (

); } ``` ```js import SVG from 'react-inlinesvg'; // Sanity data mock const data = { _type: 'iconPicker', name: 'alert-circle', provider: 'fi', svg: '', }; export default function App() { return (

); } ```

License

MIT © Christopher Af Bjur

Develop & test

This plugin uses @sanity/plugin-kit with default configuration for build & watch scripts.

See Testing a plugin in Sanity Studio on how to run this plugin with hotreload in the studio.