Browse docs

Frameworks

React

Use Softstroke icons as React components.

npm i @softstroke/react

Works with React 17 and newer, including Next.js (server and client components), Vite and Remix.

Usage

import { BellIcon, HomeIcon } from "@softstroke/react";

<HomeIcon />
<BellIcon size={20} color="#2563eb" strokeWidth={2} />

Solid icons

Every icon has a solid twin under the same name in @softstroke/react/solid. Rename one on import when you need both:

import { HomeIcon } from "@softstroke/react";
import { HomeIcon as HomeSolidIcon } from "@softstroke/react/solid";

{active ? <HomeSolidIcon /> : <HomeIcon />}

Props

Prop Default Notes
size 24 Width and height, a number (px) or any CSS length
color currentColor Stroke color, or fill color for solid icons
strokeWidth 1.5 Stroke icons only

Any other SVG prop (className, style, onClick, aria-label) is passed to the <svg>. Components forward refs.

Single-icon imports

The package is tree-shakable, so named imports from the root only ship what you use. If your bundler can't tree-shake, import one file:

import HomeIcon from "@softstroke/react/icons/home";

Request an icon

Tell us what you need. Every icon is drawn from scratch in the Softstroke style; brand logos are not added.

Posted publicly on GitHub