fix(toast): icons

[wingkwong]

Closes #

📝 Description

in the existing code, the type indicates we can pass a function that returns ReactNode in closeIcon but there is no logic to cover that. Hence, this PR is to cover this case as well as making icon and loadingIcon to do the same to keep them consistent.

closeIcon?: ReactNode | ((props: any) => ReactNode);

⛳️ Current behavior (updates)

🚀 New behavior

See the demo below.

https://heroui-9jnuobgya-heroui.vercel.app/?path=/story/components-toast--custom-icon

https://heroui-9jnuobgya-heroui.vercel.app/?path=/story/components-toast--custom-loading-icon

https://heroui-9jnuobgya-heroui.vercel.app/?path=/story/components-toast--custom-close-icon

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

📝 Additional Information

Summary by CodeRabbit

• New Features

  • Toast notifications now support dynamic icons, allowing icons to be provided as functions for more flexible rendering.
  • Added a new animated loading icon for use in Toast notifications and other components.

• Enhancements

  • Updated Toast component props to support both static and dynamic (function-based) icons.
  • Improved Toast stories to demonstrate custom and loading icons, and replaced inline SVGs with shared icon components.

• Documentation

  • Expanded storybook examples to showcase new icon capabilities in Toast notifications.

[linear]

ENG-2465 fix toast icon

[changeset-bot]

🦋 Changeset detected

Latest commit: 13a27ea

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

This PR includes changesets to release 19 packages

Name	Type
@heroui/shared-icons	Patch
@heroui/toast	Patch
@heroui/accordion	Patch
@heroui/alert	Patch
@heroui/autocomplete	Patch
@heroui/breadcrumbs	Patch
@heroui/calendar	Patch
@heroui/chip	Patch
@heroui/date-picker	Patch
@heroui/drawer	Patch
@heroui/input	Patch
@heroui/link	Patch
@heroui/modal	Patch
@heroui/number-input	Patch
@heroui/pagination	Patch
@heroui/select	Patch
@heroui/snippet	Patch
@heroui/table	Patch
@heroui/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

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
heroui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 2, 2025 11:47am
heroui-sb	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 2, 2025 11:47am

[coderabbitai]

Walkthrough

This update enhances the Toast component to support dynamic icon rendering by allowing the icon, loadingIcon, and closeIcon props to accept either React elements or render functions. Type definitions are updated to reflect this flexibility. A new LoadingIcon component is added to the shared icons library, and the Toast stories are reorganized and expanded to demonstrate the new icon capabilities, including examples with custom and loading icons. The shared icons package is updated to export the new loading icon.

Changes

File(s)	Change Summary
.changeset/fast-ways-hang.md	Documents the patch update, describing the addition of support for icon render functions in the Toast component and the introduction of a loading icon.
packages/components/toast/src/toast.tsx	Modifies the handling of icon, loadingIcon, and closeIcon props to accept either React elements or render functions, invoking functions with props when provided, and falling back to cloning valid React elements.
packages/components/toast/src/use-toast.ts	Updates ToastProps types for icon, closeIcon, and loadingIcon to accept either ReactNode or a render function. Removes an unused local variable and adds loadingIcon to the destructured props in the hook.
packages/components/toast/stories/toast.stories.tsx	Updates imports to include new icons, renames and reorganizes story exports, replaces inline SVGs with imported icon components, and adds new stories to demonstrate custom and loading icons in Toast notifications.
packages/utilities/shared-icons/src/index.ts	Adds an export for the new LoadingIcon component.
packages/utilities/shared-icons/src/loading.tsx	Adds a new LoadingIcon React component rendering an animated SVG loading indicator, accepting icon props for customization.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Toast
    participant IconFunction
    participant SharedIcons

    User->>Toast: Pass icon, loadingIcon, or closeIcon (element or function)
    Toast->>Toast: Check if icon prop is a function
    alt If function
        Toast->>IconFunction: Invoke with props
        IconFunction-->>Toast: Return ReactNode
    else If React element
        Toast->>Toast: Clone element with props
    end
    Toast->>SharedIcons: Render icon (e.g., LoadingIcon)
    SharedIcons-->>Toast: SVG Component
    Toast-->>User: Render Toast with icon

Loading

Suggested reviewers

• jrgarciadev

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @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.

[pkg-pr-new]

Open in StackBlitz

@heroui/accordion

npm i https://pkg.pr.new/@heroui/accordion@5246

