Skip to content

feat(TreeView): redesign reset search logic - #8298

Merged
ArgoZhang merged 4 commits into
mainfrom
feat-tw
Aug 5, 2026
Merged

feat(TreeView): redesign reset search logic#8298
ArgoZhang merged 4 commits into
mainfrom
feat-tw

Conversation

@ArgoZhang

@ArgoZhang ArgoZhang commented Aug 5, 2026

Copy link
Copy Markdown
Member

Link issues

fixes #8297

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

Refine TreeView search and reset behavior to support null search terms and maintain active item selection after searches are cleared.

New Features:

  • Add hierarchical search helper for TreeView samples that filters and clones tree nodes while preserving parent-child structure.

Bug Fixes:

  • Ensure TreeView reset search action re-invokes the search callback with a null term to clear results consistently.
  • Prevent search callbacks from returning non-null results on empty search terms in TreeView and SelectTree tests.

Enhancements:

  • Make sample TreeView search item collections non-nullable and improve active item restoration logic when applying search results.
  • Adjust TreeView search callback documentation to describe behavior on search reset.

Tests:

  • Update TreeView and SelectTree unit tests to validate search callbacks are invoked with null on reset and that search counts and results are correct.

@bb-auto bb-auto Bot added the enhancement New feature or request label Aug 5, 2026
@bb-auto bb-auto Bot added this to the v10.9.0 milestone Aug 5, 2026
@sourcery-ai

sourcery-ai Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Redesigns TreeView search/reset behavior to use structured, hierarchical search results and to consistently re-invoke the search callback with null on reset, while simplifying active-item handling and updating tests accordingly.

Sequence diagram for the updated TreeView search and reset logic

sequenceDiagram
    actor User
    participant TreeView
    participant OnSearchAsync

    User->>TreeView: OnClickSearch()
    alt OnSearchAsync is not null
        TreeView->>OnSearchAsync: OnSearchAsync(_searchText)
        OnSearchAsync-->>TreeView: searchItems
        TreeView->>TreeView: _searchItems = searchItems
    else OnSearchAsync is null
        TreeView->>TreeView: _searchItems = null
    end
    TreeView->>TreeView: _rows = null
    alt _activeItem is not null
        TreeView->>TreeView: Rows.FirstOrDefault(match _activeItem.Value)
        alt item found
            TreeView->>TreeView: SetActiveItem(item)
        else item not found
            TreeView->>TreeView: StateHasChanged()
        end
    else _activeItem is null
        TreeView->>TreeView: StateHasChanged()
    end

    User->>TreeView: OnClickResetSearch()
    TreeView->>TreeView: _searchText = null
    TreeView->>TreeView: OnClickSearch()
    note over TreeView,OnSearchAsync: OnSearchAsync is invoked again with null searchText
Loading

File-Level Changes

Change Details Files
Refactor sample TreeView search to perform hierarchical filtering and avoid mutating the original data source.
  • Make sample TreeView MaxItems and SearchItems collections non-nullable and initialized from TreeFoo.GetTreeItems()
  • Change sample OnSearchAsync signature to accept nullable searchText, and delegate filtering to a helper method when search text is provided
  • Introduce GetSearchItems helper that recursively filters tree items by search text, preserving hierarchy and cloning nodes to avoid polluting the source
  • Introduce CloneItem helper to copy TreeViewItem properties while forcing nodes to be expanded in search results
src/BootstrapBlazor.Server/Components/Samples/TreeViews.razor.cs
Adjust TreeView component search/reset behavior to always re-run the search callback and simplify active item restoration.
  • Update OnSearchAsync XML documentation to clarify that it is invoked again with null when search is reset
  • Refactor OnClickSearch to always recompute _searchItems and reset _rows, and to re-select the active item from the new Rows when possible
  • Simplify OnClickResetSearch to clear _searchText and delegate to OnClickSearch so reset goes through the same path and re-invokes OnSearchAsync with null
src/BootstrapBlazor/Components/TreeView/TreeView.razor.cs
Align TreeView and SelectTree tests with new search/reset semantics including null results on empty search and re-invocation counts.
  • Update Enter_Ok and SelectTree OnSearchAsync_Ok tests so their OnSearchAsync callbacks return null when the search term is null or empty, instead of always returning a result
  • Extend Search_NullBranches_Ok test to capture searchCount and searchText in the test callback and assert that search is invoked three times and that the last invocation uses a null search term
test/UnitTest/Components/TreeViewTest.cs
test/UnitTest/Components/SelectTreeTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#8297 Redesign TreeView search reset behavior so that clearing the search reuses the search logic and invokes the search callback with a null search term, updating component state accordingly and documenting this behavior.
#8297 Update TreeView/SelectTree search-related implementations and tests to align with the new reset-search behavior, including handling null/empty search terms and verifying the reset flow.

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 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Auto approved by bb-auto

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've left some high level feedback:

  • In GetSearchItems, consider defensively handling a null item.Items (e.g., iterating over item.Items ?? Enumerable.Empty<TreeViewItem<TreeFoo>>()) to avoid potential NullReferenceExceptions when a node has no children collection initialized.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In `GetSearchItems`, consider defensively handling a null `item.Items` (e.g., iterating over `item.Items ?? Enumerable.Empty<TreeViewItem<TreeFoo>>()`) to avoid potential `NullReferenceException`s when a node has no children collection initialized.

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.

@bb-auto bb-auto Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Auto approved by bb-auto

@ArgoZhang
ArgoZhang merged commit f5c4231 into main Aug 5, 2026
5 checks passed
@ArgoZhang
ArgoZhang deleted the feat-tw branch August 5, 2026 11:50
@codecov

codecov Bot commented Aug 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (d6602d2) to head (2678089).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #8298   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          769       769           
  Lines        34491     34477   -14     
=========================================
- Hits         34491     34477   -14     
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 Harness.
📢 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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): redesign reset search logic

1 participant