Skip to content

EmptyStateProps

EmptyStateProps = object

Defined in: packages/ui/src/types.ts:1118

Props for the EmptyState component.

Displays a permission-aware empty state with optional create CTA. Behavior adapts based on createAction permission status:

  • If permitted, the create button is shown.
  • If forbidden, only the title and description are shown.
  • If invisible (no relation), a generic “Nothing here” message is shown.

ListViewProps which uses EmptyState automatically when data is empty.

optional createAction: ClientDescriptor

Defined in: packages/ui/src/types.ts:1124

Action descriptor for the create button; controls CTA visibility.


optional createLabel: string

Defined in: packages/ui/src/types.ts:1126

Label for the create button. Defaults to “Create”.


optional description: string

Defined in: packages/ui/src/types.ts:1122

Description text with guidance.


optional icon: ComponentType<{ className?: string; }>

Defined in: packages/ui/src/types.ts:1128

Optional icon component displayed above the title.


title: string

Defined in: packages/ui/src/types.ts:1120

Title text (e.g. “No posts yet”).