Skip to content

docs(preact-query/devtools): add missing 'relative' to 'buttonPosition'#10611

Merged
sukvvon merged 1 commit intomainfrom
docs/preact-query-devtools-add-relative-button-position
Apr 29, 2026
Merged

docs(preact-query/devtools): add missing 'relative' to 'buttonPosition'#10611
sukvvon merged 1 commit intomainfrom
docs/preact-query-devtools-add-relative-button-position

Conversation

@sukvvon
Copy link
Copy Markdown
Collaborator

@sukvvon sukvvon commented Apr 29, 2026 •
edited by coderabbitai Bot
Loading

🎯 Changes

Add the missing "relative" value to buttonPosition in the Preact devtools docs to match the actual DevtoolsButtonPosition type exported from @tanstack/query-devtools (which is `${YPosition}-${XPosition}` | 'relative').

This is a follow-up to #10608, which fixed the same omission in the Vue and Solid docs. The Preact docs were missed in that PR.

The other adapters' docs (React, Svelte, Angular) already include "relative".

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm run test:pr.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Preact Query devtools now supports "relative" as an additional button positioning option. This documentation update includes the new positioning mode alongside the existing top-left, top-right, bottom-left, and bottom-right options, providing developers with enhanced flexibility for customizing the devtools interface layout and appearance in their applications.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 29, 2026 •
edited
Loading

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ccad912b-ab1d-40dd-9de4-4935e5e040f9

📥 Commits

Reviewing files that changed from the base of the PR and between 4ef364a and 8f02b65.

📒 Files selected for processing (1)
  • docs/framework/preact/devtools.md
📝 Walkthrough

Walkthrough

The documentation for the Preact Query devtools Floating Mode API is updated to include "relative" as an additional valid positioning option for the buttonPosition configuration parameter, expanding the union of supported positioning modes.

Changes

Cohort / File(s) Summary
Preact Devtools Documentation
docs/framework/preact/devtools.md		 Added "relative" as a valid value for the buttonPosition option in the PreactQueryDevtools configuration.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A button that floats, now relative and free,
No longer bound by corners, it can roam with glee,
Documentation expanded, positioning options bloom,
One small hop, one grand leap through the devtools room!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: adding the missing 'relative' value to 'buttonPosition' in Preact devtools documentation.
Description check ✅ Passed The description includes all required template sections with complete information: detailed changes explaining the context and reasoning, a fully checked checklist, and correct release impact classification.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/preact-query-devtools-add-relative-button-position

Review rate limit: 4/5 reviews remaining, refill in 12 minutes.

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Apr 29, 2026
@nx-cloud
Copy link
Copy Markdown

nx-cloud Bot commented Apr 29, 2026 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 8f02b65

Command Status Duration Result
nx run-many --target=build --exclude=examples/*... ✅ Succeeded <1s View ↗
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 5s View ↗

☁️ Nx Cloud last updated this comment at 2026-04-29 14:39:41 UTC

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 29, 2026

🚀 Changeset Version Preview

No changeset entries found. Merging this PR will not cause a version bump for any packages.

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Apr 29, 2026

More templates

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@10611

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@10611

@tanstack/preact-query

npm i https://pkg.pr.new/@tanstack/preact-query@10611

@tanstack/preact-query-devtools

npm i https://pkg.pr.new/@tanstack/preact-query-devtools@10611

@tanstack/preact-query-persist-client

npm i https://pkg.pr.new/@tanstack/preact-query-persist-client@10611

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@10611

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@10611

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@10611

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@10611

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@10611

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@10611

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@10611

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@10611

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@10611

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@10611

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@10611

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@10611

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@10611

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@10611

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@10611

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@10611

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@10611

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@10611

commit: 8f02b65

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 29, 2026

size-limit report 📦

Path Size
react full 12.1 KB (0%)
react minimal 9.07 KB (0%)

@sukvvon sukvvon self-assigned this Apr 29, 2026
@sukvvon sukvvon merged commit 0694696 into main Apr 29, 2026
10 checks passed
@sukvvon sukvvon deleted the docs/preact-query-devtools-add-relative-button-position branch April 29, 2026 14:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@sukvvon sukvvon

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@sukvvon