Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Feb 15, 2025

add sample code for ItemTemplate

Summary of the changes (Less than 80 chars)

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

Description

fixes #5373

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 ItemTemplate to the Dropdown component to allow customization of dropdown items. Include a sample code in the documentation to demonstrate its usage. Fix the alignment of dropdown item content within the tooltip.

New Features:

  • Add ItemTemplate property to the Dropdown component to support custom item rendering

Bug Fixes:

  • Fix dropdown item content alignment within the tooltip

Documentation:

  • Add sample code demonstrating the usage of ItemTemplate in Dropdown component

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 15, 2025

Reviewer's Guide by Sourcery

This pull request adds a new sample to the documentation demonstrating the usage of the ItemTemplate feature of the Dropdown component. The implementation involves adding a new demo section with corresponding code and data, as well as modifying the Dropdown component to render the ItemTemplate.

Sequence diagram for rendering Dropdown with ItemTemplate

sequenceDiagram
    participant Dropdown Component
    participant ItemTemplate
    participant Tooltip Component

    Dropdown Component->>ItemTemplate: For each item
    ItemTemplate->>Tooltip Component: Render Tooltip with item data
    Tooltip Component-->>ItemTemplate: Returns rendered item
    ItemTemplate-->>Dropdown Component: Returns rendered item
    Dropdown Component->>Dropdown Component: Display item in dropdown
Loading

Updated class diagram for the Dropdown component

classDiagram
    class Dropdown {
        +RenderFragment ItemTemplate
    }
    Dropdown : +renders items via ItemTemplate
Loading

File-Level Changes

Change Details Files
Added a new sample demonstrating the usage of ItemTemplate within the Dropdown component.
  • Added a new DemoBlock named ItemTemplate to showcase the Dropdown component with a custom ItemTemplate.
  • Created a List<SelectedItem> named ItemTemplateList in the code-behind file to provide data for the Dropdown in the ItemTemplate demo.
  • Modified the Dropdown component to render the ItemTemplate for each item when it is provided.
  • Added styling to align items within the dropdown when a tooltip is present.
src/BootstrapBlazor.Server/Components/Samples/Dropdowns.razor
src/BootstrapBlazor.Server/Components/Samples/Dropdowns.razor.cs
src/BootstrapBlazor/Components/Tooltip/Tooltip.razor.scss
src/BootstrapBlazor/Components/Dropdown/Dropdown.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#5373 Add a Tooltip attribute to the SelectedItem data structure. The PR does not modify the SelectedItem class to include a Tooltip attribute. It only adds sample code for the ItemTemplate feature of the Dropdown component, demonstrating how to use a tooltip within the template.
#5373 Support the Tooltip feature if the Tooltip attribute in SelectedItem is not null. The PR does not implement any logic to check for a Tooltip attribute on SelectedItem and display a tooltip accordingly. It focuses on demonstrating the ItemTemplate with a hardcoded tooltip.
#5373 Add sample code demonstrating the use of tooltips in dropdown items.

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 Feb 15, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Feb 15, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Feb 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 screenshot of the new Dropdown ItemTemplate example to the pull request description.
  • The added CSS rule seems overly specific; consider if a more general rule would suffice.
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.

@codecov
Copy link

codecov bot commented Feb 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (8a5e79c) to head (49d34fc).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5374   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          644       644           
  Lines        29220     29218    -2     
  Branches      4125      4125           
=========================================
- Hits         29220     29218    -2     

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

@ArgoZhang ArgoZhang merged commit 459ea17 into main Feb 15, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-dropdown branch February 15, 2025 15:25
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(SelectedItem): support tooltip

2 participants