Toast

Toasts are used to provide brief feedback about an operation through a message at the bottom of the screen. They are ephemeral and automatically dismiss after a set duration.

Usage

To show a toast, use the static PrimeToast.show method. You do not need a ScaffoldMessenger or ancestor Scaffold.

PrimeToast.show(context, message: 'Operation successful');

Variants

Neutral

PrimeToast.show(
  context,
  message: 'Neutral message',
  variant: PrimeToastVariant.neutral,
);

With action:

PrimeToast.show(
  context,
  message: 'Neutral message',
  variant: PrimeToastVariant.neutral,
  action: Button(
    variant: ButtonVariant.ghost,
    label: const Text('ACTION'),
    onPressed: () {},
  ),
);

Success

PrimeToast.show(
  context,
  message: 'Success message',
  variant: PrimeToastVariant.success,
);

With action:

PrimeToast.show(
  context,
  message: 'Success message',
  variant: PrimeToastVariant.success,
  action: Button(
    variant: ButtonVariant.ghost,
    label: const Text('UNDO'),
    onPressed: () {},
  ),
);

Info

PrimeToast.show(
  context,
  message: 'Info message',
  variant: PrimeToastVariant.info,
);

With action:

PrimeToast.show(
  context,
  message: 'Info message',
  variant: PrimeToastVariant.info,
  action: Button(
    variant: ButtonVariant.ghost,
    label: const Text('VIEW'),
    onPressed: () {},
  ),
);

Warning

PrimeToast.show(
  context,
  message: 'Warning message',
  variant: PrimeToastVariant.warning,
);

With action:

PrimeToast.show(
  context,
  message: 'Warning message',
  variant: PrimeToastVariant.warning,
  action: Button(
    variant: ButtonVariant.ghost,
    label: const Text('RETRY'),
    onPressed: () {},
  ),
);

Danger

PrimeToast.show(
  context,
  message: 'Danger message',
  variant: PrimeToastVariant.danger,
);

With action:

PrimeToast.show(
  context,
  message: 'Danger message',
  variant: PrimeToastVariant.danger,
  action: Button(
    variant: ButtonVariant.ghost,
    label: const Text('RETRY'),
    onPressed: () {},
  ),
);