As well as runes, Svelte 5 introduces a handful of new things you can import, alongside existing ones like getContext
, setContext
and tick
.
sveltepermalink
mountpermalink
Instantiates a component and mounts it to the given target:
ts
import {mount } from 'svelte';importApp from './App.svelte';constapp =mount (App , {target :document .querySelector ('#app'),props : {some : 'property' }});
hydratepermalink
Like mount
, but will reuse up any HTML rendered by Svelte's SSR output (from the render
function) inside the target and make it interactive:
ts
import {hydrate } from 'svelte';importApp from './App.svelte';constapp =hydrate (App , {target :document .querySelector ('#app'),props : {some : 'property' }});
unmountpermalink
Unmounts a component created with mount
or hydrate
:
ts
import {mount ,unmount } from 'svelte';importApp from './App.svelte';constapp =mount (App , {...});// laterunmount (app );
untrackpermalink
To prevent something from being treated as an $effect
/$derived
dependency, use untrack
:
<script>
import { untrack } from 'svelte';
let { a, b } = $props();
$effect(() => {
// this will run when `a` changes,
// but not when `b` changes
console.log(a);
console.log(untrack(() => b));
});
</script>
svelte/reactivitypermalink
Svelte provides reactive Map
, Set
, Date
and URL
classes. These can be imported from svelte/reactivity
and used just like their native counterparts. Demo:
<script>
import { URL } from 'svelte/reactivity';
const url = new URL('https://example.com/path');
</script>
<!-- changes to these... -->
<input bind:value={url.protocol} />
<input bind:value={url.hostname} />
<input bind:value={url.pathname} />
<hr />
<!-- will update `href` and vice versa -->
<input bind:value={url.href} />
svelte/serverpermalink
renderpermalink
Only available on the server and when compiling with the server
option. Takes a component and returns an object with html
and head
properties on it, which you can use to populate the HTML when server-rendering your app:
ts
import {render } from 'svelte/server';importApp from './App.svelte';constresult =render (App , {props : {some : 'property' }});
svelte/elementspermalink
Svelte provides built-in DOM types. A common use case for DOM types is forwarding props to an HTML element. To properly type your props and get full intellisense, your props interface should extend the attributes type for your HTML element:
<script lang="ts">
import { HTMLAttributes } from 'svelte/elements';
interface Props extends HTMLAttributes<HTMLDivElement> {
username: string;
}
let { username, ...rest }: Props = $props();
</script>
<div {...rest}>
Hi, {username}!
</div>
You can use
ComponentProps<ImportedComponent>
, if you wish to forward props to forward props to a Svelte component.
Svelte provides a best-effort of all the HTML DOM types that exist. If an attribute is missing from our type definitions, you are welcome to open an issue and/or a PR fixing it. For experimental attributes, you can augment the existing types locally by creating a .d.ts
file:
ts
import {HTMLButtonAttributes } from 'svelte/elements';declare module 'svelte/elements' {export interfaceSvelteHTMLElements {'custom-button':HTMLButtonAttributes ;}// allows for more granular control over what element to add the typings toexport interfaceHTMLButtonAttributes {veryexperimentalattribute ?: string;}}export {}; // ensure this is not an ambient module, else types will be overridden instead of augmented
The .d.ts
file must be included in your tsconfig.json
file. If you are using the standard "include": ["src/**/*"]
, this just means the file should be placed in the src
directory.