Props - Svelte Awesome Icons v1

Props #

- size: string = ctx.size || '24';
- role: string = ctx.role || 'img';
- color: string = ctx.color || 'currentColor';
- withEvents = ctx.withEvents || false;
- ariaLabel: string = '0 solid';
- title: TitleType = {};
- desc: DescType = {};

Size #

To change the size of an icon, use the size prop and specify the desired size. For example:

<CalendarCheckRegular size="40" />

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

<CalendarCheckRegular class="h-24 w-24 text-blue-700 mr-4" />

CSS HEX Color #

Use the color attribute to change colors with HEX color code for Filled and Outlined components.

<CalendarCheckRegular color="#ff0000" size="md" />

CSS framework #

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

Tailwind CSS #

<CalendarCheckRegular size="md" class="text-red-700 dark:text-green-300 inline m-1" />

<div class="text-red-700 dark:text-green-300 inline m-1">
  <CalendarCheckRegular size="md" />
</div>

Bootstrap #

<CalendarCheckRegular 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.

<CalendarCheckRegular class="text-blue-700 dark:text-red-500" />

A11y #

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

<CalendarCheckRegular ariaLabel="address card outline" />

Use title, desc, and ariaLabel props to make your icons accessible.

<BellRegular
title={{ id: 'my-title', title: 'Red heart' }}
desc={{ id: 'my-descrip', desc: 'The shape of a red heart' }}
ariaLabel="red heart"
color="red"
/>

withEvents #

As default all icons are unfocusable. However you can add withEvents prop to make your icons focusable.

<CalendarCheckRegular withEvents on:click={handleClick}/>

It is possible to add tabindex="0", but it is not recommended for A11y. If you want to use it add withEvents prop as well.

<CalendarCheckRegular tabindex="0" withEvents />

Events #

Use withEvents prop to use the following events:

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

<CalendarCheckRegular withEvents on:click="{handleClick}" />

Passing down other attributes #

Since all icons have ...$$restProps, you can pass other attibutes as well.

<CalendarCheckRegular id="my-svg" transform="rotate(45)" />