# Docs

- React: @dammers/use-signalr-react
  - [Introduction](https://use-signalr.vercel.app/docs/react.md): What use-signalr does for your app, and what it does not support.
  - [Quick start](https://use-signalr.vercel.app/docs/react/quick-start.md): Install the package, declare a contract, and call a hub from a component.
  - Concepts
    - [Client config](https://use-signalr.vercel.app/docs/react/concepts/client-config.md): Declare hubs, events, and methods, and set options for all hubs or for one hub.
    - [Provider](https://use-signalr.vercel.app/docs/react/concepts/provider.md): Mount SignalRProvider once with a base URL and a token factory, and learn when it starts and stops the connections.
    - [Authentication](https://use-signalr.vercel.app/docs/react/concepts/auth.md): Send a token or a cookie, handle 401 and 403, and recover after a new login.
    - [Lazy hubs](https://use-signalr.vercel.app/docs/react/concepts/lazy-hubs.md): Connect a hub only while a consumer needs it, and keep it open for a grace period.
    - [Connection status](https://use-signalr.vercel.app/docs/react/concepts/connection-status.md): The five statuses of a hub and the events that change them.
    - [Events](https://use-signalr.vercel.app/docs/react/concepts/events.md): Listen to events that the server pushes, with arguments typed from the contract.
    - [Calls](https://use-signalr.vercel.app/docs/react/concepts/calls.md): Call server methods with invoke, send, or teardown, and set timeouts and retries.
    - [Recovery](https://use-signalr.vercel.app/docs/react/concepts/recovery.md): How the library retries a lost connection, when errors reach you, and when to refetch.
  - Guides
    - [Server rendering](https://use-signalr.vercel.app/docs/react/guides/ssr.md): How React behaves during server-side rendering and hydration.
    - [Groups and rooms](https://use-signalr.vercel.app/docs/react/guides/groups.md): Keep server group membership correct across reconnects.
    - [MessagePack and the connection builder](https://use-signalr.vercel.app/docs/react/guides/messagepack.md): Send binary MessagePack instead of JSON, and change the SignalR connection builder.
    - [ASP.NET Core server](https://use-signalr.vercel.app/docs/react/guides/server.md): Set up the SignalR hubs that React connects to, with auth, CORS, transports, and scale-out.
    - [Testing](https://use-signalr.vercel.app/docs/react/guides/testing.md): Test components that use React without a real server.
  - Reference
    - [API reference](https://use-signalr.vercel.app/docs/react/reference/api.md): Every export of @dammers/use-signalr-react with its signature, return value, and lifetime.
    - [Configuration reference](https://use-signalr.vercel.app/docs/react/reference/config.md): Every option of the client config, the hub config, the calls, and the provider.
    - [React notes](https://use-signalr.vercel.app/docs/react/reference/notes.md): StrictMode, Next.js, latest handlers, and React Query behavior of the React adapter.
    - [Troubleshooting](https://use-signalr.vercel.app/docs/react/reference/troubleshooting.md): Find the cause and the fix for a symptom or an error message.
- Vue: @dammers/use-signalr-vue
  - [Introduction](https://use-signalr.vercel.app/docs/vue.md): What use-signalr does for your app, and what it does not support.
  - [Quick start](https://use-signalr.vercel.app/docs/vue/quick-start.md): Install the package, declare a contract, and call a hub from a component.
  - Concepts
    - [Client config](https://use-signalr.vercel.app/docs/vue/concepts/client-config.md): Declare hubs, events, and methods, and set options for all hubs or for one hub.
    - [Plugin](https://use-signalr.vercel.app/docs/vue/concepts/provider.md): Install the SignalR plugin in your Vue app, set its options, and learn when the session starts and stops.
    - [Authentication](https://use-signalr.vercel.app/docs/vue/concepts/auth.md): Send a token or a cookie, handle 401 and 403, and recover after a new login.
    - [Lazy hubs](https://use-signalr.vercel.app/docs/vue/concepts/lazy-hubs.md): Connect a hub only while a consumer needs it, and keep it open for a grace period.
    - [Connection status](https://use-signalr.vercel.app/docs/vue/concepts/connection-status.md): The five statuses of a hub and the events that change them.
    - [Events](https://use-signalr.vercel.app/docs/vue/concepts/events.md): Listen to events that the server pushes, with arguments typed from the contract.
    - [Calls](https://use-signalr.vercel.app/docs/vue/concepts/calls.md): Call server methods with invoke, send, or teardown, and set timeouts and retries.
    - [Recovery](https://use-signalr.vercel.app/docs/vue/concepts/recovery.md): How the library retries a lost connection, when errors reach you, and when to refetch.
  - Guides
    - [Server rendering](https://use-signalr.vercel.app/docs/vue/guides/ssr.md): How Vue behaves during server-side rendering and hydration.
    - [Groups and rooms](https://use-signalr.vercel.app/docs/vue/guides/groups.md): Keep server group membership correct across reconnects.
    - [MessagePack and the connection builder](https://use-signalr.vercel.app/docs/vue/guides/messagepack.md): Send binary MessagePack instead of JSON, and change the SignalR connection builder.
    - [ASP.NET Core server](https://use-signalr.vercel.app/docs/vue/guides/server.md): Set up the SignalR hubs that Vue connects to, with auth, CORS, transports, and scale-out.
    - [Testing](https://use-signalr.vercel.app/docs/vue/guides/testing.md): Test components that use Vue without a real server.
  - Reference
    - [API reference](https://use-signalr.vercel.app/docs/vue/reference/api.md): Every export of the Vue package, with signatures, return values, lifetimes, and placement errors.
    - [Configuration reference](https://use-signalr.vercel.app/docs/vue/reference/config.md): Every option of the client config, the hub config, the calls, and the provider.
    - [Vue notes](https://use-signalr.vercel.app/docs/vue/reference/notes.md): Vue-specific rules for the SignalR package. Nuxt, refs and getters, effect scopes, and why a hub call must not use top-level await.
    - [Troubleshooting](https://use-signalr.vercel.app/docs/vue/reference/troubleshooting.md): Find the cause and the fix for a symptom or an error message.
- Angular: @dammers/use-signalr-angular
  - [Introduction](https://use-signalr.vercel.app/docs/angular.md): What use-signalr does for your app, and what it does not support.
  - [Quick start](https://use-signalr.vercel.app/docs/angular/quick-start.md): Install the package, declare a contract, and call a hub from a component.
  - Concepts
    - [Client config](https://use-signalr.vercel.app/docs/angular/concepts/client-config.md): Declare hubs, events, and methods, and set options for all hubs or for one hub.
    - [Provider](https://use-signalr.vercel.app/docs/angular/concepts/provider.md): Register provideSignalR in the app config with a base URL, a token factory, and optional signals.
    - [Authentication](https://use-signalr.vercel.app/docs/angular/concepts/auth.md): Send a token or a cookie, handle 401 and 403, and recover after a new login.
    - [Lazy hubs](https://use-signalr.vercel.app/docs/angular/concepts/lazy-hubs.md): Connect a hub only while a consumer needs it, and keep it open for a grace period.
    - [Connection status](https://use-signalr.vercel.app/docs/angular/concepts/connection-status.md): The five statuses of a hub and the events that change them.
    - [Events](https://use-signalr.vercel.app/docs/angular/concepts/events.md): Listen to events that the server pushes, with arguments typed from the contract.
    - [Calls](https://use-signalr.vercel.app/docs/angular/concepts/calls.md): Call server methods with invoke, send, or teardown, and set timeouts and retries.
    - [Recovery](https://use-signalr.vercel.app/docs/angular/concepts/recovery.md): How the library retries a lost connection, when errors reach you, and when to refetch.
  - Guides
    - [Server rendering](https://use-signalr.vercel.app/docs/angular/guides/ssr.md): How Angular behaves during server-side rendering and hydration.
    - [Groups and rooms](https://use-signalr.vercel.app/docs/angular/guides/groups.md): Keep server group membership correct across reconnects.
    - [MessagePack and the connection builder](https://use-signalr.vercel.app/docs/angular/guides/messagepack.md): Send binary MessagePack instead of JSON, and change the SignalR connection builder.
    - [ASP.NET Core server](https://use-signalr.vercel.app/docs/angular/guides/server.md): Set up the SignalR hubs that Angular connects to, with auth, CORS, transports, and scale-out.
    - [Testing](https://use-signalr.vercel.app/docs/angular/guides/testing.md): Test components that use Angular without a real server.
  - Reference
    - [API reference](https://use-signalr.vercel.app/docs/angular/reference/api.md): Every export of @dammers/use-signalr-angular and its rxjs-interop entry point, with signatures, lifetimes, and types.
    - [Configuration reference](https://use-signalr.vercel.app/docs/angular/reference/config.md): Every option of the client config, the hub config, the calls, and the provider.
    - [Angular notes](https://use-signalr.vercel.app/docs/angular/reference/notes.md): Zone, signals, RxJS, server rendering, and cleanup in the Angular package.
    - [Troubleshooting](https://use-signalr.vercel.app/docs/angular/reference/troubleshooting.md): Find the cause and the fix for a symptom or an error message.
- Svelte: @dammers/use-signalr-svelte
  - [Introduction](https://use-signalr.vercel.app/docs/svelte.md): What use-signalr does for your app, and what it does not support.
  - [Quick start](https://use-signalr.vercel.app/docs/svelte/quick-start.md): Install the package, declare a contract, and call a hub from a component.
  - Concepts
    - [Client config](https://use-signalr.vercel.app/docs/svelte/concepts/client-config.md): Declare hubs, events, and methods, and set options for all hubs or for one hub.
    - [Provider](https://use-signalr.vercel.app/docs/svelte/concepts/provider.md): Call provideSignalR in your root component, set its options, and learn when the session starts and stops.
    - [Authentication](https://use-signalr.vercel.app/docs/svelte/concepts/auth.md): Send a token or a cookie, handle 401 and 403, and recover after a new login.
    - [Lazy hubs](https://use-signalr.vercel.app/docs/svelte/concepts/lazy-hubs.md): Connect a hub only while a consumer needs it, and keep it open for a grace period.
    - [Connection status](https://use-signalr.vercel.app/docs/svelte/concepts/connection-status.md): The five statuses of a hub and the events that change them.
    - [Events](https://use-signalr.vercel.app/docs/svelte/concepts/events.md): Listen to events that the server pushes, with arguments typed from the contract.
    - [Calls](https://use-signalr.vercel.app/docs/svelte/concepts/calls.md): Call server methods with invoke, send, or teardown, and set timeouts and retries.
    - [Recovery](https://use-signalr.vercel.app/docs/svelte/concepts/recovery.md): How the library retries a lost connection, when errors reach you, and when to refetch.
  - Guides
    - [Server rendering](https://use-signalr.vercel.app/docs/svelte/guides/ssr.md): How Svelte behaves during server-side rendering and hydration.
    - [Groups and rooms](https://use-signalr.vercel.app/docs/svelte/guides/groups.md): Keep server group membership correct across reconnects.
    - [MessagePack and the connection builder](https://use-signalr.vercel.app/docs/svelte/guides/messagepack.md): Send binary MessagePack instead of JSON, and change the SignalR connection builder.
    - [ASP.NET Core server](https://use-signalr.vercel.app/docs/svelte/guides/server.md): Set up the SignalR hubs that Svelte connects to, with auth, CORS, transports, and scale-out.
    - [Testing](https://use-signalr.vercel.app/docs/svelte/guides/testing.md): Test components that use Svelte without a real server.
  - Reference
    - [API reference](https://use-signalr.vercel.app/docs/svelte/reference/api.md): Every export of the Svelte package, with signatures, return values, lifetimes, and placement errors.
    - [Configuration reference](https://use-signalr.vercel.app/docs/svelte/reference/config.md): Every option of the client config, the hub config, the calls, and the provider.
    - [Svelte notes](https://use-signalr.vercel.app/docs/svelte/reference/notes.md): Svelte-specific rules for the SignalR package. Svelte 5 only, stores and runes, SvelteKit, and the readable status.
    - [Troubleshooting](https://use-signalr.vercel.app/docs/svelte/reference/troubleshooting.md): Find the cause and the fix for a symptom or an error message.
- Preact: @dammers/use-signalr-preact
  - [Introduction](https://use-signalr.vercel.app/docs/preact.md): What use-signalr does for your app, and what it does not support.
  - [Quick start](https://use-signalr.vercel.app/docs/preact/quick-start.md): Install the package, declare a contract, and call a hub from a component.
  - Concepts
    - [Client config](https://use-signalr.vercel.app/docs/preact/concepts/client-config.md): Declare hubs, events, and methods, and set options for all hubs or for one hub.
    - [Provider](https://use-signalr.vercel.app/docs/preact/concepts/provider.md): Mount SignalRProvider once with a base URL and a token factory, and learn when it starts and stops the connections.
    - [Authentication](https://use-signalr.vercel.app/docs/preact/concepts/auth.md): Send a token or a cookie, handle 401 and 403, and recover after a new login.
    - [Lazy hubs](https://use-signalr.vercel.app/docs/preact/concepts/lazy-hubs.md): Connect a hub only while a consumer needs it, and keep it open for a grace period.
    - [Connection status](https://use-signalr.vercel.app/docs/preact/concepts/connection-status.md): The five statuses of a hub and the events that change them.
    - [Events](https://use-signalr.vercel.app/docs/preact/concepts/events.md): Listen to events that the server pushes, with arguments typed from the contract.
    - [Calls](https://use-signalr.vercel.app/docs/preact/concepts/calls.md): Call server methods with invoke, send, or teardown, and set timeouts and retries.
    - [Recovery](https://use-signalr.vercel.app/docs/preact/concepts/recovery.md): How the library retries a lost connection, when errors reach you, and when to refetch.
  - Guides
    - [Server rendering](https://use-signalr.vercel.app/docs/preact/guides/ssr.md): How Preact behaves during server-side rendering and hydration.
    - [Groups and rooms](https://use-signalr.vercel.app/docs/preact/guides/groups.md): Keep server group membership correct across reconnects.
    - [MessagePack and the connection builder](https://use-signalr.vercel.app/docs/preact/guides/messagepack.md): Send binary MessagePack instead of JSON, and change the SignalR connection builder.
    - [ASP.NET Core server](https://use-signalr.vercel.app/docs/preact/guides/server.md): Set up the SignalR hubs that Preact connects to, with auth, CORS, transports, and scale-out.
    - [Testing](https://use-signalr.vercel.app/docs/preact/guides/testing.md): Test components that use Preact without a real server.
  - Reference
    - [API reference](https://use-signalr.vercel.app/docs/preact/reference/api.md): Every export of @dammers/use-signalr-preact with its signature, return value, and lifetime.
    - [Configuration reference](https://use-signalr.vercel.app/docs/preact/reference/config.md): Every option of the client config, the hub config, the calls, and the provider.
    - [Preact notes](https://use-signalr.vercel.app/docs/preact/reference/notes.md): How the Preact adapter works without preact/compat, and how it handles status, handlers, and server rendering.
    - [Troubleshooting](https://use-signalr.vercel.app/docs/preact/reference/troubleshooting.md): Find the cause and the fix for a symptom or an error message.
- Solid: @dammers/use-signalr-solid
  - [Introduction](https://use-signalr.vercel.app/docs/solid.md): What use-signalr does for your app, and what it does not support.
  - [Quick start](https://use-signalr.vercel.app/docs/solid/quick-start.md): Install the package, declare a contract, and call a hub from a component.
  - Concepts
    - [Client config](https://use-signalr.vercel.app/docs/solid/concepts/client-config.md): Declare hubs, events, and methods, and set options for all hubs or for one hub.
    - [Provider](https://use-signalr.vercel.app/docs/solid/concepts/provider.md): Mount SignalRProvider once with a base URL and a token factory, and learn when it starts and stops the connections.
    - [Authentication](https://use-signalr.vercel.app/docs/solid/concepts/auth.md): Send a token or a cookie, handle 401 and 403, and recover after a new login.
    - [Lazy hubs](https://use-signalr.vercel.app/docs/solid/concepts/lazy-hubs.md): Connect a hub only while a consumer needs it, and keep it open for a grace period.
    - [Connection status](https://use-signalr.vercel.app/docs/solid/concepts/connection-status.md): The five statuses of a hub and the events that change them.
    - [Events](https://use-signalr.vercel.app/docs/solid/concepts/events.md): Listen to events that the server pushes, with arguments typed from the contract.
    - [Calls](https://use-signalr.vercel.app/docs/solid/concepts/calls.md): Call server methods with invoke, send, or teardown, and set timeouts and retries.
    - [Recovery](https://use-signalr.vercel.app/docs/solid/concepts/recovery.md): How the library retries a lost connection, when errors reach you, and when to refetch.
  - Guides
    - [Server rendering](https://use-signalr.vercel.app/docs/solid/guides/ssr.md): How Solid behaves during server-side rendering and hydration.
    - [Groups and rooms](https://use-signalr.vercel.app/docs/solid/guides/groups.md): Keep server group membership correct across reconnects.
    - [MessagePack and the connection builder](https://use-signalr.vercel.app/docs/solid/guides/messagepack.md): Send binary MessagePack instead of JSON, and change the SignalR connection builder.
    - [ASP.NET Core server](https://use-signalr.vercel.app/docs/solid/guides/server.md): Set up the SignalR hubs that Solid connects to, with auth, CORS, transports, and scale-out.
    - [Testing](https://use-signalr.vercel.app/docs/solid/guides/testing.md): Test components that use Solid without a real server.
  - Reference
    - [API reference](https://use-signalr.vercel.app/docs/solid/reference/api.md): Every export of @dammers/use-signalr-solid with its signature, return value, and lifetime.
    - [Configuration reference](https://use-signalr.vercel.app/docs/solid/reference/config.md): Every option of the client config, the hub config, the calls, and the provider.
    - [Solid notes](https://use-signalr.vercel.app/docs/solid/reference/notes.md): Accessors, reactivity, setup-time arguments, and SolidStart behavior of the Solid adapter.
    - [Troubleshooting](https://use-signalr.vercel.app/docs/solid/reference/troubleshooting.md): Find the cause and the fix for a symptom or an error message.
- Lit: @dammers/use-signalr-lit
  - [Introduction](https://use-signalr.vercel.app/docs/lit.md): What use-signalr does for your app, and what it does not support.
  - [Quick start](https://use-signalr.vercel.app/docs/lit/quick-start.md): Install the package, declare a contract, and call a hub from a component.
  - Concepts
    - [Client config](https://use-signalr.vercel.app/docs/lit/concepts/client-config.md): Declare hubs, events, and methods, and set options for all hubs or for one hub.
    - [Session](https://use-signalr.vercel.app/docs/lit/concepts/provider.md): Create one shared session with createSession, then change it with update() and stop it with stop().
    - [Authentication](https://use-signalr.vercel.app/docs/lit/concepts/auth.md): Send a token or a cookie, handle 401 and 403, and recover after a new login.
    - [Lazy hubs](https://use-signalr.vercel.app/docs/lit/concepts/lazy-hubs.md): Connect a hub only while a consumer needs it, and keep it open for a grace period.
    - [Connection status](https://use-signalr.vercel.app/docs/lit/concepts/connection-status.md): The five statuses of a hub and the events that change them.
    - [Events](https://use-signalr.vercel.app/docs/lit/concepts/events.md): Listen to events that the server pushes, with arguments typed from the contract.
    - [Calls](https://use-signalr.vercel.app/docs/lit/concepts/calls.md): Call server methods with invoke, send, or teardown, and set timeouts and retries.
    - [Recovery](https://use-signalr.vercel.app/docs/lit/concepts/recovery.md): How the library retries a lost connection, when errors reach you, and when to refetch.
  - Guides
    - [Server rendering](https://use-signalr.vercel.app/docs/lit/guides/ssr.md): How Lit behaves during server-side rendering and hydration.
    - [Groups and rooms](https://use-signalr.vercel.app/docs/lit/guides/groups.md): Keep server group membership correct across reconnects.
    - [MessagePack and the connection builder](https://use-signalr.vercel.app/docs/lit/guides/messagepack.md): Send binary MessagePack instead of JSON, and change the SignalR connection builder.
    - [ASP.NET Core server](https://use-signalr.vercel.app/docs/lit/guides/server.md): Set up the SignalR hubs that Lit connects to, with auth, CORS, transports, and scale-out.
    - [Testing](https://use-signalr.vercel.app/docs/lit/guides/testing.md): Test components that use Lit without a real server.
  - Reference
    - [API reference](https://use-signalr.vercel.app/docs/lit/reference/api.md): Every export of @dammers/use-signalr-lit, with the members of the session and the hub controller.
    - [Configuration reference](https://use-signalr.vercel.app/docs/lit/reference/config.md): Every option of the client config, the hub config, the calls, and the provider.
    - [Lit notes](https://use-signalr.vercel.app/docs/lit/reference/notes.md): Reactive controllers, status updates, decorators, sharing a session, and server rendering in the Lit package.
    - [Troubleshooting](https://use-signalr.vercel.app/docs/lit/reference/troubleshooting.md): Find the cause and the fix for a symptom or an error message.
- Core: For adapter authors
  - [Core](https://use-signalr.vercel.app/docs/core.md): The framework-free package that owns all connection behavior. Read it if you build an adapter for another framework.
  - [Build an adapter](https://use-signalr.vercel.app/docs/core/build-an-adapter.md): The contract between core and a framework adapter, with a minimal adapter sketch and a checklist for a new adapter.
  - Reference
    - [API reference](https://use-signalr.vercel.app/docs/core/reference/api.md): Every export of @dammers/use-signalr-core with its signature.
    - [Configuration reference](https://use-signalr.vercel.app/docs/core/reference/config.md): Every option of the client config, the hub config, the calls, and the provider.
    - [Troubleshooting](https://use-signalr.vercel.app/docs/core/reference/troubleshooting.md): Find the cause and the fix for a symptom or an error message.