Status combines a colored dot, a text label, and an optional loader. Use it for workflow or record states. Use Tag for a category without the status indicator.
Record state
color is required and uses the theme palette. The label communicates the meaning independently of the color. The default element is a span; weight="medium" emphasizes its text.
Loading and announcements
loading shows a loader after the label. The component does not add a live region or change its text automatically. Keep a role="status" container mounted when updates should be announced to assistive technology, and provide a label that describes the current state.
Change a state
onClick renders a native button with pointer, Enter, and Space activation. loading does not prevent repeat activation; pass disabled when the action should wait. If render replaces the button with a non-button element, set nativeButton={false}.
Props
Types and defaults are generated from the public component types. Native attributes and event handlers are also accepted."ruby" | "red" | "crimson" | "tomato" | "orange" | "amber" | "yellow" | "lime" | "grass" | "green" | "jade" | "mint" | "turquoise" | "cyan" | "sky" | "blue" | "iris" | "violet" | "purple" | "plum" | "pink" | "bronze" | "gold" | "brown" | "gray"
required
Theme color used for the status background, text, and loader.
boolean
default:"false"
Applies disabled styling and disables activation when
onClick is supplied.boolean
default:"false"
Shows a loader after the label. Does not disable the control or announce a status change by itself.
boolean
default:"true"
Set to
false when using render with an element other than a native button.MouseEventHandler<HTMLButtonElement> | MouseEventHandler<HTMLElement>
Handles activation and renders a native button by default. Without it, the default element is a span.
NonNullable<ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, {}> | undefined>
Replaces the default element. Required when
nativeButton is false."regular" | "medium"
default:"regular"
Font weight of the label.