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): improved the TriggerChange/TriggerFilter method to update CurrentValue #5531

Merged
merged 3 commits into from
Mar 6, 2025

Conversation

celadaris
Copy link
Collaborator

@celadaris celadaris commented Mar 5, 2025

Link issues

[请在下方 # 后面填写相关 Issue 编号,如 #42]
fixes #5110
fixes #5532

Summary By Copilot

This pull request includes updates to the BootstrapBlazor project, focusing on upgrading the version and improving the AutoComplete component. The most important changes include updating the project version, translating comments and documentation from Chinese to English, and enhancing the TriggerFilter and TriggerChange methods to prevent overwriting user input.

Project version update:

Translations:

Method enhancements:

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

Fixes an issue where the input value in the AutoComplete component was being overwritten during filtering, preventing proper updates and maintaining the correct user input. The fix ensures that the CurrentValue is only updated if the value has actually changed and uses the current input value to prevent overwriting.

Bug Fixes:

  • Fixes an issue where the input value in the AutoComplete component was being overwritten during filtering.
  • Ensures that the CurrentValue is only updated if the value has actually changed to prevent overwriting the user's input.
  • Uses the current input value during filtering to prevent overwriting.

fixes the same problem I was having in issue #5110
Copy link

sourcery-ai bot commented Mar 5, 2025

Reviewer's Guide by Sourcery

This pull request addresses an issue where the input value in the AutoComplete component was being overwritten during filtering and change events. The changes ensure that the current input value is preserved and only updated when necessary, preventing unexpected behavior.

Sequence diagram for TriggerFilter method

sequenceDiagram
    participant AutoComplete
    AutoComplete->>AutoComplete: Store current input value
    AutoComplete->>AutoComplete: Filter items based on input value
    AutoComplete->>AutoComplete: Take top DisplayCount items
    AutoComplete->>AutoComplete: Set CurrentValue to currentInputValue
    alt ValueChanged.HasDelegate is false
        AutoComplete->>AutoComplete: StateHasChanged()
    end
Loading

File-Level Changes

Change Details Files
Prevented overwriting the input value in TriggerFilter and TriggerChange methods.
  • Stored the current input value in TriggerFilter to prevent overwriting.
  • Used the stored currentInputValue when setting CurrentValue in TriggerFilter.
  • Added a check in TriggerChange to update CurrentValue only if the value has changed.
src/BootstrapBlazor/Components/AutoComplete/AutoComplete.razor.cs

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

Copy link

bb-auto bot commented Mar 5, 2025

Thanks for your PR, @celadaris. Someone from the team will get assigned to your PR shortly and we'll get it reviewed.

@bb-auto bb-auto bot requested a review from ArgoZhang March 5, 2025 19:53
@bb-auto bb-auto bot added the bug Something isn't working label Mar 5, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Mar 5, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Mar 5, 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 @celadaris - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider extracting the conditional StateHasChanged call into a separate method to improve readability.
  • It looks like TriggerChange and TriggerFilter have very similar logic - could this be refactored?
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.

Copy link

codecov bot commented Mar 5, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (5ddb33d) to head (032815c).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5531   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          649       649           
  Lines        29599     29607    +8     
  Branches      4171      4173    +2     
=========================================
+ Hits         29599     29607    +8     

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

@celadaris
Copy link
Collaborator Author

@microsoft-github-policy-service agree

@bb-auto bb-auto bot added documentation Improvements or additions to documentation Welcome PR Extra attention is needed and removed bug Something isn't working labels Mar 6, 2025
@bb-auto bb-auto bot modified the milestones: v9.2.0, V7.0.0 Mar 6, 2025
@ArgoZhang ArgoZhang changed the title Update AutoComplete.razor.cs refactor(AutoComplete): improved the TriggerChange/TriggerFilter method to update CurrentValue Mar 6, 2025
@ArgoZhang ArgoZhang added enhancement New feature or request and removed documentation Improvements or additions to documentation Welcome PR Extra attention is needed labels Mar 6, 2025
@bb-auto bb-auto bot added documentation Improvements or additions to documentation Welcome PR Extra attention is needed and removed enhancement New feature or request labels Mar 6, 2025
@ArgoZhang ArgoZhang merged commit e54e37b into dotnetcore:main Mar 6, 2025
5 checks passed
@ArgoZhang ArgoZhang modified the milestones: V7.0.0, v9.4.0 Mar 6, 2025
@bb-auto bb-auto bot removed the documentation Improvements or additions to documentation label Mar 6, 2025
@bb-auto bb-auto bot added bug Something isn't working and removed Welcome PR Extra attention is needed labels Mar 6, 2025
@bb-auto bb-auto bot modified the milestones: v9.4.0, v9.2.0 Mar 6, 2025
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
2 participants