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(Heading): create a wrapper for default sizes #12901

Merged
merged 3 commits into from
May 13, 2024

Conversation

TylerAPfledderer
Copy link
Contributor

@TylerAPfledderer TylerAPfledderer commented May 4, 2024

Recreates a Heading wrapper component to set default size token values based on the heading element supplied through the as prop.

Summary by CodeRabbit

  • New Features

    • Introduced a new Heading wrapper component that automatically assigns size theme tokens based on the heading tag used.
  • Refactor

    • Streamlined import statements in Heading.stories.tsx and enhanced usage by directly passing required props.
  • Documentation

    • Added comments to clarify the usage of explicit size values in the HeadingComponent.

Copy link

netlify bot commented May 4, 2024

Deploy Preview for ethereumorg ready!

Name Link
🔨 Latest commit f26200a
🔍 Latest deploy log https://app.netlify.com/sites/ethereumorg/deploys/663c0b4223157c0008023c28
😎 Deploy Preview https://deploy-preview-12901--ethereumorg.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
7 paths audited
Performance: 47 (🟢 up 8 from production)
Accessibility: 92 (🔴 down 1 from production)
Best Practices: 94 (🔴 down 6 from production)
SEO: 95 (🔴 down 5 from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@TylerAPfledderer
Copy link
Contributor Author

TylerAPfledderer commented May 4, 2024

@pettinarip curious here: it looks like all or most of the instances of the Chakra Heading component used in prod are explicitly defining a fontSize instead of using the size token (sometimes an explicit lineHeight).

I take it this in intentional until the components they are a part of are update or replaced for the DS, correct?

I have not touched them here.

@TylerAPfledderer
Copy link
Contributor Author

@coderabbitai review

Copy link
Contributor

coderabbitai bot commented May 4, 2024

Walkthrough

These updates focus on streamlining the Heading component across two files. The Heading.stories.tsx sees a cleanup of imports and a refinement in component usage, while index.tsx introduces a new Heading component that automatically assigns size based on the heading tag. This enhancement simplifies the usage and ensures consistency in heading styles throughout the application.

Changes

File Summary of Changes
src/components/Heading/Heading.stories.tsx Refactored imports, removed unused imports, and adjusted component usage with comments on size values.
src/components/Heading/index.tsx Introduced a new Heading component that sets default sizes based on tags, and added related exports (HeadingTags, HEADING_SIZE_DEFAULTS, and the component function).

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

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

Out of diff range and nitpick comments (1)
src/components/Heading/index.tsx (1)

22-28: The documentation clearly explains the purpose and functionality of the Heading component. Consider adding more detail about the default behavior when the as prop is not provided.

src/components/Heading/index.tsx Show resolved Hide resolved
Copy link
Member

@pettinarip pettinarip left a comment

Choose a reason for hiding this comment

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

Great job @TylerAPfledderer! Thanks!

@pettinarip pettinarip merged commit 8b3b0e3 into ethereum:dev May 13, 2024
10 checks passed
@TylerAPfledderer TylerAPfledderer deleted the feat/create-heading-wrapper branch May 14, 2024 12:42
This was referenced May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants