@hig/notifications-flyout

HIG NotificationsFlyout

Stats

StarsIssuesVersionUpdatedCreatedSize
@hig/notifications-flyout
1422432.1.3a month ago3 years agoMinified + gzip package size for @hig/notifications-flyout in KB

Readme

Notifications Flyout

The notifications flyout provides information and warnings that products may recover from without user involvement. It is meant to be included in the navigation bar on the top of the page.

Read more about when and how to use the Notifications Flyout on the internal wiki.

Getting started

yarn add @hig/notifications-flyout @hig/theme-context @hig/theme-data

Import the component

import NotificationsFlyout, { Notification } from "@hig/notifications-flyout";

Basic usage

<NotificationsFlyout>
  <Notification>
    <p>Your subscription expires May 5</p>
  </Notification>
</NotificationsFlyout>

Advanced usage

import NotificationsFlyout, { anchorPoints } from "@hig/notifications-flyout";
import Timestamp from "@hig/timestamp";

<NotificationsFlyout
  open
  heading="Alerts"
  indicatorTitle="View application alerts"
  anchorPoint={anchorPoints.TOP_CENTER}
  notifications={[
    {
      id: "unique-id",
      featured: true,
      unread: true,
      timestamp: <Timestamp timestamp="2018-08-20T20:24:50.333Z" />,
      content: <p>Something happened</p>
    },
    {
      content: "Hello world"
    }
  ]}
/>

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.