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: polymorphic component return types [button, dropdown item] #1308

Merged
merged 4 commits into from
Mar 20, 2024

Conversation

SutuSebastian
Copy link
Collaborator

@SutuSebastian SutuSebastian commented Mar 20, 2024

Changes

  • fix Button and DropdownItem being rendered as React.ReactNode | null - now returns JSX.Element
  • fix incorrect import from '~/src/helpers/generic-as-prop' to '../../helpers/generic-as-prop'

Issues

#962

Result

Screenshot 2024-03-20 at 16 35 11

@SutuSebastian SutuSebastian added 🐛 bug Something isn't working confirmed This bug was confirmed labels Mar 20, 2024
@SutuSebastian SutuSebastian self-assigned this Mar 20, 2024
Copy link

stackblitz bot commented Mar 20, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

vercel bot commented Mar 20, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
flowbite-react ❌ Failed (Inspect) Mar 20, 2024 2:52pm

Copy link
Contributor

coderabbitai bot commented Mar 20, 2024

Warning

Rate Limit Exceeded

@SutuSebastian has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 49 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between d35a009 and 7c5847c.

Walkthrough

This update involves refactoring and optimizing component structures within a React project. Specifically, it refines the Button component by renaming ButtonComponentFn to ButtonComponent, adjusting type definitions, and updating export structures. These changes aim to streamline the component definition and export configuration for improved code organization and maintainability.

Changes

File Path Change Summary
src/components/Button/Button.tsx Refactored ButtonComponentFn into ButtonComponent, adjusted type definitions and exports.

Related issues

  • Button as links do not have hover states #1086: The refactoring and improved type definitions for the Button component may indirectly contribute to achieving consistent hover state behavior across buttons and links by enabling more precise control over component properties and behaviors.

🐇✨
Changes are afoot, in components so bright,
Where buttons and dropdowns now see the light.
A rabbit hopped through, code in its trail,
Leaving behind a more elegant tale.
So here's to the devs, with their craft so keen,
🎉 May your code be robust, and your errors unseen!
✨🐇

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:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests 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 tests 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 tests.
    • @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.
  • 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

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@SutuSebastian
Copy link
Collaborator Author

Note: vercel preview will fail, due to changed settings for the new monorepo structure.

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 60aa2f4 and 60ec86c.
Files selected for processing (2)
  • src/components/Button/Button.tsx (2 hunks)
  • src/components/Dropdown/DropdownItem.tsx (2 hunks)
Additional comments: 5
src/components/Dropdown/DropdownItem.tsx (2)
  • 28-30: The refinement of DropdownItemComponentType to specify the props parameter more explicitly and adjust the return type to JSX.Element is a positive change, enhancing type safety and clarity.
  • 25-35: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [32-65]

The implementation of the DropdownItem component correctly utilizes forwardRef, generics, and context management. The handling of custom themes and conditional rendering of icons is well done. This aligns with best practices for React component development.

src/components/Button/Button.tsx (3)
  • 91-93: The adjustment of ButtonComponentType to ensure a more precise and consistent type definition is a positive change, enhancing type safety and clarity.
  • 88-98: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [95-171]

The implementation of the ButtonComponent correctly utilizes forwardRef, generics, and theme management. The handling of a wide range of props for customization and conditional class name generation is well done. This aligns with best practices for React component development.

  • 175-175: The export structure of the Button component, with the Group property attached, follows a common pattern for component libraries, promoting a cleaner API surface.

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 60ec86c and d35a009.
Files selected for processing (1)
  • src/components/Button/Button.tsx (4 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/components/Button/Button.tsx

Copy link
Collaborator

@nigellima nigellima left a comment

Choose a reason for hiding this comment

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

LGTM

Tested locally

@SutuSebastian
Copy link
Collaborator Author

LGTM

Tested locally

same, looks good to me

@SutuSebastian SutuSebastian merged commit f8775d8 into main Mar 20, 2024
2 of 3 checks passed
@SutuSebastian SutuSebastian deleted the fix/polymorphic-component-types branch March 20, 2024 15:24
@SutuSebastian SutuSebastian changed the title fix: polymorphic component types [button, dropdown item] fix: polymorphic component return types [button, dropdown item] Mar 20, 2024
@rnicholus
Copy link
Contributor

0.7.4 is completely broken. npm install flowbite-react@0.7.4 pulls down a total of 3 files: LICENSE, README.md, and package.json.

@SutuSebastian
Copy link
Collaborator Author

0.7.4 is completely broken. npm install flowbite-react@0.7.4 pulls down a total of 3 files: LICENSE, README.md, and package.json.

Fixing.

@SutuSebastian
Copy link
Collaborator Author

0.7.4 is completely broken. npm install flowbite-react@0.7.4 pulls down a total of 3 files: LICENSE, README.md, and package.json.

Check 0.7.5.

@rnicholus
Copy link
Contributor

thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛 bug Something isn't working confirmed This bug was confirmed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants