Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented May 3, 2025

Link issues

fixes #5950

Summary By Copilot

This pull request introduces a new customizable toolbar template feature for the Table component in the BootstrapBlazor library. It includes updates to the component's Razor file, parameter definitions, styling, and unit tests to support and validate the new functionality.

New Feature: Customizable Toolbar Template

Styling Enhancements

Unit Test Updates

  • Unit Test for Toolbar Template: Updated the TableTest class to include a test case for the new ToolbarTemplate parameter, verifying that the custom toolbar content is rendered correctly. (test/UnitTest/Components/TableTest.cs, test/UnitTest/Components/TableTest.csR563-R567)

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

Add a new customizable toolbar template feature to the Table component, allowing developers to inject custom toolbar content

New Features:

  • Introduce a new ToolbarTemplate parameter for the Table component to enable custom toolbar content

Enhancements:

  • Add CSS styling for the custom toolbar template to ensure proper layout and alignment

Tests:

  • Update unit tests to verify the new ToolbarTemplate functionality

@ArgoZhang ArgoZhang requested a review from Copilot May 3, 2025 08:11
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 3, 2025

Reviewer's Guide

This pull request introduces a ToolbarTemplate parameter to the Table component. It adds a RenderFragment? parameter to Table<TItem>, conditionally renders its content within a new styled div in Table.razor, defines corresponding CSS styles in Table.razor.scss, and updates unit tests in TableTest.cs to validate the new functionality.

Class diagram for Table update

classDiagram
    class `Table<TItem>` {
        +RenderFragment? ToolbarTemplate
    }
    note for `Table<TItem>` "Added ToolbarTemplate parameter (RenderFragment?) to allow custom toolbar content."
Loading

File-Level Changes

Change Details Files
Introduced ToolbarTemplate parameter.
  • Added a RenderFragment? ToolbarTemplate parameter to Table<TItem> to accept custom toolbar content.
src/BootstrapBlazor/Components/Table/Table.razor.Toolbar.cs
Integrated template rendering and styling.
  • Added conditional rendering logic in the Razor file to display the ToolbarTemplate when provided.
  • Added the .table-toolbar-template CSS class to style the container for the custom template.
src/BootstrapBlazor/Components/Table/Table.razor
src/BootstrapBlazor/Components/Table/Table.razor.scss
Updated unit tests.
  • Modified the ShowToolbar_Ok test to pass the new ToolbarTemplate parameter and verify its rendering.
test/UnitTest/Components/TableTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5950 Add a new template to the Table component that allows developers to inject custom content into the toolbar, separate from existing button groups.

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!

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 May 3, 2025
@bb-auto bb-auto bot added this to the v9.6.0 milestone May 3, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces a new customizable toolbar template feature for the Table component to allow developers to inject custom toolbar content. Key changes include:

  • Adding a new RenderFragment? ToolbarTemplate parameter to the table component.
  • Updating the Razor markup to conditionally render the toolbar template.
  • Including unit tests to ensure the toolbar content is rendered as intended.

Reviewed Changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.

File Description
test/UnitTest/Components/TableTest.cs Added assertions for verifying the rendering of toolbar content.
src/BootstrapBlazor/Components/Table/Table.razor.Toolbar.cs Introduced the new ToolbarTemplate parameter with documentation.
src/BootstrapBlazor/Components/Table/Table.razor Updated Razor markup to conditionally render the custom toolbar template.
Files not reviewed (1)
  • src/BootstrapBlazor/Components/Table/Table.razor.scss: Language not supported

sourcery-ai[bot]
sourcery-ai bot previously approved these changes May 3, 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:

  • Consider using a single flex container to manage the layout of the standard toolbar buttons and the new toolbar template, instead of separate floating elements.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Testing: 2 issues found
  • 🟢 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 May 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5951   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          669       669           
  Lines        30555     30559    +4     
  Branches      4348      4349    +1     
=========================================
+ Hits         30555     30559    +4     

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

@ArgoZhang ArgoZhang merged commit 9fccdad into main May 3, 2025
3 checks passed
@ArgoZhang ArgoZhang deleted the feat-table branch May 3, 2025 08:15
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(Table): 工具栏中间增加内容模板

2 participants