2.0.2 • Published 2 years ago

@edde746/svelte-heros v2.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

Svelte-heros

Hero Icons for Svelte. You can import outline and solid icons without name conflict.

You can use this icons with Tailwind CSS.

List of icons

Icon names

See all the icons at https://heroicons.com/.

Installation

npm i svelte-heros@latest

Import

Solid icons end with xxxxxSolid and outline icons end with xxxxxOutline.

For example:

<script>
  import { AcademicCapSolid, AcademicCapOutline } from "svelte-heros";
</script>

Props

NameDefault
size24
colorcurrentColor
class

You can add class to change colors.

Size

Use the size prop to change the size of icons.

<AcademicCapOutline size="30" />
<AcademicCapOutline size="35" />
<AcademicCapOutline size="42" />

CSS HEX Colors

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

<AcademicCapOutline color="#ff0000" />
<AcademicCapOutline color="#00ffd8" />

Tailwind CSS support

Use the class prop to change colors and add additional css.

<AcademicCapSolid class="text-pink-700 mr-4" />

Dark mode with Tailwind CSS

If you use 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.

<AcademicCapSolid class="text-pink-700 dark:text-blue-300" />

Import all

Use import * as Icon from 'svelte-heros.

Examples

REPL

<script>
  import { AcademicCapSolid, AcademicCapOutline } from "svelte-heros";
</script>

<AcademicCapSolid />

<AcademicCapOutline size="36" class="text-blue-500" />

<AcademicCapSolid size="40" class=" text-green-500" />

<AcademicCapOutline size="48" class="text-red-900" />

REPL example