FeedbackInteractive playground

Empty

Provide context when there is no content yet.

Preparing the playground…

Text and Markdown example

Empty · Example

1<Empty><EmptyHeader><EmptyTitle>It all starts here</EmptyTitle><EmptyDescription>You have no projects yet.</EmptyDescription></EmptyHeader><EmptyContent><Button>Create my first project</Button></EmptyContent></Empty>

Read documentation in Markdown

How to use it

Explain why it is empty and offer a useful action. Use different messages for no data and no search results.

Import

React / Next.js

1import { Empty, EmptyHeader, EmptyIcon, EmptyTitle, EmptyDescription, EmptyContent, EmptyFooter } from "@kivora/nextjs";

Interactive examples run inside a component with "use client". The playground's Copy button includes the imports needed for the current example.

API reference 0.2.0

Types from the installed published version, including component properties and common HTML attributes. “Optional” does not imply a default value; omitting a property lets the component decide.

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`onChange`	`ChangeEventHandler<HTMLDivElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLDivElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLDivElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`size`	`"sm" \| "lg" \| "md"`	Visual size of the component.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.

Subcomponents and composition

Review each component's properties and published declaration. Native and accessibility attributes are inherited from the element specified by its type.

Empty14 properties

Empty · TypeScript

1Empty: React.ForwardRefExoticComponent<EmptyProps & React.RefAttributes<HTMLDivElement>>

EmptyHeader13 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`onChange`	`ChangeEventHandler<HTMLDivElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLDivElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLDivElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.

EmptyHeader · TypeScript

1EmptyHeader: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>

EmptyIcon13 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`onChange`	`ChangeEventHandler<HTMLDivElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLDivElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLDivElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.

EmptyIcon · TypeScript

1EmptyIcon: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>

EmptyTitle13 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`onChange`	`ChangeEventHandler<HTMLHeadingElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLHeadingElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLHeadingElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.

EmptyTitle · TypeScript

1EmptyTitle: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLHeadingElement> & React.RefAttributes<HTMLHeadingElement>>

EmptyDescription13 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`onChange`	`ChangeEventHandler<HTMLParagraphElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLParagraphElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLParagraphElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.

EmptyDescription · TypeScript

1EmptyDescription: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLParagraphElement> & React.RefAttributes<HTMLParagraphElement>>

EmptyContent13 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`onChange`	`ChangeEventHandler<HTMLDivElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLDivElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLDivElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.

EmptyContent · TypeScript

1EmptyContent: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>

EmptyFooter13 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`onChange`	`ChangeEventHandler<HTMLDivElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLDivElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLDivElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.

EmptyFooter · TypeScript

1EmptyFooter: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>

API generated from @kivora/nextjs 0.2.0View package