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: invalid icon types #43

Merged
merged 1 commit into from
Nov 14, 2023
Merged

fix: invalid icon types #43

merged 1 commit into from
Nov 14, 2023

Conversation

aversini
Copy link
Collaborator

@aversini aversini commented Nov 14, 2023

Summary by CodeRabbit

  • Refactor
    • Updated icon component properties for better integration and customization.

Copy link

coderabbitai bot commented Nov 14, 2023

Walkthrough

The change involves modifying the IconsProps definition from a type to an interface in the UI components library. This new interface extends the React.SVGAttributes<SVGElement> while omitting the "spacing" attribute, and introduces a new spacing property. Additionally, the className and viewBox properties have been removed from the IconsProps.

Changes

File Path Change Summary
packages/.../Icons/IconsTypes.d.ts Converted IconsProps from type to interface, extended Omit<React.SVGAttributes<SVGElement>, "spacing">, added spacing property, removed className and viewBox properties.

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 1573609 and 63a4da3.
Files selected for processing (1)
  • packages/ui-components/src/components/Icons/IconsTypes.d.ts (1 hunks)
Additional comments: 1
packages/ui-components/src/components/Icons/IconsTypes.d.ts (1)
  • 1-6: The change from a type alias to an interface is a structural improvement that allows for the extension of other types and interfaces, which can be beneficial for future scalability and maintainability. However, ensure that all components using IconsProps are updated to handle the removal of className and viewBox properties. If these properties are still required, consider adding them back or ensuring that they are handled elsewhere in the code.

The addition of the spacing property should be clearly documented, and any logic that depends on this property should be updated accordingly. Also, verify that the SpacingType import is correct and that the type is defined as expected.

Copy link

bundlemon bot commented Nov 14, 2023

BundleMon

Unchanged files (2)
Status Path Size Limits
assets/index-(hash).js
3.46KB 60KB
index.html
833B 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 6baef7a into main Nov 14, 2023
5 checks passed
@aversini aversini deleted the fix-invalid-icon-types branch November 14, 2023 14:56
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