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

fix(toast): Renaming the loadingIcon to loadingComponent

Open macci001 opened this issue 10 months ago • 5 comments

📝 Description

⛳️ Current behavior (updates)

🚀 New behavior

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

Yes This is an breaking change as loadingIcon prop is renamed to loadingComponent prop

📝 Additional Information

Summary by CodeRabbit

Summary by CodeRabbit

  • Documentation
    • Renamed and clarified the loading indicator attribute in the Toast component docs from "loadingIcon" to "loadingComponent."
  • New Features
    • Added a Toast example showcasing a custom loading spinner component during promise states.
  • Refactor
    • Updated Toast component and theme slot naming to use "loadingComponent" instead of "loadingIcon" for consistency.
  • Chores
    • Improved spinner functionality and updated dependencies related to Toast and theme packages.

macci001 avatar Feb 24 '25 11:02 macci001

🦋 Changeset detected

Latest commit: e52583677d14f8807ca1c83327a937ff942703d3

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

This PR includes changesets to release 14 packages
Name Type
@heroui/toast Patch
@heroui/theme Patch
@heroui/react Patch
@heroui/autocomplete Patch
@heroui/checkbox Patch
@heroui/date-input Patch
@heroui/date-picker Patch
@heroui/form Patch
@heroui/input-otp Patch
@heroui/input Patch
@heroui/number-input Patch
@heroui/radio Patch
@heroui/select Patch
@heroui/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

changeset-bot[bot] avatar Feb 24 '25 11:02 changeset-bot[bot]

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 Jun 22, 2025 7:49am
heroui-sb ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 22, 2025 7:49am

vercel[bot] avatar Feb 24 '25 11:02 vercel[bot]

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (5)
  • main
  • canary
  • fix/.*
  • chore/.*
  • feat/.*

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This pull request consistently renames the loadingIcon attribute to loadingComponent across the codebase. The change updates documentation, interface definitions, component properties, method names, and type signatures in the Toast component. Additionally, a new story export introduces a custom loading component, and a changeset documents the corresponding dependency update and spinner fix.

Changes

File(s) Change Summary
apps/docs/.../toast.mdx, packages/components/toast/src/toast.tsx, packages/components/toast/src/use-toast.ts, packages/core/.../toast.ts, .changeset/soft-weeks-sell.md Renamed all occurrences of loadingIcon to loadingComponent in documentation text, component props, hook interfaces, method signatures, slot definitions, and release notes.
packages/components/toast/stories/toast.stories.tsx Added a new export (PromiseWithCustomLoadingComponent) that renders PromiseToastTemplate with a custom <Spinner variant="spinner" /> as the loading component.

Possibly related PRs

  • heroui-inc/heroui#4881: Addresses similar renaming from loadingIcon to loadingComponent, ensuring consistent terminology across the codebase.

Suggested labels

📦 Scope : Components, 📋 Scope : Docs

Suggested reviewers

  • jrgarciadev
  • wingkwong

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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

coderabbitai[bot] avatar Feb 24 '25 11:02 coderabbitai[bot]

Open in StackBlitz

@heroui/accordion

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

npm i https://pkg.pr.new/@heroui/use-draggable@4919
@heroui/use-form-reset

npm i https://pkg.pr.new/@heroui/use-form-reset@4919
@heroui/use-image

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

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

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

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

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

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

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

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

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

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

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

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

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

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

npm i https://pkg.pr.new/@heroui/use-update-effect@4919
@heroui/use-viewport-size

npm i https://pkg.pr.new/@heroui/use-viewport-size@4919
@heroui/aria-utils

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

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

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

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

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

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

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

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

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

commit: e525836

pkg-pr-new[bot] avatar Feb 24 '25 11:02 pkg-pr-new[bot]

@wingkwong added your suggestion in latest commit.

macci001 avatar Mar 03 '25 11:03 macci001