Getting Started - Svelte Heros v2 v2
Requirements #
- Svelte 5: Runes
Installation #
Install Svelte 5: Runes
npm create svelte@latest my-project
cd my-project
pnpm i
Install svelte-heros-v2: v2
:
pnpm i -D svelte-heros-v2@next
Enable Runes in svelte.config.js:
import adapter from '@sveltejs/adapter-auto';
import { vitePreprocess } from '@sveltejs/vite-plugin-svelte';
/** @type {import('@sveltejs/kit').Config} */
const config = {
preprocess: [vitePreprocess({})],
compilerOptions: {
runes: true
},
kit: {
adapter: adapter()
}
};
export default config;
Basic Usage #
In a svelte file:
<script>
import { AcademicCap } from 'svelte-heros-v2';
</script>
<AcademicCap />
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.
Asscessible SVGs #
A11y props, title
, desc
, and ariaLabel
are used for accessible
SVG icons.
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-v2/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-v2';
</script>
<svelte:component this="{AcademicCap}" />
Import all #
Use `import * as Icon from 'svelte-heros-v2`.
<script>
import * as Icon from 'svelte-heros-v2';
</script>
<Icon.AcademicCap />
<h1>Size</h1>
<Icon.AcademicCap size="30" />