PromiseIExtendedResult
Defined in: packages/sonner-next-intl/src/types.ts:126
Result structure returned from promise-based translated toasts.
Extends
Section titled “Extends”Type Parameters
Section titled “Type Parameters”T extends Record<string, any>
Messages map.
Properties
Section titled “Properties”action?
Section titled “action?”
optionalaction:ReactNode|Action
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:62
Inherited from
Section titled “Inherited from”TranslatedExternalToast.action
actionButtonStyle?
Section titled “actionButtonStyle?”
optionalactionButtonStyle:CSSProperties
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:68
Inherited from
Section titled “Inherited from”TranslatedExternalToast.actionButtonStyle
cancel?
Section titled “cancel?”
optionalcancel:ReactNode|Action
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:63
Inherited from
Section titled “Inherited from”TranslatedExternalToast.cancel
cancelButtonStyle?
Section titled “cancelButtonStyle?”
optionalcancelButtonStyle:CSSProperties
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:67
Inherited from
Section titled “Inherited from”TranslatedExternalToast.cancelButtonStyle
className?
Section titled “className?”
optionalclassName:string
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:71
Inherited from
Section titled “Inherited from”TranslatedExternalToast.className
classNames?
Section titled “classNames?”
optionalclassNames:ToastClassnames
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:72
Inherited from
Section titled “Inherited from”TranslatedExternalToast.classNames
closeButton?
Section titled “closeButton?”
optionalcloseButton:boolean
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:57
Inherited from
Section titled “Inherited from”TranslatedExternalToast.closeButton
description?
Section titled “description?”
optionaldescription:string|TranslatedMessage<T>
Defined in: packages/sonner-next-intl/src/types.ts:115
Inherited from
Section titled “Inherited from”TranslatedExternalToast.description
descriptionClassName?
Section titled “descriptionClassName?”
optionaldescriptionClassName:string
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:73
Inherited from
Section titled “Inherited from”TranslatedExternalToast.descriptionClassName
dismissible?
Section titled “dismissible?”
optionaldismissible:boolean
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:58
Inherited from
Section titled “Inherited from”TranslatedExternalToast.dismissible
duration?
Section titled “duration?”
optionalduration:number
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:60
Inherited from
Section titled “Inherited from”TranslatedExternalToast.duration
optionalicon:ReactNode
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:53
Inherited from
Section titled “Inherited from”TranslatedExternalToast.icon
optionalid:string|number
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:125
Inherited from
Section titled “Inherited from”TranslatedExternalToast.id
invert?
Section titled “invert?”
optionalinvert:boolean
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:56
Inherited from
Section titled “Inherited from”TranslatedExternalToast.invert
message
Section titled “message”message:
string|TranslatedMessage<T>
Defined in: packages/sonner-next-intl/src/types.ts:128
onAutoClose()?
Section titled “onAutoClose()?”
optionalonAutoClose: (toast) =>void
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:65
Parameters
Section titled “Parameters”ToastT
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”TranslatedExternalToast.onAutoClose
onDismiss()?
Section titled “onDismiss()?”
optionalonDismiss: (toast) =>void
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:64
Parameters
Section titled “Parameters”ToastT
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”TranslatedExternalToast.onDismiss
position?
Section titled “position?”
optionalposition:Position
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:74
Inherited from
Section titled “Inherited from”TranslatedExternalToast.position
richColors?
Section titled “richColors?”
optionalrichColors:boolean
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:55
Inherited from
Section titled “Inherited from”TranslatedExternalToast.richColors
style?
Section titled “style?”
optionalstyle:CSSProperties
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:69
Inherited from
Section titled “Inherited from”TranslatedExternalToast.style
testId?
Section titled “testId?”
optionaltestId:string
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:75
Inherited from
Section titled “Inherited from”TranslatedExternalToast.testId
toasterId?
Section titled “toasterId?”
optionaltoasterId:string
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:50
Inherited from
Section titled “Inherited from”TranslatedExternalToast.toasterId
unstyled?
Section titled “unstyled?”
optionalunstyled:boolean
Defined in: node_modules/.pnpm/sonner@2.0.7_react-dom@19.2.0_react@19.2.0__react@19.2.0/node_modules/sonner/dist/index.d.ts:70
Inherited from
Section titled “Inherited from”TranslatedExternalToast.unstyled