phosphor-react-sc

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

Supports React Server Components: This is a fork of @phosphor-icons/react. The only change is that the icons no longer use useContext in order to support React Server Components.

Installation

1yarn add phosphor-react-sc

or

1npm install --save phosphor-react-sc

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 { Horse, Heart, Cube } from "phosphor-react-sc";
2
3const App = () => {
4  return (
5    <main>
6      <Horse />
7      <Heart color="#AE2983" weight="fill" size={32} />
8      <Cube color="teal" weight="duotone" />
9    </main>
10  );
11};

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.

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    <Cube 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    </Cube>
20  );
21};

Note: The coordinate space of slotted elements is relative to the contents of the icon viewBox, which is a 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-react-sc";
2
3<Icon.Smiley />
4<Icon.Folder weight="thin" />
5<Icon.BatteryHalf size="24px" />

Custom Icons

It is possible to extend Phosphor with your own custom icons and taking advantage of the styling. 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-react-sc";
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.

Our Related Projects

• @phosphor-icons/homepage ▲ Phosphor homepage and general info
• @phosphor-icons/core ▲ Phosphor icon assets and catalog
• @phosphor-icons/web ▲ Phosphor icons for Vanilla JS
• @phosphor-icons/vue ▲ Phosphor icon component library for Vue
• @phosphor-icons/elm ▲ Phosphor icons for Elm
• @phosphor-icons/flutter ▲ Phosphor IconData library for Flutter
• @phosphor-icons/webcomponents ▲ Phosphor icons as Web Components
• @phosphor-icons/figma ▲ Phosphor icons Figma plugin
• @phosphor-icons/sketch ▲ Phosphor icons Sketch plugin

Community Projects

• phosphor-react-native ▲ Phosphor icon component library for React Native
• phosphor-svelte ▲ Phosphor icons for Svelte apps
• phosphor-r ▲ Phosphor icon wrapper for R documents and applications
• blade-phosphor-icons ▲ Phosphor icons in your Laravel Blade views

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

License

MIT © Phosphor Icons