---
title: "Nuxt"
url: "https://spinetab.com/docs/setup/nuxt/"
description: "Add Spinetab's Nuxt module and render shared live values in a Vue page."
---

# Nuxt

This guide uses Nuxt 4 with Vite and its default `app/` directory. It adds a shared live feed to an existing app without disabling server rendering.

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

## 1\. Add the module

```sh
pnpm add spinetab
```

Add the module alongside your existing modules:

**File: `nuxt.config.ts`**

```ts
import { defineNuxtConfig } from "nuxt/config";

export default defineNuxtConfig({
  modules: ["spinetab/nuxt"],
});
```

The module configures the Vite plugin for the client build and generates the worker. You do not need to add `spinetab/vite` separately. Restart the dev server after changing the config.

## 2\. Create the client

**File: `app/live.ts`**

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

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

Import the bound composable explicitly from components. No Nuxt runtime plugin or provider is required for this setup.

## 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

**File: `app/components/Queue.vue`**

```vue
<script setup lang="ts">
import { queueSource } from "../queue-source";
import { useLive } from "../live";

const { data, error } = useLive(queueSource, {
  reconcile: "latest",
});
</script>

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

Render it from a page:

**File: `app/pages/queue.vue`**

```vue
<script setup lang="ts">
import Queue from "../components/Queue.vue";
</script>

<template>
  <main>
    <h1>Queue</h1>
    <Queue />
  </main>
</template>
```

If you have an [`app/app.vue`](https://nuxt.com/docs/4.x/directory-structure/app/app), keep its layout and ensure it renders `<NuxtPage />` for page routing.

The composable renders the loading state on the server, starts its subscription on mount in the browser and releases it when the component’s scope is disposed. A `<ClientOnly>` wrapper is not required. A page cached by `<KeepAlive>` retains its subscription until it is disposed; deactivation is not unmounting.

## Check it across tabs

Visit `/queue` in your running app. Navigate away in one tab while keeping the other on the queue page; that remaining subscriber continues receiving updates.

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).

If you introduce a new adapter during development, restart the dev server if Nuxt needs to prepare its dependencies. See the [Nuxt development restriction](https://spinetab.com/docs/compatibility.md#known-restrictions) for the WebKit cache caveat.

`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.

Pass plugin options through the module tuple; see [Nuxt configuration](https://spinetab.com/docs/bundlers.md#ssr-frameworks-using-vite).

## More recipes

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

**Available recipes**

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