feat(ListView): support IsTriggerByPagination parameter

[ArgoZhang]

Link issues

fixes #5505

Summary By Copilot

This pull request introduces several changes to the ListView component and its unit tests, primarily focused on renaming a parameter for pagination and enhancing the query functionality. The most important changes include replacing the Pageable parameter with IsPagination, updating related logic, and modifying unit tests to reflect these changes.

Changes to ListView component:

• src/BootstrapBlazor.Server/Components/Samples/ListViews.razor: Replaced the Pageable parameter with IsPagination in the ListView component.
• src/BootstrapBlazor/Components/ListView/ListView.razor: Updated conditional checks and logic to use IsPagination instead of Pageable.
• src/BootstrapBlazor/Components/ListView/ListView.razor.cs: Deprecated the Pageable parameter, added IsPagination parameter, and updated query methods to include a triggerByPagination flag. [1] [2]

Changes to unit tests:

• test/UnitTest/Components/ListViewTest.cs: Updated unit tests to use IsPagination instead of Pageable, added assertions for triggerByPagination flag, and modified tests to be asynchronous where necessary. [1] [2] [3] [4] [5] [6] [7] [8]

Regression?

• Yes
• No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

• High
• Medium
• Low

[Justify the selection above]

Verification

• Manual (required)
• Automated

Packaging changes reviewed?

• Yes
• No
• N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

• Doc is updated/provided or not needed
• Demo is updated/provided or not needed
• Merge the latest code from the main branch

Summary by Sourcery

Updates the ListView component to use IsPagination instead of the deprecated Pageable parameter for controlling pagination, and adds a triggerByPagination flag to the query methods.

Enhancements:

• Replaces the Pageable parameter with IsPagination in the ListView component and updates related logic.
• Adds a triggerByPagination flag to the query methods to indicate if the query was triggered by pagination.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request renames the Pageable parameter in the ListView component to IsPagination and introduces a IsTriggerByPagination parameter to improve clarity and functionality related to pagination. The changes include updates to the component's logic, related samples, and unit tests to ensure proper behavior with the new parameter.

Updated class diagram for ListView component

classDiagram
  class ListView {
    -bool IsPagination
    -bool Pageable
    +Task QueryAsync(int pageIndex = 1, bool triggerByPagination = false)
    +Task QueryData(bool triggerByPagination = false)
  }
  note for ListView "Pageable is deprecated, use IsPagination instead"

Loading

File-Level Changes

Change	Details	Files
Replaced the Pageable parameter with IsPagination in the ListView component to clarify its purpose.	Deprecated the Pageable parameter. Added the IsPagination parameter. Updated conditional checks to use IsPagination. Updated query methods to include a triggerByPagination flag.	src/BootstrapBlazor/Components/ListView/ListView.razor src/BootstrapBlazor/Components/ListView/ListView.razor.cs src/BootstrapBlazor.Server/Components/Samples/ListViews.razor
Updated unit tests to reflect the parameter renaming and added assertions for the triggerByPagination flag.	Replaced Pageable with IsPagination in the tests. Added assertions for the IsTriggerByPagination flag. Modified tests to be asynchronous where necessary.	test/UnitTest/Components/ListViewTest.cs

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#5505	When ListView has Pageable set to true, the IsPage property of the QueryPageOptions parameter passed to the OnQueryAsync callback should also be true.	❌	The PR renames Pageable to IsPagination but does not ensure that IsPage is true when pagination is enabled. The diff shows that IsPage is set based on the IsPagination property in the QueryData method, but the issue states that IsPage is false when Pageable is true.
#5505	When ListView has Pageable set to true, the PageIndex property of the QueryPageOptions parameter passed to the OnQueryAsync callback should not be 0 on the initial page load.	❌	The PR does not address the issue of PageIndex being 0 on the initial page load. The code changes focus on renaming the Pageable parameter and adding a triggerByPagination flag, but do not modify the initial value of PageIndex.
#5505	Change the ListView query mechanism to be consistent with the Table component, using IDataService.QueryAsync to return paginated results.	❌	The PR does not implement the requested change to use IDataService.QueryAsync. The code changes focus on renaming the Pageable parameter and adding a triggerByPagination flag, but do not modify the query mechanism.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider removing the deprecated Pageable property in a future release.
• Good job on including a triggerByPagination flag to differentiate between pagination and initial queries.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[ArgoZhang]

@sourcery-ai review

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (91eebc2) to head (48082ab).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main     #5513   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          649       649           
  Lines        29563     29566    +3     
  Branches      4165      4165           
=========================================
+ Hits         29563     29566    +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.