Getting Started - Svelte Lucide v1
Requirements #
You need to use the following:
- Svelte 4 or 5 (without Runes)
Installation #
Install Svelte and Svelte Lucide:
npm create svelte@latest my-project
cd my-project
pnpm i -D svelte-lucide
Basic Usage #
In a svelte file:
<script>
import { Album } from 'svelte-lucide';
</script>
<Album />
IDE support #
If you are using an LSP-compatible editor, such as VSCode, Atom, Sublime Text, or Neovim, hovering over a component name will display a documentation link, features, props, events, etc.
Faster compiling #
If you need only a few icons from this library in your Svelte app, import them directly. This can optimize compilation speed and improve performance by reducing the amount of code processed during compilation.
<script>
import Album from 'svelte-lucide/Album.svelte';
</script>
<Album />
Passing down other attributes #
Since all icons have "...$$restProps", you can pass other attibutes as well.
<Album id="my-svg" transform="rotate(45)" />
Using svelte:component #
<script>
import { Album } from 'svelte-lucide';
</script>
<svelte:component this="{Album}" />
Using onMount #
<script>
import { Album } from 'svelte-lucide';
import { onMount } from 'svelte';
const props = {
size: '50',
color: '#ff0000'
};
onMount(() => {
const icon = new Album({ target: document.body, props });
});
</script>
Import all #
Use `import * as Icon from 'svelte-lucide`.
<script>
import * as Icon from 'svelte-lucide';
</script>
<Icon.Album />
<h1>Size</h1>
<Icon.Album size="30" />