Getting Started - Svelte Heros v1
Requirements #
You need to use the following:
- Svelte 4 or 5 (without Runes)
Installation #
Install Svelte and Svelte Heros:
npm create svelte@latest my-project
cd my-project
pnpm i -D svelte-heros
Basic Usage #
In a svelte file:
<script>
import { AcademicCap } from 'svelte-heros';
</script>
<AcademicCap />
aria-label #
Use ariaLabel
props to edit the aria-label
.
<AcademicCap
ariaLabel="blue admin user svg icon with face"
color="blue"
/>
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, etc.
Faster compiling #
If you need only a few icons from this library in your Svelte app, import them directly. This can optimize compilation speed and improve performance by reducing the amount of code processed during compilation.
<script>
import AcademicCap from 'svelte-heros/AcademicCap.svelte';
</script>
<AcademicCap />
Passing down other attributes #
Since all icons have ...$$restProps
, you can pass other attibutes as well.
<AcademicCap id="my-svg" transform="rotate(45)" />
Using svelte:component #
<script>
import { AcademicCap } from 'svelte-heros';
</script>
<svelte:component this="{AcademicCap}" />
Using onMount #
<script>
import { AcademicCap } from 'svelte-heros';
import { onMount } from 'svelte';
const props = {
size: '50',
color: '#ff0000'
};
onMount(() => {
const icon = new AcademicCap({ target: document.body, props });
});
</script>
Import all #
Use `import * as Icon from 'svelte-heros`.
<script>
import * as Icon from 'svelte-heros';
</script>
<Icon.AcademicCap />
<Icon.AcademicCap size="30" />