Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Mar 15, 2025

Link issues

fixes #5630

Summary By Copilot

This pull request includes various changes to the BootstrapBlazor project, focusing on adding a new property IsFixedSearchWhenSelect and updating XML documentation to use <inheritdoc/> for consistency and clarity. Below are the most important changes:

New Feature Addition:

  • Added a new property IsFixedSearchWhenSelect to the AutoGenerateColumnAttribute, EditorItem, IEditorItem, LookupFilter, TableColumn, and InternalTableColumn classes to allow fixed search box within dropdowns. [1] [2] [3] [4] [5] [6] [7]

XML Documentation Updates:

  • Updated XML documentation in the EditorItem, InternalTableColumn, and TableColumn classes to use <inheritdoc/> for various properties and methods to improve documentation consistency. [1] [2] [3] [4] [5] [6]

Version Update:

  • Updated the project version in BootstrapBlazor.csproj from 9.4.9-beta07 to 9.4.9-beta08.

Localization and Consistency:

  • Changed the language of comments in the EditorItem class from Chinese to English to maintain consistency across the codebase.

Code Refactoring:

  • Refactored the LookupFilter.razor and TableFilter.razor components to include the new IsFixedSearchWhenSelect property for dropdowns. [1] [2]

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

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

Adds the IsFixedSearchWhenSelect property to several classes to allow a fixed search box within dropdowns, and updates XML documentation for consistency.

New Features:

  • Adds the IsFixedSearchWhenSelect property to AutoGenerateColumnAttribute, EditorItem, IEditorItem, LookupFilter, TableColumn, and InternalTableColumn classes to allow a fixed search box within dropdowns.

Tests:

  • Adds a test case for the IsFixedSearchWhenSelect property in AutoGenerateClassTest.cs and TableTest.cs.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Mar 15, 2025

Reviewer's Guide by Sourcery

This pull request introduces the IsFixedSearchWhenSelect property to several components, allowing for a fixed search box within dropdowns. It also updates XML documentation to use <inheritdoc/> for consistency and updates the project version.

Updated class diagram for IEditorItem

classDiagram
    class IEditorItem {
        <<interface>>
        +ShowSearchWhenSelect : bool
        +IsFixedSearchWhenSelect : bool
    }
Loading

Updated class diagram for InternalTableColumn

classDiagram
    class InternalTableColumn {
        +ShowSearchWhenSelect : bool
        +IsFixedSearchWhenSelect : bool
    }
Loading

Updated class diagram for TableColumn

classDiagram
    class TableColumn {
        +ShowSearchWhenSelect : bool
        +IsFixedSearchWhenSelect : bool
    }
Loading

Updated class diagram for AutoGenerateColumnAttribute

classDiagram
    class AutoGenerateColumnAttribute {
        +ShowSearchWhenSelect : bool
        +IsFixedSearchWhenSelect : bool
    }
Loading

File-Level Changes

Change Details Files
Added a new property IsFixedSearchWhenSelect to several classes to allow a fixed search box within dropdowns.
  • Added IsFixedSearchWhenSelect property to AutoGenerateColumnAttribute.
  • Added IsFixedSearchWhenSelect property to EditorItem.
  • Added IsFixedSearchWhenSelect property to IEditorItem.
  • Added IsFixedSearchWhenSelect property to LookupFilter.
  • Added IsFixedSearchWhenSelect property to TableColumn.
  • Added IsFixedSearchWhenSelect property to InternalTableColumn.
src/BootstrapBlazor/Components/Table/InternalTableColumn.cs
src/BootstrapBlazor/Components/EditorForm/EditorItem.cs
src/BootstrapBlazor/Components/Table/TableColumn.cs
src/BootstrapBlazor/Components/Filters/LookupFilter.razor.cs
src/BootstrapBlazor/Attributes/AutoGenerateColumnAttribute.cs
src/BootstrapBlazor/Components/EditorForm/IEditorItem.cs
src/BootstrapBlazor/Components/Filters/LookupFilter.razor
test/UnitTest/Attributes/AutoGenerateClassTest.cs
src/BootstrapBlazor/Components/Filters/TableFilter.razor
src/BootstrapBlazor/Utils/Utility.cs
test/UnitTest/Components/TableTest.cs
test/UnitTest/Extensions/ITableColumnExtensionsTest.cs
src/BootstrapBlazor/Extensions/ITableColumnExtensions.cs
test/UnitTest/Components/EditorFormTest.cs
test/UnitTest/Components/InternalTableColumnTest.cs
Updated XML documentation to use <inheritdoc/> for consistency and clarity.
  • Replaced XML documentation with <inheritdoc/> in EditorItem.
  • Replaced XML documentation with <inheritdoc/> in InternalTableColumn.
  • Replaced XML documentation with <inheritdoc/> in TableColumn.
src/BootstrapBlazor/Components/Table/InternalTableColumn.cs
src/BootstrapBlazor/Components/EditorForm/EditorItem.cs
src/BootstrapBlazor/Components/Table/TableColumn.cs
Refactored LookupFilter.razor and TableFilter.razor components to include the new IsFixedSearchWhenSelect property.
  • Added IsFixedSearch parameter to the Select component in LookupFilter.razor.
  • Passed IsFixedSearchWhenSelect from TableColumn to LookupFilter in TableFilter.razor.
src/BootstrapBlazor/Components/Filters/LookupFilter.razor
src/BootstrapBlazor/Components/Filters/TableFilter.razor
Updated the project version.
  • Updated the project version in BootstrapBlazor.csproj from 9.4.9-beta07 to 9.4.9-beta08.
src/BootstrapBlazor/BootstrapBlazor.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#5630 Implement a feature to fix the search box at the top of the Select dropdown when it is activated, so that it does not disappear when scrolling.

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 Mar 15, 2025
@bb-auto bb-auto bot added this to the v9.4.0 milestone Mar 15, 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:

  • Consider adding a demo page to showcase the new IsFixedSearchWhenSelect feature.
  • The commit includes a version update from 9.4.9-beta07 to 9.4.9-beta08; please ensure this is intentional and follows the project's versioning strategy.
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.

@ArgoZhang ArgoZhang merged commit 7ac44fb into main Mar 15, 2025
4 checks passed
@ArgoZhang ArgoZhang deleted the feat-table branch March 15, 2025 04:49
@codecov
Copy link

codecov bot commented Mar 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d8336a6) to head (879d022).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5636   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          653       653           
  Lines        29343     29368   +25     
  Branches      4182      4183    +1     
=========================================
+ Hits         29343     29368   +25     

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

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.

Table 组件支持 Select 固定搜索栏功能

2 participants