feat(FormField): add boldLabel prop for InputPromo #1495

JoannaSikora · 2025-01-23T10:59:07Z

Resolves: #1447

Description

This pull request includes changes to the FormField component and its associated stories to introduce a new boldLabel property to be used mainly for the InputPromo component.

Storybook

https://feature-1447--613a8e945a5665003a05113b.chromatic.com

Checklist

Obligatory:

Self review (use this as your final check for proposed changes before requesting the review)
Add correct label
Assign pull request with the correct issue

Summary by CodeRabbit

New Features
- Added an optional boldLabel prop to the FormField component for bold label rendering.
- Introduced a new story demonstrating bold label functionality with promo input.
Bug Fixes
- Updated styles for the label to improve spacing with a variable margin.
Documentation
- Updated Storybook controls to exclude boldLabel control.

coderabbitai · 2025-01-23T10:59:15Z

Walkthrough

The pull request introduces a new boldLabel property to the FormField component, allowing labels to be rendered in bold, specifically designed for promo inputs. Additionally, a new story is added to showcase this functionality in Storybook. The changes enhance the flexibility of label styling while maintaining the existing component structure.

Changes

File	Change Summary
`packages/react-components/src/components/FormField/FormField.tsx`	Added `boldLabel` optional boolean prop to `FormFieldProps` interface
`packages/react-components/src/components/FormField/FormField.stories.tsx`	Added new `BoldLabelWithPromoInput` story demonstrating bold label functionality
`packages/react-components/src/components/FormField/FormField.module.scss`	Updated `margin-bottom` for `.form-field__label` class to use `var(--spacing-1)`

Assessment against linked issues

Objective	Addressed	Explanation
Promo input label style (#1447)	✅

Possibly related PRs

feat(Input): new promo component and tokens update #1441: This PR introduces a new InputPromo component, which is directly related to the changes in the main PR that enhance the FormField component with the InputPromo import and the boldLabel prop.
feat(Typography): new semi-bold variant #1439: Although this PR focuses on adding a semiBold variant to the Text component, the introduction of the boldLabel prop suggests a thematic connection in styling options for text.

Suggested reviewers

VadymBezpalko
vladko-uxds

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

packages/react-components/src/components/FormField/FormField.stories.tsx (1)
105-109: Add description to clarify specialized use case

Consider adding a description to the story explaining that boldLabel is specifically designed for use with InputPromo.
 export const BoldLabelWithPromoInput: StoryFn<FormFieldProps> = () => (
   <FormFieldComponent labelText="Username" boldLabel>
     <ExampleInputPromo />
   </FormFieldComponent>
 );
+BoldLabelWithPromoInput.parameters = {
+  docs: {
+    description: {
+      story: 'This example demonstrates the boldLabel prop, which is specifically designed for use with InputPromo components.',
+    },
+  },
+};

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bf5c0f0 and c841cd9.

📒 Files selected for processing (2)

packages/react-components/src/components/FormField/FormField.stories.tsx (3 hunks)
packages/react-components/src/components/FormField/FormField.tsx (3 hunks)

🔇 Additional comments (6)

packages/react-components/src/components/FormField/FormField.stories.tsx (3)

5-5: LGTM: Import statement is properly organized

26-30: LGTM: Good practice excluding specialized prop from general controls

38-40: LGTM: Example component follows established patterns

packages/react-components/src/components/FormField/FormField.tsx (3)

26-29: LGTM: Well-documented prop with clear usage instructions

66-66: LGTM: Appropriate default value maintaining compatibility

133-133: Add test coverage for boldLabel functionality

Consider adding a test case to verify that the Text component receives the correct bold prop value based on boldLabel.

Would you like me to help create a test case for this functionality?

vladko-uxds

👍

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

packages/react-components/src/components/FormField/FormField.module.scss (1)

20-20: Good use of design system spacing variable!

Using var(--spacing-1) improves consistency and maintainability.

Consider updating other fixed pixel values in the file (e.g., 4px, 5px) to use spacing variables for better consistency.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c841cd9 and 2719638.

📒 Files selected for processing (1)

packages/react-components/src/components/FormField/FormField.module.scss (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: chromatic-deployment
GitHub Check: build

feat(FormField): add boldLabel prop for InputPromo

c841cd9

coderabbitai bot reviewed Jan 23, 2025

View reviewed changes

JoannaSikora requested review from marcinsawicki and vladko-uxds January 23, 2025 11:03

JoannaSikora added High-prio High priority task feature New feature or request labels Jan 23, 2025

vladko-uxds approved these changes Jan 23, 2025

View reviewed changes

feat(FormField): update margin-bottom to use spacing variable

2719638

coderabbitai bot reviewed Jan 23, 2025

View reviewed changes

marcinsawicki approved these changes Jan 24, 2025

View reviewed changes

Merge branch 'main' into feature/1447

462691e

JoannaSikora merged commit df33d0d into main Jan 24, 2025
6 checks passed

JoannaSikora deleted the feature/1447 branch January 24, 2025 07:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(FormField): add boldLabel prop for InputPromo #1495

feat(FormField): add boldLabel prop for InputPromo #1495

JoannaSikora commented Jan 23, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 23, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

vladko-uxds left a comment

coderabbitai bot left a comment

feat(FormField): add boldLabel prop for InputPromo #1495

feat(FormField): add boldLabel prop for InputPromo #1495

Conversation

JoannaSikora commented Jan 23, 2025 • edited by coderabbitai bot Loading

Description

Storybook

Checklist

Summary by CodeRabbit

coderabbitai bot commented Jan 23, 2025 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

vladko-uxds left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

JoannaSikora commented Jan 23, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 23, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)