nextui icon indicating copy to clipboard operation
nextui copied to clipboard
verified publisher icon nextui-org

fix(toast): adding close method for removing the toast

Open macci001 opened this issue 9 months ago • 4 comments

Closes #

📝 Description

⛳️ Current behavior (updates)

🚀 New behavior

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

📝 Additional Information

Summary by CodeRabbit

  • New Features
    • Added the ability to programmatically close toast notifications.
    • Introduced a new example demonstrating how to close toasts by their key in the toast component stories.

macci001 avatar Apr 14 '25 10:04 macci001

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 12, 2025 4:02pm
heroui-sb ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 12, 2025 4:02pm

vercel[bot] avatar Apr 14 '25 10:04 vercel[bot]

🦋 Changeset detected

Latest commit: ab0271bfba30f5ecaf9e0dadd2d645f6b4e9c788

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

This PR includes changesets to release 2 packages
Name Type
@heroui/toast 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

changeset-bot[bot] avatar Apr 14 '25 10:04 changeset-bot[bot]

Walkthrough

A new method named closeToast has been introduced to the @heroui/toast package, enabling the removal of toast notifications by their key. The addToast function was updated to return the key of the created toast. Storybook stories were updated to demonstrate the new functionality, including a new story that shows how to programmatically close a toast using its key. The changes are documented in a new changeset file.

Changes

File(s) Change Summary
.changeset/green-squids-fix.md Added a changeset documenting the introduction of the closeToast method to the @heroui/toast package.
packages/components/toast/src/toast-provider.tsx Modified addToast to return the toast key; added and exported new closeToast function.
packages/components/toast/stories/toast.stories.tsx Added a new story demonstrating closeToast usage; imported useState and closeToast.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI
    participant ToastProvider

    User->>UI: Click "Add Toast" button
    UI->>ToastProvider: addToast()
    ToastProvider-->>UI: Returns toast key
    UI->>UI: Store toast key

    User->>UI: Click "Remove Last Toast" button
    UI->>ToastProvider: closeToast(toast key)
    ToastProvider->>UI: Toast is closed

Suggested reviewers

  • jrgarciadev

[!TIP]

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
✨ 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
🪧 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.
  • @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.

coderabbitai[bot] avatar Apr 14 '25 10:04 coderabbitai[bot]

Open in StackBlitz

@heroui/accordion

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

npm i https://pkg.pr.new/@heroui/use-aria-multiselect@5190
@heroui/use-callback-ref

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

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

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

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

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

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

npm i https://pkg.pr.new/@heroui/use-infinite-scroll@5190
@heroui/use-intersection-observer

npm i https://pkg.pr.new/@heroui/use-intersection-observer@5190
@heroui/use-is-mobile

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

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

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

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

npm i https://pkg.pr.new/@heroui/use-real-shape@5190
@heroui/use-ref-state

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

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

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

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

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

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

npm i https://pkg.pr.new/@heroui/use-update-effect@5190
@heroui/aria-utils

npm i https://pkg.pr.new/@heroui/aria-utils@5190
@heroui/dom-animation

npm i https://pkg.pr.new/@heroui/dom-animation@5190
@heroui/framer-utils

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

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

npm i https://pkg.pr.new/@heroui/react-utils@5190
@heroui/shared-icons

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

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

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

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

commit: ab0271b

pkg-pr-new[bot] avatar Apr 14 '25 10:04 pkg-pr-new[bot]

Closing - handled in https://github.com/heroui-inc/heroui/pull/5125

wingkwong avatar Jun 22 '25 08:06 wingkwong