Skip to content

docs(react-query): document hideDisabledQueries devtools option - #11635

Open
grzdev wants to merge 1 commit into
TanStack:mainfrom
grzdev:docs/react-devtools-hide-disabled-queries
Open

grzdev wants to merge 1 commit into
TanStack:mainfrom
grzdev:docs/react-devtools-hide-disabled-queries

Conversation

@grzdev

@grzdev grzdev commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

🎯 Changes

Document the hideDisabledQueries option for ReactQueryDevtools and ReactQueryDevtoolsPanel in docs/framework/react/devtools.md.

In @tanstack/react-query-devtools, both DevtoolsOptions and DevtoolsPanelOptions support hideDisabledQueries?: boolean to hide disabled queries from the devtools panel, matching the underlying @tanstack/query-devtools implementation.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested code changes locally with pnpm run test:pr, or these tests do not apply to this pull request.
  • I fully understand the code in this pull request, including any code generated with AI assistance.

🚀 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
    • Documented the hideDisabledQueries option for Floating and Embedded modes, which hides disabled queries from the devtools panel when enabled.

@coderabbitai

coderabbitai Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: TanStack/query/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 2b002c4c-495c-473f-a5f0-1faaad3b1475

📥 Commits

Reviewing files that changed from the base of the PR and between b0222f2 and 6ced688.

📒 Files selected for processing (1)
  • docs/framework/react/devtools.md

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.


📝 Walkthrough

Walkthrough

The React devtools documentation adds hideDisabledQueries?: boolean to the Floating Mode and Embedded Mode options. It states that setting the option to true hides disabled queries from the panel.

Changes

Devtools options

Layer / File(s) Summary
Document disabled-query option for both modes
docs/framework/react/devtools.md
The Floating Mode and Embedded Mode options document hideDisabledQueries?: boolean and state that true hides disabled queries from the panel.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Suggested reviewers: dborysov

Merge Risk: ⚪ Minimal · up to 6ced6

The documented option is supported in both modes; no issue identified here prevents merging.

Architecture Summary

Architecture risk: 🔵 Low · up to 6ced6

The change affects 1 system.

Changed systems: docs

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in docs/framework/react/devtools.md: The Floating Mode options add hideDisabledQueries?: boolean and document that setting it to true hides disabled queries from the panel.
  • observed — Modified behavior in docs/framework/react/devtools.md: The Embedded Mode options add the same hideDisabledQueries?: boolean option and behavior description.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Title check ✅ Passed The title clearly and concisely identifies the documented React Query devtools option. It matches the primary change.
Description check ✅ Passed The description explains the documentation change, identifies the affected options, completes the checklist, and marks the change as documentation-only with no release impact.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@sukvvon

sukvvon commented Sep 25, 2026

Copy link
Copy Markdown
Member

@grzdev This prop currently has no effect, since query-devtools only reads the local storage setting. #11638 fixes that, so this should be merged after it.

@sukvvon
sukvvon marked this pull request as draft September 25, 2026 08:23
@grzdev

grzdev commented Sep 25, 2026

Copy link
Copy Markdown
Contributor Author

Sounds good! Thanks for putting together the fix in #11638. Happy to wait and rebase if needed once that lands.

@grzdev
grzdev marked this pull request as ready for review September 27, 2026 01:31

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants