Lucide Svelte ​

Implementation of the lucide icon library for svelte applications.

Installation ​

pnpm install lucide-svelte

yarn add lucide-svelte

npm install lucide-svelte

How to use ​

It's build with ES Modules so it's completely tree-shakable.

Each icon can be imported as a Svelte component, what renders a inline SVG Element. This way only the icons that are imported into your project are included in the final bundle. The rest of the icons are tree-shaken away.

Example ​

Default usage:

<script>
  import { Skull } from 'lucide-svelte';
</script>

<Skull />

Additional props can be passed to adjust the icon:

<script>
  import { Camera } from 'lucide-svelte';
</script>

<Camera color="#ff3e98" />

Props ​

Applying props ​

To apply custom props to change the look of the icon, this can be done by simply pass them as props to the component. All SVG attributes are available as props to style the SVGs. See the list of SVG Presentation Attributes on MDN.

<script>
  import { Phone } from 'lucide-svelte';
</script>

<Phone fill="#333" />

This results a filled phone icon.

One generic icon component ​

It is possible to create one generic icon component to load icons. It's not recommended.

Icon Component Example ​

<script>
  import * as icons from 'lucide-svelte';
  export let name;
</script>

<svelte:component this="{icons[name]}" {...$$props} />

Using the Icon Component ​

<script>
  import LucideIcon from './LucideIcon';
</script>

<LucideIcon name="Menu" />