foundation-notifications

Home > @genesislcap/foundation-notifications

foundation-notifications package

Classes

Class	Description
BannerBuilder	BannerBuilder
DialogBuilder	DialogBuilder class
NotificationBuilder	NotificationBuilder to build NotificationStructure
SnackbarBuilder	SnackbarBuilder to build Snackbar
ToastBuilder

Enumerations

Enumeration	Description
NotificationEvent	enum for different types of notification events

Functions

Function	Description
getBannerAnchor(element)	Get the banner anchor to attach the banner to
getBannerBuilder()	Get banner builder instance
getDialogBuilder()	Returns an instance of DialogBuilder
getLoglevel(details)	Retrieves the log level from an NotificationStructure object
getNotificationBuilder()	Returns a new NotificationBuilder instance
getNotificationContainer(id, tagName)	Get/Create the error container in the DOM
getNotificationDetails(details)	Retrieves the notification details from an NotificationStructure object
getSnackbarBuilder()	Get snackbar builder instance
getToastBuilder()	Get notification builder instance
showBanner(notificationStructure, tagName, notificationBoundary)	Shows the notificationStructure dialog
showLoggerLogLevel(notificationStructure)	Shows logger with log level from NotificationStructure object
showNotification(notificationStructure, tagName, notificationBoundary)	Shows the notificationStructure in the appropriate component
showNotificationAlert(configuration)	Shows the notification alert
showNotificationBanner(configuration, tagName, notificationBoundary)	Shows the notification banner
showNotificationDialog(configuration, tagName)	Shows the notification dialog
showNotificationSnackbar(configuration, tagName)	Shows the notification snackbar
showNotificationToast(configuration, tagName, notificationContainer)	Shows the notification toast

Interfaces

Interface	Description
AlertStructure	Interface for Alert Structure
Banner	Interface for Banner configuration
BannerStructure	Interface for Banner Structure
ConfirmingAction	Interface for Confirming Action configuration
Dialog	Interface for Dialog configuration
DialogStructure	Interface for Dialog Structure
DismissingAction	Interface for Dismissing Action configuration
NotificationDataRow	Interface for notify data
NotificationStructure	Interface for Notification Structure
Snackbar	Interface for Snackbar configuration
SnackbarStructure	Interface for Snackbar Structure
Toast	Interface for Toast configuration
ToastButton	Interface for ToastButton
ToastStructure	Interface for Toast Structure

Type Aliases

Type Alias	Description
NotificationSeverity	type for notification severity
NotificationType	type for notification
SnackbarType	type for snackbar type
ToastPosition	type for notification position