/

<Notification> Component

Share
Code Editor


<Notification

  description="lAliquet in lacus, scelerisque tristique purus. Lob ortis felis orci lacus egestas et turpis."

  cta={{

    title: 'Standalone link',

    url: '/'

  }}

  onDismiss={() => {}}

/>
NameDescription
appearance
string
Render on light or dark background.
Options: "light", "dark"
description*
string
The text that appears within the notification.
cta*
object
Object contains nested props, see below:
cta.title*
string
The text used within the link.
cta.url*
string
The url used within the link.
cta.onClick
function
An optional function that will be called when the button is clicked.
onDismiss*
function
A function called when the close button is clicked.

notification API

// Render a notification
notification(
  (n) => {
    // Render your notification UI component
    return <Notification />
  },
  {
    // Provide a custom id to the notification, this ensures
    // your not rendering the same notification more than once
    // at a given time, and allows you to programmatically remove
    // notifications via notification.remove('custom-id').
    id: 'custom-id',
    // Set a custom auto dismiss duration.
    // Set to `Infinity` to prevent auto dismissal.
    duration: 6000,
  }
)
 
// Remove a notification from the UI
notification.remove('custom-id')

How to render notifications

Import and add the <Notifications /> component within your App file. Ensure your app is wrapped the MotionConfig component to lazy load Framer Motion features.

// pages/_app.tsx
import MotionConfig from '@hashicorp/react-motion-config'
import { Notfications } from '@hashicorp/react-notification'
 
export default function App({ Component, pageProps }) {
  return (
    <MotionConfig>
      <Component {...pageProps} />
      <Notifications />
    </MotionConfig>
  )
}

Render a notification using the notification function. Below we demonstrate how you can render a notification on page load, and also based on a user interaction.

// pages/index.tsx
import * as React from 'react'
import { notification, Notification } from '@hashicorp/react-notification'
 
export default function Homepage() {
  React.useEffect(() => {
    // Render a notification on page load
    notification((n) => {
      return (
        <Notification
          description="lAliquet in lacus, scelerisque tristique purus. Lob ortis felis orci lacus egestas et turpis."
          cta={{
            title: 'Standalone link',
            url: '/',
          }}
          onDismiss={() => notification.remove(n.id)}
        />
      )
    })
  }, [])
 
  const handleCopy = () => {
    // Trigger a notification based on a user action
    notification((n) => {
      return <Notification />
    })
  }
 
  return (
    <>
      <button onClick={handleCopy}>Copy</button>
    </>
  )
}

While we recommend you use the appropriate Notification UI components, you have the ability to render custom markup using the notification function.

With language

Share
Code Editor


<NotificationWithLanguage

  language="en"

  description="lAliquet in lacus, scelerisque tristique purus. Lob ortis felis orci lacus egestas et turpis."

  cta={{

    title: 'Standalone link',

    url: '/'

  }}

  onDismiss={() => {}}

/>

With product

Share
Code Editor


<NotificationWithProduct

  product="vault"

  description="lAliquet in lacus, scelerisque tristique purus. Lob ortis felis orci lacus egestas et turpis."

  cta={{

    title: 'Standalone link',

    url: '/'

  }}

  onDismiss={() => {}}

/>

With resource

Share
Code Editor


<NotificationWithResource

  type="webinar"

  description="lAliquet in lacus, scelerisque tristique purus. Lob ortis felis orci lacus egestas et turpis."

  cta={{

    title: 'Standalone link',

    url: '/'

  }}

  onDismiss={() => {}}

/>

With thumbnail

Share
Code Editor


<NotificationWithThumbnail

  thumbnail={{

    src: 'https://www.datocms-assets.com/2885/1651495958-infrastructure.png',

    alt: 'HashiCorp Infrastructure'

  }}

  description="lAliquet in lacus, scelerisque tristique purus. Lob ortis felis orci lacus egestas et turpis."

  cta={{

    title: 'Standalone link',

    url: '/'

  }}

  onDismiss={() => {}}

/>

With actions

Share
Code Editor


<NotificationWithActions

  heading="Notification heading"

  description="lAliquet in lacus, scelerisque tristique purus. Lob ortis felis orci lacus egestas et turpis."

  actions={[

    {

      title: 'Primary action',

      onClick: () => {}

    },

    {

      title: 'Secondary action',

      onClick: () => {}

    },

  ]}

  onDismiss={() => {}}

/>