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

feat(Search): add IsClearable parameter #5296

Merged
merged 27 commits into from
Feb 4, 2025
Merged

feat(Search): add IsClearable parameter #5296

merged 27 commits into from
Feb 4, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Feb 4, 2025

add IsClearable parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #5260

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

New Features:

  • Added IsClearable parameter to the Search component. This adds a small clear button within the search input box itself. When clicked, it clears the current search text.

Copy link

sourcery-ai bot commented Feb 4, 2025

Reviewer's Guide by Sourcery

This pull request adds the IsClearable parameter to the Search component, allowing users to add a clear button to the search input field. It also adds IconTemplate, ButtonTemplate, and PrefixButtonTemplate parameters for customizing the search component.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added IsClearable parameter to the Search component.
  • Added IsClearable property to Search.razor.cs
  • Added ClearIcon property to Search.razor.cs
  • Added logic to display clear icon in Search.razor when IsClearable is true
  • Added a test case for IsClearable in SearchTest.cs
src/BootstrapBlazor/Components/Search/Search.razor
src/BootstrapBlazor/Components/Search/Search.razor.cs
test/UnitTest/Components/SearchTest.cs
Added IconTemplate, ButtonTemplate, and PrefixButtonTemplate parameters for customizing the search component.
  • Added IconTemplate property to Search.razor.cs
  • Added ButtonTemplate property to Search.razor.cs
  • Added PrefixButtonTemplate property to Search.razor.cs
  • Added logic to display IconTemplate, ButtonTemplate, and PrefixButtonTemplate in Search.razor
  • Added a test case for ButtonTemplate and PrefixButtonTemplate in SearchTest.cs
src/BootstrapBlazor/Components/Search/Search.razor
src/BootstrapBlazor/Components/Search/Search.razor.cs
test/UnitTest/Components/SearchTest.cs
Updated the Search component's style to accommodate the new features.
  • Modified the CSS to support the new IsClearable parameter and templates.
src/BootstrapBlazor/Components/Search/Search.razor.scss
Added demo for the new features in the Searches sample.
  • Added demo code for IsClearable
  • Added demo code for IconTemplate
  • Added demo code for ButtonTemplate
  • Added localizations for the new demos
  • Created SearchButtonTemplateDemo component for ButtonTemplate demo
src/BootstrapBlazor.Server/Components/Samples/Searches.razor
src/BootstrapBlazor.Server/Components/Samples/Searches.razor.cs
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
src/BootstrapBlazor.Server/Components/Components/SearchButtonTemplateDemo.razor
src/BootstrapBlazor.Server/Components/Components/SearchButtonTemplateDemo.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5260 Support IsClearable parameter for 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 Feb 4, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Feb 4, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Feb 4, 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.

Copy link

codecov bot commented Feb 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (15fa69e) to head (955968c).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5296   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          642       643    +1     
  Lines        28873     28901   +28     
  Branches      4103      4108    +5     
=========================================
+ Hits         28873     28901   +28     

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

@ArgoZhang ArgoZhang merged commit fff6f06 into main Feb 4, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-search branch February 4, 2025 18:34
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): support IsClearable
1 participant