Skip to content

feat(Tab): add OnToolbarRefreshCallback parameter #5696

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.

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

Merged
merged 5 commits into from
Mar 23, 2025
Merged

feat(Tab): add OnToolbarRefreshCallback parameter #5696

merged 5 commits into from
Mar 23, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Mar 23, 2025

Link issues

fixes #5695

Summary By Copilot

This pull request includes several updates to the Tabs component in the BootstrapBlazor project. The changes focus on adding a new callback method for the toolbar refresh button, updating the localization files, and modifying the unit tests to cover the new functionality.

Enhancements to Tabs Component:

  • New Callback Method:

    • Added a new parameter OnToolbarRefreshCallback to the Tab component to handle the toolbar refresh button click event. (src/BootstrapBlazor/Components/Tab/Tab.razor.cs)
    • Modified the OnRefreshAsync method to invoke OnToolbarRefreshCallback if it is set. (src/BootstrapBlazor/Components/Tab/Tab.razor.cs)
  • Localization Updates:

    • Updated the English localization file to include descriptions for the new OnToolbarRefreshCallback attribute and its behavior. (src/BootstrapBlazor.Server/Locales/en-US.json)
    • Updated the Chinese localization file with similar changes. (src/BootstrapBlazor.Server/Locales/zh-CN.json)
  • Component Samples:

    • Added a section in the Tabs.razor sample file to demonstrate the usage of the new OnToolbarRefreshCallback attribute. (src/BootstrapBlazor.Server/Components/Samples/Tabs.razor)
  • Unit Tests:

    • Enhanced the ShowToolbar_Ok test to verify the functionality of the OnToolbarRefreshCallback attribute. (test/UnitTest/Components/TabTest.cs) [1] [2] [3]

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 a new OnToolbarRefreshCallback parameter to the Tab component, allowing developers to execute custom logic when the toolbar refresh button is clicked.

New Features:

  • Adds OnToolbarRefreshCallback parameter to the Tab component to handle toolbar refresh button clicks.

Tests:

  • Adds a unit test to verify the functionality of the OnToolbarRefreshCallback attribute.

@bb-auto bb-auto bot added the enhancement New feature or request label Mar 23, 2025
Copy link
Contributor

sourcery-ai bot commented Mar 23, 2025

Reviewer's Guide by Sourcery

This pull request introduces the OnToolbarRefreshCallback parameter to the Tab component, enabling developers to execute custom logic when the toolbar refresh button is clicked. The changes include modifications to the Tab component, localization files, component samples, and unit tests to accommodate the new functionality.

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

File-Level Changes

Change Details Files
Added a new OnToolbarRefreshCallback parameter to the Tab component to allow handling of the toolbar refresh button click event.
  • Added OnToolbarRefreshCallback parameter.
  • Modified OnRefreshAsync to invoke the new callback.
src/BootstrapBlazor/Components/Tab/Tab.razor.cs
Updated localization files to include descriptions for the new OnToolbarRefreshCallback attribute and its behavior.
  • Updated the English localization file.
  • Updated the Chinese localization file.
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
Added a section in the Tabs.razor sample file to demonstrate the usage of the new OnToolbarRefreshCallback attribute.
  • Added a description for the Tabs Toolbar.
  • Added a counter to the TabItem.
src/BootstrapBlazor.Server/Components/Samples/Tabs.razor
Enhanced the ShowToolbar_Ok unit test to verify the functionality of the OnToolbarRefreshCallback attribute.
  • Added a check to verify that the callback is executed when the refresh button is clicked.
test/UnitTest/Components/TabTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5695 Add OnToolbarRefreshCallback parameter to the Tab component.
#5695 Update localization files to include descriptions for the new OnToolbarRefreshCallback attribute.
#5695 Add a section in the Tabs.razor sample file to demonstrate the usage of the new OnToolbarRefreshCallback attribute.

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.4.0 milestone Mar 23, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Mar 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 @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a try-catch block around the OnToolbarRefreshCallback invocation to handle potential exceptions.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue 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.

Copy link

codecov bot commented Mar 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5696   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          657       657           
  Lines        29789     29792    +3     
  Branches      4223      4224    +1     
=========================================
+ Hits         29789     29792    +3     

☔ 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 b5fbcfd into main Mar 23, 2025
3 checks passed
@ArgoZhang ArgoZhang deleted the feat-tab branch March 23, 2025 03:34
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(Tab): add OnToolbarRefreshCallback parameter
1 participant