Skip to content

feat(Tab): reduce cascade parameters #5771

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 10 commits into from
Apr 2, 2025
Merged

feat(Tab): reduce cascade parameters #5771

merged 10 commits into from
Apr 2, 2025

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Apr 2, 2025 •
edited by sourcery-ai bot
Loading

Link issues

fixes #5770

Summary By Copilot

This pull request includes significant updates and refactoring to the Layout and Tab components in the BootstrapBlazor library. The changes improve the flexibility and functionality of these components by introducing new templates and refactoring the context menu handling.

Key Changes:

Layout Component:

  • Updated the ToolbarTemplate parameter to use a generic RenderFragment<Tab> type instead of RenderFragment.

Tab Component:

  • Refactored to use RenderFragment<Tab> for several parameters, including ButtonTemplate, ToolbarTemplate, BeforeNavigatorTemplate, and AfterNavigatorTemplate, enhancing type safety and flexibility.
  • Introduced a new RenderTabList method to handle the rendering of tab items and context menus more efficiently. [1] [2]
  • Simplified the context menu rendering by moving it into a separate RenderFragment.
  • Added a new LayoutId property to improve initialization logic.

Styling Updates:

  • Removed unnecessary styles related to tabs and adjusted the layout styles to improve the visual appearance and consistency. [1] [2]
  • Added new styles to support the updated context menu and tab layout. [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

Refactor Tab and Layout components to improve type safety, flexibility, and rendering efficiency by reducing cascade parameters and introducing more generic render fragments

New Features:

  • Updated template parameters to use generic RenderFragment for improved type safety

Enhancements:

  • Simplified context menu rendering by extracting it into a separate render fragment
  • Improved tab item rendering with a new RenderTabList method
  • Optimized initialization logic with a new LayoutId property

@bb-auto bb-auto bot added the enhancement New feature or request label Apr 2, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Apr 2, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request refactors the Tab component to reduce cascade parameters by using RenderFragment<Tab> for templates, improving flexibility and type safety. It also enhances the rendering logic for tab items and context menus, and adjusts related styles for better visual consistency.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated several parameters in the Tab component to use RenderFragment<Tab>, providing more context and flexibility when rendering tab-related content.
  • Changed ButtonTemplate to RenderFragment<Tab>
  • Changed ToolbarTemplate to RenderFragment<Tab>
  • Changed BeforeNavigatorTemplate to RenderFragment<Tab>
  • Changed AfterNavigatorTemplate to RenderFragment<Tab>
 src/BootstrapBlazor/Components/Tab/Tab.razor.cs
Refactored the Tab component to improve the rendering of tab items and context menus.
  • Introduced a new RenderTabList method to encapsulate the rendering logic for tab items and context menus.
  • Moved the context menu rendering into a separate RenderFragment named RenderContextMenu.
  • The context menu is now rendered using the ContextMenuZone component when ShowContextMenu is enabled.
 src/BootstrapBlazor/Components/Tab/Tab.razor
src/BootstrapBlazor/Components/Tab/Tab.razor.cs
Added a LayoutId property to the Tab component to improve the initialization logic.
  • The LayoutId is now passed to the InvokeInitAsync method instead of Layout?.Id.
  • The LayoutId is derived from the Layout property's Id if ShowTabInHeader is true; otherwise, it's null.
 src/BootstrapBlazor/Components/Tab/Tab.razor.cs
Removed unnecessary styles related to tabs and adjusted the layout styles to improve visual appearance and consistency.
  • Removed specific styles for .tabs-item-fix within the card-style tabs.
  • Adjusted the layout styles to remove direct styling of tabs within the layout-main container.
 src/BootstrapBlazor/Components/Tab/Tab.razor.scss
src/BootstrapBlazor/Components/Layout/Layout.razor.scss
Updated the ToolbarTemplate parameter in the Layout component to use a generic RenderFragment<Tab> type.
  • Changed ToolbarTemplate to RenderFragment<Tab>
 src/BootstrapBlazor/Components/Layout/Layout.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5770 Reduce cascade parameters in the Tab 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. 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 this to the v9.5.0 milestone Apr 2, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Apr 2, 2025
View reviewed changes
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 RenderFragment<TValue> overload to RenderTemplate to avoid the need for cascading values.
  • The LayoutId property could be a method instead of a property.
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 b0c29a6 into main Apr 2, 2025
2 checks passed
@ArgoZhang ArgoZhang deleted the refactor-tab branch April 2, 2025 06:39
@codecov
Copy link

codecov bot commented Apr 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (14a1b19) to head (49dfb98).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff            @@
##              main     #5771   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          658       658           
  Lines        29996     30030   +34     
  Branches      4253      4243   -10     
=========================================
+ Hits         29996     30030   +34

☔ 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

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

@ArgoZhang ArgoZhang

Labels

enhancement New feature or request

Projects

None yet

Milestone

v9.5.0

Development

Successfully merging this pull request may close these issues.

feat(Tab): reduce cascade parameters

2 participants

@ArgoZhang