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(ValidateForm): add LabelWidth parameter #5267

Merged
merged 5 commits into from
Feb 1, 2025
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Feb 1, 2025

add LabelWidth parameter

Summary of the changes (Less than 80 chars)

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

Description

fixes #5266

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 a new LabelWidth parameter to the ValidateForm component to control the width of form labels.

@bb-auto bb-auto bot added the enhancement New feature or request label Feb 1, 2025
Copy link

sourcery-ai bot commented Feb 1, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new LabelWidth parameter to the ValidateForm component, allowing users to set the width of labels within the form. This parameter is cascaded down to the EditorForm component.

Class diagram showing ValidateForm and EditorForm relationship with new LabelWidth parameter

classDiagram
    class ValidateForm {
        +bool? DisableAutoSubmitFormByEnter
        +int? LabelWidth
        +IOptions<JsonLocalizationOptions> Options
    }
    class EditorForm {
        +int? LabelWidth
        +OnParametersSet()
    }
    ValidateForm <-- EditorForm : cascades parameters
    note for ValidateForm "Added LabelWidth parameter"
    note for EditorForm "Inherits LabelWidth from ValidateForm"
Loading

File-Level Changes

Change Details Files
Added LabelWidth parameter to ValidateForm component.
  • Added a new parameter LabelWidth of type int? to the ValidateForm component.
  • The LabelWidth parameter allows setting the width of labels within the form.
  • The default value of LabelWidth is null, which means the global CSS variable --bb-row-label-width will be used.
src/BootstrapBlazor/Components/ValidateForm/ValidateForm.razor.cs
Cascaded LabelWidth parameter from ValidateForm to EditorForm.
  • Modified OnParametersSet method in EditorForm to inherit LabelWidth from ValidateForm if not explicitly set.
  • The LabelWidth parameter in EditorForm will now use the value from the parent ValidateForm if it's not set directly on the EditorForm.
src/BootstrapBlazor/Components/EditorForm/EditorForm.razor.cs
Added a unit test for the LabelWidth parameter.
  • Added a new unit test LabelWidth_Ok to verify the functionality of the LabelWidth parameter.
  • The test renders a ValidateForm with a specified LabelWidth and checks if the correct CSS style is applied.
test/UnitTest/Components/EditorFormTest.cs
Added documentation for the LabelWidth parameter.
  • Added a new AttributeItem for the LabelWidth parameter in the GetAttributes method.
  • The documentation includes the parameter name, description, type, and default value.
src/BootstrapBlazor.Server/Components/Samples/ValidateForms.razor.cs
Added localization for the LabelWidth parameter.
  • Added a new localization entry for LabelWidth in both English and Chinese locale files.
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json

Assessment against linked issues

Issue Objective Addressed Explanation
#5266 Add LabelWidth parameter to ValidateForm component
#5266 Ensure LabelWidth can be cascaded to child components like EditorForm
#5266 Update documentation and localization for the new parameter

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.3.0 milestone Feb 1, 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:

  • Please improve the PR description by filling out all relevant sections of the template and providing a clear English description of the purpose and impact of adding the LabelWidth parameter.
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.

Copy link

codecov bot commented Feb 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (3423330) to head (643040c).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5267   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          639       639           
  Lines        28763     28765    +2     
  Branches      4085      4086    +1     
=========================================
+ Hits         28763     28765    +2     

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

@ArgoZhang ArgoZhang merged commit 5f1f7b9 into main Feb 1, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-validate-form branch February 1, 2025 06: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(ValidateForm): add LabelWidth parameter
1 participant