@heroui/alert

npm i https://pkg.pr.new/@heroui/alert@5246

@heroui/autocomplete

npm i https://pkg.pr.new/@heroui/autocomplete@5246

@heroui/avatar

npm i https://pkg.pr.new/@heroui/avatar@5246

@heroui/badge

npm i https://pkg.pr.new/@heroui/badge@5246

@heroui/breadcrumbs

npm i https://pkg.pr.new/@heroui/breadcrumbs@5246

@heroui/button

npm i https://pkg.pr.new/@heroui/button@5246

@heroui/calendar

npm i https://pkg.pr.new/@heroui/calendar@5246

@heroui/card

npm i https://pkg.pr.new/@heroui/card@5246

@heroui/checkbox

npm i https://pkg.pr.new/@heroui/checkbox@5246

@heroui/chip

npm i https://pkg.pr.new/@heroui/chip@5246

@heroui/code

npm i https://pkg.pr.new/@heroui/code@5246

@heroui/date-input

npm i https://pkg.pr.new/@heroui/date-input@5246

@heroui/date-picker

npm i https://pkg.pr.new/@heroui/date-picker@5246

@heroui/divider

npm i https://pkg.pr.new/@heroui/divider@5246

@heroui/drawer

npm i https://pkg.pr.new/@heroui/drawer@5246

@heroui/dropdown

npm i https://pkg.pr.new/@heroui/dropdown@5246

@heroui/form

npm i https://pkg.pr.new/@heroui/form@5246

@heroui/image

npm i https://pkg.pr.new/@heroui/image@5246

@heroui/input

npm i https://pkg.pr.new/@heroui/input@5246

@heroui/input-otp

npm i https://pkg.pr.new/@heroui/input-otp@5246

@heroui/kbd

npm i https://pkg.pr.new/@heroui/kbd@5246

@heroui/link

npm i https://pkg.pr.new/@heroui/link@5246

@heroui/listbox

npm i https://pkg.pr.new/@heroui/listbox@5246

@heroui/menu

npm i https://pkg.pr.new/@heroui/menu@5246

@heroui/modal

npm i https://pkg.pr.new/@heroui/modal@5246

@heroui/navbar

npm i https://pkg.pr.new/@heroui/navbar@5246

@heroui/number-input

npm i https://pkg.pr.new/@heroui/number-input@5246

@heroui/pagination

npm i https://pkg.pr.new/@heroui/pagination@5246

@heroui/popover

npm i https://pkg.pr.new/@heroui/popover@5246

@heroui/progress

npm i https://pkg.pr.new/@heroui/progress@5246

@heroui/radio

npm i https://pkg.pr.new/@heroui/radio@5246

@heroui/ripple

npm i https://pkg.pr.new/@heroui/ripple@5246

@heroui/scroll-shadow

npm i https://pkg.pr.new/@heroui/scroll-shadow@5246

@heroui/select

npm i https://pkg.pr.new/@heroui/select@5246

@heroui/skeleton

npm i https://pkg.pr.new/@heroui/skeleton@5246

@heroui/slider

npm i https://pkg.pr.new/@heroui/slider@5246

@heroui/snippet

npm i https://pkg.pr.new/@heroui/snippet@5246

@heroui/spacer

npm i https://pkg.pr.new/@heroui/spacer@5246

@heroui/spinner

npm i https://pkg.pr.new/@heroui/spinner@5246

@heroui/switch

npm i https://pkg.pr.new/@heroui/switch@5246

@heroui/table

npm i https://pkg.pr.new/@heroui/table@5246

@heroui/tabs

npm i https://pkg.pr.new/@heroui/tabs@5246

@heroui/toast

npm i https://pkg.pr.new/@heroui/toast@5246

@heroui/tooltip

npm i https://pkg.pr.new/@heroui/tooltip@5246

@heroui/user

npm i https://pkg.pr.new/@heroui/user@5246

@heroui/react

npm i https://pkg.pr.new/@heroui/react@5246

@heroui/system

npm i https://pkg.pr.new/@heroui/system@5246

@heroui/system-rsc

npm i https://pkg.pr.new/@heroui/system-rsc@5246

@heroui/theme

npm i https://pkg.pr.new/@heroui/theme@5246

@heroui/use-aria-accordion

npm i https://pkg.pr.new/@heroui/use-aria-accordion@5246

@heroui/use-aria-accordion-item

