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

fix(Button): children is not an optional prop #83

Merged
merged 1 commit into from
Nov 26, 2023

Conversation

aversini
Copy link
Collaborator

@aversini aversini commented Nov 26, 2023

Summary by CodeRabbit

  • Refactor
    • Enhanced button components to support child elements.
    • Streamlined button properties for improved consistency and integration with standard HTML button attributes.

Copy link

coderabbitai bot commented Nov 26, 2023

Walkthrough

The update to the UI components package involves enhancing the button component's type definitions. A new children property has been added to the CommonButtonProps interface, allowing React nodes to be passed as children. Additionally, the ButtonProps type has been simplified by merging the common button properties with HTML button attributes directly, streamlining the type structure for better clarity and usage.

Changes

File Path Change Summary
.../Button/ButtonTypes.d.ts Added children property to CommonButtonProps; Merged CommonButtonProps with React.ButtonHTMLAttributes<HTMLButtonElement> in ButtonProps.

Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

Copy link

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

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 23383fe and 65860ac.
Files selected for processing (1)
  • packages/ui-components/src/components/Button/ButtonTypes.d.ts (2 hunks)
Additional comments: 3
packages/ui-components/src/components/Button/ButtonTypes.d.ts (3)
  • 1-5:
    The addition of the children property as a required attribute in CommonButtonProps aligns with the intent to make it a non-optional prop for the Button component.

  • 14-18:
    The restructuring of ButtonProps to include CommonButtonProps and React.ButtonHTMLAttributes<HTMLButtonElement> directly is a good simplification that clarifies the expected properties for the Button component.

  • 21-21:
    The children prop in ButtonLinkProps is marked as optional, which may be inconsistent with the intent to enforce children as a required prop for button components. Please verify if this is intentional or an oversight.

Copy link

bundlemon bot commented Nov 26, 2023

BundleMon

Unchanged files (3)
Status Path Size Limits
assets/index.js
6.1KB 10KB
assets/style.css
3.35KB 4KB
index.html
316B 2KB

No change in files bundle size

Final result: ✅

View report in BundleMon website ➡️


Current branch size history | Target branch size history

@aversini aversini merged commit e37f273 into main Nov 26, 2023
6 checks passed
@aversini aversini deleted the fix(Button)-children-is-not-an-optional-prop branch November 26, 2023 18:49
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.

1 participant