A modern, tree-shakeable React library for Feather icons with native TypeScript support, Tailwind-compatible size presets, ref forwarding, and full compatibility with React 18, React 19, and Next.js (App Router / React Server Components).
- ⚡ React 18 & 19 Ready: Fully compatible with React 18 and React 19.
- 🎯 TypeScript First: Comprehensive typings with IDE autocomplete for Tailwind size presets.
- 🪶 Tree-Shakeable: Bundled with
"sideEffects": falsein ESM and CommonJS — bundle only the icons you use. - 🔗 Ref Forwarding: All icons forward their
refto the underlyingSVGSVGElement. - 🌐 Next.js & SSR Ready: Preconfigured with
'use client'directive for seamless use in Next.js App Router and client components. - 🎨 Tailwind Size Presets: Use familiar Tailwind sizes (
xs,sm,base,lg,xl,2xl, etc.) or custom numbers/strings.
npm install react-fi
# or
yarn add react-fi
# or
pnpm add react-fiimport React from "react";
import { FiActivity, FiArrowRight } from "react-fi";
export default function App() {
return (
<div>
<FiActivity />
<FiArrowRight color="#3b82f6" size="lg" />
</div>
);
}All SVG attributes (including ref, role, aria-*, className, and style) are forwarded to the underlying <svg> element:
import React, { useRef } from "react";
import { FiCheck } from "react-fi";
export default function StatusBadge() {
const svgRef = useRef<SVGSVGElement>(null);
return (
<FiCheck
ref={svgRef}
role="img"
aria-label="Operation completed successfully"
className="text-green-500 hover:scale-110 transition-transform"
strokeWidth={2.5}
/>
);
}Each SVG attribute is customizable:
| Prop Name | Type | Default Value | Description |
|---|---|---|---|
size |
IconSize (number | string) |
24 |
Size in pixels or Tailwind preset ('xs', 'sm', 'lg', etc.) |
color |
string |
'currentColor' |
SVG stroke color |
strokeWidth |
number | string |
2 |
Stroke width |
fill |
string |
'none' |
SVG fill color |
strokeLinecap |
string |
'round' |
Stroke line cap |
strokeLinejoin |
string |
'round' |
Stroke line join |
Predefined Tailwind CSS font-size presets map directly to standard pixel values:
| Preset | Pixel Size |
|---|---|
'xs' |
12px |
'sm' |
14px |
'base' |
16px |
'lg' |
18px |
'xl' |
20px |
'2xl' |
24px |
'3xl' |
30px |
'4xl' |
36px |
'5xl' |
48px |
'6xl' |
60px |
'7xl' |
72px |
'8xl' |
96px |
'9xl' |
128px |
<FiActivity size="lg" /> // Same as size={18}
<FiActivity size="2xl" /> // Same as size={24}
<FiActivity size={48} /> // Custom number
<FiActivity size="2.5rem" /> // Custom stringThe formatSize utility function is exported for use in custom icon wrappers:
import { formatSize } from "react-fi";
const size = formatSize("lg"); // 18For bug reports or feature requests, please open an issue on GitHub Issues. Contributions are welcome!