diff --git a/.changeset/good-pots-brush.md b/.changeset/good-pots-brush.md new file mode 100644 index 00000000000..b4163808742 --- /dev/null +++ b/.changeset/good-pots-brush.md @@ -0,0 +1,10 @@ +--- +'@tanstack/angular-query-experimental': patch +'@tanstack/preact-query-devtools': patch +'@tanstack/svelte-query-devtools': patch +'@tanstack/react-query-devtools': patch +'@tanstack/solid-query-devtools': patch +'@tanstack/vue-query-devtools': patch +--- + +docs(devtools): align logo, panel, and 'buttonPosition' union descriptions across docs and JSDoc diff --git a/docs/framework/preact/devtools.md b/docs/framework/preact/devtools.md index 951c57cbaac..7305b99dd5e 100644 --- a/docs/framework/preact/devtools.md +++ b/docs/framework/preact/devtools.md @@ -72,7 +72,7 @@ function App() { - Set this `true` if you want the dev tools to default to being open - `buttonPosition?: "top-left" | "top-right" | "bottom-left" | "bottom-right" | "relative"` - Defaults to `bottom-right` - - The position of the Preact Query logo to open and close the devtools panel + - The position of the TanStack logo to open and close the devtools panel - `position?: "top" | "bottom" | "left" | "right"` - Defaults to `bottom` - The position of the Preact Query devtools panel diff --git a/docs/framework/react/devtools.md b/docs/framework/react/devtools.md index 63df459e80c..d4ffa1ee7b9 100644 --- a/docs/framework/react/devtools.md +++ b/docs/framework/react/devtools.md @@ -78,7 +78,7 @@ function App() { - Set this `true` if you want the dev tools to default to being open - `buttonPosition?: "top-left" | "top-right" | "bottom-left" | "bottom-right" | "relative"` - Defaults to `bottom-right` - - The position of the React Query logo to open and close the devtools panel + - The position of the TanStack logo to open and close the devtools panel - If `relative`, the button is placed in the location that you render the devtools. - `position?: "top" | "bottom" | "left" | "right"` - Defaults to `bottom` diff --git a/docs/framework/solid/devtools.md b/docs/framework/solid/devtools.md index 68f6fcf1160..7a4b6677106 100644 --- a/docs/framework/solid/devtools.md +++ b/docs/framework/solid/devtools.md @@ -72,7 +72,7 @@ function App() { - Set this `true` if you want the dev tools to default to being open - `buttonPosition?: "top-left" | "top-right" | "bottom-left" | "bottom-right" | "relative"` - Defaults to `bottom-right` - - The position of the Solid Query logo to open and close the devtools panel + - The position of the TanStack logo to open and close the devtools panel - `position?: "top" | "bottom" | "left" | "right"` - Defaults to `bottom` - The position of the Solid Query devtools panel diff --git a/docs/framework/vue/devtools.md b/docs/framework/vue/devtools.md index add5f8bdbfd..a19f9ad4347 100644 --- a/docs/framework/vue/devtools.md +++ b/docs/framework/vue/devtools.md @@ -67,10 +67,10 @@ import { VueQueryDevtools } from '@tanstack/vue-query-devtools' - Set this `true` if you want the dev tools to default to being open. - `buttonPosition?: "top-left" | "top-right" | "bottom-left" | "bottom-right" | "relative"` - Defaults to `bottom-right`. - - The position of the React Query logo to open and close the devtools panel. + - The position of the TanStack logo to open and close the devtools panel. - `position?: "top" | "bottom" | "left" | "right"` - Defaults to `bottom`. - - The position of the React Query devtools panel. + - The position of the Vue Query devtools panel. - `client?: QueryClient` - Use this to use a custom QueryClient. Otherwise, the one from the nearest context will be used. - `errorTypes?: { name: string; initializer: (query: Query) => TError}` diff --git a/packages/angular-query-experimental/src/devtools/types.ts b/packages/angular-query-experimental/src/devtools/types.ts index 614c6f95fd1..8e533783721 100644 --- a/packages/angular-query-experimental/src/devtools/types.ts +++ b/packages/angular-query-experimental/src/devtools/types.ts @@ -50,7 +50,7 @@ export interface DevtoolsOptions { */ buttonPosition?: DevtoolsButtonPosition /** - * The position of the TanStack Query devtools panel. + * The position of the Angular Query devtools panel. * `top` | `bottom` | `left` | `right` * Defaults to `bottom`. */ diff --git a/packages/preact-query-devtools/src/PreactQueryDevtools.tsx b/packages/preact-query-devtools/src/PreactQueryDevtools.tsx index e8186ccda15..8d1e479bd8b 100644 --- a/packages/preact-query-devtools/src/PreactQueryDevtools.tsx +++ b/packages/preact-query-devtools/src/PreactQueryDevtools.tsx @@ -17,11 +17,13 @@ export interface DevtoolsOptions { initialIsOpen?: boolean /** * The position of the TanStack logo to open and close the devtools panel. + * 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'relative' * Defaults to 'bottom-right'. */ buttonPosition?: DevtoolsButtonPosition /** * The position of the Preact Query devtools panel. + * 'top' | 'bottom' | 'left' | 'right' * Defaults to 'bottom'. */ position?: DevtoolsPosition diff --git a/packages/react-query-devtools/src/ReactQueryDevtools.tsx b/packages/react-query-devtools/src/ReactQueryDevtools.tsx index 959d5a739be..936664f9035 100644 --- a/packages/react-query-devtools/src/ReactQueryDevtools.tsx +++ b/packages/react-query-devtools/src/ReactQueryDevtools.tsx @@ -16,8 +16,8 @@ export interface DevtoolsOptions { */ initialIsOpen?: boolean /** - * The position of the React Query logo to open and close the devtools panel. - * 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' + * The position of the TanStack logo to open and close the devtools panel. + * 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'relative' * Defaults to 'bottom-right'. */ buttonPosition?: DevtoolsButtonPosition diff --git a/packages/solid-query-devtools/src/devtools.tsx b/packages/solid-query-devtools/src/devtools.tsx index 079f8bf95d8..2b441583959 100644 --- a/packages/solid-query-devtools/src/devtools.tsx +++ b/packages/solid-query-devtools/src/devtools.tsx @@ -15,13 +15,13 @@ interface DevtoolsOptions { */ initialIsOpen?: boolean /** - * The position of the React Query logo to open and close the devtools panel. - * 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' + * The position of the TanStack logo to open and close the devtools panel. + * 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'relative' * Defaults to 'bottom-right'. */ buttonPosition?: DevtoolsButtonPosition /** - * The position of the React Query devtools panel. + * The position of the Solid Query devtools panel. * 'top' | 'bottom' | 'left' | 'right' * Defaults to 'bottom'. */ diff --git a/packages/svelte-query-devtools/src/Devtools.svelte b/packages/svelte-query-devtools/src/Devtools.svelte index e80064de68f..d0df767098e 100644 --- a/packages/svelte-query-devtools/src/Devtools.svelte +++ b/packages/svelte-query-devtools/src/Devtools.svelte @@ -16,13 +16,13 @@ */ initialIsOpen?: boolean /** - * The position of the TanStack Query logo to open and close the devtools panel. - * 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' + * The position of the TanStack logo to open and close the devtools panel. + * 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'relative' * Defaults to 'bottom-right'. */ buttonPosition?: DevtoolsButtonPosition /** - * The position of the TanStack Query devtools panel. + * The position of the Svelte Query devtools panel. * 'top' | 'bottom' | 'left' | 'right' * Defaults to 'bottom'. */ diff --git a/packages/vue-query-devtools/src/types.ts b/packages/vue-query-devtools/src/types.ts index bf896240e9e..f45ba725682 100644 --- a/packages/vue-query-devtools/src/types.ts +++ b/packages/vue-query-devtools/src/types.ts @@ -12,13 +12,13 @@ export interface DevtoolsOptions { */ initialIsOpen?: boolean /** - * The position of the React Query logo to open and close the devtools panel. - * 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' + * The position of the TanStack logo to open and close the devtools panel. + * 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'relative' * Defaults to 'bottom-right'. */ buttonPosition?: DevtoolsButtonPosition /** - * The position of the React Query devtools panel. + * The position of the Vue Query devtools panel. * 'top' | 'bottom' | 'left' | 'right' * Defaults to 'bottom'. */