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: icon wrapper border on alert component #4383

Merged
merged 1 commit into from
Dec 17, 2024
Merged

fix: icon wrapper border on alert component #4383

merged 1 commit into from
Dec 17, 2024

Conversation

jrgarciadev
Copy link
Member

@jrgarciadev jrgarciadev commented Dec 17, 2024

Closes #4382

📝 Description

⛳️ Current behavior (updates)

🚀 New behavior

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

📝 Additional Information

Summary by CodeRabbit

  • New Features
    • Introduced a new story for the Alert component that allows rendering without the icon wrapper.
  • Bug Fixes
    • Fixed the hideIconWrapper property to correctly remove the border from the Alert component.
  • Improvements
    • Enhanced content visibility logic for the Alert component.
    • Updated styling and layout for the Alert component, including adjustments to icon positioning and content alignment.

Copy link

linear bot commented Dec 17, 2024

Copy link

vercel bot commented Dec 17, 2024

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

Name Status Preview Comments Updated (UTC)
nextui-docs-v2 🔄 Building (Inspect) Visit Preview 💬 Add feedback Dec 17, 2024 3:18pm
nextui-storybook-v2 🔄 Building (Inspect) Visit Preview 💬 Add feedback Dec 17, 2024 3:18pm

Copy link

changeset-bot bot commented Dec 17, 2024

🦋 Changeset detected

Latest commit: 6767a07

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

This PR includes changesets to release 13 packages
Name Type
@nextui-org/alert Patch
@nextui-org/theme Patch
@nextui-org/react Patch
@nextui-org/autocomplete Patch
@nextui-org/checkbox Patch
@nextui-org/date-input Patch
@nextui-org/date-picker Patch
@nextui-org/form Patch
@nextui-org/input-otp Patch
@nextui-org/input Patch
@nextui-org/radio Patch
@nextui-org/select Patch
@nextui-org/table 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
Contributor

coderabbitai bot commented Dec 17, 2024

Walkthrough

This pull request addresses an issue with the NextUI Alert component's hideIconWrapper property. The changes span multiple files in the components and theme packages, focusing on refining the Alert component's styling and content handling. The modifications include updating type definitions, adjusting content detection logic, and improving the icon wrapper's styling to correctly remove borders when the hideIconWrapper prop is set.

Changes

File Change Summary
packages/components/alert/src/alert.tsx Updated AlertProps interface to omit hasContent instead of hasDescription
packages/components/alert/src/use-alert.ts Modified useAlert function to check for content using description or children
packages/components/alert/stories/alert.stories.tsx Added WithoutIconWrapper story and removed mt-3 class from button container
packages/core/theme/src/components/alert.ts Updated icon wrapper styling, renamed hasDescription to hasContent

Assessment against linked issues

Objective Addressed Explanation
Remove border when hideIconWrapper is true [#4382]
Ensure consistent Alert component behavior

Possibly related PRs

Suggested reviewers

  • wingkwong

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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

🧹 Nitpick comments (3)
.changeset/many-kiwis-pretend.md (1)

6-6: Fix typo in changeset description

There's a typo in the description: "borded" should be "border"

-Fix #4382 `hideIconWrapper` property wasn't removing the borded on `Alert` component
+Fix #4382 `hideIconWrapper` property wasn't removing the border on `Alert` component
packages/components/alert/src/use-alert.ts (1)

127-127: LGTM with a minor optimization suggestion

The logic correctly checks for both description and children content. However, we could optimize the isEmpty calls.

Consider caching the isEmpty results to avoid double computation:

-() => alert({hasContent: !isEmpty(description) || !isEmpty(children), ...variantProps}),
+() => {
+  const hasDescription = !isEmpty(description);
+  const hasChildren = !isEmpty(children);
+  return alert({hasContent: hasDescription || hasChildren, ...variantProps});
+},
packages/core/theme/src/components/alert.ts (1)

32-32: Improve icon centering with grid layout

The switch from flex to grid layout with place-items-center provides more reliable centering for the icon wrapper.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fa38828 and 6767a07.

📒 Files selected for processing (5)
  • .changeset/many-kiwis-pretend.md (1 hunks)
  • packages/components/alert/src/alert.tsx (1 hunks)
  • packages/components/alert/src/use-alert.ts (1 hunks)
  • packages/components/alert/stories/alert.stories.tsx (2 hunks)
  • packages/core/theme/src/components/alert.ts (2 hunks)
🔇 Additional comments (5)
packages/components/alert/src/alert.tsx (1)

27-27: LGTM: Improved prop naming for better semantics

The change from hasDescription to hasContent in the AlertProps interface better represents the component's actual state, as it considers both description and children content.

packages/components/alert/stories/alert.stories.tsx (2)

229-235: LGTM! Good test coverage addition

The new WithoutIconWrapper story effectively demonstrates and tests the hideIconWrapper functionality, providing a clear example of the border fix implementation.


192-192: Verify spacing change impact

The removal of mt-3 class affects the vertical spacing of buttons. This change seems unrelated to the icon wrapper border fix.

✅ Verification successful

Spacing change appears to be intentional

The removal of mt-3 class aligns with the codebase's patterns. The search results show that the mt-3 class was previously used in the example code (apps/docs/content/components/alert/custom-styles.raw.tsx), but has been removed from both the example and the story for consistency. This change maintains visual harmony between the documentation and the component stories.

  • The story now matches other similar button container implementations that use flex items-center gap-1 without additional margin classes
  • The change appears to be part of a deliberate styling update rather than an unrelated modification
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other instances of mt-3 class in alert stories
rg "mt-3" --type tsx

Length of output: 48


Script:

#!/bin/bash
# Search for mt-3 class in all files
rg "mt-3"

# Also check for similar margin classes that might be used for consistency
rg "className=\".*?flex items-center gap-1.*?\"" -A 2 -B 2

Length of output: 6569

packages/core/theme/src/components/alert.ts (2)

79-79: LGTM! Properly fixes icon wrapper border

The addition of !border-none along with !bg-transparent and !shadow-none effectively addresses the icon wrapper border issue when hideIconWrapper is true.


82-86: Verify impact of hasContent variant rename

The rename from hasDescription to hasContent and alignment updates seem to be a breaking change.

@jrgarciadev jrgarciadev added this to the v2.6.9 milestone Dec 17, 2024
@jrgarciadev jrgarciadev merged commit e15ef62 into canary Dec 17, 2024
6 of 8 checks passed
@jrgarciadev jrgarciadev deleted the eng-1749 branch December 17, 2024 15:20
@coderabbitai coderabbitai bot mentioned this pull request Dec 19, 2024
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 still shows border even with prop hideIconWrapper
1 participant