TFlashMessageOptions object¶
The TFlashMessageOptions object represents configuration options of flash messages and is used in the methods of the Flash Messenger API.
export type TFlashMessageOptions = {
content: string;
type?: TFlashMessageTypeName;
timeout?: number;
isCloseable?: boolean;
icon?: TFlashMessageIconOptions;
};
Properties¶
TFlashMessageOptions.content¶
string A content passed to the flash-message webcomponent once it is rendered.
TFlashMessageOptions.type (optional)¶
TFlashMessageType Type of the flash-message webcomponent that tells the component how should it look like. See the TFlashMessageType type to learn more.
TFlashMessageOptions.isCloseable (optional)¶
boolean If it's true it will be possible to close the flash-message webcomponent with an X icon. By default it is set to true.
TFlashMessageOptions.timeout (optional)¶
number A duration of the flash-message webcomponent existence specified in miliseconds. If set to 0 the message will not have any timeout and it will be possible to close it only by clicking the X icon available with isCloseable set to true. If not specified the default timeout of the message wil be 6 seconds or 10 seconds if the message is more than 100 characters long.
TFlashMessageOptions.icon (optional)¶
TFlashMessageIconOptions Options of an icon inside the flash-message webcomponent. Learn more about the TFlashMessageIconOptions type here.