constcreateToast:WidgetFactory<ToastWidget>
Create an ToastWidget with given config props
an optional alert config
an ToastWidget
constdefaultToasterProps:ToasterProps
constgetToastDefaultConfig: () =>ToastProps
Retrieve a shallow copy of the default Toast config
the default Toast config
Toast(
props):Element
Toast component that uses a forward ref to expose the Toast API.
This component utilizes the useWidgetWithConfig hook to create a toast widget with the provided properties and configuration. It also uses useImperativeHandle to expose the widget's API through the forwarded ref.
Partial<ToastProps> & object
Partial properties of ToastProps to configure the toast widget.
Element
A JSX element that conditionally renders the ToastElement based on the widget's state.
Represents the API for the toast component.
close():
void
Triggers alert closing programmatically (same as clicking on the close button (×)).
void
open():
void
Triggers the alert to be displayed for the user.
void
Represents the context for a Toast widget.
This interface is an alias for WidgetSlotContext<ToastWidget>.
api:
ToastApi
all the api functions to interact with the widget
directives:
ToastDirectives
directives to be used on html elements in the template of the widget or in the slots
state:
ToastState
the state of the widget
ToastDefaultSlotStructure(
slotContext):Element
Renders the default slot structure for a Toast component.
The context containing the state and properties for the Toast component.
Element
The JSX element representing the default slot structure of the Toast.
Interface representing the directives for a toast component.
autoHideDirective:
Directive
Directive that handles the autohide of the toast component
bodyDirective:
Directive
Directive that adds all the necessary attributes to the body
closeButtonDirective:
Directive
Directive that adds all the necessary attributes to the close button depending on the presence of the header
transitionDirective:
Directive
the transition directive, piloting what is the visual effect of going from hidden to visible
ToasterContainer():
Element
Toaster component that displays a list of toast notifications.
This component uses the useToaster hook to manage the state of the toasts.
It renders a container with a list of toasts and an optional "Close all" button
if the closeAll option is enabled and there is more than one toast.
Element
The rendered Toaster component.
Props of the toaster
optionalcloseAll:boolean
Add a button to close all the toasts at once
optionalcloseAllLabel:string
Close all label
dismissible:
boolean
Display a dismiss button on each toast. When duration = 0, this is enforced to true
duration:
number
How much time (ms) a toast is displayed; 0 means it won't be removed until a manual action
optionallimit:number
Maximum number of toasts displayed
optionalpauseOnHover:boolean
Pause toast when hover
position:
ToastPositions
Where to position the toasts
ToasterProvider(
props):Element
ToasterProvider component to provide toaster context to its children.
PropsWithChildren<{ options: ToasterProps; }>
The properties object.
Element
The ToasterProvider component.
Represents a timer used by the toaster service.
duration:
number
The duration for which the timer is set (optional). Used internally to compute the remaining time.
optionalpaused:number
The timestamp when the timer was paused (optional).
started:
number
The timestamp when the timer was started.
timeout:
null|Timeout
The timeout identifier returned by setTimeout.
Toast object
Props
Type of the toast properties.
id:
number
Identifier of the toasts in the toaster
props:
Props
Properties of the toast
consttoastPositions:Record<ToastPositions,string>
A mapping of toast position keys to their corresponding CSS class strings of bootstrap. These classes define the positioning of toast notifications on the screen.
The keys represent various positions on the screen, such as top-left, top-center, middle-right, etc., and the values are the CSS classes of bootstrap that apply the respective positioning styles.
Example usage:
const positionClass = toastPositions.topLeft; // "top-0 start-0"ToastPositions =
"topLeft"|"topCenter"|"topRight"|"middleLeft"|"middleCenter"|"middleRight"|"bottomLeft"|"bottomCenter"|"bottomRight"
Represents the possible positions for displaying a toast notification.
The positions are defined based on a grid layout with three horizontal alignments (left, center, right) and three vertical alignments (top, middle, bottom).
Available positions:
topLeft: Top-left corner of the screen.topCenter: Top-center of the screen.topRight: Top-right corner of the screen.middleLeft: Middle-left side of the screen.middleCenter: Center of the screen.middleRight: Middle-right side of the screen.bottomLeft: Bottom-left corner of the screen.bottomCenter: Bottom-center of the screen.bottomRight: Bottom-right corner of the screen.
Interface representing the properties for the Toast component.
animated:
boolean
If true, alert closing will be animated.
Animation is triggered when clicked on the close button (×),
via the .close() function or the visible prop is changed
true
animatedOnInit:
boolean
If true, alert opening will be animated.
Animation is triggered when the .open() function is called
or the visible prop is changed
false
ariaCloseButtonLabel:
string
Accessibility close button label
'Close'
autoHide:
boolean
If true automatically hides the toast after the delay.
true
children:
SlotContent<ToastContext>
Template for the toast content
className:
string
CSS classes to be applied on the widget main container
''
delay:
number
Delay in milliseconds before hiding the toast.
5000
dismissible:
boolean
If true, alert can be dismissed by the user.
The close button (×) will be displayed and you can be notified of the event with the (close) output.
true
header:
SlotContent<ToastContext>
Header template for the toast component
onHidden: () =>
void
Callback called when the alert is hidden.
void
() => {}onShown: () =>
void
Callback called when the alert is shown.
void
() => {}onVisibleChange: (
visible) =>void
Callback called when the alert visibility changed.
boolean
void
() => {}structure:
SlotContent<ToastContext>
Global template for the toast component
transition:
TransitionFn
The transition function will be executed when the alert is displayed or hidden.
Depending on the value of animatedOnInit, the animation can be optionally skipped during the showing process.
fadeTransition
visible:
boolean
If true the alert is visible to the user
true
Represents the state of a Toast component.
ariaCloseButtonLabel:
string
Accessibility close button label
'Close'
autoHide:
boolean
If true automatically hides the toast after the delay.
true
children:
SlotContent<ToastContext>
Template for the toast content
className:
string
CSS classes to be applied on the widget main container
''
delay:
number
Delay in milliseconds before hiding the toast.
5000
dismissible:
boolean
If true, alert can be dismissed by the user.
The close button (×) will be displayed and you can be notified of the event with the (close) output.
true
header:
SlotContent<ToastContext>
Header template for the toast component
hidden:
boolean
Is true when the alert is hidden. Compared to visible, this is updated after the transition is executed.
structure:
SlotContent<ToastContext>
Global template for the toast component
visible:
boolean
If true the alert is visible to the user
true
ToastWidget =
Widget<ToastProps,ToastState,ToastApi,ToastDirectives>
Represents a Toast widget component.
useToaster():
object
Custom hook to use the toaster context.
object
The toaster context.
addToast: (
props) =>number
number
closeAll: () =>
void
Helper to close all toasts at once
void
eventsDirective:
Directive<number>
options:
ToasterProps=toasterOptions
removeToast: (
id) =>void
Helper to remove a toast to the viewport.
number
Id of the toast to remove.
void
toasts:
ToasterToast<Partial<ToastProps>>[]