svelte-heros-v2

Svelte Heros v2

If you are looking for the version 1, go to Svelte-Heros

Hero Icons v2 uses Heroicon v2 to create Svelte SVG icons. You can select outline and solid icons using the variation props. Svlete-Heros support major CSS framework. You can add additional CSS using the class props.

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

tailwindlabs/heroicons

License

Svelte-Heros-V2 License

tailwindlabs/heroicons LICENSE

Installation

pnpm i -D svelte-heros-v2

Usage

<script>
  import { IconOutline, IconSolid, IconMini } from 'svelte-heros-v2';
</script>

<IconOutline name="academic-cap-outline" />
<IconSolid name="academic-cap-solid" />
<IconMini name="academic-cap-mini" />

Props

IconOutline IconSolid

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

IconMini

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

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.

<IconOutline name="academic-cap-outline" 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:

<IconOutline name="academic-cap-outline" class="shrink-0 h-20 w-20" />

CSS HEX Colors

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

<IconOutline name="academic-cap-outline" 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:

<IconOutline name="academic-cap-outline" class="text-red-700 inline m-1" />

Bootstrap examples:

<IconOutline name="academic-cap-outline" 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.

<IconOutline name="academic-cap-outline"  class="text-blue-700 dark:text-red-500" />

aria-label

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

<IconOutline name="academic-cap-outline" ariaLabel="red academic cap outline" color="#c61515"/>

Unfocusable icon

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

<IconOutline name="academic-cap-outline"  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.

<IconOutline name="academic-cap-outline"  tabindex="0" />

Using svelte:component

<svelte:component this="{IconOutline}" name="academic-cap-outline" />

Using onMount

<script>
  import { IconOutline } from 'svelte-heros-v2';
  import { onMount } from 'svelte';
  const props = {
    name: 'academic-cap-outline',
    size: '50',
    color: '#ff0000'
  };
  onMount(() => {
    const icon = new Icon({ target: document.body, props });
  });
</script>

Import all

Use import { IconOutline, icons } from 'svelte-heros-v2';.

<script>
  import { IconOutline, icons } from 'svelte-heros-v2';
  function filterIconsByKeyword(icons, keyword) {
    const filteredIcons = {};
    for (const key in icons) {
      if (key.includes(keyword)) {
        filteredIcons[key] = icons[key];
      }
    }
    return filteredIcons;
  }
  const outlineIcons = filterIconsByKeyword(icons, '-outline');
</script>

{#each Object.keys(outlineIcons) as name}
<div class="flex gap-4 items-center text-lg">
  <IconOutline name={name} class="shrink-0"/>
  {name}
</div>
{/each}

Other icons

Svelte-Icon-Sets