EmptyState class

A configurable empty-state widget for screens with no content.

Renders an icon (or custom illustration), an optional title, a message, and an optional action button in a vertically centred layout.

EmptyState(
  message: 'You\'re all caught up.',
  title: 'No messages',
  icon: Icons.inbox_outlined,
)

// Pre-built variants
EmptyState.noResults(onClear: clearFilters)
EmptyState.noConnection(onRetry: reload)
EmptyState.error(onRetry: reload)
EmptyState.noData(onCreate: openForm)
Inheritance

Constructors

EmptyState({required String message, String? title, IconData? icon, Widget? illustration, String? actionLabel, VoidCallback? onAction, Key? key})
Creates a fully customisable empty-state widget.
const
EmptyState.error({Key? key, VoidCallback? onRetry, String? message})
Shows an empty state for unexpected errors.
factory
EmptyState.noConnection({Key? key, VoidCallback? onRetry})
Shows an empty state for when the device is offline.
factory
EmptyState.noData({Key? key, String? message, VoidCallback? onCreate})
Shows an empty state for screens with no data yet.
factory
EmptyState.noResults({Key? key, VoidCallback? onClear})
Shows an empty state for empty search or filter results.
factory

Properties

actionLabel String?
Label for the optional action button.
final
hashCode int
The hash code for this object.
no setterinherited
icon IconData?
Icon displayed when illustration is not provided.
final
illustration Widget?
A custom illustration widget. Takes precedence over icon.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
message String
The main descriptive message shown to the user.
final
onAction VoidCallback?
Callback invoked when the action button is pressed.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
title String?
Optional bold title displayed above message.
final

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
override
createElement() StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
inherited
toStringShort() String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited