Skip to content

metonym/svelte-iconoir

Repository files navigation

svelte-iconoir

NPM

Iconoir SVG icons as Svelte components.

Try it in the Svelte REPL.


Installation

# Yarn
yarn add -D svelte-iconoir

# npm
npm i -D svelte-iconoir

# pnpm
pnpm i -D svelte-iconoir

Usage

Basic

<script>
  import { Activity, BubbleStar, Camera } from "svelte-iconoir";
</script>

<Activity />
<BubbleStar />
<Camera />

Refer to ICON_INDEX.md for a list of supported icons.

Direct import

Use the direct import for faster compiling during development.

Note: even if using base imports, unused imports are still tree shakeable by application bundlers like Rollup or webpack.

<script>
  import AddPage from "svelte-iconoir/lib/AddPage.svelte";
</script>

Using svelte:component

<script>
  import * as icons from "svelte-iconoir";
</script>

{#each Object.entries(icons) as [icon, component]}
  <div>
    <svelte:component this={component} />
    {icon}
  </div>
{/each}

TypeScript

Svelte version 3.31 or greater is required to use this library with TypeScript.

License

MIT