| Description | Primary action button for the page, usually it will be something like "Create" (or "Retry" for error pages). |
|---|---|
| Type | string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal |
Empty state
An empty state appears when there is no data to display and describes what the user can do next.Installation
| Install | yarn add @atlaskit/empty-state |
|---|---|
| Source | Bitbucket.org, (opens new window) |
| npm | @atlaskit/empty-state, (opens new window) |
| Bundle | unpkg.com, (opens new window) |
Props
| Description | The main block of text that holds additional supporting information. |
|---|---|
| Type | string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal |
| Description | Title that briefly describes the page to the user. |
|---|---|
| Type | string |
| 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. |
|---|---|
| Default | 4 |
| Type | number |
| 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" |
| 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 |
|---|---|
| Type | number |
| Description | The url of image that will be shown above the title, fed directly into the |
|---|---|
| Type | string |
| 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. |
|---|---|
| Type | number |
| Description | Used to indicate a loading state. Will show a spinner next to the action buttons when true. |
|---|---|
| Type | boolean |
| Description | Maximum height (in pixels) of the image, default value is 160. |
|---|---|
| Default | 160 |
| Type | number |
| Description | Maximum width (in pixels) of the image, default value is 160. |
|---|---|
| Default | 160 |
| Type | number |
| Description | An alternative API to supply an image using a render prop. Only rendered if no |
|---|---|
| Type | (props: RenderImageProps) => React.ReactNode |
| Description | Secondary action button for the page. |
|---|---|
| Type | string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal |
| Description | Button with link to some external resource like documentation or tutorial, it will be opened in a new tab. |
|---|---|
| Type | string | number | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal |
| Description | A hook for automated testing. |
|---|---|
| Type | string |
| Description | Controls how much horizontal space the component fills. Defaults to "wide". |
|---|---|
| Type | "narrow" | "wide" |