Actions Notification

Last updated:
Edit on GitHub

This document explains the Actions Notification service in the Components Library.

Overview

Actions Notification is an Angular Service that renders notification box.

Check out an example usage of the Actions Notification.

Service configuration:

  • type—an action type.
  • notifications—an array with notifications configuration based on the Notification component.
<spy-button-action
    [action]="{
        type: 'notification',
        notifications: [
            {
                type: 'info',
                title': 'Notification title',
                description: 'Notification description',
                closeable: true,
            },
        ],
    }"
>
</spy-button-action>

Service registration

Register the service:

declare module '@spryker/actions' {
    interface ActionsRegistry {
        notification: NotificationActionHandlerService;
    }
}

@NgModule({
    imports: [
        ActionsModule.withActions({
            notification: NotificationActionHandlerService,
        }),
    ],
})
export class RootModule {}

Interfaces

Below you can find interfaces for the Actions Notification:

export interface NotificationActionConfig extends ActionConfig {
    notifications: NotificationData[];
}

export interface NotificationData extends NotificationConfig {
    type?: NotificationType;
    title: string | TemplateRef<NotificationContext>;
    description?: string | TemplateRef<NotificationContext>;
    closeable?: boolean;
}

export enum NotificationType {
    Info = 'info',
    Error = 'error',
    Warning = 'warning',
    Success = 'success',
}