@thesvg/svelte
v2.0.1
Published
Typed Svelte SVG components for all 4000+ brand icons from thesvg.org
Maintainers
Readme
@thesvg/svelte
Typed Svelte SVG components for all 4000+ brand icons from thesvg.org.
- Zero runtime dependencies (Svelte is a peer dep)
- TypeScript support with full
SVGAttributestypes - Tree-shakeable ESM - import only what you use
- Individual icon imports for maximum bundle efficiency
- Works with Svelte 4 and Svelte 5
Installation
npm install @thesvg/svelte
# or
pnpm add @thesvg/svelte
# or
yarn add @thesvg/svelteSvelte 4 or later is required as a peer dependency.
Usage
Named import from barrel (convenient, relies on tree-shaking)
<script>
import { Github, VisualStudioCode, Figma } from "@thesvg/svelte";
</script>
<div>
<Github width="24" height="24" />
<VisualStudioCode width="24" height="24" class="text-blue-500" />
<Figma width="32" height="32" aria-label="Figma" />
</div>Individual icon import (best for bundle size)
<script>
import Github from "@thesvg/svelte/github";
import VisualStudioCode from "@thesvg/svelte/visual-studio-code";
</script>
<Github width="24" height="24" />Each icon is a separate module so bundlers that do not support tree-shaking will still include only the icons you import.
Props
Every component accepts all standard SVG attributes via $$restProps (Svelte 4) or spread props (Svelte 5):
| Prop | Type | Default | Description |
| ------------ | ------------------ | ----------------- | ------------------------------ |
| width | number \| string | (SVG default) | Icon width |
| height | number \| string | (SVG default) | Icon height |
| class | string | - | CSS class name |
| style | string | - | Inline styles (prefer class) |
| fill | string | "none" | SVG fill color |
| viewBox | string | from original SVG | Override the viewBox |
| aria-label | string | - | Accessible label |
| ... | ... | - | Any other SVG attribute |
Sizing example
<!-- Fixed size -->
<Github width="24" height="24" />
<!-- Responsive via CSS -->
<Github class="w-6 h-6" />
<!-- Scale with font-size (em units) -->
<Github width="1em" height="1em" />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.
Tree-shaking
When using SvelteKit or Vite, named imports from the barrel (@thesvg/svelte)
are tree-shaken automatically - only the icons you import are included in the
final bundle.
For maximum control, use individual icon imports:
<script>
import Github from "@thesvg/svelte/github";
</script>Available icons
Over 4000 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.
