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.
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
Choose something else when
Examples
StatusDot example
tsximport { StatusDot } from "@tavojs/ui/status-dot";
export function StatusDotExample1() {
return (
<>
<StatusDot tone="success" label="Online" pulse />
</>
);
}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. |
tone | Tone | — | Configures tone for this component. |
size | Size | — | Configures size for this component. |
pulse | boolean | — | Configures pulse for this component. |
label | string | — | Configures label for this component. |
Complete TypeScript API
Import from @tavojs/ui/status-dot. Published exports: StatusDot, StatusDotProps.
StatusDotProps
| Property | Type | Required | Description |
|---|---|---|---|
children | Child | No | Inherited children attribute accepted by StatusDot. |
className | string | No | Optional class hook applied to the public root element owned by the component. |
sx | Sx | No | Inherited sx attribute accepted by StatusDot. |
id | string | No | Inherited id attribute accepted by StatusDot. |
role | string | No | Inherited role attribute accepted by StatusDot. |
style | Record<string, unknown> | No | Inherited style attribute accepted by StatusDot. |
title | string | No | Inherited title attribute accepted by StatusDot. |
tabIndex | number | No | Inherited tabIndex attribute accepted by StatusDot. |
hidden | boolean | No | Inherited hidden attribute accepted by StatusDot. |
disabled | boolean | No | Inherited disabled attribute accepted by StatusDot. |
onClick | TavoEventHandler<MouseEvent> | No | Inherited onClick attribute accepted by StatusDot. |
onChange | TavoEventHandler<Event> | No | Inherited onChange attribute accepted by StatusDot. |
onInput | TavoEventHandler<Event> | No | Inherited onInput attribute accepted by StatusDot. |
onKeyDown | TavoEventHandler<KeyboardEvent> | No | Inherited onKeyDown attribute accepted by StatusDot. |
onFocus | TavoEventHandler<FocusEvent> | No | Inherited onFocus attribute accepted by StatusDot. |
onBlur | TavoEventHandler<FocusEvent> | No | Inherited onBlur attribute accepted by StatusDot. |
as | PolymorphicAs | No | Changes the rendered root element or component while preserving Tavo.js UI styling and public props. |
tone | Tone | No | Configures tone for this component. |
size | "sm" | "md" | "lg" | No | Configures size for this component. |
pulse | boolean | No | Configures pulse 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
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
| Contract | Current value |
|---|---|
| Maturity | stable |
| Category | data |
| Component import | @tavojs/ui/status-dot |
| Explicit CSS import | @tavojs/ui/css/status-dot |
| Preview | Interactive preview available on this page |