Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 25, 2025

remove IsAutoClearAfterSearch parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #5204

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 an issue where the search box wasn't cleared after a search when IsAutoClearAfterSearch was set to true.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 25, 2025

Reviewer's Guide by Sourcery

This pull request removes the IsAutoClearAfterSearch parameter from the Search component and refactors the component to remove the logic associated with this parameter. Additionally, it adds TriggerFilter and TriggerChange methods to the PopoverCompleteBase class and overrides them in the Search, AutoComplete, and AutoFill components.

Sequence diagram showing the updated search behavior

sequenceDiagram
    participant U as User
    participant S as Search Component
    participant P as Parent Component
    U->>S: Enter search text
    S->>S: Update _displayText
    U->>S: Click search button
    activate S
    S->>P: OnSearch(_displayText)
    P-->>S: Return search results
    S->>S: Update _filterItems
    S-->>U: Display results
    deactivate S
Loading

Class diagram showing the changes to component hierarchy

classDiagram
    class PopoverCompleteBase {
      +Task TriggerBlur()
      +Task TriggerFilter(string val)*
      +Task TriggerChange(string val)*
      +string? GetInputId()
    }
    class Search {
      -List~TValue~ _filterItems
      -string _displayText
      +Task TriggerFilter(string val)
      +Task TriggerChange(string val)
    }
    class AutoComplete {
      +Task TriggerFilter(string val)
      +Task TriggerChange(string val)
    }
    class AutoFill {
      +Task TriggerFilter(string val)
      +Task TriggerChange(string val)
    }
    PopoverCompleteBase <|-- Search
    PopoverCompleteBase <|-- AutoComplete
    PopoverCompleteBase <|-- AutoFill
    note for PopoverCompleteBase "Added abstract methods TriggerFilter and TriggerChange"
    note for Search "Removed IsAutoClearAfterSearch parameter"
Loading

File-Level Changes

Change Details Files
Removed the IsAutoClearAfterSearch parameter from the Search component.
  • Removed the IsAutoClearAfterSearch property.
  • Removed the logic that clears the search input after a search when IsAutoClearAfterSearch was true.
  • Removed the IsAutoClearAfterSearch parameter from the test case.
  • Removed the IsAutoClearAfterSearch parameter from the sample page.
src/BootstrapBlazor/Components/Search/Search.razor.cs
test/UnitTest/Components/SearchTest.cs
src/BootstrapBlazor.Server/Components/Samples/Searches.razor
Added TriggerFilter and TriggerChange methods to PopoverCompleteBase and overrode them in Search, AutoComplete, and AutoFill components.
  • Added virtual TriggerFilter and TriggerChange methods to PopoverCompleteBase.
  • Overrode TriggerFilter and TriggerChange methods in Search component.
  • Added a test case for TriggerFilter and TriggerChange methods in PopoverCompleteBase.
  • Overrode TriggerFilter and TriggerChange methods in AutoComplete component.
  • Overrode TriggerFilter and TriggerChange methods in AutoFill component.
src/BootstrapBlazor/Components/AutoComplete/PopoverCompleteBase.cs
src/BootstrapBlazor/Components/Search/Search.razor.cs
test/UnitTest/Components/AutoCompleteTest.cs
src/BootstrapBlazor/Components/AutoComplete/AutoComplete.razor.cs
src/BootstrapBlazor/Components/AutoFill/AutoFill.razor.cs
Refactored the Search component to use a private field for FilterItems.
  • Changed FilterItems property to a private field _filterItems.
  • Updated the razor file to use the new private field.
src/BootstrapBlazor/Components/Search/Search.razor.cs
src/BootstrapBlazor/Components/Search/Search.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#5204 Remove the IsAutoClearAfterSearch parameter from the Search 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. 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

@bb-auto bb-auto bot added the enhancement New feature or request label Jan 25, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 25, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jan 25, 2025
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 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (c95a60f) to head (9e68bb6).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5205   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          634       634           
  Lines        28190     28189    -1     
  Branches      4057      4056    -1     
=========================================
- Hits         28190     28189    -1     

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

@ArgoZhang ArgoZhang merged commit c4f78b4 into main Jan 25, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-search branch January 25, 2025 03:38
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.

feat(Search): remove IsAutoClearAfterSearch parameter

2 participants