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(alert): propagate className #4535

Open
wants to merge 2 commits into
base: canary
Choose a base branch
from
Open

fix(alert): propagate className #4535

wants to merge 2 commits into from

Conversation

wingkwong
Copy link
Member

@wingkwong wingkwong commented Jan 11, 2025

Closes #4533

📝 Description

Apply className to base (i.e. the same pattern like other components)

⛳️ Current behavior (updates)

className doesn't add to base

🚀 New behavior

className is added to base

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

No

📝 Additional Information

Summary by CodeRabbit

  • Bug Fixes
  • New Features
    • Added support for custom class names in the Alert component

Copy link

vercel bot commented Jan 11, 2025

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

Name Status Preview Comments Updated (UTC)
nextui-docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 12, 2025 6:08am
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 12, 2025 6:08am

Copy link

changeset-bot bot commented Jan 11, 2025

🦋 Changeset detected

Latest commit: e1465bd

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/alert 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

@wingkwong wingkwong added this to the v2.6.12 milestone Jan 11, 2025
Copy link
Contributor

coderabbitai bot commented Jan 11, 2025

Walkthrough

The pull request addresses a bug in the @nextui-org/alert package where the className property was not being properly propagated to the DOM. The changes modify the use-alert.ts file to improve class name handling by introducing clsx for combining class names and updating the component's styling logic to ensure that custom classes are correctly applied to the alert component.

Changes

File Change Summary
packages/components/alert/src/use-alert.ts - Added clsx import
- Introduced className in destructured props
- Created baseStyles using clsx to combine class names
- Updated dependencies for useMemo and useCallback hooks
- Modified getBaseProps to use baseStyles
.changeset/hot-owls-sniff.md Patch file for the @nextui-org/alert package

Assessment against linked issues

Objective Addressed Explanation
Propagate className to DOM [#4533]

Possibly related PRs

Suggested reviewers

  • jrgarciadev

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6b78c9d and e1465bd.

📒 Files selected for processing (1)
  • packages/components/alert/src/use-alert.ts (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/components/alert/src/use-alert.ts
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: TypeScript
  • GitHub Check: Build

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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

linear bot commented Jan 11, 2025

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

🧹 Nitpick comments (1)
.changeset/hot-owls-sniff.md (1)

1-5: Enhance the changeset description

While the patch version is correct for this bug fix, consider adding more details about what was fixed and why:

---
"@nextui-org/alert": patch
---

-propagate className (#4533)
+fix: ensure className prop is correctly propagated to alert base element (#4533)
+
+Previously, custom classNames weren't being applied to the alert's base element.
+This fix ensures that className prop is properly combined with the component's
+base classes using clsx.
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between eada8cb and 6b78c9d.

📒 Files selected for processing (2)
  • .changeset/hot-owls-sniff.md (1 hunks)
  • packages/components/alert/src/use-alert.ts (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: TypeScript
  • GitHub Check: Build
🔇 Additional comments (3)
packages/components/alert/src/use-alert.ts (3)

106-106: LGTM: className prop destructuring

The className prop is correctly destructured from the props object.


127-127: LGTM: Base styles combination

The baseStyles variable correctly combines the base classNames with the custom className using clsx.


147-148: LGTM: Base props className application

The baseStyles are correctly applied using the slots.base utility.

packages/components/alert/src/use-alert.ts 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] - Alert seems not propagate className
2 participants