Skip to content

Notivue


ts
import { Notivue } from 'notivue'

Notifications stream and renderer.

Props

ts
type NotivueElements = 'list' | 'listItem' | 'itemContainer'

interface NotivueProps {
  class?:
    | string
    | Record<string, boolean>
    | (string | Record<string, boolean>)[]
  /**
   * Notification containers tab index map.
   * Only needed if using NotivueKeyboard.
   *
   * @default undefined
   */
  containersTabIndex?: ContainersTabIndexMap
  /**
   * Aria label for the list container.
   * Only effective if using NotivueKeyboard.
   *
   * @default "Notifications"
   */
  listAriaLabel?: string
  /**
   * CSS styles for the list container, list items and their notification containers.
   *
   * They have higher priority over the internal styles and will override them.
   *
   * @default undefined
   */
  styles?: Partial<Record<NotivueElements, CSSProperties>>
}