Spinner

Loading spinner with status labeling.

Preview

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

Loading preview…

Import

Import from the focused entry point below, or use the same named export from @tavojs/ui. Both are public APIs; measure the built application when comparing their bundle cost.

TSX

tsximport { Spinner } from "@tavojs/ui/spinner";

The component import loads compiled component CSS. Enable tavoUi() for your project theme variables, or import @tavojs/ui/theme.css once for the package default theme. The equivalent CSS-safe component alias is @tavojs/ui/css/spinner.

When to use

Use it when

Use `Spinner` for indeterminate loading

Choose something else when

Avoid Spinner when using feedback components as primary page layout.

Examples

These examples include imports and local state where interaction requires it. Render the exported component in a page after completing UI installation. Demo state stays in the mounted component; connect file handling, persistence, and data loading to your application as needed.

Spinner example

TSXCreate: src/components/examples/SpinnerExample1.tsx

tsximport { Spinner } from "@tavojs/ui/spinner";

export function SpinnerExample1() {
  return (
    <>
      <Spinner label="Loading report" />
    </>
  );
}

Common props and defaults

A curated starting point. The complete TypeScript API below includes additional props and compound member contracts.

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.
`size`	`Size`	—	Configures size for this component.
`tone`	`"primary" \| "secondary" \| "neutral"`	—	Configures tone for this component.
`label`	`string`	—	Configures label for this component.

Complete TypeScript API

Import from @tavojs/ui/spinner. Published exports: Spinner, SpinnerProps.

`SpinnerProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by Spinner.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by Spinner.
`id`	`string`	No	Inherited id attribute accepted by Spinner.
`role`	`string`	No	Inherited role attribute accepted by Spinner.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by Spinner.
`title`	`string`	No	Inherited title attribute accepted by Spinner.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by Spinner.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by Spinner.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by Spinner.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by Spinner.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by Spinner.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by Spinner.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by Spinner.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by Spinner.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by Spinner.
`as`	`PolymorphicAs`	No	Changes the rendered root element or component while preserving Tavo.js UI styling and public props.
`size`	`Size`	No	Configures size for this component.
`tone`	`"neutral" \| "primary" \| "secondary"`	No	Configures tone for this component.
`label`	`string`	No	Configures label 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 Spinner 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

Uses `label` for screen-reader context.

Uses `label` for screen-reader context.

Component status

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