Open History to see the last commit
1---
2id: QueryClientProvider
3title: QueryClientProvider
4---
5β
6# Class: QueryClientProvider
7β
8Defined in: [packages/lit-query/src/QueryClientProvider.ts:64](https://github.com/TanStack/query/blob/main/packages/lit-query/src/QueryClientProvider.ts#L64)
9β
10Lit element that provides a `QueryClient` to descendant Lit Query
11controllers through Lit context.
12β
13The `client` is a property, not an attribute. When rendering this element in
14a Lit template, bind it with property binding: `.client=${queryClient}`.
15The provider throws if it connects without a client, or if an already
16connected provider has its client cleared.
17β
18This class is not registered as a custom element by the package. Applications
19must register either a subclass or the class itself with
20`customElements.define`.
21β
22## Examples
23β
24```ts
25import { html, LitElement } from 'lit'
26import { QueryClient, QueryClientProvider } from '@tanstack/lit-query'
27β
28const queryClient = new QueryClient()
29β
30class AppQueryProvider extends QueryClientProvider {
31 constructor() {
32 super()
33 this.client = queryClient
34 }
35}
36β
37customElements.define('app-query-provider', AppQueryProvider)
38β
39class AppRoot extends LitElement {
40 render() {
41 return html`<app-query-provider><todos-view></todos-view></app-query-provider>`
42 }
43}
44```
45β
46```ts
47import { html } from 'lit'
48import { QueryClient, QueryClientProvider } from '@tanstack/lit-query'
49β
50const queryClient = new QueryClient()
51β
52customElements.define('query-client-provider', QueryClientProvider)
53β
54const view = html`
55 <query-client-provider .client=${queryClient}>
56 <todos-view></todos-view>
57 </query-client-provider>
58`
59```
60β
61## Extends
62β
63- `LitElement`
64β
65## Constructors
66β
67### Constructor
68β
69```ts
70new QueryClientProvider(): QueryClientProvider;
71```
72β
73Defined in: [packages/lit-query/src/QueryClientProvider.ts:82](https://github.com/TanStack/query/blob/main/packages/lit-query/src/QueryClientProvider.ts#L82)
74β
75#### Returns
76β
77`QueryClientProvider`
78β
79#### Overrides
80β
81```ts
82LitElement.constructor
83```
84β
85## Properties
86β
87### client
88β
89```ts
90client: QueryClient;
91```
92β
93Defined in: [packages/lit-query/src/QueryClientProvider.ts:76](https://github.com/TanStack/query/blob/main/packages/lit-query/src/QueryClientProvider.ts#L76)
94β
95The `QueryClient` provided to descendant controllers and global fallback
96helpers while this provider is connected.
97β
98Bind this as a property in Lit templates with `.client=${queryClient}`.