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(Typography): new semi-bold variant #1439

Merged
merged 2 commits into from
Nov 27, 2024
Merged

feat(Typography): new semi-bold variant #1439

merged 2 commits into from
Nov 27, 2024

Conversation

marcinsawicki
Copy link
Contributor

@marcinsawicki marcinsawicki commented Nov 26, 2024

Resolves: #1419

Description

New semiBold props for Text component.

Storybook

https://feature-1419--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

    • Introduced an optional semiBold property for the Text component, allowing for semi-bold text styling.
    • Added a new .paragraph--semi-bold modifier in styles for enhanced typography options.
    • Updated TextExamples to showcase the new semi-bold text variant.
  • Bug Fixes

    • No bug fixes were made in this release.
  • Documentation

    • No documentation updates were included in this release.

@marcinsawicki marcinsawicki added the feature New feature or request label Nov 26, 2024
@marcinsawicki marcinsawicki added this to the Cycle #10 milestone Nov 26, 2024
@marcinsawicki marcinsawicki self-assigned this Nov 26, 2024
Copy link
Contributor

coderabbitai bot commented Nov 26, 2024

Walkthrough

The changes introduce a new optional property semiBold to the Text component's IProps interface, enabling the rendering of text in a semi-bold style. Corresponding CSS modifications add a .paragraph--semi-bold class to the stylesheet. Additionally, the TextExamples component is updated to showcase examples of the new semi-bold text variant, enhancing the overall text styling options without altering existing functionalities.

Changes

File Change Summary
packages/react-components/src/components/Typography/Text.tsx Added optional property semiBold to IProps interface and utilized it in the Text component.
packages/react-components/src/components/Typography/Typography.module.scss Introduced new modifier .paragraph--semi-bold for semi-bold text styling.
packages/react-components/src/stories/foundations/Typography/components/TextExamples.tsx Added example of Text component using semiBold prop within the TextExamples component.

Assessment against linked issues

Objective Addressed Explanation
Add new typography style -paragraph-md-semi-bold (1419) The specific styles for -paragraph-md-semi-bold were not implemented.
Add new typography style -paragraph-lg-semi-bold (1419) The specific styles for -paragraph-lg-semi-bold were not implemented.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1c44f8b and aca97d8.

📒 Files selected for processing (1)
  • packages/react-components/src/components/Typography/Text.tsx (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/react-components/src/components/Typography/Text.tsx

🪧 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 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.

@marcinsawicki marcinsawicki linked an issue Nov 26, 2024 that may be closed by this pull request
2 tasks
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
packages/react-components/src/components/Typography/Text.tsx (1)

25-26: Enhance JSDoc documentation for semiBold property

Add details about the font-weight value (500) and usage guidelines.

-  /** Optional prop to set the semi-bold */
+  /** Optional prop to set semi-bold weight (500). Use for moderate emphasis without the heaviness of bold. */
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 75e7e14 and 1c44f8b.

📒 Files selected for processing (3)
  • packages/react-components/src/components/Typography/Text.tsx (3 hunks)
  • packages/react-components/src/components/Typography/Typography.module.scss (1 hunks)
  • packages/react-components/src/stories/foundations/Typography/components/TextExamples.tsx (1 hunks)
🔇 Additional comments (3)
packages/react-components/src/stories/foundations/Typography/components/TextExamples.tsx (1)

15-17: LGTM! Well-integrated example of the new semiBold variant.

The example is logically placed between regular and bold variants, providing clear documentation of the new feature.

Let's verify the visual implementation:

packages/react-components/src/components/Typography/Text.tsx (1)

45-45: LGTM!

Default value and placement are consistent with existing patterns.

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

165-167: Well-structured semi-bold variant implementation!

The new semi-bold modifier follows the established patterns and uses appropriate font weight that aligns with the design system's typography scale.

Copy link

@vladko-uxds vladko-uxds left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@marcinsawicki marcinsawicki merged commit 93ef182 into main Nov 27, 2024
7 checks passed
@marcinsawicki marcinsawicki deleted the feature/1419 branch November 27, 2024 13:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
Development

Successfully merging this pull request may close these issues.

[Typography] - new style
3 participants