Skeleton

Loading placeholder primitive.

Preview

A live, theme-aware example rendered with the published component.

Loading preview…

Import

Import the component from its dedicated entry point to keep the dependency and generated bundle explicit.

TSX

tsximport { Skeleton } from "@tavojs/ui/skeleton";

Normal Tavo.js applications load component styles through the Tavo.js UI plugin. If the application manages component CSS manually, also import @tavojs/ui/css/skeleton.

When to use

Use it when

Use `Skeleton` for loading placeholders

Choose something else when

Avoid Skeleton when using feedback components as primary page layout.

Examples

Skeleton example

TSX

tsximport { Skeleton } from "@tavojs/ui/skeleton";

export function SkeletonExample1() {
  return (
    <>
      <Skeleton height="2rem" />
    </>
  );
}

Common props and defaults

Prop	Type	Default	Description
`className`	`string`	—	Optional class hook applied to the public root element owned by the component.
`as`	`string \| Component<Record<string, unknown>>`	—	Changes the rendered root element or component while preserving Tavo.js UI styling and public props.
`width`	`number \| string`	—	Configures width for this component.
`height`	`number \| string`	—	Configures height for this component.
`variant`	`"text" \| "circular" \| "rectangular" \| "rounded"`	—	Configures variant for this component.

Complete TypeScript API

Import from @tavojs/ui/skeleton. Published exports: Skeleton, SkeletonProps.

`SkeletonProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by Skeleton.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by Skeleton.
`id`	`string`	No	Inherited id attribute accepted by Skeleton.
`role`	`string`	No	Inherited role attribute accepted by Skeleton.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by Skeleton.
`title`	`string`	No	Inherited title attribute accepted by Skeleton.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by Skeleton.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by Skeleton.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by Skeleton.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by Skeleton.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by Skeleton.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by Skeleton.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by Skeleton.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by Skeleton.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by Skeleton.
`as`	`PolymorphicAs`	No	Changes the rendered root element or component while preserving Tavo.js UI styling and public props.
`width`	`string \| number`	No	Configures width for this component.
`height`	`string \| number`	No	Configures height for this component.
`variant`	`"text" \| "circular" \| "rectangular" \| "rounded"`	No	Configures variant for this component.

State ownership and DOM target

Concern	Contract
State	No component state contract is exposed; the application owns the rendered content and surrounding behavior.
DOM target	The public root follows the as/component prop. Root attributes, className, style, and supported events are forwarded there.

Anatomy and related components

This component exposes one public component root rather than a compound member API.

Limitations

Avoid Skeleton when using feedback components as primary page layout.

Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.

Accessibility

Feedback components should announce status changes and manage focus only when the component owns that behavior.

Use Dialog, Sheet, or FocusTrap for modal workflows.
Use Toast or native live-region semantics for dynamic announcements.
Make dismiss and escape behavior clear for overlays.

Component status

Contract	Current value
Maturity	stable
Category	feedback
Component import	`@tavojs/ui/skeleton`
Explicit CSS import	`@tavojs/ui/css/skeleton`
Preview	Interactive preview available on this page