Skip to content
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

feat(Tab): add IsDisabled parameter #5200

Merged
merged 16 commits into from
Jan 24, 2025
Merged

feat(Tab): add IsDisabled parameter #5200

merged 16 commits into from
Jan 24, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Jan 24, 2025

add IsDisabled parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #5198

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

New Features:

  • Added support for disabling individual tabs in a tabset via the IsDisabled parameter on the TabItem component.

Copy link

sourcery-ai bot commented Jan 24, 2025

Reviewer's Guide by Sourcery

This pull request introduces the IsDisabled parameter to the TabItem component, allowing individual tabs to be disabled. It also includes corresponding updates to the Tab component to handle disabled states, and adds a demo for the new functionality.

Class diagram showing TabItem changes with IsDisabled parameter

classDiagram
    class TabItem {
        +bool IsActive
        +bool IsDisabled
        +bool IsCloseable
        +SetActive(bool active)
        +SetDisabled(bool disabled)
        -SetDisabledWithoutRender(bool disabled)
    }
    class Tab {
        +SetDisabledItem(TabItem item, bool disabled)
        -GetClassString(TabItem item)
        -RenderTabItemContent(TabItem item)
    }
    TabItem --> Tab: Uses
    note for TabItem "Added IsDisabled property
and related methods"
    note for Tab "Added support for
disabled state handling"
Loading

State diagram for TabItem states

stateDiagram-v2
    [*] --> Enabled
    Enabled --> Disabled: SetDisabled(true)
    Disabled --> Enabled: SetDisabled(false)
    state Enabled {
        [*] --> Active
        Active --> Inactive: SetActive(false)
        Inactive --> Active: SetActive(true)
    }
    note right of Disabled: Cannot be activated
when disabled
Loading

File-Level Changes

Change Details Files
Added IsDisabled parameter to TabItem component
  • Added IsDisabled property to TabItem.cs.
  • Added SetDisabled and SetDisabledWithoutRender methods to TabItem.cs.
  • Added test cases for IsDisabled functionality in TabTest.cs.
  • Modified Tab.razor to include disabled class.
  • Modified Tab.razor.cs to handle disabled state.
src/BootstrapBlazor/Components/Tab/TabItem.cs
test/UnitTest/Components/TabTest.cs
src/BootstrapBlazor/Components/Tab/Tab.razor
src/BootstrapBlazor/Components/Tab/Tab.razor.cs
Added demo for IsDisabled functionality
  • Added a new demo section to Tabs.razor to showcase the IsDisabled functionality.
  • Added a toggle button to Tabs.razor.cs to control the disabled state of the tab.
  • Created a new component TabItemContentDemo to demonstrate disabling a tab from within its content.
  • Added logic to TabItemContentDemo.razor.cs to disable the parent tab.
src/BootstrapBlazor.Server/Components/Samples/Tabs.razor
src/BootstrapBlazor.Server/Components/Samples/Tabs.razor.cs
src/BootstrapBlazor.Server/Components/Components/TabItemContentDemo.razor
src/BootstrapBlazor.Server/Components/Components/TabItemContentDemo.razor.cs
Updated styling for disabled tabs
  • Added styling for the disabled state of tabs in Tab.razor.scss.
  • Added a new variable for disabled tab opacity in bootstrapblazor.scss.
src/BootstrapBlazor/Components/Tab/Tab.razor.scss
src/BootstrapBlazor/wwwroot/scss/theme/bootstrapblazor.scss

Assessment against linked issues

Issue Objective Addressed Explanation
#5198 Add an IsDisabled parameter to the TabItem component to disable specific tab items
#5198 When a TabItem is disabled, it should be visually greyed out and not clickable
#5198 Ensure that a disabled TabItem cannot be activated when clicked

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 Jan 24, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 24, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jan 24, 2025
Copy link

@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 and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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.

src/BootstrapBlazor/Components/Tab/Tab.razor Show resolved Hide resolved
test/UnitTest/Components/TabTest.cs Show resolved Hide resolved
test/UnitTest/Components/TabTest.cs Show resolved Hide resolved
Copy link

codecov bot commented Jan 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (4dc56bb) to head (9d40569).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5200   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          634       634           
  Lines        28169     28190   +21     
  Branches      4053      4057    +4     
=========================================
+ Hits         28169     28190   +21     

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

# Conflicts:
#	src/BootstrapBlazor/BootstrapBlazor.csproj

Co-Authored-By: EliasIsmail <[email protected]>
@ArgoZhang ArgoZhang merged commit fe4f050 into main Jan 24, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-tabitem branch January 24, 2025 16:21
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 IsDisabled parameter
1 participant