Toast

​

Examples

NeoToast.show(
  ref: ref,
  label: "Viewing in read-only mode",
  type: .info,
);

final toastId = NeoToast.show(
  ref: ref,
  label: "Uploading file...",
  type: .loading,
);

NeoToast.show(
  ref: ref,
  label: "Profile updated",
  type: .success,
);

NeoToast.show(
  ref: ref,
  label: "Connection unstable",
  type: .warning,
);

NeoToast.show(
  ref: ref,
  label: "Failed to save changes",
  type: .danger,
);

NeoToast.show(
  ref: ref,
  label: "Export completed",
  description: "Your data has been exported to Downloads/report.pdf",
  type: .success,
);

NeoToast.show(
  ref: ref,
  label: "Item archived",
  type: .info,
  action: NeoToastAction(
    label: "Undo",
    onPressed: () {},
  ),
);

// Start with loading toast
final toastId = NeoToast.show(
  ref: ref,
  label: "Uploading file...",
  type: .loading,
);

// Update to success when done
NeoToast.update(
  ref: ref,
  id: toastId,
  label: "File uploaded successfully",
  type: .success,
  description: "Available in your documents folder",
);

​

Methods

​

NeoToast.show()

​

Required Parameters

​

Optional Parameters

​

NeoToast.update()

​

Required Parameters

​

Optional Parameters

​

Action

​

Required

​

Enums

​

NeoToastType

• info: General information
• loading: Ongoing operations with spinner
• success: Successful actions with checkmark icon
• warning: Cautionary messages with warning icon
• danger: Error states with error icon

​

Best Practices

• Use a NeoToastType preset unless you need a custom toast.
• Call NeoToast.update() when one operation moves from loading to success or danger.
• You could put a file path, an error code, or a next step in description.
• You could use action for a follow-up, such as undo. Set autoDismiss: false when that follow-up should stay on screen.
• Do not also call NeoHaptics for the same show or update.

​

Behavior

• Toasts stack vertically. Each toast’s height is measured, and the stack moves when one changes.
• An update scales the toast up briefly.
• When autoDismiss is on, or a dismiss control is visible, a horizontal drag past about 25% of the width scales the toast down and dismisses it. A shorter drag springs it back.
• info, success, and warning dismiss on their own. danger stays until the user dismisses it. loading stays until the type changes or you dismiss it.
• show and a typed update play haptics from NeoConfig.enableToastHaptics: light for a loading show, heavy for other non-danger types, and error for danger.