Empty state

An empty state appears when there is no data to display and describes what the user can do next.

Installation

Package installation information
Installyarn add @atlaskit/empty-state
SourceBitbucket.org, (opens new window)
npm@atlaskit/empty-state, (opens new window)
Bundleunpkg.com, (opens new window)

Props

buttonGroupLabel

Description

Accessible name for the action buttons group of empty state. Can be used for internationalization. Default is "Button group".

Typestring

description

Description

The main block of text that holds additional supporting information.

Typestring | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal

headingLevel

Description

The value used to set the heading level of the header element. Must be in the range of 1 to 6. Defaults to 4.

Default4
Typenumber

headingSize

Description

The keyword used to set the visual appearance of the header element. Defaults to "medium". "xsmall" can be used for empty states in smaller contexts such as popups.

Default"medium"
Type"xsmall" | "medium"

imageHeight

Description

Height of the image that is rendered in EmptyState component. Useful when you want image to be of exact height to stop it bouncing around when loading in. Only set height if you want the image to resize down on smaller devices.

Typenumber

imageUrl

Description

The url of image that will be shown above the title, fed directly into the src prop of an <img> element. Note, this image will be constrained by the maxWidth and maxHeight props.

Typestring

imageWidth

Description

Width of the image that is rendered in EmptyState component. Useful when you want image to be of exact width to stop it bouncing around when loading in.

Typenumber

isLoading

Description

Used to indicate a loading state. Will show a spinner next to the action buttons when true.

Typeboolean

maxImageHeight

Description

Maximum height (in pixels) of the image, default value is 160.

Default160
Typenumber

maxImageWidth

Description

Maximum width (in pixels) of the image, default value is 160.

Default160
Typenumber

primaryAction

Description

Primary action button for the page, usually it will be something like "Create" (or "Retry" for error pages).

Typestring | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal

renderImage

Description

An alternative API to supply an image using a render prop. Only rendered if no imageUrl is supplied.

Type(props: RenderImageProps) => React.ReactNode

secondaryAction

Description

Secondary action button for the page.

Typestring | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal

tertiaryAction

Description

Button with link to some external resource like documentation or tutorial, it will be opened in a new tab.

Typestring | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal

testId

Description

A hook for automated testing.

Typestring

width

Description

Controls how much horizontal space the component fills. Defaults to "wide".

Type"narrow" | "wide"
Was this page helpful?
We use this feedback to improve our documentation.
© 2026 AtlassianTrademark, (opens new window)Privacy, (opens new window)License