Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 29, 2025

add ShowSearchButton parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #5238

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

Add a ShowSearchButton parameter to the Search component to control the visibility of the search button and add ShowPrefixIcon and PrefixIcon parameters with a template to customize the prefix icon.

New Features:

  • Added ShowSearchButton parameter to the Search component to control the search button's visibility.

Tests:

  • Added unit tests for the new features.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 29, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new ShowSearchButton parameter to the Search component, allowing users to hide the search button. Additionally, it adds the ability to display a prefix icon within the search input field, with options for a default icon or a custom template.

State diagram for Search component display options

stateDiagram-v2
    [*] --> SearchComponent
    SearchComponent --> WithSearchButton: ShowSearchButton=true
    SearchComponent --> WithoutSearchButton: ShowSearchButton=false
    WithSearchButton --> WithPrefixIcon: ShowPrefixIcon=true
    WithoutSearchButton --> WithPrefixIcon: ShowPrefixIcon=true
    WithPrefixIcon --> DefaultIcon: PrefixIcon set
    WithPrefixIcon --> CustomIcon: PrefixIconTemplate set
Loading

File-Level Changes

Change Details Files
Added ShowSearchButton parameter to control the visibility of the search button.
  • Added ShowSearchButton property to the Search component.
  • Modified the Search.razor file to conditionally render the search button based on the ShowSearchButton parameter.
  • Added a unit test to verify the functionality of the ShowSearchButton parameter.
src/BootstrapBlazor/Components/Search/Search.razor.cs
src/BootstrapBlazor/Components/Search/Search.razor
test/UnitTest/Components/SearchTest.cs
Implemented prefix icon functionality for the Search component.
  • Added ShowPrefixIcon, PrefixIcon, and PrefixIconTemplate parameters to the Search component.
  • Modified the Search.razor file to include a prefix icon container and render the icon or template.
  • Added a unit test to verify the prefix icon functionality.
  • Added scss to style the prefix icon.
  • Added a demo to showcase the prefix icon.
src/BootstrapBlazor/Components/Search/Search.razor.cs
src/BootstrapBlazor/Components/Search/Search.razor
test/UnitTest/Components/SearchTest.cs
src/BootstrapBlazor/wwwroot/scss/theme/bootstrapblazor.scss
src/BootstrapBlazor/wwwroot/scss/components.scss
src/BootstrapBlazor/Components/Search/Search.razor.scss
src/BootstrapBlazor.Server/Components/Samples/Searches.razor
src/BootstrapBlazor.Server/Components/Samples/Searches.razor.css

Assessment against linked issues

Issue Objective Addressed Explanation
#5238 Hide the search button
#5238 Add a prefix search icon option
#5238 Make the Search component look like GitHub's top search box

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 29, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Jan 29, 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 - here's some feedback:

Overall Comments:

  • There's an empty catch block added in CultureChooser.razor.cs that could hide important errors. Please either handle the error appropriately or remove this unrelated change from the PR.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (78f2789) to head (44488e2).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5243   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          637       637           
  Lines        28317     28333   +16     
  Branches      4078      4082    +4     
=========================================
+ Hits         28317     28333   +16     

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

@ArgoZhang ArgoZhang merged commit cfa0597 into main Jan 29, 2025
6 checks passed
@ArgoZhang ArgoZhang deleted the doc-log branch January 29, 2025 12:13
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): add ShowPrefixSearchIcon attribute

2 participants