Fix React warning in ButtonGroup #1323

chunkerchunker · 2024-03-28T17:44:08Z

[ x ] I have followed the Your First Code Contribution section of the Contributing guide

Summarize the changes made and the motivation behind them.

This change fixes the following issue that was introduced recently in commit d0dc810:

ButtonGroup was adding positionInGroup to all children rather than just Buttons. For example, in the following, both the Buttons and the child spans get positionInGroup props:

<Button.Group>
  <Button><span>b1</span></Button>
  <Button><span>b2</span></Button>
</Button.Group>

This results in a React warning: “Warning: React does not recognize the positionInGroup prop on a DOM element...”

The review comment on the original commit hints at this issue as well:

#1273 (comment)

Summary by CodeRabbit

Refactor
- Enhanced the logic for determining button positions within groups to improve usability.

stackblitz · 2024-03-28T17:44:11Z

Run & review this pull request in StackBlitz Codeflow.

changeset-bot · 2024-03-28T17:44:12Z

⚠️ No Changeset found

Latest commit: 8f1b296

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel · 2024-03-28T17:44:13Z

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

Name	Status	Preview	Comments	Updated (UTC)
flowbite-react	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 1, 2024 3:22am
flowbite-react-storybook	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 1, 2024 3:22am

coderabbitai · 2024-03-28T17:44:17Z

Walkthrough

This update refines the import approach for ButtonProps and enhances the logic for determining button positions within groups, ensuring a smoother and more intuitive grouping of buttons in the UI component.

Changes

File Path	Change Summary
`.../Button/ButtonGroup.tsx`	Modified `ButtonProps` import and refactored button positioning logic.

Possibly related issues

Conditional Button in a Button.Group breaks application #900: The refactoring could potentially address the React error when adding conditional Buttons to a Button.Group by improving how button positions and conditions are handled.
Different heights of buttons in Button.Group when text is rendered in more than one line due to lack of space #855: If the changes include adjustments in handling wrapped text, this could potentially ensure uniform button heights within Button.Groups, addressing the issue of varying button heights due to text wrapping.

Poem

In the realm of code where buttons align,
A rabbit hopped, making designs refine.
With each leap and bound, errors unwind,
Grouped buttons in harmony, you'll find.
🐰✨
"To group or not?" No more debate,
For CodeRabbit's touch makes all integrate.

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

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between c2fb19a and 544cb84.

Files selected for processing (1)

packages/ui/src/components/Button/ButtonGroup.tsx (2 hunks)

Additional comments (3)

packages/ui/src/components/Button/ButtonGroup.tsx (3)

7-7: The import statement correctly imports Button and ButtonProps, which are necessary for the changes made in this pull request.

32-45: The logic to conditionally apply the positionInGroup prop only to Button components is correctly implemented. This should effectively resolve the issue with React warnings.

Please ensure to verify the behavior with nested children, especially in complex component trees, to confirm that the recursive processing works as intended.

53-53: The determinePosition function correctly calculates a button's position within a group. The logic is clear and should work as intended.

SutuSebastian

formatting

coderabbitai

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between e33c469 and 1ba2a8f.

Files selected for processing (1)

packages/ui/src/components/Button/ButtonGroup.tsx (2 hunks)

Files skipped from review as they are similar to previous changes (1)

packages/ui/src/components/Button/ButtonGroup.tsx

Additional Context Used

coderabbitai

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 1ba2a8f and c45f441.

Files selected for processing (1)

packages/ui/src/components/Button/ButtonGroup.tsx (2 hunks)

Files skipped from review as they are similar to previous changes (1)

packages/ui/src/components/Button/ButtonGroup.tsx

Additional Context Used

chunkerchunker · 2024-03-29T14:58:08Z

formatting

Apologies, fixed.

This change fixes the following issue: ButtonGroup was adding positionInGroup to all children rather than just Buttons. For example, in the following, both the Buttons and the child spans get positionInGroup props: ``` <Button.Group><Button><span>b1</span></Button><Button><span>b2</span></Button></Button.Group> ``` This results in a React warning: “Warning: React does not recognize the `positionInGroup` prop on a DOM element...” The review comment in the original code change causing this hints at this issue as well: themesberg#1273 (comment)

coderabbitai

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between fe68502 and 728aa5a.

Files selected for processing (1)

packages/ui/src/components/Button/ButtonGroup.tsx (2 hunks)

Files skipped from review as they are similar to previous changes (1)

packages/ui/src/components/Button/ButtonGroup.tsx

Additional Context Used

chunkerchunker mentioned this pull request Mar 28, 2024

fix(ButtonGroup): dynamic generated button with group wasn't styled properly #1273

Merged

vercel bot temporarily deployed to Preview March 28, 2024 17:45 Inactive

coderabbitai bot reviewed Mar 28, 2024

View reviewed changes

SutuSebastian reviewed Mar 29, 2024

View reviewed changes

SutuSebastian force-pushed the fix/button-group-warning branch from 544cb84 to 1ba2a8f Compare March 29, 2024 13:07

coderabbitai bot reviewed Mar 29, 2024

View reviewed changes

vercel bot deployed to Preview – flowbite-react March 29, 2024 13:09 View deployment

vercel bot deployed to Preview – flowbite-react-storybook March 29, 2024 13:10 View deployment

coderabbitai bot reviewed Mar 29, 2024

View reviewed changes

vercel bot deployed to Preview – flowbite-react-storybook March 29, 2024 14:55 View deployment

vercel bot deployed to Preview – flowbite-react March 29, 2024 14:56 View deployment

chunkerchunker added 2 commits March 29, 2024 16:59

fix formatting

728aa5a

SutuSebastian force-pushed the fix/button-group-warning branch from 41c54e8 to 728aa5a Compare March 29, 2024 14:59

vercel bot deployed to Preview – flowbite-react March 29, 2024 15:00 View deployment

vercel bot deployed to Preview – flowbite-react-storybook March 29, 2024 15:01 View deployment

coderabbitai bot reviewed Mar 29, 2024

View reviewed changes

Merge branch 'main' into fix/button-group-warning

8f1b296

vercel bot deployed to Preview – flowbite-react April 1, 2024 03:21 View deployment

vercel bot deployed to Preview – flowbite-react-storybook April 1, 2024 03:22 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix React warning in ButtonGroup #1323

Fix React warning in ButtonGroup #1323

chunkerchunker commented Mar 28, 2024 •

edited by coderabbitai bot

stackblitz bot commented Mar 28, 2024

changeset-bot bot commented Mar 28, 2024 •

edited

vercel bot commented Mar 28, 2024 •

edited

coderabbitai bot commented Mar 28, 2024 •

edited

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

coderabbitai bot left a comment

SutuSebastian left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

chunkerchunker commented Mar 29, 2024

coderabbitai bot left a comment

Fix React warning in ButtonGroup #1323

Are you sure you want to change the base?

Fix React warning in ButtonGroup #1323

Conversation

chunkerchunker commented Mar 28, 2024 • edited by coderabbitai bot

Summary by CodeRabbit

stackblitz bot commented Mar 28, 2024

changeset-bot bot commented Mar 28, 2024 • edited

⚠️ No Changeset found

vercel bot commented Mar 28, 2024 • edited

coderabbitai bot commented Mar 28, 2024 • edited

Walkthrough

Changes

Possibly related issues

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

SutuSebastian left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

chunkerchunker commented Mar 29, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

chunkerchunker commented Mar 28, 2024 •

edited by coderabbitai bot

changeset-bot bot commented Mar 28, 2024 •

edited

vercel bot commented Mar 28, 2024 •

edited

coderabbitai bot commented Mar 28, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)