Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 6, 2025

support Items update

Summary of the changes (Less than 80 chars)

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

Description

fixes #5054

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

Update the AutoComplete component to support updating items.

New Features:

  • Add support for updating the items in the AutoComplete component.

Tests:

  • Add tests to verify the updated AutoComplete component.

@bb-auto bb-auto bot added the enhancement New feature or request label Jan 6, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 6, 2025

Reviewer's Guide by Sourcery

This pull request refactors the AutoComplete component to support updating the Items parameter. It changes the initialization logic, filtering behavior, and rendering process to correctly handle changes to the Items.

Sequence diagram for AutoComplete filtering process

sequenceDiagram
    participant User
    participant AC as AutoComplete
    participant Filter as FilterLogic

    User->>AC: Enter text
    AC->>Filter: TriggerOnChange(val)
    alt has OnCustomFilter
        Filter->>Filter: OnCustomFilter(val)
    else empty value
        Filter->>Filter: Reset to Items.ToList()
    else normal filtering
        Filter->>Filter: Apply Contains/StartsWith filter
    end
    Filter-->>AC: Update FilterItems
    AC->>User: Show filtered results
Loading

Class diagram for AutoComplete component changes

classDiagram
    class AutoComplete {
        +List<string> Items
        -List<string> FilterItems
        -List<string> Rows
        +bool IgnoreCase
        +bool IsLikeMatch
        +OnCustomFilter(string)
        +TriggerOnChange(string)
        #OnParametersSet()
        -OnClickItem(string)
    }
    note for AutoComplete "Changed Items initialization and filtering logic"
Loading

State diagram for AutoComplete filtering states

stateDiagram-v2
    [*] --> Initial: Initialize
    Initial --> Filtered: User Input
    Filtered --> CustomFiltered: OnCustomFilter
    Filtered --> ResetFilter: Empty Input
    Filtered --> NormalFilter: Contains/StartsWith
    CustomFiltered --> [*]
    ResetFilter --> [*]
    NormalFilter --> [*]
Loading

File-Level Changes

Change Details Files
Update Item Initialization and Filtering Logic
  • Initialized Items to an empty list if null to avoid null reference exceptions.
  • Added logic to reset FilterItems to the current Items when the input value is empty.
  • Modified filtering logic to use the updated Items when the input is not empty or null.
  • Added a Rows property to encapsulate the logic for determining the items to display in the dropdown based on FilterItems and Items.
src/BootstrapBlazor/Components/AutoComplete/AutoComplete.razor.cs
Modify Dropdown Rendering Logic
  • Updated the dropdown rendering logic to use the Rows property instead of FilterItems to display the correct items.
  • Updated the no data tip display condition to use Rows.Count instead of FilterItems.Count.
src/BootstrapBlazor/Components/AutoComplete/AutoComplete.razor
Update Unit Tests
  • Added tests to verify the filtering behavior when the input value is empty.
  • Added tests to verify the filtering behavior when the input value matches some items.
  • Added tests to verify the filtering behavior when the input value matches only one item.
test/UnitTest/Components/AutoCompleteTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5054 Support Items update functionality in 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 this to the v9.2.0 milestone Jan 6, 2025
@ArgoZhang ArgoZhang enabled auto-merge (squash) January 6, 2025 11:50
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 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.

@codecov
Copy link

codecov bot commented Jan 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (bb08bc6) to head (87df07e).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5055   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          631       631           
  Lines        27964     27969    +5     
  Branches      4008      4010    +2     
=========================================
+ Hits         27964     27969    +5     

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

@ArgoZhang ArgoZhang merged commit 41a0230 into main Jan 6, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the fix-auto-complete branch January 6, 2025 11:52
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(AutoComplete): support Items update

2 participants