Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Dec 26, 2024

update clear cache logic

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #4954

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

Update the tree view to improve scrolling behavior and cache clearing logic.

Enhancements:

  • Improve scrolling to active tree nodes by using scrollIntoView API.
  • Add parent tracking to tree nodes to improve cache clearing logic.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 26, 2024

Reviewer's Guide by Sourcery

This PR refactors the TreeView component to update the clear cache logic and improves scrolling behavior.

Sequence diagram for TreeView cache clearing and scrolling

sequenceDiagram
    participant TV as TreeView
    participant Cache as TreeNodeStateCache
    participant Ext as TreeViewExtensions

    TV->>Cache: Reset()
    Note over TV: Parameters Set
    TV->>Ext: ToFlat(items, parent)
    Note over Ext: Build flat list<br/>with parent refs
    TV->>TV: GetTreeItems()
    Note over TV: Get items from<br/>search or main list
Loading

File-Level Changes

Change Details Files
Updated the ToFlat method to include a parent parameter
  • Added a parent parameter to the ToFlat method to track the parent of each node.
  • Set the Parent property of each tree node.
  • Used the parent parameter in the recursive calls to ToFlat to maintain the parent-child relationship between nodes.
src/BootstrapBlazor/Extensions/TreeViewExtensions.cs
Improved scrolling behavior
  • Added ScrollIntoViewOptions to control scrolling behavior.
  • Used scrollIntoView with options for smooth scrolling and alignment.
  • Updated CSS to support scrolling behavior.
  • Reset TreeNodeStateCache to ensure consistent behavior after clearing the cache.
src/BootstrapBlazor/Options/ScrollIntoViewOptions.cs
src/BootstrapBlazor/Components/TreeView/TreeView.razor.cs
src/BootstrapBlazor/Components/TreeView/TreeView.razor.js
src/BootstrapBlazor/Components/TreeView/TreeView.razor.scss
Updated the clear cache logic
  • Reset TreeNodeStateCache on OnParametersSetAsync to clear the cache when parameters change.
  • Updated Rows property to use GetTreeItems instead of GetItems to ensure the correct items are used after clearing the cache.
src/BootstrapBlazor/Components/TreeView/TreeView.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4954 Update and improve the TreeView cache clearing logic

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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 the enhancement New feature or request label Dec 26, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Dec 26, 2024
@ArgoZhang ArgoZhang enabled auto-merge (squash) December 26, 2024 05:08
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 and they look great!

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 Dec 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (194bdea) to head (2881260).
Report is 665 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main     #4955      +/-   ##
===========================================
+ Coverage   99.96%   100.00%   +0.03%     
===========================================
  Files         584       629      +45     
  Lines       24876     28093    +3217     
  Branches     3600      4035     +435     
===========================================
+ Hits        24867     28093    +3226     
+ Misses          4         0       -4     
+ Partials        5         0       -5     

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

@ArgoZhang ArgoZhang merged commit a24bfe5 into main Dec 26, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-treeview branch December 26, 2024 05:10
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.

refactor(TreeView): update clear cache logic

2 participants