---
title: "Vite"
url: "https://spinetab.com/docs/setup/vite/"
description: "Add Spinetab to a Vite app and share a live feed across tabs, with a complete React component."
---

# Vite

Add a shared live feed to an existing Vite app. Choose your renderer and data library below for a complete recipe. The walkthrough on this page uses React.

You need an API that supplies a queue value such as `{ "open": 12 }`. Choose its transport in step 3 and replace the URL and type with your own. If your API runs on another local port, use your app’s existing dev proxy or an absolute URL with CORS configured on the API.

## 1\. Add the plugin

```sh
pnpm add spinetab
```

Add `spinetab()` alongside the plugins already in your config:

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

```ts
import react from "@vitejs/plugin-react";
import { spinetab } from "spinetab/vite";
import { defineConfig } from "vite";

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

The plugin builds the worker and includes the adapters your app imports. Restart the dev server after changing the config.

## 2\. Create the client

Create one client for your app and bind the React hooks to it:

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

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

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

Import these hooks wherever you need them. No provider is required.

## 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: `src/Queue.tsx`**

```tsx
import { queueSource } from "./queue-source";
import { useLive } from "./live";

export function Queue() {
  const { data, error } = useLive(queueSource, {
    reconcile: "latest",
  });

  if (error) return <p role="alert">Could not load the queue: {error.code}</p>;
  if (data === undefined) return <p role="status">Loading queue…</p>;

  return <p>{data.open} open</p>;
}
```

Render it in your app:

**File: `src/App.tsx`**

```tsx
import { Queue } from "./Queue";

export default function App() {
  return <Queue />;
}
```

The hook subscribes on mount and cleans up on unmount. Polling reads every five seconds by default and pauses when no consumer is eligible, for example when all subscribing tabs are hidden. It performs a catch-up read when a tab returns.

## 5\. Check it across tabs

Open the app in two tabs of the same browser profile. With SharedWorker available, matching subscriptions share the upstream feed or polling schedule. Each tab still renders its own component and holds its own value.

To inspect the mode, temporarily render this component alongside `Queue`:

**File: `src/LiveStatus.tsx`**

```tsx
import { useSpinetabStatus } from "./live";