npm i https://pkg.pr.new/@heroui/use-aria-accordion-item@5246

@heroui/use-aria-button

npm i https://pkg.pr.new/@heroui/use-aria-button@5246

@heroui/use-aria-link

npm i https://pkg.pr.new/@heroui/use-aria-link@5246

@heroui/use-aria-modal-overlay

npm i https://pkg.pr.new/@heroui/use-aria-modal-overlay@5246

@heroui/use-aria-multiselect

npm i https://pkg.pr.new/@heroui/use-aria-multiselect@5246

@heroui/use-callback-ref

npm i https://pkg.pr.new/@heroui/use-callback-ref@5246

@heroui/use-clipboard

npm i https://pkg.pr.new/@heroui/use-clipboard@5246

@heroui/use-data-scroll-overflow

npm i https://pkg.pr.new/@heroui/use-data-scroll-overflow@5246

@heroui/use-disclosure

npm i https://pkg.pr.new/@heroui/use-disclosure@5246

@heroui/use-draggable

npm i https://pkg.pr.new/@heroui/use-draggable@5246

@heroui/use-image

npm i https://pkg.pr.new/@heroui/use-image@5246

@heroui/use-infinite-scroll

npm i https://pkg.pr.new/@heroui/use-infinite-scroll@5246

@heroui/use-intersection-observer

npm i https://pkg.pr.new/@heroui/use-intersection-observer@5246

@heroui/use-is-mobile

npm i https://pkg.pr.new/@heroui/use-is-mobile@5246

@heroui/use-is-mounted

npm i https://pkg.pr.new/@heroui/use-is-mounted@5246

@heroui/use-measure

npm i https://pkg.pr.new/@heroui/use-measure@5246

@heroui/use-pagination

npm i https://pkg.pr.new/@heroui/use-pagination@5246

@heroui/use-real-shape

npm i https://pkg.pr.new/@heroui/use-real-shape@5246

@heroui/use-ref-state

npm i https://pkg.pr.new/@heroui/use-ref-state@5246

@heroui/use-resize

npm i https://pkg.pr.new/@heroui/use-resize@5246

@heroui/use-safe-layout-effect

npm i https://pkg.pr.new/@heroui/use-safe-layout-effect@5246

@heroui/use-scroll-position

npm i https://pkg.pr.new/@heroui/use-scroll-position@5246

@heroui/use-ssr

npm i https://pkg.pr.new/@heroui/use-ssr@5246

@heroui/use-theme

npm i https://pkg.pr.new/@heroui/use-theme@5246

@heroui/use-update-effect

npm i https://pkg.pr.new/@heroui/use-update-effect@5246

@heroui/aria-utils

npm i https://pkg.pr.new/@heroui/aria-utils@5246

@heroui/dom-animation

npm i https://pkg.pr.new/@heroui/dom-animation@5246

@heroui/framer-utils

npm i https://pkg.pr.new/@heroui/framer-utils@5246

@heroui/react-rsc-utils

npm i https://pkg.pr.new/@heroui/react-rsc-utils@5246

@heroui/shared-icons

npm i https://pkg.pr.new/@heroui/shared-icons@5246

@heroui/react-utils

npm i https://pkg.pr.new/@heroui/react-utils@5246

@heroui/shared-utils

npm i https://pkg.pr.new/@heroui/shared-utils@5246

@heroui/stories-utils

npm i https://pkg.pr.new/@heroui/stories-utils@5246

@heroui/test-utils

npm i https://pkg.pr.new/@heroui/test-utils@5246

commit: 13a27ea

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

packages/components/toast/src/toast.tsx (1)

84-87: Consider passing props to closeIcon function for consistency.

While the implementation correctly supports closeIcon as a function, it passes an empty object {} to the function, unlike the other icon props which receive their respective props (getIconProps(), getLoadingIconProps()). Consider using getCloseIconProps() for consistency, unless this is intentional.

const customCloseIcon =
  typeof closeIcon === "function"
-    ? closeIcon({})
+    ? closeIcon(getCloseIconProps())
    : isValidElement(closeIcon) && cloneElement(closeIcon as ReactElement, {});

packages/utilities/shared-icons/src/loading.tsx (1)

1-39: Well-implemented loading animation component.

The LoadingIcon component is well-structured with a clean SVG implementation that creates a visually pleasing loading animation. The staggered animation of the three circles creates a nice wave-like effect.

A few suggestions for potential improvements:

