Skip to content

Conversation

@meixger
Copy link

@meixger meixger commented Dec 30, 2025

Add required initialPageParam to useInfiniteQuery in Vue.js guide

🎯 Changes

Align React and Vue.js guides

βœ… 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
    • Updated Vue infinite queries guide to show how to set an explicit initial page for pagination.
    • Clarified example usage for fetching subsequent pages and adjusted the example to rely on the documented initial page behavior so the starting page is explicit and consistent.

✏️ Tip: You can customize this high-level summary in your review settings.

@changeset-bot
Copy link

changeset-bot bot commented Dec 30, 2025

⚠️ No Changeset found

Latest commit: 0e2b0ea

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 30, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 30, 2025

πŸ“ Walkthrough

Walkthrough

Documentation example updated: useInfiniteQuery call now includes initialPageParam: 0; the example query function fetchProjects signature was changed from ({ pageParam = 0 }) to ({ pageParam }). No other behavior or error-handling changes.

Changes

Cohort / File(s) Summary
Documentation example
docs/framework/vue/guides/infinite-queries.md
Add initialPageParam: 0 to useInfiniteQuery options; change example fetchProjects signature to ({ pageParam }) (remove default).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

package: vue-query

Poem

πŸ‡ I nibble pages, one by one,
A zero seed β€” the scroll begun,
Infinite hops across the fields,
Small changes, tiny carrot yields,
πŸ₯•βœ¨

Pre-merge checks

βœ… Passed checks (3 passed)
Check name Status Explanation
Title check βœ… Passed The title accurately describes the main change: adding a missing parameter (initialPageParam) to the Vue infinite queries documentation example.
Description check βœ… Passed The description follows the template structure with all required sections completed: Changes section explains the purpose, Checklist shows contributor compliance, and Release Impact is marked appropriately.
Docstring Coverage βœ… Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

πŸ“œ Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between d619343 and 0e2b0ea.

πŸ“’ Files selected for processing (1)
  • docs/framework/vue/guides/infinite-queries.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/framework/vue/guides/infinite-queries.md

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 and usage tips.

Copy link
Collaborator

@TkDodo TkDodo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line 13 needs to change too:

- const fetchProjects = async ({ pageParam = 0 }) => {
+ const fetchProjects = async ({ pageParam }) => {

@meixger meixger force-pushed the docs-vue-infinite-queries branch from d619343 to 0e2b0ea Compare December 30, 2025 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants