@launchpad-ui/icons

@launchpad-ui/icons

An element that supplements content and represents an action or feature within LaunchDarkly.

Installation

$ yarn add @launchpad-ui/icons
# or
$ npm install @launchpad-ui/icons

Usage

Basic

By default, the Icon component expects the package's provided sprite.svg file to be located in /static/sprite.svg of your app. The name prop specifies which icon to render.

import { Icon } from '@launchpad-ui/icons';

const MyIcon = () => <Icon name="info" />;

Custom static location

A custom path to the sprite can be set via the IconContext provider. For example, if importing a static asset returns a resolved URL (like in Vite or Remix) you can do the following in your app to load the icons:

import { IconContext } from '@launchpad-ui/icons';
import icons from '@launchpad-ui/icons/sprite.svg';
import { createRoot } from 'react-dom/client';

const domNode = document.getElementById('root');
const root = createRoot(domNode);

root.render(
  <IconContext.Provider value={{ path: icons }}>
    <App />
  </IconContext.Provider>
);

CORS limitation

Unfortunately SVG sprites cannot be accessed cross-domain. If you are hosting the sprite file in a CDN or different domain you will have to fetch the file and inject it into the document to access the icons directly.

First set the Icon context path to an empty string to indicate the symbols are available in the DOM:

import { IconContext } from '@launchpad-ui/icons';
import { createRoot } from 'react-dom/client';

const domNode = document.getElementById('root');
const root = createRoot(domNode);

root.render(
  <IconContext.Provider value={{ path: '' }}>
    <App />
  </IconContext.Provider>
);

Then fetch and inject the sprite for Icon to render icons correctly:

fetch('https://cdn.example.com/sprite.svg')
  .then(async (response) => response.text())
  .then((data) => {
    const parser = new DOMParser();
    const content = parser.parseFromString(data, 'image/svg+xml').documentElement;
    content.id = 'lp-icons-sprite';
    content.style.display = 'none';
    document.body.appendChild(content);
  })
  .catch((err) => {
    console.log('Failed to fetch sprite', err);
  });

To minimize latency, you can preload the sprite file accordingly:

<link
  rel="preload"
  href="https://cdn.example.com/sprite.svg"
  as="fetch"
  type="image/svg+xml"
  crossorigin
/>