svelte-lucide

Svelte Lucide

590+ Lucide-icons for Svelte.

Thank you for considering my open-source package. If you use it in a commercial project, please support me by sponsoring me on GitHub: https://github.com/sponsors/shinokada. Your support helps me maintain and improve this package for the benefit of the community.

Repo

GitHub Repo

Original source

lucide-icons/lucide

License

Svelte-Lucide License

lucide-icons/lucide LICENSE

Installation

pnpm i -D svelte-lucide

Usage

In a svelte file:

<script>
  import { Icon } from 'svlete-lucide';
</script>

<Icon name="accessibility" />

Props

• @prop name;
• @prop width = "24";
• @prop height = "24";
• @prop role = 'img';
• @prop color = 'currentColor'
• @prop ariaLabel='icon name'
• @prop strokeWidth = "2";

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, and an example.

Size

Use the width and height props to change the size of icons.

<Icon name="accessibility" width="100" height="100" />

If you are using Tailwind CSS, you can add a custom size using Tailwind CSS by including the desired classes in the class prop. For example:

<Icon name="accessibility" class="shrink-0 h-20 w-20" />

CSS HEX Colors

Use the color prop to change colors with HEX color code.

<Icon name="accessibility" color="#c61515" />

CSS frameworks suport

You can apply CSS framework color and other attributes directly to the icon component or its parent tag using the class prop.

Tailwind CSS example:

<Icon name="accessibility" class="text-red-700 inline m-1" />

Bootstrap examples:

<Icon name="accessibility" class="position-absolute top-0 px-1" />

Dark mode

If you are using the dark mode on your website with Tailwind CSS, add your dark mode class to the class prop.

Let's use dark for the dark mode class as an example.

<Icon name="accessibility"  class="text-blue-700 dark:text-red-500" />

aria-label

All icons have aria-label. For example accessibility has aria-label="accessibility". Use ariaLabel prop to modify the aria-label value.

<Icon name="accessibility" ariaLabel="red accessibility" color="#c61515"/>

Unfocusable icon

If you want to make an icon unfocusable, add tabindex="-1".

<Icon name="accessibility"  tabindex="-1" />

Events

All icons have the following events:

• on:click
• on:keydown
• on:keyup
• on:focus
• on:blur
• on:mouseenter
• on:mouseleave
• on:mouseover
• on:mouseout

Passing down other attributes

You can pass other attibutes as well.

<Icon name="accessibility"  tabindex="0" />

Using svelte:component

<svelte:component this="{Icon}" name="accessibility" />

Using onMount

<script>
  import {Icon} from 'svelte-evil-icons';
  import { onMount } from 'svelte';
  const props = {
    name: 'accessibility',
    size: '50',
    color: '#ff0000'
  };
  onMount(() => {
    const icon = new Icon({ target: document.body, props });
  });
</script>

Import all

Use import {Icon, icons} from 'svelte-evil-icons';.

<script>
  import {Icon, icons} from 'svelte-evil-icons';
</script>

{#each Object.keys(icons) as name}
<div class="flex gap-4 items-center text-lg">
  <Icon name={name} bind:width={size} bind:height={size} class="shrink-0"/>
  {name}
</div>
{/each}

Other icons

Svelte-Icon-Sets