@thesvg/react
v2.0.1
Published
Typed React SVG components for all 3,800+ brand icons from thesvg.org
Maintainers
Readme
@thesvg/react
Typed React SVG components for all 3,800+ brand icons from thesvg.org.
- Zero runtime dependencies (React is a peer dep)
- TypeScript strict mode with full
SVGProps<SVGSVGElement>support forwardRefon every component for imperative access- Tree-shakeable ESM, import only what you use
- Individual icon imports for maximum bundle efficiency
- Compatible with Next.js 16, Turbopack, and React 19
- Works as Server Components (no
"use client"needed)
Installation
npm install @thesvg/reactpnpm add @thesvg/reactyarn add @thesvg/reactbun add @thesvg/reactReact 18 or later is required as a peer dependency.
Usage
Named import from barrel (convenient, relies on tree-shaking)
import { Github, VisualStudioCode, Figma } from '@thesvg/react';
export function MyComponent() {
return (
<div>
<Github width={24} height={24} />
<VisualStudioCode width={24} height={24} className="text-blue-500" />
<Figma width={32} height={32} aria-label="Figma" />
</div>
);
}Individual icon import (best for bundle size)
import Github from '@thesvg/react/github';
import VisualStudioCode from '@thesvg/react/visual-studio-code';Each icon is a separate module so bundlers that do not support tree-shaking (e.g. CommonJS environments) will still include only the icons you import.
With Next.js App Router
Icons work as Server Components by default. No "use client" directive needed:
// app/page.tsx (Server Component)
import { Github, Figma } from '@thesvg/react';
export default function Page() {
return (
<div className="flex gap-4">
<Github className="w-6 h-6" />
<Figma className="w-6 h-6" />
</div>
);
}With Tailwind CSS
<Github className="w-8 h-8 text-gray-700 dark:text-gray-300 hover:text-black transition-colors" />TypeScript
Every component accepts SVGProps<SVGSVGElement>. You can import the shared type:
import type { SvgIconProps } from '@thesvg/react';
function IconButton({ icon: Icon, ...props }: { icon: React.ComponentType<SvgIconProps> }) {
return <Icon width={20} height={20} {...props} />;
}Props
Every component accepts all standard SVG props via SVGProps<SVGSVGElement>:
| Prop | Type | Default | Description |
|-------------|----------|------------------------|-------------------------------------|
| width | number \| string | (SVG default) | Icon width |
| height | number \| string | (SVG default) | Icon height |
| className | string | - | CSS class name |
| style | CSSProperties | - | Inline styles (prefer className) |
| fill | string | "none" | SVG fill color |
| viewBox | string | from original SVG | Override the viewBox |
| ref | Ref<SVGSVGElement> | - | Forwarded ref |
| aria-label| string | - | Accessible label |
| ... | ... | - | Any other SVGProps<SVGSVGElement> |
Sizing example
// Fixed size
<Github width={24} height={24} />
// Responsive via CSS
<Github className="w-6 h-6" />
// Scale with font-size (em units)
<Github width="1em" height="1em" />Forwarded refs
import { useRef } from 'react';
import Github from '@thesvg/react/github';
function MyComponent() {
const svgRef = useRef<SVGSVGElement>(null);
return <Github ref={svgRef} width={24} height={24} />;
}Accessibility
// Meaningful icon - label it
<Github aria-label="GitHub" role="img" width={24} height={24} />
// Decorative icon - hide from screen readers
<Github aria-hidden="true" width={24} height={24} />Component names
Slugs are converted to PascalCase component names:
| Slug | Component name |
|-----------------------|------------------------|
| github | Github |
| visual-studio-code | VisualStudioCode |
| figma | Figma |
| 01dotai | I01Dotai |
| dotnet | Dotnet |
Slugs that start with a digit are prefixed with I to produce a valid
JavaScript identifier.
Performance
- Tree-shaking: Named imports from the barrel (
@thesvg/react) are tree-shaken by Webpack 5, Rollup, Vite, esbuild, and Turbopack - Individual imports:
@thesvg/react/githubalways includes only the single icon regardless of bundler - No runtime deps: Only
reactas a peer dependency - Server Components: Works without
"use client", keeping icons out of the client bundle in Next.js
Compatibility
| Environment | Version | Status | |-------------|---------|--------| | React | 18, 19 | Supported | | Next.js | 13-16 | Supported | | Turbopack | Latest | Supported | | Vite | 5+ | Supported | | Node.js | 18+ | Supported | | Bun | 1+ | Supported |
Migration from < 1.0
v1.0.0 fixes the ESM output to emit valid JavaScript (previously .js files contained TypeScript syntax that some bundlers could not parse).
Breaking changes:
SvgIconPropsis no longer re-exported from the runtime barrel (index.js). Import it as a type:import type { SvgIconProps } from '@thesvg/react'(the.d.tsbarrel still exports it, so TypeScript consumers are unaffected).- SVG
styleattributes are now converted to React style objects. If you were working around string styles, you can remove those workarounds.
Available icons
Over 3,800 brand icons are available. Browse the full list at thesvg.org.
License
MIT - see LICENSE.
Brand icons and logos are the property of their respective trademark holders. See thesvg.org for details.
