API toast

• props?: PropsConfig<ToastProps>

ToastWidget

an ToastWidget

ToastProps

the default Toast config

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

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

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

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.

• visible: 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

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