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.

Element
igc-toast
Slots
default — Default slot for the toast content.
CSS Parts
base — The base wrapper of the toast.

IgcToastComponent

new IgcToastComponent(): IgcToastComponent

Defined in src/components/toast/toast.ts:33

Returns IgcToastComponent

Inherited from: IgcBaseAlertLikeComponent

Determines the duration in milliseconds in which the component will be visible.

displayTime: number = 4000

Defined in src/components/common/mixins/alert.ts:31

Inherited from: IgcBaseAlertLikeComponent

Determines whether the component should close after the displayTime is over.

keepOpen: boolean = false

Defined in src/components/common/mixins/alert.ts:40

Inherited from: IgcBaseAlertLikeComponent

Whether the component is in shown state.

open: boolean = false

Defined in src/components/common/mixins/alert.ts:22

Inherited from: IgcBaseAlertLikeComponent

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: AbsolutePosition = 'bottom'

Defined in src/components/common/mixins/alert.ts:53

Inherited from: IgcBaseAlertLikeComponent

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: "container" | "viewport" = 'viewport'

Defined in src/components/common/mixins/alert.ts:65

Array of styles to apply to the element. The styles should be defined using the css tag function, via constructible stylesheets, or imported from native CSS module scripts.

Note on Content Security Policy:

Element styles are implemented with <style> tags when the browser doesn't support adopted StyleSheets. To use such <style> tags with the style-src CSP directive, the style-src value must either include 'unsafe-inline' or nonce-<base64-value> with <base64-value> replaced be a server-generated nonce.

To provide a nonce to use on generated <style> elements, set window.litNonce to a server-generated nonce in your page's HTML, before loading application code:

``

styles: CSSResult[]

Defined in src/components/toast/toast.ts:26

tagName: "igc-toast" = 'igc-toast'

Defined in src/components/toast/toast.ts:25

Inherited from: IgcBaseAlertLikeComponent

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(): void

Defined in src/components/common/mixins/alert.ts:83

Returns void

Inherited from: IgcBaseAlertLikeComponent

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>

Defined in src/components/common/mixins/alert.ts:172

Returns Promise<boolean>

Inherited from: IgcBaseAlertLikeComponent

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>

Defined in src/components/common/mixins/alert.ts:162

Returns Promise<boolean>

Inherited from: IgcBaseAlertLikeComponent

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>

Defined in src/components/common/mixins/alert.ts:182

Returns Promise<boolean>

register(): void

Defined in src/components/toast/toast.ts:29

Returns void