Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Aug 23, 2025

Link issues

fixes #6672

Summary By Copilot

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 CssClass support for breadcrumb items and prevent rendering when Value is null

New Features:

  • Introduce CssClass property on BreadcrumbItem and apply it in the Breadcrumb component

Bug Fixes:

  • Default the Breadcrumb.Value collection to empty to avoid rendering items when Value is null

Enhancements:

  • Rename GetItemClassName to GetItemClassString and adjust CascadingValue nesting in the Breadcrumb markup

Tests:

  • Extend Breadcrumb unit tests to cover CssClass rendering, null Value handling, and AdditionalAttributes support

Copilot AI review requested due to automatic review settings August 23, 2025 09:00
@bb-auto bb-auto bot added the enhancement New feature or request label Aug 23, 2025
@bb-auto bb-auto bot added this to the 9.9.0 milestone Aug 23, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Aug 23, 2025

Reviewer's Guide

This PR enhances the Breadcrumb component by adding a CssClass property to BreadcrumbItem, updating rendering logic to include custom classes and handle null values, and adjusts related markup and tests accordingly.

Class diagram for updated BreadcrumbItem with CssClass property

classDiagram
    class BreadcrumbItem {
        +string Text
        +string? Url
        +string? CssClass
        +BreadcrumbItem(string text, string? url = null, string? cssClass = null)
    }
Loading

Class diagram for updated Breadcrumb component rendering logic

classDiagram
    class Breadcrumb {
        +IEnumerable<BreadcrumbItem>? Value
        +protected override void OnParametersSet()
        +static string? GetItemClassString(BreadcrumbItem item)
    }
    Breadcrumb --> "*" BreadcrumbItem
Loading

File-Level Changes

Change Details Files
Added CssClass support to BreadcrumbItem
  • Replaced default ctor with primary constructor including cssClass parameter
  • Initialized CssClass property and updated Text/Url initializers
  • Removed old constructor overload and adjusted XML docs
src/BootstrapBlazor/Components/Breadcrumb/BreadcrumbItem.cs
Updated Breadcrumb component logic for item classes and null safety
  • Renamed GetItemClassName to GetItemClassString and added item.CssClass
  • Added NotNull attribute and OnParametersSet override to default Value to empty
  • Adjusted aria-current removal in RenderItem fragment
src/BootstrapBlazor/Components/Breadcrumb/Breadcrumb.razor.cs
src/BootstrapBlazor/Components/Breadcrumb/Breadcrumb.razor
Refactored markup structure in Breadcrumb.razor
  • Moved CascadingValue inside
      with IsFixed=true
    1. Updated li class binding to use new GetItemClassString
    2. Cleaned up closing tags and whitespace
src/BootstrapBlazor/Components/Breadcrumb/Breadcrumb.razor
Enhanced Breadcrumb unit tests for CssClass and null Value
  • Asserted presence of custom class in rendered markup
  • Tested absence of
  • when Value is set to null
  • Verified AdditionalAttributes passthrough
test/UnitTest/Components/BreadcrumbsTest.cs
Applied inheritdoc to Button OnAfterRenderAsync
  • Replaced explicit XML comments with
src/BootstrapBlazor/Components/Button/Button.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#6672 Add a CssClass property to the BreadcrumbItem class.
#6672 Update Breadcrumb rendering logic to use the CssClass property for custom CSS classes on breadcrumb items.
#6672 Add or update tests to verify that the CssClass property works as intended in BreadcrumbItem.

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

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 adds a CssClass property to the BreadcrumbItem class to allow custom CSS styling of individual breadcrumb items. The changes modernize the class using C# primary constructor syntax and update the rendering logic to apply the custom CSS classes.

  • Converts BreadcrumbItem to use C# primary constructor with CssClass parameter
  • Updates breadcrumb rendering to include custom CSS classes in the output
  • Adds tests to verify the CssClass functionality works correctly

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
BreadcrumbItem.cs Converts to primary constructor and adds CssClass property
Breadcrumb.razor.cs Updates rendering method and adds null initialization for Value property
Breadcrumb.razor Updates template to use new CSS class method and fixes CascadingValue placement
BreadcrumbsTest.cs Adds test cases for the new CssClass functionality
Button.razor.cs Updates documentation comment to use inheritdoc

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

sourcery-ai[bot]
sourcery-ai bot previously approved these changes Aug 23, 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 there - I've reviewed your changes and they look great!

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `src/BootstrapBlazor/Components/Breadcrumb/Breadcrumb.razor.cs:17` </location>
<code_context>
     /// </summary>
     [Parameter]
-    public IEnumerable<BreadcrumbItem> Value { get; set; } = Enumerable.Empty<BreadcrumbItem>();
+    [NotNull]
+    public IEnumerable<BreadcrumbItem>? Value { get; set; }

-    private string? GetItemClassName(BreadcrumbItem item) => CssBuilder.Default("breadcrumb-item")
</code_context>

<issue_to_address>
The [NotNull] annotation may be redundant due to null-coalescing in OnParametersSet.

Consider removing the [NotNull] attribute, as Value is always assigned a non-null value in OnParametersSet.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
    [Parameter]
    [NotNull]
    public IEnumerable<BreadcrumbItem>? Value { get; set; }
=======
    [Parameter]
    public IEnumerable<BreadcrumbItem>? Value { get; set; }
>>>>>>> REPLACE

</suggested_fix>

### Comment 2
<location> `test/UnitTest/Components/BreadcrumbsTest.cs:39` </location>
<code_context>
         {
             pb.Add(b => b.AdditionalAttributes, new Dictionary<string, object>() { ["tag"] = "tagok" });
         });
+        cut.Contains("tag=\"tagok\"");
+
+        cut.SetParametersAndRender(pb =>
</code_context>

<issue_to_address>
Typo in assertion: should use Assert.Contains instead of cut.Contains.

Replace 'cut.Contains("tag=\"tagok\"")' with 'Assert.Contains("tag=\"tagok\"", cut.Markup)' to properly verify the output in the test.
</issue_to_address>

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 Aug 23, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (54f416c) to head (bb4ce3a).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6673   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          739       739           
  Lines        31707     31698    -9     
  Branches      4460      4462    +2     
=========================================
- Hits         31707     31698    -9     
Flag Coverage Δ
BB 100.00% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

feat(BreadcrumbItem): add CssClass property

2 participants