TanStack Query Svelte Docs

While Svelte v5 has legacy compatibility with the stores syntax from Svelte v3/v4, it has been somewhat buggy and unreliable for this adapter. The @tanstack/svelte-query v6 adapter fully migrates to the runes syntax, which relies on signals. This rewrite should also simplify the code required to ensure your query inputs remain reactive.

Installation

Please ensure your project has Svelte v5.25.0 or newer.

Run pnpm add @tanstack/svelte-query@latest (or your package manager's equivalent).

Note that @tanstack/svelte-query v6 depends on @tanstack/query-core v5.

Function Inputs

Like the Angular and Solid adapters, most functions for the Svelte adapter now require options to be provided as a "thunk" (() => options) to provide reactivity. TypeScript will be your friend here and warn you if you're missing this notation.

- const query = createQuery({  // [!code --]
+ const query = createQuery(() => ({ // [!code ++]
    queryKey: ['todos'],
    queryFn: () => fetchTodos(),
- }) // [!code --]
+ })) // [!code ++]

- const query = createQuery({  // [!code --]
+ const query = createQuery(() => ({ // [!code ++]
    queryKey: ['todos'],
    queryFn: () => fetchTodos(),
- }) // [!code --]
+ })) // [!code ++]

Accessing Properties

Given the adapter no longer uses stores, it is no longer necessary to prefix with $.

- {#if $todos.isSuccess} // [!code --]
+ {#if todos.isSuccess} // [!code ++]
    <ul>
-     {#each $todos.data.items as item} // [!code --]
+     {#each todos.data.items as item} // [!code ++]
        <li>{item}</li>
      {/each}
    </ul>
  {/if}

- {#if $todos.isSuccess} // [!code --]
+ {#if todos.isSuccess} // [!code ++]
    <ul>
-     {#each $todos.data.items as item} // [!code --]
+     {#each todos.data.items as item} // [!code ++]
        <li>{item}</li>
      {/each}
    </ul>
  {/if}

Reactivity

You previously needed to do some funky things with stores to achieve reactivity for inputs. This is no longer the case! You don't even need to wrap your query in a $derived.

- const intervalMs = writable(1000) // [!code --]
+ let intervalMs = $state(1000) // [!code ++]

- const query = createQuery(derived(intervalMs, ($intervalMs) => ({ // [!code --]
+ const query = createQuery(() => ({ // [!code ++]
    queryKey: ['refetch'],
    queryFn: async () => await fetch('/api/data').then((r) => r.json()),
    refetchInterval: $intervalMs,
- }))) // [!code --]
+ })) // [!code ++]

- const intervalMs = writable(1000) // [!code --]
+ let intervalMs = $state(1000) // [!code ++]

- const query = createQuery(derived(intervalMs, ($intervalMs) => ({ // [!code --]
+ const query = createQuery(() => ({ // [!code ++]
    queryKey: ['refetch'],
    queryFn: async () => await fetch('/api/data').then((r) => r.json()),
    refetchInterval: $intervalMs,
- }))) // [!code --]
+ })) // [!code ++]

  compilerOptions: {
    runes: true,
  },

  compilerOptions: {
    runes: true,
  },

This can be added once you've 100% eradicated stores syntax from your app.

Installation

Function Inputs

Accessing Properties

Reactivity

Disabling Legacy Mode

On a per-file basis

On an project-wide basis

Want to Skip the Docs?

Want to Skip the Docs?