Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

QueryClientProvider.md

98 lines2.4 KB

1---
2id: QueryClientProvider
3title: QueryClientProvider
4---
5​
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7​
8Defined in: [packages/lit-query/src/QueryClientProvider.ts:62](https://github.com/TanStack/query/blob/main/packages/lit-query/src/QueryClientProvider.ts#L62)
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 }
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 }
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>
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:80](https://github.com/TanStack/query/blob/main/packages/lit-query/src/QueryClientProvider.ts#L80)
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:74](https://github.com/TanStack/query/blob/main/packages/lit-query/src/QueryClientProvider.ts#L74)
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}`.