Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Mar 15, 2025

Link issues

fixes #5634

Summary By Copilot

This pull request introduces a new feature to the Select component, allowing the search box to be fixed within the dropdown. The changes include updates to the component's Razor and C# files, as well as localization files.

New Feature: Fixed Search Box in Dropdown

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

Adds the ability to fix the search box within the dropdown of the Select component. This change introduces a new IsFixedSearch property to control the search box's position.

New Features:

  • Introduces the IsFixedSearch property to the Select component, allowing the search box to be fixed within the dropdown.
  • Adds UI elements and bindings for the IsFixedSearch property in the sample component to demonstrate the new feature.
  • Adds localization strings for the IsFixedSearch property and updates the introduction text for the search box feature in both English and Chinese locales.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Mar 15, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new IsFixedSearch property to the Select component, allowing the search box to be fixed within the dropdown. The changes include updates to the component's Razor and C# files, as well as localization files and CSS styling.

Updated class diagram for the Select component

classDiagram
    class Select {
        +bool IsFixedSearch
        +bool IsEditable
        +bool IsClearable
        +RenderFragment Options
        +RenderFragment DisplayTemplate
        +bool IsVirtualize
        +float RowHeight
        +int OverscanCount
        +string DefaultVirtualizeItemText
        +Func~Task~ OnClearAsync
        +bool DisableItemChangedWhenFirstRender
        +IEnumerable~SelectedItem~ Items
        +RenderFragment~SelectedItem~ ItemTemplate
        +Func~SelectedItem, Task~bool~~ OnBeforeSelectedItemChange
        +Func~SelectedItem, Task~ OnSelectedItemChanged
        +SwalCategory SwalCategory
        +string SwalTitle
        +string SwalContent
        +string SwalFooter
        +object LookupServiceData
        +Func~VirtualizeQueryOption, Task~QueryData~SelectedItem~~~ OnQueryAsync
    }
Loading

File-Level Changes

Change Details Files
Introduced the IsFixedSearch property to the Select component, allowing the search box to be fixed within the dropdown.
  • Added the IsFixedSearch property.
  • Updated the component's Razor file to conditionally render the fixed search box.
  • Updated related methods and properties to support the fixed search box functionality.
  • Added UI elements and bindings for the IsFixedSearch property in the sample component.
  • Added a new private field to manage the state of the IsFixedSearch property in the sample component.
  • Added localization strings for the IsFixedSearch property.
src/BootstrapBlazor/Components/Select/Select.razor
src/BootstrapBlazor/Components/Select/Select.razor.cs
src/BootstrapBlazor.Server/Components/Samples/Selects.razor
src/BootstrapBlazor.Server/Components/Samples/Selects.razor.cs
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
Updated the UI layout and styling for the Select component.
  • Modified the CSS file to include styles for the fixed search box.
  • Adjusted the dropdown menu's max-height when IsFixedSearch is enabled.
src/BootstrapBlazor/Components/Select/Select.razor.scss
src/BootstrapBlazor/Components/Select/Select.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#5634 Redesign the IsFixedSearch UI layout for the Select component.

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 the enhancement New feature or request label Mar 15, 2025
@bb-auto bb-auto bot added this to the v9.4.0 milestone Mar 15, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Mar 15, 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 CSS class to control the visibility of the search input, instead of using the show class directly.
  • The dropdown-menu-body class in the SCSS file could be more generic and reusable.
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.

@ArgoZhang ArgoZhang merged commit d8336a6 into main Mar 15, 2025
3 checks passed
@ArgoZhang ArgoZhang deleted the feat-select branch March 15, 2025 04:15
@codecov
Copy link

codecov bot commented Mar 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (434f507) to head (24d7893).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5635   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          653       653           
  Lines        29342     29343    +1     
  Branches      4180      4182    +2     
=========================================
+ Hits         29342     29343    +1     

☔ 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.

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(Select): redesign IsFixedSearch UI layout

2 participants