Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 20, 2025

redesign search feature

Summary of the changes (Less than 80 chars)

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

Description

fixes #5159

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

Redesign the search feature of the MultiSelect component to improve user experience. Update the search input interaction logic and add a loading icon during searches.

New Features:

  • Display a loading icon while searching in the MultiSelect dropdown.

Tests:

  • No changes

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 20, 2025

Reviewer's Guide by Sourcery

This pull request redesigns the search feature of the MultiSelect component. It introduces a debounce mechanism for the search input, improves keyboard navigation, and enhances the overall user experience.

Class diagram for MultiSelect component changes

classDiagram
    class MultiSelect {
        +string SearchText
        +bool ShowSearch
        +string SearchLoadingIcon
        +Task ConfirmSelectedItem(int index)
        +Task TriggerOnSearch(string searchText)
        +Task ToggleRow(string value)
        -bool _isToggle
    }

    class MultiSelectJS {
        +init(id, invoke, options)
        +dispose(id)
        -onSearch()
        -keydown()
        -shown()
        -scrollIntoView()
    }

    MultiSelect --> MultiSelectJS : uses
    note for MultiSelectJS "Added debounce and
keyboard navigation"
Loading

File-Level Changes

Change Details Files
Implements a debounce mechanism for the search input.
  • Introduces the debounce function from utility.js.
  • Wraps the search input's oninput event with a debounce function to delay the execution of the search logic.
  • Adds a loading indicator while the search is in progress.
src/BootstrapBlazor/Components/Select/MultiSelect.razor.js
Enhances keyboard navigation within the dropdown.
  • Adds keydown event listener to the search input.
  • Implements arrow key navigation to move through the dropdown items.
  • Implements enter key to confirm the selected item.
  • Adds scrollIntoView to keep the selected item in view.
src/BootstrapBlazor/Components/Select/MultiSelect.razor.js
Refactors the component initialization and event handling.
  • Passes callback methods as options during component initialization.
  • Moves the logic for handling the close button click to the popover clickToggle method.
  • Adds shown event to focus the search input when the dropdown is shown.
src/BootstrapBlazor/Components/Select/MultiSelect.razor.js
Updates the component's Razor markup and C# logic.
  • Adds a new SearchClassString property to control the visibility of the search input.
  • Adds a new SearchLoadingIconString property to control the visibility of the loading icon.
  • Adds a new ScrollIntoViewBehaviorString property to control the scroll behavior.
  • Updates the Razor markup to include the new search input and loading icon.
  • Adds ConfirmSelectedItem method to handle the enter key press.
  • Adds TriggerOnSearch method to handle the search input.
src/BootstrapBlazor/Components/Select/MultiSelect.razor.cs
src/BootstrapBlazor/Components/Select/MultiSelect.razor
Minor CSS and JavaScript changes.
  • Removes flex property from mul-select-item class.
  • Updates the Select.razor.js to use strict equality.
  • Updates the Select.razor to use the correct aria-label.
  • Updates the BootstrapBlazor.csproj to include the new files.
src/BootstrapBlazor.Server/Components/Samples/MultiSelects.razor.css
src/BootstrapBlazor/Components/Select/Select.razor.js
src/BootstrapBlazor/Components/Select/Select.razor
src/BootstrapBlazor/BootstrapBlazor.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#5159 Ensure MultiSelect search input is displayed when ShowSearch is set to true
#5159 Enable search functionality to filter items in MultiSelect
#5159 Implement search input behavior in the MultiSelect component

Possibly linked issues

  • MultiSelect search doesn't work #5159: The PR fixes the issue by redesigning the search feature. The PR includes changes to the MultiSelect.razor.js file to handle search functionality and update selected values correctly.
  • MultiSelect search doesn't work #5159: The PR fixes the issue by redesigning the search feature of the MultiSelect component. The changes in MultiSelect.razor.js introduce a debounced search function and improve keyboard navigation, addressing the original issue.

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 bug Something isn't working label Jan 20, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 20, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jan 20, 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 making null checks consistent throughout the code - some places use == while others use ===. Standardize on === for strict equality checks.
  • Add error handling for async operations, particularly around the search functionality, to gracefully handle potential failures.
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 Jan 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5162   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          634       634           
  Lines        28093     28122   +29     
  Branches      4039      4043    +4     
=========================================
+ Hits         28093     28122   +29     

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

@ArgoZhang ArgoZhang merged commit e0f6516 into main Jan 20, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the fix-multiselect branch January 20, 2025 05:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

MultiSelect search doesn't work

2 participants