1. Consider making the color customizable instead of hardcoding #3871FF, perhaps by using a theme variable or allowing color override through props.
2. Add accessibility attributes such as aria-label="loading" to improve screen reader support.

However, these are minor suggestions and the current implementation is fully functional.

export const LoadingIcon = (props: IconSvgProps) => (
-  <svg viewBox="0 0 200 200" xmlns="http://www.w3.org/2000/svg" {...props}>
+  <svg viewBox="0 0 200 200" xmlns="http://www.w3.org/2000/svg" aria-label="loading" role="img" {...props}>

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2cbc689 and 13a27ea.

📒 Files selected for processing (6)

• .changeset/fast-ways-hang.md (1 hunks)
• packages/components/toast/src/toast.tsx (3 hunks)
• packages/components/toast/src/use-toast.ts (3 hunks)
• packages/components/toast/stories/toast.stories.tsx (5 hunks)
• packages/utilities/shared-icons/src/index.ts (1 hunks)
• packages/utilities/shared-icons/src/loading.tsx (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (2)

packages/utilities/shared-icons/src/loading.tsx (1)

packages/utilities/shared-icons/src/index.ts (1)

• IconSvgProps (49-49)

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

packages/utilities/shared-icons/src/close.tsx (1)

• CloseIcon (3-36)

packages/utilities/shared-icons/src/loading.tsx (1)

• LoadingIcon (3-39)

🔇 Additional comments (14)

packages/utilities/shared-icons/src/index.ts (1)

31-31: Good addition!

This export makes the new LoadingIcon component available from the shared-icons package, allowing it to be used in the Toast component and elsewhere in the application.

.changeset/fast-ways-hang.md (1)

1-7: Appropriate changeset description.

The changeset correctly indicates patch updates to both affected packages and provides a clear, concise description of the change. This matches the PR objectives of supporting function-based icons in Toast.

packages/components/toast/src/toast.tsx (3)

1-2: Good explicit import of ReactElement type.

Adding the explicit import of ReactElement type for the element casting is appropriate and improves code clarity.

---

61-65: Proper implementation of function-based icon support.

This implementation correctly handles both function and ReactNode cases for the icon prop, providing the icon props when invoking the function. This is in line with the PR objectives to support both rendering methods.

---

68-73: Good implementation of function-based loadingIcon support.

Similar to the icon implementation, this correctly handles the loadingIcon prop as either a function or ReactNode, maintaining consistency across icon props.

packages/components/toast/src/use-toast.ts (3)

2-2: Good addition of DOMAttributes import.

This import is necessary for the updated type definitions that now support function-based icon props.

---

71-71: Great enhancement to icon props typing.

The type updates now allow each icon prop to accept either a ReactNode directly or a function that receives DOM attributes and returns a ReactNode. This enhancement provides better flexibility for dynamic icon rendering while maintaining proper type safety.

Also applies to: 75-75, 79-79

---

161-161: Correct addition of loadingIcon to destructured props.

Adding the loadingIcon to the destructured props ensures it's properly extracted from the incoming props and can be used consistently with the other icon props throughout the component.

packages/components/toast/stories/toast.stories.tsx (6)

14-14: Good addition of icon imports.

Adding imports for LoadingIcon, AvatarIcon, and CloseIcon is necessary to demonstrate the new icon functionality in the stories.

---

356-356: Improved naming consistency and icon implementation.

Renaming to CustomCloseIconTemplate better reflects its purpose. Using the CloseIcon component instead of an inline SVG demonstrates the new function-based icon prop capabilities.

Also applies to: 373-373

---

398-400: Better story organization and naming.

The renamed story exports better reflect their purpose and improve the overall organization of the storybook. This makes it easier for developers to understand the different toast variants and their capabilities.

Also applies to: 405-405, 441-443, 448-450

---

455-462: Great addition of CustomIcon story.

This new story nicely demonstrates how to use a component (AvatarIcon) as the icon prop, showcasing the enhanced capability of accepting either ReactNode or function components for icons.

---

464-470: Excellent addition of CustomLoadingIcon story.

This story effectively demonstrates the new loadingIcon prop functionality, which was a key part of this enhancement. It shows how to use the new LoadingIcon component in a promise-based toast.

---

473-475: Appropriate renaming to CustomCloseIcon.

Renaming from CustomCloseButton to CustomCloseIcon maintains consistency with the template name and better reflects what's being demonstrated - a custom close icon rather than a whole button.