A toast component is used to show a brief, non-interactive notification.
The component integrates with the
Invoker Commands API:
an Ignite button or a native <button> with command="--show" / "--hide" /
"--toggle" and commandfor pointing to this element will call the
corresponding method declaratively without any JavaScript.
- Slots
-
default— Default slot for the toast content.
- CSS Parts
-
base— The base wrapper of the toast.
Properties
Section titled "Properties"displayTime
Section titled "displayTime"Determines the duration in milliseconds in which the component will be visible.
displayTime: numberkeepOpen
Section titled "keepOpen"Determines whether the component should close after the displayTime is over.
keepOpen: booleanposition
Section titled "position"Sets the position of the component in the viewport.
bottom - positions the component at the bottom. This is the default.
middle - positions the component at the center.
top - positions the component at the top.
position: AbsolutePositionpositioning
Section titled "positioning"Sets the positioning strategy of the component.
viewport - positions the component relative to the viewport, ignoring any ancestor elements. This is the default behavior.
container - positions the component relative to the nearest visible ancestor. In this mode, the component will be constrained within the bounding box of the ancestor and will be positioned according to the position attribute.
positioning: NotificationPositioningMethods
Section titled "Methods"connectedCallback
Section titled "connectedCallback"Invoked when the component is added to the document's DOM.
In connectedCallback() you should setup tasks that should only occur when
the element is connected to the document. The most common of these is
adding event listeners to nodes external to the element, like a keydown
event handler added to the window.
``
Typically, anything done in connectedCallback() should be undone when the
element is disconnected, in disconnectedCallback().
connectedCallback(): voidReturns void
Closes the component.
Returns a promise that resolves to true if the component was successfully closed, or false
if it was already closed.
hide(): Promise<boolean>Returns Promise<boolean>
Opens the component.
Returns a promise that resolves to true if the component was successfully opened, or false
if it was already open or could not be shown (e.g., in container positioning mode with no visible ancestors).
show(): Promise<boolean>Returns Promise<boolean>
toggle
Section titled "toggle"Toggles the open state of the component.
Returns a promise that resolves to true if the operation completed successfully, or false
if it was already in the desired state.
toggle(): Promise<boolean>