Skip to main content

EmptyState

A centred illustration and message shown when a list or page has no data.

When to use it​

Use EmptyState for empty lists, empty search results, or first-run screens — an icon in a circular background, a heading, a description, and an optional call-to-action. Use EmptyState.large for a more prominent full-page version.

Import​

import 'package:catalyst_ui/catalyst_ui.dart';

Usage​

EmptyState(
icon: LucideIcons.inbox,
title: const Text('Nothing here yet'),
description: const Text('Add your first item to get started.'),
action: Button(
label: const Text('Add item'),
onPressed: _onAdd,
),
)

Parameters​

ParameterTypeDefaultDescription
iconIconDatarequiredThe icon rendered inside the circular background.
titleWidgetrequiredThe primary heading.
descriptionWidgetrequiredSupporting description below the heading.
actionWidget?nullAn optional call-to-action widget.
iconColorColor?nullOverrides the default brand-coloured icon colour.
iconBackgroundColorColor?nullOverrides the default tint background colour of the icon circle.

EmptyState.large​

An alternate constructor with the same parameters, rendering an 88px icon circle instead of the default 64px.