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

QueryDevtoolsContext.ts

47 lines1.3 KB

1import { createContext, useContext } from 'solid-js'
2import type { Query, QueryClient, onlineManager } from '@tanstack/query-core'
3​
4type XPosition = 'left' | 'right'
5type YPosition = 'top' | 'bottom'
6export type DevtoolsPosition = XPosition | YPosition
7export type DevtoolsButtonPosition = `${YPosition}-${XPosition}` | 'relative'
8export type Theme = 'dark' | 'light' | 'system'
9​
10export interface DevtoolsErrorType {
11 /**
12 * The name of the error.
13 */
14 name: string
15 /**
16 * How the error is initialized.
17 */
18 initializer: (query: Query) => Error
20​
21export interface QueryDevtoolsProps {
22 readonly client: QueryClient
23 queryFlavor: string
24 version: string
25 onlineManager: typeof onlineManager
26​
27 buttonPosition?: DevtoolsButtonPosition
28 position?: DevtoolsPosition
29 initialIsOpen?: boolean
30 errorTypes?: Array<DevtoolsErrorType>
31 shadowDOMTarget?: ShadowRoot
32 onClose?: () => unknown
33 hideDisabledQueries?: boolean
34 theme?: Theme
36​
37export const QueryDevtoolsContext = createContext<QueryDevtoolsProps>({
38 client: undefined as unknown as QueryClient,
39 onlineManager: undefined as unknown as typeof onlineManager,
40 queryFlavor: '',
41 version: '',
42 shadowDOMTarget: undefined,
43})
44​
45export function useQueryDevtoolsContext() {
46 return useContext(QueryDevtoolsContext)