Skip to content

docs(pager): optimize pager demos #3612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 25, 2025
Merged

docs(pager): optimize pager demos #3612

merged 1 commit into from
Jul 25, 2025

Conversation

gimmyhehe
Copy link
Member

@gimmyhehe gimmyhehe commented Jul 25, 2025

PR

分页组件demo优化

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features
    • Updated the default page size for the pager component to 20 and revised available page size options to 10, 20, 50, and 100.
  • Refactor
    • Simplified pager component usage in several demo examples by removing explicit page size and page size options, allowing default values to be used.
  • Tests
    • Adjusted tests to reflect the new default page size of 20.

Copy link

coderabbitai bot commented Jul 25, 2025

Walkthrough

The changes update multiple pager component demo and test files. Default page size values are increased, and available page size options are updated in several demo files. Many explicit page-size and page-sizes bindings are removed, simplifying component usage. Related test files are updated to reflect the new defaults.

Changes

File(s) Change Summary
page-size.vue, page-size-composition-api.vue Default page size changed from 5 to 20; page size options updated; unused imports removed.
pager-in-grid.vue, pager-in-grid-composition-api.vue Explicit page-sizes prop removed from <tiny-pager>; now uses default or no page size options.
popper-append-to-body.vue, popper-append-to-body-composition-api.vue Removed explicit page-size and page-sizes props from <tiny-pager>.
popper-class.vue, popper-class-composition-api.vue Removed explicit page-size and page-sizes props from <tiny-pager>.
page-size.spec.ts Test updated: initial page size changed from 5 to 20; baseline expectations adjusted accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PagerDemo
    participant TinyPager

    User->>PagerDemo: Loads demo page
    PagerDemo->>TinyPager: Renders with new defaults (page size 20, options [10,20,50,100])
    User->>TinyPager: Interacts with pager (change size, navigate)
    TinyPager-->>PagerDemo: Emits events (page change, size change)
    PagerDemo-->>User: Updates display
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

A hop through the fields of code so bright,
Page sizes grew, options took flight!
Less clutter in props, more defaults in play,
The pager’s now simpler in every way.
With every review, a bunny’s delight—
Hopping through changes, all crisp and light!
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

examples/sites/demos/pc/app/pager/page-size-composition-api.vue

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

examples/sites/demos/pc/app/pager/page-size.vue

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

examples/sites/demos/pc/app/pager/page-size.spec.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-vue".

(The package "eslint-plugin-vue" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-vue@latest --save-dev

The plugin "eslint-plugin-vue" was referenced from the config file in ".eslintrc.js » @antfu/eslint-config » @antfu/eslint-config-vue".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

  • 4 others

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch cgm/docs-pager-optimize

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
examples/sites/demos/pc/app/pager/popper-append-to-body.vue (1)

2-2: Trim spaces in layout string to avoid stray tokens.

The current value contains embedded spaces ("sizes,prev, pager, next"). If the component splits on commas without trimming, this may introduce an empty/whitespace token and break the layout parsing. Recommend removing the spaces:

-  <tiny-pager :popper-append-to-body="false" layout="sizes,prev, pager, next" :total="50"></tiny-pager>
+  <tiny-pager :popper-append-to-body="false" layout="sizes,prev,pager,next" :total="50"></tiny-pager>
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 875322c and c3d2678.

⛔ Files ignored due to path filters (2)
  • packages/theme/src/svgs/triangle-down.svg is excluded by !**/*.svg
  • packages/theme/src/svgs/triangle-up.svg is excluded by !**/*.svg
📒 Files selected for processing (9)
  • examples/sites/demos/pc/app/pager/page-size-composition-api.vue (1 hunks)
  • examples/sites/demos/pc/app/pager/page-size.spec.ts (1 hunks)
  • examples/sites/demos/pc/app/pager/page-size.vue (1 hunks)
  • examples/sites/demos/pc/app/pager/pager-in-grid-composition-api.vue (0 hunks)
  • examples/sites/demos/pc/app/pager/pager-in-grid.vue (0 hunks)
  • examples/sites/demos/pc/app/pager/popper-append-to-body-composition-api.vue (1 hunks)
  • examples/sites/demos/pc/app/pager/popper-append-to-body.vue (1 hunks)
  • examples/sites/demos/pc/app/pager/popper-class-composition-api.vue (1 hunks)
  • examples/sites/demos/pc/app/pager/popper-class.vue (1 hunks)
💤 Files with no reviewable changes (2)
  • examples/sites/demos/pc/app/pager/pager-in-grid.vue
  • examples/sites/demos/pc/app/pager/pager-in-grid-composition-api.vue
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: PR E2E Test (pnpm test:e2e3)
🔇 Additional comments (7)
examples/sites/demos/pc/app/pager/popper-class-composition-api.vue (1)

2-2: LGTM! Demo simplification improves focus.

Removing the explicit page-size and page-sizes props allows the component to use default values, making this demo cleaner and more focused on demonstrating the popper-class functionality.

examples/sites/demos/pc/app/pager/popper-append-to-body-composition-api.vue (1)

2-2: LGTM! Demo simplification enhances clarity.

The removal of explicit page-size and page-sizes props streamlines this demo to focus on the popper-append-to-body functionality while using component defaults for pagination settings.

examples/sites/demos/pc/app/pager/popper-class.vue (1)

2-2: Consistent simplification with composition API variant.

This change aligns well with the composition API version of this demo, maintaining consistency across different API styles while focusing on the core popper-class functionality.

examples/sites/demos/pc/app/pager/page-size.vue (2)

2-2: Improved default page size values for better demo experience.

The update from page size 5 to 20 and the revised page size options [10, 20, 50, 100] provide more realistic and practical values for demonstrating pagination functionality.


6-6: Good cleanup of unused import.

Removing the unused TinyModal import improves code cleanliness.

examples/sites/demos/pc/app/pager/page-size.spec.ts (1)

10-10: Test updated to match demo changes.

The update from initPageSize = 5 to initPageSize = 20 correctly aligns the test expectations with the updated default page size in the corresponding demo file.

examples/sites/demos/pc/app/pager/page-size-composition-api.vue (1)

2-2: Demo correctly reflects new defaults – looks good.

The updated page-size and page-sizes align with the global pager demo changes and remove an unused import. No functional issues spotted.

@zzcr zzcr merged commit 6b27c30 into dev Jul 25, 2025
10 of 11 checks passed
@zzcr zzcr deleted the cgm/docs-pager-optimize branch July 25, 2025 07:36
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.

3 participants