Navigated to /docs/ui/components/status-dot

StatusDot

Compact semantic status indicator.

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 { StatusDot } from "@tavojs/ui/status-dot";

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/status-dot.

When to use

Use it when

Use `StatusDot` for compact live or static statuses

Choose something else when

Avoid StatusDot when using data components as decorative layout containers.

Examples

StatusDot example

TSX
tsximport { StatusDot } from "@tavojs/ui/status-dot";

export function StatusDotExample1() {
  return (
    <>
      <StatusDot tone="success" label="Online" pulse />
    </>
  );
}

Common props and defaults

PropTypeDefaultDescription
classNamestring

Optional class hook applied to the public root element owned by the component.
asstring | Component<Record<string, unknown>>

Changes the rendered root element or component while preserving Tavo.js UI styling and public props.
toneTone

Configures tone for this component.
sizeSize

Configures size for this component.
pulseboolean

Configures pulse for this component.
labelstring

Configures label for this component.

Complete TypeScript API

Import from @tavojs/ui/status-dot. Published exports: StatusDot, StatusDotProps.

StatusDotProps

PropertyTypeRequiredDescription
childrenChild

No

Inherited children attribute accepted by StatusDot.

classNamestring

No

Optional class hook applied to the public root element owned by the component.

sxSx

No

Inherited sx attribute accepted by StatusDot.

idstring

No

Inherited id attribute accepted by StatusDot.

rolestring

No

Inherited role attribute accepted by StatusDot.

styleRecord<string, unknown>

No

Inherited style attribute accepted by StatusDot.

titlestring

No

Inherited title attribute accepted by StatusDot.

tabIndexnumber

No

Inherited tabIndex attribute accepted by StatusDot.

hiddenboolean

No

Inherited hidden attribute accepted by StatusDot.

disabledboolean

No

Inherited disabled attribute accepted by StatusDot.

onClickTavoEventHandler<MouseEvent>

No

Inherited onClick attribute accepted by StatusDot.

onChangeTavoEventHandler<Event>

No

Inherited onChange attribute accepted by StatusDot.

onInputTavoEventHandler<Event>

No

Inherited onInput attribute accepted by StatusDot.

onKeyDownTavoEventHandler<KeyboardEvent>

No

Inherited onKeyDown attribute accepted by StatusDot.

onFocusTavoEventHandler<FocusEvent>

No

Inherited onFocus attribute accepted by StatusDot.

onBlurTavoEventHandler<FocusEvent>

No

Inherited onBlur attribute accepted by StatusDot.

asPolymorphicAs

No

Changes the rendered root element or component while preserving Tavo.js UI styling and public props.

toneTone

No

Configures tone for this component.

size"sm" | "md" | "lg"

No

Configures size for this component.

pulseboolean

No

Configures pulse for this component.

labelstring

No

Configures label for this component.

State ownership and DOM target

ConcernContract
StateNo component state contract is exposed; the application owns the rendered content and surrounding behavior.
DOM targetThe 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 StatusDot when using data components as decorative layout containers.

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

`label` becomes the accessible label.

  • `label` becomes the accessible label.

Component status

ContractCurrent value
Maturitystable
Categorydata
Component import@tavojs/ui/status-dot
Explicit CSS import@tavojs/ui/css/status-dot
PreviewInteractive preview available on this page