Skip to content

Docs/preact add polling guide#10991

Merged
TkDodo merged 2 commits into
TanStack:mainfrom
poetryofcode:docs/preact-add-polling-guide
Jun 27, 2026
Merged

Docs/preact add polling guide#10991
TkDodo merged 2 commits into
TanStack:mainfrom
poetryofcode:docs/preact-add-polling-guide

Conversation

@poetryofcode

@poetryofcode poetryofcode commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

🎯 Changes

✅ 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
    • Added a new Preact guide for polling to the navigation and documentation set.
    • Updated the Preact guide metadata to point to the correct query package.
    • Refreshed the Svelte example to use the current loading state check.

poetryofcode and others added 2 commits June 26, 2026 13:07
`isLoading` is a deprecated alias for `isPending && isFetching` and is
scheduled for removal in the next major version. The overview example
shows a standard (always-enabled) query, so `isPending` is the correct
flag. All other framework overview docs (React, Vue, Angular, Lit,
Preact) already use `isPending`.

Note: `isLoading` is intentionally retained in disabling-queries guides
where it is the right flag for disabled/lazy queries.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The Polling guide existed for React, Vue, Solid, and Angular but was
missing from the Preact docs. Added the ref stub and wired it into
the nav config between Window Focus Refetching and Disabling Queries,
matching the ordering used by all other frameworks.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 26, 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 214213b1-9408-47ff-8fca-21eaf808a219

📥 Commits

Reviewing files that changed from the base of the PR and between e6ad3fc and c205330.

📒 Files selected for processing (3)
  • docs/config.json
  • docs/framework/preact/guides/polling.md
  • docs/framework/svelte/overview.md

📝 Walkthrough

Walkthrough

Adds a new Preact Polling guide entry and navigation link, and updates a Svelte overview example to check query.isPending in the loading branch.

Changes

Framework documentation updates

Layer / File(s) Summary
Preact polling guide and nav
docs/framework/preact/guides/polling.md, docs/config.json
Adds the Preact Polling guide frontmatter and the matching navigation entry under Guides & Concepts.
Svelte pending-state example
docs/framework/svelte/overview.md
Changes the loading branch in the example from query.isLoading to query.isPending.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

I’m a rabbit with a docs-filled cart,
Hop-hopping through the guide-chart!
Polling joined the Preact trail,
Pending paws now never fail 🐰
And Svelte’s example got a quick new heart.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The required template is present, but the Changes section is empty and the checklist/release impact items are not completed. Fill in the Changes section with the actual Preact polling guide update and complete the checklist and release impact selections.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: adding a Preact polling guide.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 Jun 27, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit c205330

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

☁️ Nx Cloud last updated this comment at 2026-06-27 13:48:27 UTC

@TkDodo TkDodo merged commit 661c1af into TanStack:main Jun 27, 2026
8 checks passed
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