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(progress): turn twMerge true to fix custom styling #2668

Merged
merged 8 commits into from
Apr 21, 2024

Conversation

caebwallace
Copy link
Contributor

@caebwallace caebwallace commented Apr 8, 2024

Closes #2153

📝 Description

Allow slot customisation by turning parameter twMerge of the progress theme to true.

image

⛳️ Current behavior (updates)

Progress component can not be customised as default className override custom classNames

image

🚀 New behavior

Use twMerge to apply customisation

image

💣 Is this a breaking change (Yes/No): No

📝 Additional Information

Summary by CodeRabbit

  • New Features
    • Introduced CustomSlots for more flexible customization in progress components.
  • Bug Fixes
    • Fixed an issue with custom slot styling not properly merging with Tailwind CSS in progress components.

Copy link

vercel bot commented Apr 8, 2024

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

Name Status Preview Comments Updated (UTC)
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 21, 2024 10:29am

Copy link

changeset-bot bot commented Apr 8, 2024

🦋 Changeset detected

Latest commit: dc270de

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@nextui-org/theme Patch
@nextui-org/react Patch

Not sure what this means? Click here to learn what changesets are.

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

Copy link

vercel bot commented Apr 8, 2024

Someone is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Apr 8, 2024

Warning

Rate Limit Exceeded

@wingkwong has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 31 minutes and 6 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 58d1498 and dc270de.

Walkthrough

The recent update enhances the customization capabilities of the @nextui-org/progress and @nextui-org/theme packages by enabling better handling of custom slot styling with the twMerge property set to true. This update also introduces a fix for issues related to customizing the Progress component slots.

Changes

File Path Change Summary
.changeset/short-trainers-dance.md Updates to "@nextui-org/progress" and "@nextui-org/theme", fixing custom slot styling with twMerge set to true.
.../progress/stories/progress.stories.tsx Added CustomSlots with custom rendering template and class name customization arguments.
.../theme/src/components/progress.ts Changed twMerge from false to true in the progress component, impacting tailwind CSS merging behavior.

Assessment against linked issues

Objective Addressed Explanation
Fix the twMerge being false in progress.ts to allow customizing Progress slots without twMerge (#2153)
Ensure the original flex-col is replaced by flex-row-reverse when customizing the base in Progress (#2153)

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.
  • 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: 0

Review Status

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between ebab108 and 6f08037.
Files selected for processing (3)
  • .changeset/short-trainers-dance.md (1 hunks)
  • packages/components/progress/stories/progress.stories.tsx (1 hunks)
  • packages/core/theme/src/components/progress.ts (1 hunks)
Additional comments not posted (3)
.changeset/short-trainers-dance.md (1)

1-6: The changeset description is clear and accurately reflects the changes made to the @nextui-org/progress and @nextui-org/theme packages. The spelling of twMerge is correct in this context.

packages/components/progress/stories/progress.stories.tsx (1)

126-136: The addition of the CustomSlots story effectively demonstrates the new customization capabilities with twMerge set to true. This is a valuable example for users looking to customize the Progress component.

packages/core/theme/src/components/progress.ts (1)

136-136: Changing the twMerge property from false to true correctly implements the intended functionality to enable customization of the Progress component. This change is described as non-breaking and aligns with the PR objectives.

.changeset/short-trainers-dance.md Outdated Show resolved Hide resolved
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: 0

Review Status

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 6f08037 and 2fa993d.
Files selected for processing (1)
  • .changeset/short-trainers-dance.md (1 hunks)
Additional comments not posted (2)
.changeset/short-trainers-dance.md (2)

2-3: The versioning strategy using patch for both "@nextui-org/progress" and "@nextui-org/theme" is appropriate, considering the changes are non-breaking and focused on enhancing customization capabilities.


6-6: Consider refining the description to provide more context about the change, for example: "Enables custom slot styling in the Progress component by setting twMerge to true, allowing for more flexible class name customization."

@caebwallace
Copy link
Contributor Author

Hi! Just checking in : everything okay with the code in that PR ?
Tell me if not :)

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

.changeset/short-trainers-dance.md Outdated Show resolved Hide resolved
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.

[BUG] - why the twMerge is false in progress.ts
2 participants