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

doc(SearchBox): add SearchableColumns parameter #4875

Merged
merged 3 commits into from
Dec 18, 2024
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Dec 17, 2024

add SearchableColumns parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #4874

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:

  • Introduce a new parameter 'SearchableColumns' to the MeiliSearchBox component, allowing specification of columns to be searched.

Copy link

sourcery-ai bot commented Dec 17, 2024

Reviewer's Guide by Sourcery

The PR adds a SearchableColumns parameter to the MeiliSearchBox component in GlobalSearch.razor, configuring specific columns that can be searched. The implementation defines a list of searchable columns including menu, title, subTitle, and demos-related fields.

Class diagram for GlobalSearch component update

classDiagram
    class GlobalSearch {
        - IStringLocalizer<GlobalSearch> Localizer
        + List~string~ SearchableColumns
    }
    class MeiliSearchBox {
        + string SearchBoxPlaceHolder
        + string SearchStatus
        + string SearchResultPlaceHolder
        + List~string~ SearchableColumns
    }
    GlobalSearch --> MeiliSearchBox: uses
    note for GlobalSearch "SearchableColumns parameter added to specify searchable fields"
Loading

File-Level Changes

Change Details Files
Added SearchableColumns configuration to MeiliSearchBox
  • Added SearchableColumns parameter to MeiliSearchBox component
  • Defined a private property with default searchable columns
  • Configured searchable columns to include menu, title, subTitle, demos.title, and demos.raw
src/BootstrapBlazor.Server/Components/Components/GlobalSearch.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#4874 Add SearchableColumns parameter to SearchBox 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.
  • 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 the enhancement New feature or request label Dec 17, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Dec 17, 2024
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Dec 17, 2024
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 complete the PR template, particularly the Risk assessment and Verification sections, to help reviewers better understand the impact of these changes.
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 Dec 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (a704298) to head (bfd0a05).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4875   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          623       623           
  Lines        27832     27832           
  Branches      3982      3982           
=========================================
  Hits         27832     27832           

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

@ArgoZhang ArgoZhang merged commit 1c48683 into main Dec 18, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-search branch December 18, 2024 01:02
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.

doc(SearchBox): add SearchableColumns parameter
1 participant