Getting Started - Svelte Flags v1
Requirements #
You need to use the following:
- Svelte 4 or 5
Installation #
Install Svelte and Svelte Flags:
npm create svelte@latest myapp
cd myapp
pnpm i -D svelte-flags@v1-latest
Basic Usage #
In a svelte file:
<script>
import { Us } from 'svelte-flags';
</script>
<Us />
aria-label #
Use ariaLabel
props to edit the aria-label
value.
<Us ariaLabel="The USA flag" />
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}" />
Using onMount #
<script>
import { Us } from 'svelte-flags';
import { onMount } from 'svelte';
const props = {
size: '50',
};
onMount(() => {
const icon = new Us({ target: document.body, props });
});
</script>
Import all #
Use `import * as Icon from 'svelte-flags`.
<script>
import * as Icon from 'svelte-flags';
</script>
<Icon.Us />
<h1>Size</h1>
<Icon.Us size="30" />