Skip to content

docs(react-query, preact-query): use 'button' instead of undefined 'Button' in suspense guide examples - #11390

Merged
sukvvon merged 1 commit into
mainfrom
docs/fix-undefined-button-in-suspense-guide
Sep 4, 2026
Merged

docs(react-query, preact-query): use 'button' instead of undefined 'Button' in suspense guide examples#11390
sukvvon merged 1 commit into
mainfrom
docs/fix-undefined-button-in-suspense-guide

Conversation

@sukvvon

@sukvvon sukvvon commented Sep 4, 2026

Copy link
Copy Markdown
Member

🎯 Changes

The "Resetting Error Boundaries" examples in guides/suspense.md use <Button onClick={...}>Try again</Button>, but Button is never imported or defined — copying the example as-is throws Button is not defined. Replaced with the plain <button> element the rest of the docs' examples consistently use (e.g. disabling-queries.md, mutations.md, paginated-queries.md).

  • docs/framework/react/guides/suspense.md: fixes both occurrences (component-based and hook-based reset examples).
  • docs/framework/preact/guides/suspense.md: the same two occurrences in its ExampleResetComponent/ExampleResetHook override sections (added in docs(preact-query): add 'Suspense' and 'Testing' guides #11377, which inherited the bug from react's original via ref:).

Found while reviewing #11377 for a related issue (#11389).

✅ 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
    • Updated the Preact Suspense guide’s error-boundary examples to use the native HTML <button> element for “Try again” actions.
    • Updated the React Suspense guide’s QueryErrorResetBoundary and useQueryErrorResetBoundary examples with the same native button usage.
    • These documentation examples now provide more consistent, directly applicable markup for retry actions.

@sukvvon sukvvon self-assigned this Sep 4, 2026
@coderabbitai

coderabbitai Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: f06eb1d0-cc72-4171-8808-95c3864caf23

📥 Commits

Reviewing files that changed from the base of the PR and between ec3f992 and 320b448.

📒 Files selected for processing (2)
  • docs/framework/preact/guides/suspense.md
  • docs/framework/react/guides/suspense.md

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


📝 Walkthrough

Walkthrough

The Preact and React Suspense guides replace Button components with native HTML <button> elements in four error-boundary reset examples.

Changes

Suspense guide examples

Layer / File(s) Summary
Native button reset actions
docs/framework/preact/guides/suspense.md, docs/framework/react/guides/suspense.md
Four “Try again” reset actions now use native HTML <button> elements instead of Button components.

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

Merge Risk: ⚪ Minimal · up to 320b4

The React and Preact Suspense guides now use native buttons for all documented error-boundary retry actions, fixing the undefined component examples without changing library behavior. The change is ready to merge.

Suggested reviewers: s-jooyoung, tkdodo

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation-only fix and the replacement of undefined Button components with native button elements in the suspense examples.
Description check ✅ Passed The description explains the problem, lists the affected React and Preact files, documents the motivation, completes the checklist, and identifies the change as having no release impact.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/fix-undefined-button-in-suspense-guide

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.

@nx-cloud

nx-cloud Bot commented Sep 4, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 320b448

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

☁️ Nx Cloud last updated this comment at 2026-09-04 06:36:26 UTC

@pkg-pr-new

pkg-pr-new Bot commented Sep 4, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

npm i https://pkg.pr.new/@tanstack/lit-query@11390

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 320b448

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
react full 11.87 KB (0%)
react minimal 8.84 KB (0%)

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

2 package(s) bumped directly, 23 bumped as dependents.

🟨 Minor bumps

Package Version Reason
@tanstack/svelte-query 6.1.48 → 6.2.0 Changeset
@tanstack/svelte-query-devtools 6.1.48 → 6.2.0 Dependent
@tanstack/svelte-query-persist-client 6.1.48 → 6.2.0 Dependent
@tanstack/vue-query-devtools 6.1.48 → 6.2.0 Dependent

🟩 Patch bumps

Package Version Reason
@tanstack/query-core 5.102.8 → 5.102.9 Changeset
@tanstack/angular-query-experimental 5.102.8 → 5.102.9 Dependent
@tanstack/angular-query-persist-client 5.102.8 → 5.102.9 Dependent
@tanstack/eslint-plugin-query 5.102.8 → 5.102.9 Dependent
@tanstack/lit-query 0.2.20 → 0.2.21 Dependent
@tanstack/preact-query 5.102.8 → 5.102.9 Dependent
@tanstack/preact-query-devtools 5.102.8 → 5.102.9 Dependent
@tanstack/preact-query-persist-client 5.102.8 → 5.102.9 Dependent
@tanstack/query-async-storage-persister 5.102.8 → 5.102.9 Dependent
@tanstack/query-broadcast-client-experimental 5.102.8 → 5.102.9 Dependent
@tanstack/query-devtools 5.102.8 → 5.102.9 Dependent
@tanstack/query-persist-client-core 5.102.8 → 5.102.9 Dependent
@tanstack/query-sync-storage-persister 5.102.8 → 5.102.9 Dependent
@tanstack/react-query 5.102.8 → 5.102.9 Dependent
@tanstack/react-query-devtools 5.102.8 → 5.102.9 Dependent
@tanstack/react-query-next-experimental 5.102.8 → 5.102.9 Dependent
@tanstack/react-query-persist-client 5.102.8 → 5.102.9 Dependent
@tanstack/solid-query 5.102.8 → 5.102.9 Dependent
@tanstack/solid-query-devtools 5.102.8 → 5.102.9 Dependent
@tanstack/solid-query-persist-client 5.102.8 → 5.102.9 Dependent
@tanstack/vue-query 5.102.8 → 5.102.9 Dependent

@sukvvon
sukvvon merged commit fc51e96 into main Sep 4, 2026
9 checks passed
@sukvvon
sukvvon deleted the docs/fix-undefined-button-in-suspense-guide branch September 4, 2026 07:00
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.

1 participant