---
title: "SvelteKit"
url: "https://spinetab.com/docs/setup/sveltekit/"
description: "Add Spinetab to SvelteKit and render a shared live feed with a Svelte store."
---

# SvelteKit

This guide adds a shared live feed to an existing SvelteKit app using Svelte 5. It keeps server rendering enabled and uses Spinetab’s Svelte store binding.

The examples display a queue value such as `{ "open": 12 }`. Choose the source that matches your backend in step 3. Use an existing endpoint or replace the URL and type with your API. Spinetab does not create the endpoint.

## 1\. Add the Vite plugin

```sh
pnpm add spinetab
```

Keep the SvelteKit plugin and add `spinetab()` alongside it:

**File: `vite.config.ts`**

```ts
import { sveltekit } from "@sveltejs/kit/vite";
import { spinetab } from "spinetab/vite";
import { defineConfig } from "vite";

export default defineConfig({
  plugins: [sveltekit(), spinetab()],
});
```

The plugin generates the worker from the adapters your app imports. Restart the dev server after changing the config; keep your existing SvelteKit deployment adapter in `svelte.config.js`.

## 2\. Create the client

**File: `src/lib/live.ts`**

```ts
import { createSpinetab } from "spinetab";
import { bindClient } from "spinetab/svelte";

export const spinetab = createSpinetab();
export const { liveStore } = bindClient(spinetab);
```

## 3\. Choose your source

Choose the format your server already serves. Save **one** of these as `queue-source.ts` alongside `live.ts`. Each example receives the complete queue value, `{ "open": 12 }`, so the component below stays the same.

### Polling

Read a JSON response from `GET /api/queue` every five seconds by default.

**File: `queue-source.ts`**

```ts
import { polling } from "spinetab/polling";

export const queueSource = polling<{ open: number }>("/api/queue");
```

[Polling options](https://spinetab.com/docs/transports/polling.md)

### SSE

Your endpoint serves `text/event-stream` with JSON in each `data:` field.

**File: `queue-source.ts`**

```ts
import { sse } from "spinetab/sse";

export const queueSource = sse<{ open: number }>("/api/queue/events");
```

[SSE options and named events](https://spinetab.com/docs/transports/sse.md)

### WebSocket

Your WebSocket endpoint sends a JSON queue value in each text frame. This is a raw WebSocket feed; GraphQL and Socket.IO need their own adapters.

**File: `queue-source.ts`**

```ts
import { websocket } from "spinetab/websocket";

export const queueSource = websocket<{ open: number }>("/ws/queue", {
  decoder: "json",
});
```

[WebSocket options and custom protocols](https://spinetab.com/docs/transports/websocket.md)

### Fetch stream

Your endpoint streams one JSON value per line (NDJSON). Only declare it repeatable when opening the request again is safe.

**File: `queue-source.ts`**

```ts
import { stream } from "spinetab/stream";

export const queueSource = stream<{ open: number }>("/api/queue/stream", {
  repeatable: true,
});
```

[Fetch stream options](https://spinetab.com/docs/transports/stream.md)

These URLs are examples, not routes created by the plugin. Replace them with your API. For GraphQL, Socket.IO or a client library, see [how sources and integrations fit together](https://spinetab.com/docs/choose-integration.md).

## 4\. Render a subscription

Create a [SvelteKit page](https://svelte.dev/docs/kit/project-structure) at `/queue`:

**File: `src/routes/queue/+page.svelte`**

```svelte
<script lang="ts">
  import { queueSource } from "$lib/queue-source";
  import { liveStore } from "$lib/live";

  const queue = liveStore(queueSource, {
    reconcile: "latest",
  });
</script>

<h1>Queue</h1>

{#if $queue.error}
  <p role="alert">Could not load the queue: {$queue.error.code}</p>
{:else if $queue.data === undefined}
  <p role="status">Loading queue…</p>
{:else}
  <p>{$queue.data.open} open</p>
{/if}
```

`$queue` subscribes through Svelte’s store contract. The store starts live work when it gains a browser subscriber and releases it when the last subscriber leaves. During server rendering it returns the inactive snapshot without connecting. You do not need `ssr = false` or an `onMount` wrapper.

Keep the store in the component as shown. For URLs that change with route parameters, follow the [reactive source rules](https://spinetab.com/docs/bindings.md#svelte) so the store tracks the new source. Do not start subscriptions from a server `load` function.

## Check it across tabs

Visit `/queue` in your running app. Navigating away removes that page’s store subscriber; another tab on the page keeps its own subscription alive.

Open the page in two tabs of the same browser profile. With SharedWorker available, matching subscriptions share the upstream feed or polling schedule. Each component keeps its own value. For polling, a new subscriber can trigger a fresh read; check ongoing requests rather than expecting exactly one initial request.

Polling reads every five seconds by default and pauses when no consumer is eligible, such as when all subscribing tabs are hidden. It reads again when a tab returns. If worker sharing is unavailable, each tab runs its own subscriptions; see [execution modes](https://spinetab.com/docs/concepts/modes.md).

`reconcile: "latest"` fits these full-state feeds. After a delivery gap, the next value restores the displayed state. Use a [refresh policy](https://spinetab.com/docs/concepts/continuity.md) for feeds of incremental changes.

## Next steps

-   Use [GraphQL, Socket.IO or a client library](https://spinetab.com/docs/choose-integration.md) with this setup.
-   Add [authentication and user scopes](https://spinetab.com/docs/concepts/credentials.md) for private data. Keep request-specific credentials out of server module singletons.
-   Read [continuity and recovery](https://spinetab.com/docs/concepts/continuity.md) before using an event stream: reconnecting alone cannot recover missed events.
-   Check [compatible versions and restrictions](https://spinetab.com/docs/compatibility.md) for your stack.

See [Vite framework configuration](https://spinetab.com/docs/bundlers.md#ssr-frameworks-using-vite) for build options and [Svelte bindings](https://spinetab.com/docs/bindings.md#svelte) for store APIs.

## More recipes

Choose a data library and connection for a complete example using this framework.

**Available recipes**

- [SvelteKit · Component state · HTTP polling](https://spinetab.com/docs/recipes/sveltekit/direct/polling.md)
- [SvelteKit · Component state · Server-sent events](https://spinetab.com/docs/recipes/sveltekit/direct/sse.md)
- [SvelteKit · Component state · WebSocket](https://spinetab.com/docs/recipes/sveltekit/direct/websocket.md)
- [SvelteKit · Component state · Fetch stream](https://spinetab.com/docs/recipes/sveltekit/direct/stream.md)
- [SvelteKit · Component state · GraphQL over WebSocket](https://spinetab.com/docs/recipes/sveltekit/direct/graphql-ws.md)
- [SvelteKit · Component state · GraphQL over SSE](https://spinetab.com/docs/recipes/sveltekit/direct/graphql-sse.md)
- [SvelteKit · Component state · Socket.IO](https://spinetab.com/docs/recipes/sveltekit/direct/socket-io.md)
- [SvelteKit · TanStack Query · HTTP polling](https://spinetab.com/docs/recipes/sveltekit/query/polling.md)
- [SvelteKit · TanStack Query · Server-sent events](https://spinetab.com/docs/recipes/sveltekit/query/sse.md)
- [SvelteKit · TanStack Query · WebSocket](https://spinetab.com/docs/recipes/sveltekit/query/websocket.md)
- [SvelteKit · TanStack Query · Fetch stream](https://spinetab.com/docs/recipes/sveltekit/query/stream.md)
- [SvelteKit · TanStack Query · GraphQL over WebSocket](https://spinetab.com/docs/recipes/sveltekit/query/graphql-ws.md)
- [SvelteKit · TanStack Query · GraphQL over SSE](https://spinetab.com/docs/recipes/sveltekit/query/graphql-sse.md)
- [SvelteKit · TanStack Query · Socket.IO](https://spinetab.com/docs/recipes/sveltekit/query/socket-io.md)
- [SvelteKit · tRPC · tRPC over WebSocket](https://spinetab.com/docs/recipes/sveltekit/trpc/trpc-ws.md)
- [SvelteKit · tRPC · tRPC over SSE](https://spinetab.com/docs/recipes/sveltekit/trpc/trpc-sse.md)
- [SvelteKit · AI SDK · Resumable chat](https://spinetab.com/docs/recipes/sveltekit/ai/chat.md)
