Skip to content

doc(TreeView): add auto expand after drag sample code #6471

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 5 commits into from
Jul 23, 2025
Merged

Conversation

ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jul 23, 2025

Link issues

fixes #6470

Summary By Copilot

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

Enhance tree view drag-and-drop sample by extending the CascadingTree method with a callback option and updating sample code to auto-expand target nodes after reordering.

New Features:

  • Add an optional callback parameter to the CascadingTree extension to allow custom node handling during tree construction

Enhancements:

  • Update TreeView sample to automatically expand the dropped-into target node when dragging items
  • Simplify sample item labels by removing parenthetical notes

@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Jul 23, 2025
Copy link
Contributor

sourcery-ai bot commented Jul 23, 2025

Reviewer's Guide

Enhance TreeView drag-and-drop sample by adding automatic expansion of target nodes via a new callback in CascadingTree, extend the CascadingTree APIs to support expansion callbacks, and clean up sample item labels.

Sequence diagram for auto-expanding target node after drag-and-drop in TreeView

sequenceDiagram
    actor User
    participant TreeViewComponent
    participant TreeFoo
    participant ExpandableNodeExtensions
    participant TreeViewItem

    User->>TreeViewComponent: Drag and drop node
    TreeViewComponent->>TreeFoo: Call CascadingTree(items, cb)
    TreeFoo->>ExpandableNodeExtensions: Call CascadingTree with callback
    loop For each item
        ExpandableNodeExtensions->>TreeViewItem: Create TreeViewItem
        ExpandableNodeExtensions->>ExpandableNodeExtensions: Recursively call CascadingTree for children
        alt Callback provided
            ExpandableNodeExtensions->>TreeViewItem: Invoke callback (may set IsExpand=true)
        end
    end
    TreeViewComponent->>TreeViewComponent: Set DraggableItems, expand target node
Loading

File-Level Changes

Change Details Files
Add auto-expand logic to the TreeView sample after drag operations
  • Declare a callback to set IsExpand on the target node when dropped as a child
  • Pass the callback into TreeFoo.CascadingTree to apply automatic expansion
src/BootstrapBlazor.Server/Components/Samples/TreeViews.razor.cs
Clean up sample data labels in GetDraggableItems
  • Remove “(Drop inside blocked)” suffix from Item B
  • Remove “(Can not move out)” suffix from Item G
src/BootstrapBlazor.Server/Components/Samples/TreeViews.razor.cs
Extend CascadingTree extension to accept and invoke node callbacks
  • Add optional treeViewItemCallback parameter and invoke it on each TreeViewItem in CascadingTree
  • Update TreeFoo.CascadingTree wrapper to forward the callback to the extension method
src/BootstrapBlazor/Extensions/ExpandableNodeExtensions.cs
src/BootstrapBlazor.Server/Data/TreeFoo.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#6470 Add sample code demonstrating auto-expand of a TreeView node after a drag operation in the documentation or sample project.

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!

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 9.8.0 milestone Jul 23, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jul 23, 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:

  • Remove the unused expandNodeIds variable in OnDragItemEndAsync or integrate it into your expand logic as intended.
  • The expression‐bodied CascadingTree extension uses square brackets around the LINQ query which isn’t valid C#—refactor it into a proper block or return ToList() directly.
  • Since you removed descriptive suffixes like “(Drop inside blocked)” from the sample items, double-check that the sample behavior and labels still accurately reflect any movement restrictions.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Remove the unused `expandNodeIds` variable in OnDragItemEndAsync or integrate it into your expand logic as intended.
- The expression‐bodied CascadingTree extension uses square brackets around the LINQ query which isn’t valid C#—refactor it into a proper block or return `ToList()` directly.
- Since you removed descriptive suffixes like “(Drop inside blocked)” from the sample items, double-check that the sample behavior and labels still accurately reflect any movement restrictions.

## Individual Comments

### Comment 1
<location> `src/BootstrapBlazor.Server/Data/TreeFoo.cs:181` </location>
<code_context>
     /// <param name="items">数据集合</param>
-    public static List<TreeViewItem<TreeFoo>> CascadingTree(IEnumerable<TreeFoo> items) => items.CascadingTree(null, (foo, parent) => foo.ParentId == parent?.Value.Id, foo => new TreeViewItem<TreeFoo>(foo)
+    /// <param name="treeviewItemCallback">节点状态回调方法</param>
+    public static List<TreeViewItem<TreeFoo>> CascadingTree(IEnumerable<TreeFoo> items, Action<TreeViewItem<TreeFoo>>? treeviewItemCallback = null) => items.CascadingTree(null, (foo, parent) => foo.ParentId == parent?.Value.Id, foo => new TreeViewItem<TreeFoo>(foo)
     {
         Text = foo.Text,
         Icon = foo.Icon,
         IsActive = foo.IsActive
-    });
+    }, treeviewItemCallback);
 }
</code_context>

<issue_to_address>
Parameter naming is inconsistent with the extension method.

Please use consistent casing for the parameter name to match the extension method.
</issue_to_address>

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.

Copy link

codecov bot commented Jul 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (e0f10c0) to head (d2a99af).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6471   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          749       749           
  Lines        32364     32366    +2     
  Branches      4572      4573    +1     
=========================================
+ Hits         32364     32366    +2     
Flag Coverage Δ
BB 100.00% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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 fc34c3c into main Jul 23, 2025
6 checks passed
@ArgoZhang ArgoZhang deleted the feat-tree branch July 23, 2025 03:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc(TreeView): add auto expand after drag sample code
1 participant