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(BootstrapLabelSetting): add BootstrapLabelSetting component #5274

Merged
merged 11 commits into from
Feb 2, 2025

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Feb 2, 2025

add BootstrapLabelSetting component

Summary of the changes (Less than 80 chars)

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

Description

fixes #5273

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

Introduce the BootstrapLabelSetting component to cascade label settings, such as LabelWidth, to child components like BootstrapLabel.

New Features:

  • Add a new component BootstrapLabelSetting which allows cascading label settings to child BootstrapLabel components.

Tests:

  • Add unit tests for the BootstrapLabelSetting component.

Copy link

sourcery-ai bot commented Feb 2, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new BootstrapLabelSetting component that allows setting the label width for child BootstrapLabel components. It also modifies the CssBuilder to support adding styles.

Sequence diagram showing how BootstrapLabel resolves its LabelWidth

sequenceDiagram
    participant BL as BootstrapLabel
    participant BLS as BootstrapLabelSetting
    participant CB as CssBuilder
    BL->>BL: OnParametersSet()
    alt LabelWidth not set
        BL->>BLS: Get cascading LabelWidth
        BLS-->>BL: Return LabelWidth value
    end
    BL->>CB: AddStyle("--bb-row-label-width", width)
    CB-->>BL: Return style string
Loading

File-Level Changes

Change Details Files
Added AddStyle methods to CssBuilder to support adding CSS styles.
  • Added AddStyle(string key, string? value) to add a raw style string.
  • Added AddStyle(string key, string? value, bool when = true) to add a style conditionally.
  • Added AddStyle(string key, string? value, Func<bool> when) to add a style conditionally based on a function.
  • Added AddStyle(string key, Func<string?> value, bool when = true) to add a style conditionally based on a function that returns a string.
  • Added AddStyle(string key, Func<string?> value, Func<bool> when) to add a style conditionally based on a function that returns a string and a condition function.
  • Added AddStyle(CssBuilder builder, bool when = true) to add a style from a CssBuilder conditionally.
  • Added AddStyle(CssBuilder builder, Func<bool> when) to add a style from a CssBuilder conditionally based on a function.
  • Added unit tests for the new AddStyle methods.
src/BootstrapBlazor/Utils/CssBuilder.cs
test/UnitTest/Utils/CssBuilderTest.cs
Created a new BootstrapLabelSetting component to provide a cascading label width.
  • Created BootstrapLabelSetting component with a LabelWidth parameter.
  • The component uses CascadingValue to provide the LabelWidth to child components.
  • Added a razor file for the component.
src/BootstrapBlazor/Components/Label/BootstrapLabelSetting.razor.cs
src/BootstrapBlazor/Components/Label/BootstrapLabelSetting.razor
Modified BootstrapLabel to use the new BootstrapLabelSetting component and CssBuilder.
  • Added a CascadingParameter to receive the BootstrapLabelSetting.
  • Modified the StyleString property to use AddStyle instead of AddClass.
  • The LabelWidth is now obtained from the BootstrapLabelSetting if available.
  • Added unit tests for the new BootstrapLabelSetting component.
src/BootstrapBlazor/Components/Label/BootstrapLabel.razor.cs
test/UnitTest/Components/BootstrapLabelTest.cs
Modified EditorForm and ValidateForm to use AddStyle instead of AddClass.
  • Modified the FormStyleString property in EditorForm to use AddStyle instead of AddClass.
  • Modified the StyleString property in ValidateForm to use AddStyle instead of AddClass.
src/BootstrapBlazor/Components/EditorForm/EditorForm.razor.cs
src/BootstrapBlazor/Components/ValidateForm/ValidateForm.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#5273 Add BootstrapLabelSetting 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 the enhancement New feature or request label Feb 2, 2025
@bb-auto bb-auto bot added this to the v9.3.0 milestone Feb 2, 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 - here's some feedback:

Overall Comments:

  • There's a typo in the test assertions - 'widht' should be 'width' in AddStyle_When test method
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟢 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/Utils/CssBuilder.cs Outdated Show resolved Hide resolved
src/BootstrapBlazor/Utils/CssBuilder.cs Outdated Show resolved Hide resolved
Copy link

codecov bot commented Feb 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.99%. Comparing base (3c07dff) to head (acd3bc4).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5274   +/-   ##
=======================================
  Coverage   99.99%   99.99%           
=======================================
  Files         639      640    +1     
  Lines       28777    28781    +4     
  Branches     4091     4092    +1     
=======================================
+ Hits        28775    28779    +4     
  Partials        2        2           

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

@ArgoZhang ArgoZhang merged commit c33eb02 into main Feb 2, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-label-setting branch February 2, 2025 03:05
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(BootstrapLabelSetting): add BootstrapLabelSetting component
1 participant