Skip to content
10 changes: 10 additions & 0 deletions .changeset/good-pots-brush.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion docs/framework/preact/devtools.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/framework/react/devtools.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion docs/framework/solid/devtools.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/framework/vue/devtools.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}`
Expand Down
2 changes: 1 addition & 1 deletion packages/angular-query-experimental/src/devtools/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
*/
Expand Down
2 changes: 2 additions & 0 deletions packages/preact-query-devtools/src/PreactQueryDevtools.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions packages/react-query-devtools/src/ReactQueryDevtools.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions packages/solid-query-devtools/src/devtools.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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'.
*/
Expand Down
6 changes: 3 additions & 3 deletions packages/svelte-query-devtools/src/Devtools.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -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'.
*/
Expand Down
6 changes: 3 additions & 3 deletions packages/vue-query-devtools/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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'.
*/
Expand Down
Loading