Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Feb 12, 2025

add keep toggle/check state function

Summary of the changes (Less than 80 chars)

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

Description

fixes #5352

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

Add the keep toggle/check state function to the TreeView component.

New Features:

  • Preserve the expansion state of TreeView nodes across UI refreshes.

Tests:

  • Added unit tests to verify the node expansion state is maintained.

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

sourcery-ai bot commented Feb 12, 2025

Reviewer's Guide by Sourcery

This pull request adds a new test to verify that toggle and check state are maintained across re-renders, adjusts UI layout in the TreeView sample, and refines the internal logic for handling expanded nodes by considering both explicit children and loaded items.

Sequence diagram for maintaining toggle/check state in TreeView

sequenceDiagram
    actor User
    participant UI as "TreeView UI"
    participant Component as "TreeView Component"
    participant Cache as "State Cache"

    User->>UI: Click toggle/check on a node
    UI->>Component: Trigger OnTreeItemChecked
    Component->>Cache: Check node state (if HasChildren or Items.Any())
    Cache-->>Component: Return preserved state
    Component-->>UI: Render TreeView with maintained check/toggle state

    User->>UI: Click Refresh Button
    UI->>Component: Trigger OnRefresh/OnParametersSetAsync
    Component->>Cache: Retrieve existing state (no reset)
    Component-->>UI: Re-render TreeView with preserved state
Loading

Updated class diagram for TreeView state management

classDiagram
    class TreeView {
      +List<Item> Items
      +bool ShowCheckbox
      +bool AutoCheckChildren
      +bool AutoCheckParent
      +void OnTreeItemChecked()
      +Task OnParametersSetAsync()
      +void OnRefresh()
    }

    class ExpandableNodeCache {
      +Task CheckExpandAsync(TNode node, Func<TNode, Task<IEnumerable<IExpandableItem>>> callback)
      -List<Value> ExpandedNodeCache
    }

    class TreeNode {
      +bool IsExpand
      +bool HasChildren
      +IEnumerable<Item> Items
    }

    TreeView --> "uses" ExpandableNodeCache
    ExpandableNodeCache --> "checks" TreeNode
Loading

File-Level Changes

Change Details Files
Added new unit test to verify keep toggle/check state functionality.
  • Introduced the KeepExpandState_Ok test in the TreeViewTest file.
  • The test manipulates tree items, simulates node expansion clicks, and verifies that node count remains consistent after re-rendering.
  • Test simulates both collapsing and re-loading scenarios to ensure state persistence.
test/UnitTest/Components/TreeViewTest.cs
Modified UI layout in the TreeView sample component.
  • Adjusted the markup in the TreeViews.razor file to wrap checkboxes and buttons inside a single
    with the row and form-inline classes.
  • Ensured better grouping and alignment of form elements for a cleaner UI presentation.
src/BootstrapBlazor.Server/Components/Samples/TreeViews.razor
Enhanced TreeView state persistence logic.
  • Removed the reset call (TreeNodeStateCache.Reset()) from OnParametersSetAsync in TreeView.razor.cs to preserve toggle state across re-renders.
  • Added an additional check in ExpandableNodeCache.cs to verify a node's expanded state by checking both HasChildren and existence of child items.
  • Ensures that nodes with lazily loaded children maintain their expanded status correctly.
src/BootstrapBlazor/Components/TreeView/TreeView.razor.cs
src/BootstrapBlazor/Misc/ExpandableNodeCache.cs
Minimal project file update.
  • Updated the project file to align with the overall changes.
src/BootstrapBlazor/BootstrapBlazor.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#5352 Add a function to keep toggle/check state in TreeView

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.3.0 milestone Feb 12, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Feb 12, 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:

  • Consider adding a comment to explain the purpose of ExpandableNodeCache.CheckExpandAsync.
  • The new test case could benefit from a clearer name that reflects the specific scenario being tested.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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 Feb 12, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (9ee6ea5) to head (3880b09).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5353   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          644       644           
  Lines        29206     29210    +4     
  Branches      4124      4124           
=========================================
+ Hits         29206     29210    +4     

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

@ArgoZhang ArgoZhang merged commit 7b78b81 into main Feb 13, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-treeview branch February 13, 2025 04:29
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 keep toggle/check state function

2 participants