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(AutoComplete): redesign value change logic #5130

Merged
merged 9 commits into from
Jan 16, 2025
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Jan 16, 2025

redesign value change logic

Summary of the changes (Less than 80 chars)

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

Description

link #5110

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

Rename the TriggerOnChange method to TriggerFilter and introduce a new TriggerChange method. Update the AutoComplete component to trigger value changes on the change event instead of the composition event.

New Features:

  • Introduce a new TriggerChange method to the AutoComplete component, which triggers value changes on the change event.

Tests:

  • Update unit tests to reflect the change in the method name from TriggerOnChange to TriggerFilter.

@bb-auto bb-auto bot added the chore This are tasks or bot action label Jan 16, 2025
Copy link

sourcery-ai bot commented Jan 16, 2025

Reviewer's Guide by Sourcery

This PR refactors the AutoComplete component to redesign the value change logic. It renames the TriggerOnChange method to TriggerFilter and introduces a new TriggerChange method. The change event now triggers TriggerChange to update the component's value, while user input triggers TriggerFilter to filter the dropdown items.

Sequence diagram for AutoComplete value change and filter logic

sequenceDiagram
    participant User
    participant Input
    participant AutoComplete
    participant JSRuntime

    Note over AutoComplete: New value change logic

    alt User types in input
        User->>Input: Types text
        Input->>JSRuntime: composition event
        JSRuntime->>AutoComplete: TriggerFilter(value)
        AutoComplete->>AutoComplete: Filter items
        AutoComplete->>AutoComplete: StateHasChanged()
    else User changes value
        User->>Input: Change value
        Input->>JSRuntime: change event
        JSRuntime->>AutoComplete: TriggerChange(value)
        AutoComplete->>AutoComplete: Update CurrentValue
        AutoComplete->>AutoComplete: StateHasChanged()
    end
Loading

Class diagram for AutoComplete component changes

classDiagram
    class AutoComplete {
        -List~string~ FilterItems
        -List~string~ Items
        -List~string~ Rows
        +Task TriggerFilter(string val)
        +Task TriggerChange(string val)
        -Task OnClickItem(string val)
    }
    note for AutoComplete "Split value change logic into
TriggerFilter and TriggerChange"
Loading

File-Level Changes

Change Details Files
Renamed TriggerOnChange to TriggerFilter and introduced TriggerChange.
  • Renamed the TriggerOnChange method to TriggerFilter.
  • Introduced a new TriggerChange method to handle value changes.
  • Updated the JavaScript change event handler to call TriggerChange.
  • Updated unit tests to reflect the method name changes.
src/BootstrapBlazor/Components/AutoComplete/AutoComplete.razor.cs
src/BootstrapBlazor/Components/AutoComplete/AutoComplete.razor.js
test/UnitTest/Components/AutoCompleteTest.cs
Added IsClearable parameter to Cascader component and added a validate button to the Cascaders sample.
  • Added an IsClearable parameter to the Cascader component.
  • Added a validate button to the Cascaders sample to trigger form validation.
src/BootstrapBlazor.Server/Components/Samples/Cascaders.razor
src/BootstrapBlazor.Server/Components/Samples/Cascaders.razor.cs
Added value property to AutoComplete sample.
  • Added a Value property to the AutoComplete sample and bound it to the component.
src/BootstrapBlazor.Server/Components/Samples/AutoCompletes.razor
src/BootstrapBlazor.Server/Components/Samples/AutoCompletes.razor.cs
Updated localization files.
  • Updated localization files to reflect the changes in the samples.
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
Updated project file.
  • Updated the project file to include the changes.
src/BootstrapBlazor/BootstrapBlazor.csproj

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 16, 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 - here's some feedback:

Overall Comments:

  • Please provide a more detailed PR description explaining the motivation behind this refactoring and any potential breaking changes that users should be aware of.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 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.

test/UnitTest/Components/AutoCompleteTest.cs Show resolved Hide resolved
@ArgoZhang ArgoZhang enabled auto-merge (squash) January 16, 2025 11:48
@ArgoZhang ArgoZhang added enhancement New feature or request and removed chore This are tasks or bot action labels Jan 16, 2025
@ArgoZhang ArgoZhang linked an issue Jan 16, 2025 that may be closed by this pull request
@ArgoZhang ArgoZhang disabled auto-merge January 16, 2025 11:54
Copy link

codecov bot commented Jan 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (b149582) to head (817d4bd).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5130   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          634       634           
  Lines        28174     28178    +4     
  Branches      4040      4040           
=========================================
+ Hits         28174     28178    +4     

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

@ArgoZhang ArgoZhang merged commit 3b2af83 into main Jan 16, 2025
6 checks passed
@ArgoZhang ArgoZhang deleted the feat-auto branch January 16, 2025 11:54
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.

bug(AutoComplete): interrupt input cause network delay
1 participant