Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface INotificationElement

Element used to render a notification.

An example of a notification:

example

{
   tag: 'Notification',
   props: {
     size: 'small',
     theme: 'light'
   },
   children: 'New Notification!'
}

Hierarchy

  • INotificationElement

Index

Properties

Properties

children

children: IStandardElement[] | string

HTML children as an array of IStandardElement or as a string.

props

props: object

Must have a size of PortalSize.

Type declaration

  • Optional hideBeak?: boolean

    Optional parameter to remove the beak from the notification.

  • size: PortalSize

    Must be one of PortalSize.

    Note: this is only the requested size. In certain breakpoints the size may be altered to ensure the content remains within the current screen size.

  • Optional theme?: NotificationTheme

    Optional parameter to set the theme of the notification (light/dark). Default is light.

tag

Must be Notification

Generated using TypeDoc