[!IMPORTANT] As part of a major update, we will be replacing the existing phosphor-react package with @phosphor-icons/react. We recommend using this new version, as it has improved performance and a significantly smaller bundle size. No APIs have been changed, so drop-in replacement should be straightforward. The legacy package will continue to receive maintenance, but will not be updated with new icons upstream. Take me to the legacy version ➜

@phosphor-icons/react

Phosphor is a flexible icon family for interfaces, diagrams, presentations — whatever, really. Explore all our icons at phosphoricons.com.

Installation

1npm i @phosphor-icons/react

Usage

Simply import the icons you need, and add them anywhere in your render method. Phosphor supports tree-shaking, so your bundle only includes code for the icons you use.

1import { HorseIcon, HeartIcon, CubeIcon } from "@phosphor-icons/react";
2
3const App = () => {
4  return (
5    <main>
6      <HorseIcon />
7      <HeartIcon color="#AE2983" weight="fill" size={32} />
8      <CubeIcon color="teal" weight="duotone" />
9    </main>
10  );
11};

Import Performance Optimization

When importing icons during development directly from the main module @phosphor-icons/react, some bundlers may eagerly transpile all 9,000+ modules exported by the package. This behavior can drastically increase compilation time. To avoid transpiling all modules, import individual icons from their specific file paths instead:

1import { BellSimpleIcon } from "@phosphor-icons/react/dist/csr/BellSimple";

Next.js Specific Optimizations

If you're using Next.js 13+, consider using optimizePackageImports in your next.config.js to have Next.js only load the modules that you are actually using. With this approach, you can use @phosphor-icons/react directly without causing Next.js to compile all its modules:

1module.exports = {
2  experimental: {
3    optimizePackageImports: ["@phosphor-icons/react"],
4  },
5}

React Server Components and SSR

When using Phosphor Icons in an SSR environment, within a React Server Component, or in any environment that does not permit the use of the Context API (Next.js Server Component, for example), import icons from the /dist/ssr submodule:

1import { FishIcon } from "@phosphor-icons/react/ssr";
2
3const MyServerComponent = () => {
4  return <FishIcon weight="duotone" />;
5};

[!NOTE] These variants do not use React Context, and thus cannot inherit styles from an ancestor IconContext.

Props

Icon components accept all props that you can pass to a normal SVG element, including inline style objects, onClick handlers, and more. The main way of styling them will usually be with the following props:

• color?: string – Icon stroke/fill color. Can be any CSS color string, including hex, rgb, rgba, hsl, hsla, named colors, or the special currentColor variable.
• size?: number | string – Icon height & width. As with standard React elements, this can be a number, or a string with units in px, %, em, rem, pt, cm, mm, in.
• weight?: "thin" | "light" | "regular" | "bold" | "fill" | "duotone" – Icon weight/style. Can also be used, for example, to "toggle" an icon's state: a rating component could use Stars with weight="regular" to denote an empty star, and weight="fill" to denote a filled star.
• mirrored?: boolean – Flip the icon horizontally. Can be useful in RTL languages where normal icon orientation is not appropriate.
• alt?: string – Add accessible alt text to an icon.

Context

Phosphor takes advantage of React Context to make applying a default style to all icons simple. Create an IconContext.Provider at the root of the app (or anywhere above the icons in the tree) and pass in a configuration object with props to be applied by default to all icons:

1import { IconContext, HorseIcon, HeartIcon, CubeIcon } from "@phosphor-icons/react";
2
3const App = () => {
4  return (
5    <IconContext.Provider
6      value={{
7        color: "limegreen",
8        size: 32,
9        weight: "bold",
10        mirrored: false,
11      }}
12    >
13      <div>
14        <HorseIcon /> {/* I'm lime-green, 32px, and bold! */}
15        <HeartIcon /> {/* Me too! */}
16        <CubeIcon /> {/* Me three :) */}
17      </div>
18    </IconContext.Provider>
19  );
20};

You may create multiple Contexts for styling icons differently in separate regions of an application; icons use the nearest Context above them to determine their style.

[!NOTE] The context will also pass any provided SVG props down to icon instances, which can be useful E.G. in adding accessible aria-labels, classNames, etc.

[!NOTE] React Context is not available in some environments. See React Server Components and SSR for details.

Composability

Components can accept arbitrary SVG elements as children, so long as they are valid children of the <svg> element. This can be used to modify an icon with background layers or shapes, filters, animations, and more. The children will be placed below the normal icon contents.

The following will cause the Cube icon to rotate and pulse:

1const RotatingCube = () => {
2  return (
3    <CubeIcon color="darkorchid" weight="duotone">
4      <animate
5        attributeName="opacity"
6        values="0;1;0"
7        dur="4s"
8        repeatCount="indefinite"
9      ></animate>
10      <animateTransform
11        attributeName="transform"
12        attributeType="XML"
13        type="rotate"
14        dur="5s"
15        from="0 0 0"
16        to="360 0 0"
17        repeatCount="indefinite"
18      ></animateTransform>
19    </CubeIcon>
20  );
21};

[!NOTE] The coordinate space of slotted elements is relative to the contents of the icon viewBox, which is 256x256 square. Only valid SVG elements will be rendered.

Imports

You may wish to import all icons at once for use in your project, though depending on your bundler this could prevent tree-shaking and make your app's bundle larger.

1import * as Icon from "@phosphor-icons/react";
2
3<Icon.SmileyIcon />
4<Icon.FolderIcon weight="thin" />
5<Icon.BatteryHalfIcon size="24px" />

For information on using Phosphor Icons in Server Components, see See React Server Components and SSR.

Custom Icons

