svelte-core-bestpractices

Only use the $state rune for variables that should be reactive — in other words, variables that cause an $effect , $derived or template expression to update. Everything else can be a normal variable.

Safety Notice

This listing is imported from skills.sh public index metadata. Review upstream SKILL.md and repository scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "svelte-core-bestpractices" with this command: npx skills add sveltejs/ai-tools/sveltejs-ai-tools-svelte-core-bestpractices

$state

Only use the $state rune for variables that should be reactive — in other words, variables that cause an $effect , $derived or template expression to update. Everything else can be a normal variable.

Objects and arrays ($state({...}) or $state([...]) ) are made deeply reactive, meaning mutation will trigger updates. This has a trade-off: in exchange for fine-grained reactivity, the objects must be proxied, which has performance overhead. In cases where you're dealing with large objects that are only ever reassigned (rather than mutated), use $state.raw instead. This is often the case with API responses, for example.

$derived

To compute something from state, use $derived rather than $effect :

// do this let square = $derived(num * num);

// don't do this let square;

$effect(() => { square = num * num; });

[!NOTE] $derived is given an expression, not a function. If you need to use a function (because the expression is complex, for example) use $derived.by .

Deriveds are writable — you can assign to them, just like $state , except that they will re-evaluate when their expression changes.

If the derived expression is an object or array, it will be returned as-is — it is not made deeply reactive. You can, however, use $state inside $derived.by in the rare cases that you need this.

$effect

Effects are an escape hatch and should mostly be avoided. In particular, avoid updating state inside effects.

  • If you need to sync state to an external library such as D3, it is often neater to use {@attach ...}

  • If you need to run some code in response to user interaction, put the code directly in an event handler or use a function binding as appropriate

  • If you need to log values for debugging purposes, use $inspect

  • If you need to observe something external to Svelte, use createSubscriber

Never wrap the contents of an effect in if (browser) {...} or similar — effects do not run on the server.

$props

Treat props as though they will change. For example, values that depend on props should usually use $derived :

// @errors: 2451 let { type } = $props();

// do this let color = $derived(type === 'danger' ? 'red' : 'green');

// don't do this — color will not update if type changes let color = type === 'danger' ? 'red' : 'green';

$inspect.trace

$inspect.trace is a debugging tool for reactivity. If something is not updating properly or running more than it should you can add $inspect.trace(label) as the first line of an $effect or $derived.by (or any function they call) to trace their dependencies and discover which one triggered an update.

Events

Any element attribute starting with on is treated as an event listener:

<button onclick={() => {...}}>click me</button>

<!-- attribute shorthand also works --> <button {onclick}>...</button>

<!-- so do spread attributes --> <button {...props}>...</button>

If you need to attach listeners to window or document you can use <svelte:window> and <svelte:document> :

<svelte:window onkeydown={...} /> <svelte:document onvisibilitychange={...} />

Avoid using onMount or $effect for this.

Snippets

Snippets are a way to define reusable chunks of markup that can be instantiated with the {@render ...} tag, or passed to components as props. They must be declared within the template.

{#snippet greeting(name)} <p>hello {name}!</p> {/snippet}

{@render greeting('world')}

[!NOTE] Snippets declared at the top level of a component (i.e. not inside elements or blocks) can be referenced inside <script> . A snippet that doesn't reference component state is also available in a <script module> , in which case it can be exported for use by other components.

Each blocks

Prefer to use keyed each blocks — this improves performance by allowing Svelte to surgically insert or remove items rather than updating the DOM belonging to existing items.

[!NOTE] The key must uniquely identify the object. Do not use the index as a key.

Avoid destructuring if you need to mutate the item (with something like bind:value={item.count} , for example).

Using JavaScript variables in CSS

If you have a JS variable that you want to use inside CSS you can set a CSS custom property with the style: directive.

<div style:--columns={columns}>...</div>

You can then reference var(--columns) inside the component's <style> .

Styling child components

The CSS in a component's <style> is scoped to that component. If a parent component needs to control the child's styles, the preferred way is to use CSS custom properties:

<!-- Parent.svelte --> <Child --color="red" />

<!-- Child.svelte --> <h1>Hello</h1>

<style> h1 { color: var(--color); } </style>

If this is impossible (for example, the child component comes from a library) you can use :global to override styles:

<div> <Child /> </div>

<style> div :global { h1 { color: red; } } </style>

Context

Consider using context instead of declaring state in a shared module. This will scope the state to the part of the app that needs it, and eliminate the possibility of it leaking between users when server-side rendering.

Use createContext rather than setContext and getContext , as it provides type safety.

Async Svelte

If using version 5.36 or higher, you can use await expressions and hydratable to use promises directly inside components. Note that these require the experimental.async option to be enabled in svelte.config.js as they are not yet considered fully stable.

Avoid legacy features

Always use runes mode for new code, and avoid features that have more modern replacements:

  • use $state instead of implicit reactivity (e.g. let count = 0; count += 1 )

  • use $derived and $effect instead of $: assignments and statements (but only use effects when there is no better solution)

  • use $props instead of export let , $$props and $$restProps

  • use onclick={...} instead of on:click={...}

  • use {#snippet ...} and {@render ...} instead of <slot> and $$slots and <svelte:fragment>

  • use <DynamicComponent> instead of <svelte:component this={DynamicComponent}>

  • use import Self from './ThisComponent.svelte' and <Self> instead of <svelte:self>

  • use classes with $state fields to share reactivity between components, instead of using stores

  • use {@attach ...} instead of use:action

  • use clsx-style arrays and objects in class attributes, instead of the class: directive

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Related Skills

Related by shared tags or category signals.

Coding

svelte-code-writer

No summary provided by upstream source.

Repository SourceNeeds Review
General

Interior Fullplan

# 室内设计·全案方案自动生成器

Archived SourceRecently Updated
General

kb-archiver

智能本地知识库归档系统 v1.1.0。支持 AI 智能分类、批量归档、全文搜索、统计报告。 自动将文件分类归档到本地知识库,提取全文索引支持秒级搜索。 小文件存本地、大文件可对接云存储。支持 Excel/Word/PPT/PDF/TXT 等格式。 当用户需要:归档文件、建立知识库、全文检索文档内容、管理大量工作文档、批量处理文件夹时使用。 关键词:知识库、归档、文件管理、全文搜索、文档索引、批量归档、AI分类

Archived SourceRecently Updated
General

honest-agent

强制诚实系统:防止AI撒谎、虚构、言行不一。核心功能:(1) 承诺自动追踪(写入honest-commitments.json)(2) 回复前诚实校验拦截 (3) 媒体并行识别(大模型+OCR择优)(4) 诚实审计日志 (5) 安全独立存储。触发词:诚实、撒谎、虚构、承诺、图片识别、媒体处理、我承诺、我会帮你。

Archived SourceRecently Updated