Skip to content
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

refactor(AutoFill): add IsLikeMatch/IgnoreCase parameter #5014

Merged
merged 6 commits into from
Jan 1, 2025
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Jan 1, 2025

add IsLikeMatch/IgnoreCase parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #5013

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 IsLikeMatch and IgnoreCase parameters to the AutoFill component to control string matching behavior.

New Features:

  • Added IsLikeMatch parameter to the AutoFill component to enable like/fuzzy matching. When set to true, the component performs a contains search instead of a starts-with search.
  • Added IgnoreCase parameter to the AutoFill component to control case sensitivity during matching.

Copy link

sourcery-ai bot commented Jan 1, 2025

Reviewer's Guide by Sourcery

This pull request adds two new parameters to the AutoFill component: IsLikeMatch and IgnoreCase. These parameters allow developers to control how the component filters items in the dropdown list. The IsLikeMatch parameter determines whether the component uses a "like" match or a "starts with" match when filtering items. The IgnoreCase parameter determines whether the component ignores case when filtering items.

Sequence diagram for AutoFill filtering behavior

sequenceDiagram
    participant User
    participant AutoFill
    participant FilterItems

    User->>AutoFill: Enter text
    AutoFill->>AutoFill: TriggerOnChange(val)
    alt Has CustomFilter
        AutoFill->>AutoFill: OnCustomFilter(val)
    else No CustomFilter
        alt IsLikeMatch is true
            AutoFill->>FilterItems: Filter with Contains
        else IsLikeMatch is false
            AutoFill->>FilterItems: Filter with StartsWith
        end
        Note over AutoFill,FilterItems: Apply IgnoreCase setting
    end
    AutoFill->>AutoFill: Apply DisplayCount limit
    AutoFill-->>User: Show filtered results
Loading

Class diagram for AutoFill component changes

classDiagram
    class AutoFill {
        +bool IsLikeMatch
        +bool IgnoreCase
        +int? DisplayCount
        +List~TValue~ Items
        +List~TValue~ FilterItems
        +TriggerOnChange(string val)
        +OnParametersSet()
    }
    note for AutoFill "IsLikeMatch: Controls if filtering uses Contains or StartsWith
IgnoreCase: Controls case sensitivity of matching"
Loading

File-Level Changes

Change Details Files
Added IsLikeMatch and IgnoreCase parameters to the AutoFill component.
  • Added IsLikeMatch parameter to control whether to use a "like" match or a "starts with" match when filtering items.
  • Added IgnoreCase parameter to control whether to ignore case when filtering items.
  • Updated the TriggerOnChange method to use the IsLikeMatch and IgnoreCase parameters when filtering items.
src/BootstrapBlazor/Components/AutoFill/AutoFill.razor.cs
Updated the AutoFill component to use the new parameters.
  • Updated the OnGetDisplayText_Ok test to verify the functionality of the new parameters.
  • Updated the IgnoreCase_Ok test to verify the functionality of the IgnoreCase parameter.
  • Updated the IsLikeMatch_Ok test to verify the functionality of the IsLikeMatch parameter.
  • Updated the InputGroups sample to use the new parameters.
src/BootstrapBlazor/Components/AutoFill/AutoFill.razor.cs
test/UnitTest/Components/AutoFillTest.cs
src/BootstrapBlazor.Server/Components/Samples/InputGroups.razor
Updated the OnGetDisplayText method to handle null values.
  • Updated the OnGetDisplayText method to handle null values in the Value parameter.
src/BootstrapBlazor/Components/AutoFill/AutoFill.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5013 Add IsLikeMatch parameter to control fuzzy matching behavior
#5013 Add IgnoreCase parameter to control case sensitivity of matching

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.
  • 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 enhancement New feature or request label Jan 1, 2025
@bb-auto bb-auto bot added this to the v9.0.0 milestone Jan 1, 2025
@ArgoZhang ArgoZhang enabled auto-merge (squash) January 1, 2025 10:45
Copy link

@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 and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟢 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.

Copy link

codecov bot commented Jan 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (c9a3d03) to head (3f58891).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5014   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          631       631           
  Lines        27938     27946    +8     
  Branches      3998      4003    +5     
=========================================
+ Hits         27938     27946    +8     

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

@ArgoZhang ArgoZhang merged commit a69614f into main Jan 1, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the doc-fill branch January 1, 2025 10:46
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(AutoFill): add IsLikeMatch/IgnoreCase parameter
1 participant