It is possible to extend Phosphor with your custom icons, taking advantage of the styling and context abstractions used in our library. To create a custom icon, first design your icons on a 256x256 pixel grid, and export them as SVG. For best results, flatten the icon so that you only export assets with path elements. Strip any fill or stroke attributes, as these will be inherited from the wrapper.

Next, create a new React forwardRef component, importing the IconBase component, as well as the Icon and IconWeight types from this library. Define a Map<IconWeight, ReactElement> that maps each icon weight to the contents of each SVG asset, effectively removing the wrapping <svg> element from each. Name your component, and render an <IconBase />, passing all props and the ref, as well as the weights you defined earlier, as JSX props:

1import { forwardRef, ReactElement } from "react";
2import { Icon, IconBase, IconWeight } from "@phosphor-icons/react";
3
4const weights = new Map<IconWeight, ReactElement>([
5  ["thin", <path d="..." />],
6  ["light", <path d="..." />],
7  ["regular", <path d="..." />],
8  ["bold", <path d="..." />],
9  ["fill", <path d="..." />],
10  [
11    "duotone",
12    <>
13      <path d="..." opacity="0.2" />
14      <path d="..." />
15    </>,
16  ],
17]);
18
19const CustomIcon: Icon = forwardRef((props, ref) => (
20  <IconBase ref={ref} {...props} weights={weights} />
21));
22
23CustomIcon.displayName = "CustomIcon";
24
25export default CustomIcon;

[!NOTE] If you have multiple child elements, wrap them in a Fragment. Typically our duotone icons have multiple elements, with the background layer at 20% opacity.

If Custom Icons are intended to be used in React Server Components, use <SSRBase /> instead of <IconBase /> as the render component.

Our Projects

• @phosphor-icons/homepage ▲ Phosphor homepage and general info
• @phosphor-icons/core ▲ Phosphor icon assets and catalog
• @phosphor-icons/elm ▲ Phosphor icons for Elm
• @phosphor-icons/figma ▲ Phosphor icons Figma plugin
• @phosphor-icons/flutter ▲ Phosphor IconData library for Flutter
• @phosphor-icons/pack ▲ Phosphor web font stripper to generate minimal icon bundles
• @phosphor-icons/penpot ▲ Phosphor icons Penpot plugin
• @phosphor-icons/react ▲ Phosphor icon component library for React
• @phosphor-icons/sketch ▲ Phosphor icons Sketch plugin
• @phosphor-icons/swift ▲ Phosphor icon component library for SwiftUI
• @phosphor-icons/theme ▲ A VS Code (and other IDE) theme with the Phosphor color palette
• @phosphor-icons/unplugin ▲ A multi-framework bundler plugin for generating Phosphor sprite sheets
• @phosphor-icons/vue ▲ Phosphor icon component library for Vue
• @phosphor-icons/web ▲ Phosphor icons for Vanilla JS
• @phosphor-icons/webcomponents ▲ Phosphor icons as Web Components

Community Projects

• adamglin0/compose-phosphor-icons ▲ Phosphor icons for Compose Multiplatform
• altdsoy/phosphor_icons ▲ Phosphor icons for Phoenix and TailwindCSS
• amPerl/egui-phosphor ▲ Phosphor icons for egui apps (Rust)
• babakfp/phosphor-icons-svelte ▲ Phosphor icons for Svelte apps
• brettkolodny/phosphor-lustre ▲ Phosphor icons for Lustre
• cellularmitosis/phosphor-uikit ▲ XCode asset catalog generator for Phosphor icons (Swift/UIKit)
• cjohansen/phosphor-clj ▲ Phosphor icons as Hiccup for Clojure and ClojureScript
• codeat3/blade-phosphor-icons ▲ Phosphor icons in your Laravel Blade views
• dreamRs/phosphor-r ▲ Phosphor icon wrapper for R documents and applications
• duongdev/phosphor-react-native ▲ Phosphor icon component library for React Native
• haruaki07/phosphor-svelte ▲ Phosphor icons for Svelte apps
• IgnaceMaes/ember-phosphor-icons ▲ Phosphor icons for Ember apps
• iota-uz/icons ▲ Phosphor icons as Templ components (Go)
• jajuma/phosphorhyva ▲ Phosphor icons for Magento 2 & Mage-OS with Hyvä Theme
• Kitten ▲ Phosphor icons integrated by default in Kitten
• lucagoslar/phosphor-css ▲ CSS wrapper for Phosphor SVG icons
• maful/ruby-phosphor-icons ▲ Phosphor icons for Ruby and Rails applications
• meadowsys/phosphor-svgs ▲ Phosphor icons as Rust string constants
• mwood/tamagui-phosphor-icons ▲ Phosphor icons for Tamagui
• noozo/phosphoricons_elixir ▲ Phosphor icons as SVG strings for Elixir/Phoenix
• oyedejioyewole/nuxt-phosphor-icons ▲ Phosphor icons integration for Nuxt
• pepaslabs/phosphor-uikit ▲ Xcode asset catalog generator for Swift/UIKit
• raycast/phosphor-icons ▲ Phosphor icons Raycast extension
• reatlat/eleventy-plugin-phosphoricons ▲ An Eleventy shortcode plugin to embed icons as inline SVGs
• robruiz/wordpress-phosphor-icons-block ▲ Phosphor icon block for use in WordPress v5.8+
• sachaw/solid-phosphor ▲ Phosphor icons for SolidJS
• SeanMcP/phosphor-astro ▲ Phosphor icons as Astro components
• SorenHolstHansen/phosphor-leptos ▲ Phosphor icon component library for Leptos apps (Rust)
• vnphanquang/phosphor-icons-tailwindcss ▲ TailwindCSS plugin for Phosphor icons
• wireui/phosphoricons ▲ Phosphor icons for Laravel

If you've made a port of Phosphor and you want to see it here, just open a PR here!

License

MIT © Phosphor Icons