export function LiveStatus() {
  const status = useSpinetabStatus();
  return <p>Mode: {status.mode}</p>;
}
```

`shared` means the client is using a worker. `local` means this tab runs its own subscriptions. See [execution modes](https://spinetab.com/docs/concepts/modes.md) for fallback reasons. Server logs are the useful check for shared upstream work. With polling, a new consumer may trigger a fresh read without creating another ongoing schedule.

`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 [polling options](https://spinetab.com/docs/transports/polling.md) to change the interval, or choose [another subscription source](https://spinetab.com/docs.md#use-the-api-you-already-have).
-   Keep your existing [Apollo](https://spinetab.com/docs/integrations/apollo.md), [TanStack Query](https://spinetab.com/docs/integrations/tanstack-query.md) or [SWR](https://spinetab.com/docs/integrations/swr.md) data flow through its integration.
-   Add [authentication](https://spinetab.com/docs/concepts/credentials.md) and [recovery handling](https://spinetab.com/docs/concepts/continuity.md) for your app’s feeds.

For plugin options, base paths and custom builds, see [bundler configuration](https://spinetab.com/docs/bundlers.md).

## More recipes

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

**Available recipes**

- [Vite · React · Component state · HTTP polling](https://spinetab.com/docs/recipes/vite-react/direct/polling.md)
- [Vite · React · Component state · Server-sent events](https://spinetab.com/docs/recipes/vite-react/direct/sse.md)
- [Vite · React · Component state · WebSocket](https://spinetab.com/docs/recipes/vite-react/direct/websocket.md)
- [Vite · React · Component state · Fetch stream](https://spinetab.com/docs/recipes/vite-react/direct/stream.md)
- [Vite · React · Component state · GraphQL over WebSocket](https://spinetab.com/docs/recipes/vite-react/direct/graphql-ws.md)
- [Vite · React · Component state · GraphQL over SSE](https://spinetab.com/docs/recipes/vite-react/direct/graphql-sse.md)
- [Vite · React · Component state · Socket.IO](https://spinetab.com/docs/recipes/vite-react/direct/socket-io.md)
- [Vite · React · TanStack Query · HTTP polling](https://spinetab.com/docs/recipes/vite-react/query/polling.md)
- [Vite · React · TanStack Query · Server-sent events](https://spinetab.com/docs/recipes/vite-react/query/sse.md)
- [Vite · React · TanStack Query · WebSocket](https://spinetab.com/docs/recipes/vite-react/query/websocket.md)
- [Vite · React · TanStack Query · Fetch stream](https://spinetab.com/docs/recipes/vite-react/query/stream.md)
- [Vite · React · TanStack Query · GraphQL over WebSocket](https://spinetab.com/docs/recipes/vite-react/query/graphql-ws.md)
- [Vite · React · TanStack Query · GraphQL over SSE](https://spinetab.com/docs/recipes/vite-react/query/graphql-sse.md)
- [Vite · React · TanStack Query · Socket.IO](https://spinetab.com/docs/recipes/vite-react/query/socket-io.md)
- [Vite · React · SWR · HTTP polling](https://spinetab.com/docs/recipes/vite-react/swr/polling.md)
- [Vite · React · SWR · Server-sent events](https://spinetab.com/docs/recipes/vite-react/swr/sse.md)
- [Vite · React · SWR · WebSocket](https://spinetab.com/docs/recipes/vite-react/swr/websocket.md)
- [Vite · React · SWR · Fetch stream](https://spinetab.com/docs/recipes/vite-react/swr/stream.md)
- [Vite · React · SWR · GraphQL over WebSocket](https://spinetab.com/docs/recipes/vite-react/swr/graphql-ws.md)
- [Vite · React · SWR · GraphQL over SSE](https://spinetab.com/docs/recipes/vite-react/swr/graphql-sse.md)
- [Vite · React · SWR · Socket.IO](https://spinetab.com/docs/recipes/vite-react/swr/socket-io.md)
- [Vite · React · Apollo Client · GraphQL over WebSocket](https://spinetab.com/docs/recipes/vite-react/apollo/graphql-ws.md)
- [Vite · React · Apollo Client · GraphQL over SSE](https://spinetab.com/docs/recipes/vite-react/apollo/graphql-sse.md)
- [Vite · React · tRPC · tRPC over WebSocket](https://spinetab.com/docs/recipes/vite-react/trpc/trpc-ws.md)
- [Vite · React · tRPC · tRPC over SSE](https://spinetab.com/docs/recipes/vite-react/trpc/trpc-sse.md)
- [Vite · React · AI SDK · Resumable chat](https://spinetab.com/docs/recipes/vite-react/ai/chat.md)
- [Vite · Vue · Component state · HTTP polling](https://spinetab.com/docs/recipes/vite-vue/direct/polling.md)
- [Vite · Vue · Component state · Server-sent events](https://spinetab.com/docs/recipes/vite-vue/direct/sse.md)
- [Vite · Vue · Component state · WebSocket](https://spinetab.com/docs/recipes/vite-vue/direct/websocket.md)
- [Vite · Vue · Component state · Fetch stream](https://spinetab.com/docs/recipes/vite-vue/direct/stream.md)
- [Vite · Vue · Component state · GraphQL over WebSocket](https://spinetab.com/docs/recipes/vite-vue/direct/graphql-ws.md)
- [Vite · Vue · Component state · GraphQL over SSE](https://spinetab.com/docs/recipes/vite-vue/direct/graphql-sse.md)
- [Vite · Vue · Component state · Socket.IO](https://spinetab.com/docs/recipes/vite-vue/direct/socket-io.md)
- [Vite · Vue · TanStack Query · HTTP polling](https://spinetab.com/docs/recipes/vite-vue/query/polling.md)
- [Vite · Vue · TanStack Query · Server-sent events](https://spinetab.com/docs/recipes/vite-vue/query/sse.md)
- [Vite · Vue · TanStack Query · WebSocket](https://spinetab.com/docs/recipes/vite-vue/query/websocket.md)
- [Vite · Vue · TanStack Query · Fetch stream](https://spinetab.com/docs/recipes/vite-vue/query/stream.md)
- [Vite · Vue · TanStack Query · GraphQL over WebSocket](https://spinetab.com/docs/recipes/vite-vue/query/graphql-ws.md)
- [Vite · Vue · TanStack Query · GraphQL over SSE](https://spinetab.com/docs/recipes/vite-vue/query/graphql-sse.md)
- [Vite · Vue · TanStack Query · Socket.IO](https://spinetab.com/docs/recipes/vite-vue/query/socket-io.md)
- [Vite · Vue · tRPC · tRPC over WebSocket](https://spinetab.com/docs/recipes/vite-vue/trpc/trpc-ws.md)
- [Vite · Vue · tRPC · tRPC over SSE](https://spinetab.com/docs/recipes/vite-vue/trpc/trpc-sse.md)
- [Vite · Vue · AI SDK · Resumable chat](https://spinetab.com/docs/recipes/vite-vue/ai/chat.md)
- [Vite · Svelte · Component state · HTTP polling](https://spinetab.com/docs/recipes/vite-svelte/direct/polling.md)
- [Vite · Svelte · Component state · Server-sent events](https://spinetab.com/docs/recipes/vite-svelte/direct/sse.md)
- [Vite · Svelte · Component state · WebSocket](https://spinetab.com/docs/recipes/vite-svelte/direct/websocket.md)
- [Vite · Svelte · Component state · Fetch stream](https://spinetab.com/docs/recipes/vite-svelte/direct/stream.md)
- [Vite · Svelte · Component state · GraphQL over WebSocket](https://spinetab.com/docs/recipes/vite-svelte/direct/graphql-ws.md)
- [Vite · Svelte · Component state · GraphQL over SSE](https://spinetab.com/docs/recipes/vite-svelte/direct/graphql-sse.md)
- [Vite · Svelte · Component state · Socket.IO](https://spinetab.com/docs/recipes/vite-svelte/direct/socket-io.md)
- [Vite · Svelte · TanStack Query · HTTP polling](https://spinetab.com/docs/recipes/vite-svelte/query/polling.md)
- [Vite · Svelte · TanStack Query · Server-sent events](https://spinetab.com/docs/recipes/vite-svelte/query/sse.md)
- [Vite · Svelte · TanStack Query · WebSocket](https://spinetab.com/docs/recipes/vite-svelte/query/websocket.md)
- [Vite · Svelte · TanStack Query · Fetch stream](https://spinetab.com/docs/recipes/vite-svelte/query/stream.md)
- [Vite · Svelte · TanStack Query · GraphQL over WebSocket](https://spinetab.com/docs/recipes/vite-svelte/query/graphql-ws.md)
- [Vite · Svelte · TanStack Query · GraphQL over SSE](https://spinetab.com/docs/recipes/vite-svelte/query/graphql-sse.md)
- [Vite · Svelte · TanStack Query · Socket.IO](https://spinetab.com/docs/recipes/vite-svelte/query/socket-io.md)
- [Vite · Svelte · tRPC · tRPC over WebSocket](https://spinetab.com/docs/recipes/vite-svelte/trpc/trpc-ws.md)
- [Vite · Svelte · tRPC · tRPC over SSE](https://spinetab.com/docs/recipes/vite-svelte/trpc/trpc-sse.md)
- [Vite · Svelte · AI SDK · Resumable chat](https://spinetab.com/docs/recipes/vite-svelte/ai/chat.md)
- [Vite · Solid · Component state · HTTP polling](https://spinetab.com/docs/recipes/vite-solid/direct/polling.md)
- [Vite · Solid · Component state · Server-sent events](https://spinetab.com/docs/recipes/vite-solid/direct/sse.md)
- [Vite · Solid · Component state · WebSocket](https://spinetab.com/docs/recipes/vite-solid/direct/websocket.md)
- [Vite · Solid · Component state · Fetch stream](https://spinetab.com/docs/recipes/vite-solid/direct/stream.md)
- [Vite · Solid · Component state · GraphQL over WebSocket](https://spinetab.com/docs/recipes/vite-solid/direct/graphql-ws.md)
- [Vite · Solid · Component state · GraphQL over SSE](https://spinetab.com/docs/recipes/vite-solid/direct/graphql-sse.md)
- [Vite · Solid · Component state · Socket.IO](https://spinetab.com/docs/recipes/vite-solid/direct/socket-io.md)
- [Vite · Solid · TanStack Query · HTTP polling](https://spinetab.com/docs/recipes/vite-solid/query/polling.md)
- [Vite · Solid · TanStack Query · Server-sent events](https://spinetab.com/docs/recipes/vite-solid/query/sse.md)
- [Vite · Solid · TanStack Query · WebSocket](https://spinetab.com/docs/recipes/vite-solid/query/websocket.md)
- [Vite · Solid · TanStack Query · Fetch stream](https://spinetab.com/docs/recipes/vite-solid/query/stream.md)
- [Vite · Solid · TanStack Query · GraphQL over WebSocket](https://spinetab.com/docs/recipes/vite-solid/query/graphql-ws.md)
- [Vite · Solid · TanStack Query · GraphQL over SSE](https://spinetab.com/docs/recipes/vite-solid/query/graphql-sse.md)
- [Vite · Solid · TanStack Query · Socket.IO](https://spinetab.com/docs/recipes/vite-solid/query/socket-io.md)
- [Vite · Solid · tRPC · tRPC over WebSocket](https://spinetab.com/docs/recipes/vite-solid/trpc/trpc-ws.md)
- [Vite · Solid · tRPC · tRPC over SSE](https://spinetab.com/docs/recipes/vite-solid/trpc/trpc-sse.md)
