Get started with notifications

A notification contains the following configurable areas:


A notification card, with its parts annotated

You work with the properties of the NotificationOptions object to create or update a notification:

  • Indicator: Optional banner to call attention to the rest of the notification. See Configure important notifications.

    • indicator.text

    • indicator.color

  • Basic identifying information

    • icon: Optional image to help identify the application that produced the notification.

    • date: Optional timestamp. If not specified, defaults to current date and time.

    • title: Required title to introduce the notification. title and body are the only required properties.

  • The main section, specified with a template. One of:

  • Buttons: A row of buttons for the user to take action or dismiss the notification.

You can add other elements, to help your users interact with the notification or to organize notifications in Notification Center. These elements include:

And you can configure a notification to persist on the desktop or to appear only in Notification Center, with the toast property.

Create a basic notification

The following example shows how to apply basic options to generate the illustrated card:

    const exampleNotification: BaseNotificationOptions = 
      // banner at the top of the notification
        color: 'orange',
        text: 'News Alert',

      icon: '', //optional
      title: 'US added 138K jobs; Lower than target 185K', // required
      // TemplateMarkdown
      body: 'After more than a decade of growth, U.S. nonfarm payrolls shrunk by 701,000, and the unemployment rate rose to 4.4%...',
      // simple button
          title: “Read More”,
          type: “button”,
          cta: true,
          // see main article on buttons for more complex actions you can invoke with a button
          // this is the simplest possible example, provides only an informational link
  "”, "_blank")