---
title: "Documentation"
url: "https://spinetab.com/docs/"
description: "Share live subscriptions across browser tabs. Start with your frontend setup, then connect your existing API."
---

# Documentation

Spinetab shares live subscriptions across tabs of your app. When two tabs ask for the same feed, Spinetab can share its connection or polling schedule between them.

It runs in the browser and connects to your existing API. Your framework handles rendering; libraries such as Apollo, TanStack Query and SWR keep managing their own data and caches.

## Start with your app

[Choose your setup](https://spinetab.com/docs/getting-started.md) to add the bundler plugin, create a client and render your first subscription. The plugin generates the worker for you. Use a framework binding for component cleanup, or the core API in vanilla JavaScript.

Try [Orbit](https://spinetab.com/docs/examples/orbit.md) or [Live transit](https://spinetab.com/docs/examples/live-transit.md) to see sharing work across real browser tabs before adding it to your app.

## Use the API you already have

Choose the source that matches your backend. There is no Spinetab server to install.

| Your API | Guide |
| --- | --- |
| An HTTP endpoint you read at intervals | [Polling](https://spinetab.com/docs/transports/polling.md) |
| Server-sent events | [SSE](https://spinetab.com/docs/transports/sse.md) |
| NDJSON or a line-delimited streaming response | [Fetch streams](https://spinetab.com/docs/transports/stream.md) |
| A WebSocket feed or custom socket protocol | [WebSocket](https://spinetab.com/docs/transports/websocket.md) |
| GraphQL subscriptions over WebSocket or SSE | [GraphQL](https://spinetab.com/docs/protocols/graphql.md) |
| Socket.IO events | [Socket.IO](https://spinetab.com/docs/protocols/socket-io.md) |

For an existing client library, use its integration: [Apollo](https://spinetab.com/docs/integrations/apollo.md), [TanStack Query](https://spinetab.com/docs/integrations/tanstack-query.md), [SWR](https://spinetab.com/docs/integrations/swr.md), [tRPC](https://spinetab.com/docs/integrations/trpc.md) or [AI SDK](https://spinetab.com/docs/integrations/ai-sdk.md).

[Choose your integration](https://spinetab.com/docs/choose-integration.md) maps these sources to your framework and data library, including lifecycle and result-shape differences.

## Understand sharing and recovery

A [SharedWorker](https://developer.mozilla.org/en-US/docs/Web/API/SharedWorker) owns the subscriptions and forwards updates to the tabs. Matching requests share work within the same worker and scope. Use a different scope for each user or tenant; different endpoints and subscription parameters also stay separate. When a browser cannot share a worker, Spinetab falls back to running in each tab.

After an interruption, Spinetab restores active, repeatable subscriptions. Recovering missed events still needs replay from your server or a refresh from your app. Spinetab reports uncertainty rather than treating a reconnected feed as complete.

Read [sharing and identity](https://spinetab.com/docs/concepts/identity.md) for the boundaries, [status and health](https://spinetab.com/docs/concepts/status.md) for what to show in the UI, and [continuity and recovery](https://spinetab.com/docs/concepts/continuity.md) for handling missed events.
