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

fix(AutoComplete): do not show Items when set OnCustomFilter #5053

Merged
merged 2 commits into from
Jan 6, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Jan 6, 2025

do not show Items when set OnCustomFilter

Summary of the changes (Less than 80 chars)

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

Description

fixes #5052

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

Bug Fixes:

  • Fix the unexpected display of AutoComplete items when OnCustomFilter is set.

Copy link

sourcery-ai bot commented Jan 6, 2025

Reviewer's Guide by Sourcery

This pull request fixes a bug where AutoComplete items would still be displayed when a custom filter was set. The fix involves updating the logic for filtering items to consider whether a custom filter is set. If it is set, the items are filtered based on the custom filter. Otherwise, the items are filtered based on the search input. Additionally, the initialization of FilterItems is updated to ensure that it is not unnecessarily reassigned.

Sequence diagram for AutoComplete filtering behavior

sequenceDiagram
    participant User
    participant AC as AutoComplete
    participant Filter as FilterLogic

    User->>AC: Enter text
    AC->>Filter: TriggerOnChange(val)
    alt Has OnCustomFilter
        Filter-->>AC: Use custom filter results
    else No custom filter
        alt Empty input
            Filter-->>AC: Show all items
        else Has input
            alt IsLikeMatch
                Filter-->>AC: Filter items containing value
            else
                Filter-->>AC: Filter items starting with value
            end
        end
    end
    AC-->>User: Display filtered items
Loading

Class diagram for AutoComplete component changes

classDiagram
    class AutoComplete {
        +List<string> Items
        +List<string> FilterItems
        +bool IsLikeMatch
        +bool IgnoreCase
        +Func<string, Task<IEnumerable<string>>> OnCustomFilter
        +OnParametersSet()
        +TriggerOnChange(string val)
    }
    note for AutoComplete "Modified FilterItems initialization
and filtering logic"
Loading

State diagram for AutoComplete filtering states

stateDiagram-v2
    [*] --> Idle
    Idle --> Filtering: User Input
    Filtering --> CustomFiltering: OnCustomFilter Set
    Filtering --> DefaultFiltering: No OnCustomFilter
    DefaultFiltering --> EmptyInput: Input Empty
    DefaultFiltering --> LikeMatch: Input Present & IsLikeMatch
    DefaultFiltering --> StartsWith: Input Present & !IsLikeMatch
    EmptyInput --> ShowAllItems
    LikeMatch --> ShowFilteredItems
    StartsWith --> ShowFilteredItems
    CustomFiltering --> ShowCustomFilteredItems
    ShowAllItems --> Idle
    ShowFilteredItems --> Idle
    ShowCustomFilteredItems --> Idle
Loading

File-Level Changes

Change Details Files
Updated the filtering logic to consider custom filters
  • Added a conditional check for an empty search value to determine whether to use the full items list or filter based on the search input.
  • Modified the filtering logic to use the entire items list when the search value is empty and a custom filter is set.
  • Ensured that the filtering logic correctly applies the IsLikeMatch parameter when a custom filter is not set and the search value is not empty.
src/BootstrapBlazor/Components/AutoComplete/AutoComplete.razor.cs
Initialized the FilterItems property
  • Initialized the FilterItems property to the Items list if it is not null, or to an empty list if Items is null. This ensures that FilterItems is always initialized, preventing potential null reference exceptions.
src/BootstrapBlazor/Components/AutoComplete/AutoComplete.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5052 Do not show Items when OnCustomFilter is set
#5052 Ensure correct filtering behavior for AutoComplete component

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 bug Something isn't working label Jan 6, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 6, 2025
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: 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 changed the title bug(AutoComplete): do not show Items when set OnCustomFilter fix(AutoComplete): do not show Items when set OnCustomFilter Jan 6, 2025
@ArgoZhang ArgoZhang merged commit 2fa34aa into main Jan 6, 2025
2 of 3 checks passed
@ArgoZhang ArgoZhang deleted the fix-auto branch January 6, 2025 10:14
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.

bug(AutoComplete): do not show Items when set OnCustomFilter
1 participant