Toaster

Hosts toast notifications. Place one high in the app (wrapping your content); it floats toasts in a screen corner above everything — including modals — via an Overlay entry, stacking them and auto-dismissing each after a delay unless it is persistent.

Import: package:fleury/fleury.dart, or package:fleury/fleury_core.dart in browser code.

Usage

// Wrap your app once:
Toaster(child: app)

// …then from anywhere below it:
Toaster.show(context, 'Saved', severity: ToastSeverity.success);

Details

To show a toast from anywhere below it, call Toaster.show with a BuildContext and the message. It returns a ToastHandle that can dismiss that toast early.

Constructors

`Toaster()`

Parameter	Type	Default	Description
`child:`	`Widget`	required	Application subtree over which toast overlays are presented.
`alignment:`	`Alignment`	`Alignment.bottomRight`	Which corner toasts stack in.
`duration:`	`Duration`	`const Duration(seconds: 5)`	How long each toast stays before auto-dismissing.
`maxToasts:`	`int?`	—	Maximum retained toasts. Null preserves unrestricted stacking. More

maxToasts: Adding a distinct toast while full evicts the oldest, even if persistent. There is no pending queue. Replacing an ID retains its position and does not consume another slot. Reducing the limit also evicts oldest toasts.

Source

Toaster is defined in packages/fleury/lib/src/catalog/toaster.dart.

Category: Navigation & overlays · All widgets

Example · editable

/// Wraps the app once, so any widget below it can raise a toast.
class _ToasterExample extends StatelessWidget {
  const _ToasterExample();

  @override
  Widget build(BuildContext context) =>
      const Toaster(duration: Duration(seconds: 3), child: _ToastButtons());
}

/// Raises toasts with [Toaster.show], from below the [Toaster].
class _ToastButtons extends StatelessWidget {
  const _ToastButtons();

  @override
  Widget build(BuildContext context) => Column(
    crossAxisAlignment: CrossAxisAlignment.start,
    children: [
      const Text('Raise a toast:'),
      const SizedBox(height: 1),
      Row(
        children: [
          Button(
            text: 'Save',
            autofocus: true,
            onPressed: () =>
                Toaster.show(context, 'Saved', severity: ToastSeverity.success),
          ),
          const SizedBox(width: 1),
          Button(
            text: 'Retry',
            onPressed: () => Toaster.show(
              context,
              'Connection slow, retrying',
              severity: ToastSeverity.warning,
            ),
          ),
          const SizedBox(width: 1),
          Button(
            text: 'Fail',
            onPressed: () => Toaster.show(
              context,
              'Upload failed',
              severity: ToastSeverity.error,
            ),
          ),
        ],
      ),
    ],
  );
}

Live preview

Live · interactive

click & type to interact ⓘ how this demo runs