Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1021 Bytes

File metadata and controls

38 lines (26 loc) · 1021 Bytes
title Spinner
parent Display and data
grand_parent Components

Spinner

{: .no_toc }

Work in progress, with no measurable amount of it.

import { Spinner } from '@textui/widgets';

<Spinner label="Connecting" />

Props

Prop Type Default
label string
tone 'default' | 'primary' | 'secondary' | 'accent' | 'success' | 'warning' | 'danger' | 'info' | 'muted'

Plus everything on BoxProps.

Role: status.

Use it only when the duration is genuinely unknown. Anything with a numerator and a denominator should be a Progress, because a spinner tells a reader nothing except that the program has not died.

The frames come from the theme's glyph set and degrade to ASCII where the terminal cannot draw them.

See also

  • Progress - when the size is known
  • Skeleton - when the shape of what is coming is known