Props - Svelte Heros v2

Props #

- size = ctx.size || '24'
- role = ctx.role || 'img'
- color = ctx.color || 'currentColor'
- variation = ctx.variation || "outline
- strokeWidth = ctx.strokeWidth || '1.5
- title
- desc
- ariaLabel = "arrow circle down"
- ...restProps

Types #

All icons are extended SVGAttributes from svelte/elements.

import type { SVGAttributes } from 'svelte/elements';
export type TitleType = {
  id?: string;
  title?: string;
};
export type DescType = {
  id?: string;
  desc?: string;
};
export interface BaseProps extends SVGAttributes<SVGElement>{
  size?: string;
  role?: string;
  color?: string;
  variation?: "solid" | "outline";
  strokeWidth?: string;
}

export interface CtxType extends BaseProps {}

export interface Props extends BaseProps{
  title?: TitleType;
  desc?: DescType;
  ariaLabel?: string;
}

Size #

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

<AcademicCap size="40" />

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

<AcademicCap class="h-24 w-24" />

Colors #

Use the color props to change colors with HEX color code or HTML color names:

<AcademicCap color="#ff0000" />
<AcademicCap color="green" />

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 #

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

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

Bootstrap #

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

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

<AcademicCap ariaLabel="address card outline" />

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

<AcademicCap
  title={{ id: 'my-title', title: 'A green AcademicCap' }}
  desc={{ id: 'my-descrip', desc: 'The shape of a green AcademicCap icon' }}
  ariaLabel="green AcademicCap"
  color="green"
/>

Passing down other attributes #

Since all icons have ...restProps, you can pass other SVGAttributes.

<AcademicCap 
  id="my-svg" 
  transform="rotate(45)" 
  class="hover:cursor-pointer dark:text-white"
  onclick={() => alert('hello')}
/>