Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Mar 21, 2025

Link issues

fixes #5672

Summary By Copilot

This pull request includes changes to the BootstrapBlazor project, focusing on version adjustment, improvements to the TreeView component, and cleanup in unit tests. The most important changes are listed below:

Version Adjustment:

  • Updated the project version in src/BootstrapBlazor/BootstrapBlazor.csproj from 9.5.0-beta09 to 9.4.10.

TreeView Component Improvements:

  • Modified the Virtualize component in src/BootstrapBlazor/Components/TreeView/TreeView.razor to use the OverscanCount property instead of a hardcoded value.
  • Updated the TreeView class in src/BootstrapBlazor/Components/TreeView/TreeView.razor.cs:
    • Changed the default RowHeight for virtual scrolling from 38f to 29f.
    • Added a new parameter OverscanCount with a default value of 10 for virtual scrolling.

Unit Test Cleanup:

  • Removed unnecessary Task.Delay calls in the OnCancel_Ok method of test/UnitTest/Components/TimerTest.cs to streamline the test execution. [1] [2]

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

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

Configures the TreeView component's Virtualize component to use the OverscanCount property instead of a hardcoded value, and updates the default RowHeight. Also, this PR removes unnecessary Task.Delay calls in the TimerTest unit tests.

Enhancements:

  • Expose OverscanCount parameter to the TreeView component to allow users to configure the number of items rendered outside of the visible viewport in the Virtualize component.
  • Update the default RowHeight for virtual scrolling in the TreeView component from 38f to 29f.
  • Remove unnecessary Task.Delay calls in the OnCancel_Ok method of TimerTest.cs to streamline test execution.

@bb-auto bb-auto bot added the enhancement New feature or request label Mar 21, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Mar 21, 2025

Reviewer's Guide by Sourcery

This pull request introduces the OverscanCount parameter to the TreeView component, allowing configuration of the number of items rendered outside the visible viewport during virtual scrolling. It also adjusts the default RowHeight and cleans up a unit test by removing unnecessary delays. Additionally, the project version has been updated in the .csproj file.

Updated class diagram for the TreeView component

classDiagram
  class TreeView {
    +bool IsVirtualize
    +float RowHeight
    +int OverscanCount
  }
  note for TreeView "RowHeight default value changed from 38f to 29f\nOverscanCount parameter added with default value of 10"
Loading

File-Level Changes

Change Details Files
Introduced OverscanCount parameter to the TreeView component for virtual scrolling, enhancing performance by allowing developers to configure the number of items rendered outside the visible viewport.
  • Added OverscanCount parameter with a default value of 10.
  • Modified the Virtualize component to use the OverscanCount parameter.
src/BootstrapBlazor/Components/TreeView/TreeView.razor
src/BootstrapBlazor/Components/TreeView/TreeView.razor.cs
Adjusted the default RowHeight in the TreeView component to improve the default rendering.
  • Changed the default RowHeight from 38f to 29f.
src/BootstrapBlazor/Components/TreeView/TreeView.razor.cs
Removed unnecessary delays in a unit test to improve test execution speed and reliability.
  • Removed Task.Delay calls in the OnCancel_Ok method.
test/UnitTest/Components/TimerTest.cs
Adjusted the project version in the .csproj file.
  • Updated the project version from 9.5.0-beta09 to 9.4.10.
src/BootstrapBlazor/BootstrapBlazor.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#5672 Add an OverscanCount parameter to the TreeView component to allow users to configure the number of items rendered outside the visible viewport during virtual scrolling.

Possibly linked issues


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

@bb-auto bb-auto bot added this to the v9.4.0 milestone Mar 21, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

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

Overall Comments:

  • The change to the project version seems out of place; is it intentional?
  • Consider adding a unit test for the new OverscanCount parameter to ensure it functions as expected.
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 ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link

codecov bot commented Mar 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.98%. Comparing base (acb3c9e) to head (fcf82b3).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5673   +/-   ##
=======================================
  Coverage   99.98%   99.98%           
=======================================
  Files         654      654           
  Lines       29690    29691    +1     
  Branches     4216     4216           
=======================================
+ Hits        29687    29688    +1     
  Misses          3        3           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ArgoZhang ArgoZhang merged commit e6d3a6a into main Mar 21, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the test-fill branch March 21, 2025 03:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(TreeView): add OverscanCount parameter

2 participants