Notification

Notification

Toast notification system with variants, auto-dismiss, flood prevention, and custom components. Wrap your app in <Notifications> and use useNotification hook to trigger.

Import

import { Notifications, useNotification } from 'reablocks';

Setup

Wrap your app (or a section) in the Notifications provider:

<Notifications>
  <App />
</Notifications>

Notifications Props

useNotification Hook

function MyComponent() {
  const {
    notify,
    notifySuccess,
    notifyError,
    notifyWarning,
    notifyInfo,
    clearNotification,
    clearAllNotifications
  } = useNotification();

  return (
    <>
      <Button => notify('Default message')}>Notify</Button>
      <Button => notifySuccess('Saved!')}>Success</Button>
      <Button => notifyError('Failed!')}>Error</Button>
      <Button => notifyWarning('Careful!')}>Warning</Button>
      <Button => notifyInfo('FYI...')}>Info</Button>
      <Button => clearAllNotifications()}>Clear All</Button>
    </>
  );
}

Notification Options

Both notify() and variant methods accept a second options argument:

notify('Title', {
  body: 'Additional details here',          // Body text (string or ReactNode)
  variant: 'success',                       // default | success | error | warning | info
  timeout: 6000,                            // Override auto-dismiss delay
  showClose: true,                          // Show close button
  icon: <CustomIcon />,                     // Override icon
  action: <Button size="small">Undo</Button>, // Action element
  className: 'custom-class'                 // Additional CSS classes
});

Custom Notification Components

<Notifications
  components={{
    error: ({ message, onClose }) => (
      <div className="custom-error">
        {message}
        <button
      </div>
    )
  }}
>
  <App />
</Notifications>

NotificationTheme Interface

interface NotificationTheme {
  container: string;     // Outer container
  positions: string;     // Fixed positioning (bottom-center by default)
  notification: {
    base: string;        // Notification card (flex, min-w, rounded, bg, border)
    variants: {
      default: { base: string; icon?: string };
      success: { base: string; icon?: string };
      error: { base: string; icon?: string };
      warning: { base: string; icon?: string };
      info: { base: string; icon?: string };
    };
    header: string;       // Title area
    content: string;      // Content wrapper
    body: string;         // Body text
    closeContainer: string;
    action: string;       // Action slot
    closeButton: string;  // Close button
  };
}