File
|
Optional
component
|
Type : Type<T>
|
|
|
The (optional) component is rendered inside message component.
If no specific component is given, the NotificationMessageComponent is used.
|
|
Optional
events
|
Type : Subject<O>
|
|
|
The event data subject can be used to publish and observe custom events.
|
|
Optional
message
|
Type : Translatable
|
|
|
The message contains the translatable message that is rendered
inside the message component.
|
|
Optional
messageIcon
|
Type : ICON_TYPE
|
|
|
Icon used to display next to the message.
|
|
Optional
timeout
|
Type : number
|
|
|
The timeout is used to remove the message component automatically
without any user interaction.
|
|
Optional
type
|
Type : GlobalMessageType
|
|
|
The type of message is used to render the style of the message.
|
import { Type } from '@angular/core';
import { GlobalMessageType, Translatable } from '@spartacus/core';
import { ICON_TYPE } from '@spartacus/storefront';
import { Subject } from 'rxjs';
import { BaseMessageComponent } from './base-message.component';
export class MessageData<
O extends MessageEventData = MessageEventData,
T extends BaseMessageComponent = BaseMessageComponent
> {
/**
* The message contains the `translatable` message that is rendered
* inside the message component.
*/
message?: Translatable;
messageTitle?: Translatable;
cancel?: Translatable;
confirm?: Translatable;
/**
* Icon used to display next to the message.
*/
messageIcon?: ICON_TYPE;
/**
* The type of message is used to render the style of the message.
*/
type?: GlobalMessageType;
/**
* The timeout is used to remove the message component automatically
* without any user interaction.
*/
timeout?: number;
/**
* The (optional) component is rendered inside message component.
*
* If no specific component is given, the `NotificationMessageComponent` is used.
*/
component?: Type<T>;
/**
* The event data subject can be used to publish and observe custom events.
*/
events?: Subject<O>;
}
export interface MessageEventData {
close?: boolean;
}