notifications-flyout
v1.0.0arrow_drop_down
Triggers when the user’s mouse is over the notification
Triggers when the user’s mouse is no longer over the notification
This is an action that’s provided to the consumer, as a result a value must always be available.
When the flyout overflows the viewport, it’ll attempt to use the given anchor points in order to keep the flyout within the viewport.
Rendered notifications.
It takes precedent over children, and accepts an array
containing any combination of
Sets the current height of the notification so that the height transition can occur
Begins the hide transition by setting the isVisible prop
The height is then controlled via CSS in the NotificationPresenter
This method calls requestAnimationFrame again to ensure that a repaint occurs.
Action to dismiss a notification
Handler for when the flyout opens
Converts the given notifications input into an array
| Name | Type | Description |
|---|---|---|
transitionStatus | string | |
handleDismissButtonClick | function (MouseEvent): void | |
height | string | Inline style height of the Notification wrapper |
isVisible | boolean | Determines whether the state of the visibility transition |
dismissNotification | Function | |
notifications | Array<ParsedNotification> | |
showUnreadCount | boolean | |
unreadCount | number | |
children | ||
notifications | NotificationsInput? | |
unreadCount | number? | |
dismissedNotifications | Array<string> | An array of notification IDs that have been dismissed |
notifications | Array<ParsedNotification> | |
readNotifications | Array<string> | An array of notification IDs that have been read |
id | string | |
key | string | |
content | NotificationContent? | |
featured | boolean? | |
onDismiss | function (): void? | |
showDismissButton | boolean? | |
timestamp | ||
type | string? | |
unread | boolean |