bmates-uiBMates UI
Latest
/Components

Toast

A temporary notification that appears outside the document flow.

A temporary notification that appears outside the document flow.

Import

import { Toaster, Toast, useToast, ToastData } from 'bmates-ui';

Basic usage

The example below mirrors the primary Storybook composition and can be used as a starting point.

function SaveToast() {
  const { toast } = useToast();
  return (
    <Button
      onClick={() => toast({ title: 'Project saved', variant: 'success' })}
    >
      Show toast
    </Button>
  );
}

<SaveToast />
<Toaster position="bottom-right" />

Preview

Toast

Prop previews

The examples below isolate the props that change visual output or interaction.

Position

Position

Danger variant

Danger variant

Component API

Toaster.position

Viewport position for queued toasts.

toast.title

Toast heading.

toast.description

Toast body content.

toast.variant

Visual notification status.

toast.time

Dismiss delay in milliseconds; a negative value keeps it visible.

toast.action

Called when the toast is clicked.

toast.data

Custom data passed to the action callback.

Usage notes

  • Every component in the table is exported from bmates-ui.
  • Unless noted otherwise, a component also accepts the standard props of its underlying HTML element.
  • For application-owned state, use a controlled value and its change handler instead of only a default* prop.