Getting Started - Svelte Flags v2

Requirements #

- Svelte 5 Runes

Installation #

Install Svelte:

npm create svelte@latest my-project
cd my-project
pnpm i

Install svelte-ionicons v2:

pnpm i -D svelte-flags@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 { Us } from 'svelte-flags';
</script>

<Us />

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 Us from 'svelte-flags/Us.svelte';
</script>

<Us />

Passing down other attributes #

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

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

Using svelte:component #

<script>
  import { Us } from 'svelte-flags';
</script>

<svelte:component this="{Us}" />

Import all #

Use `import * as Icon from 'svelte-flags`.

<script>
  import * as Icon from 'svelte-flags';
</script>

<Icon.Us />
<Icon.Us size="30" />