File

src/modules/toast-notification/components/toast-message.intf.ts

Description

Stark Toast Notification Message Interface

Extends

StarkMessage

Index

Properties

Properties

actionClasses
actionClasses: string[]
Type : string[]
Optional

Array containing the CSS classes to be applied to the action button (if the message contains an action to be displayed)

actionLabel
actionLabel: string
Type : string
Optional

If provided, an action button with the label provided will be added in the notification The return value is "ok" when this button is clicked

delay
delay: number
Type : number
Optional

How many milliseconds the message will be displayed before automatically closing If set to 0, the toast will stay open until closed manually

import { StarkMessage } from "@nationalbankbelgium/stark-ui/src/common";

/**
 * Stark Toast Notification Message Interface
 */
export interface StarkToastMessage extends StarkMessage {
	/**
	 * How many milliseconds the message will be displayed before automatically closing
	 * If set to `0`, the toast will stay open until closed manually
	 */
	delay?: number;

	/**
	 * If provided, an action button with the label provided will be added in the notification
	 * The return value is `"ok"` when this button is clicked
	 */
	actionLabel?: string;

	/**
	 * Array containing the CSS classes to be applied to the action button (if the message contains an action to be displayed)
	 */
	actionClasses?: string[];
}

results matching ""

    No results matching ""