Dot
Dot component for indicating status, color, or presence. Uses semantic design token variants by default, with optional custom color override.
In stock
Low stock
Discontinued
Usage
import { Dot, DOT_TONE_BG_CLASSES, DotProps, dotVariants } from "@desk/ui/components/dot";Best practices
Use
Dotfor a bare colour/status indicator with no text; if you need a label or count, reach forBadge(orBadgeDot), and for a removable/interactive chip useTag.Prefer the semantic
tone(success/warning/danger/…) over a rawcolorso the dot tracks theme tokens; reservecolorfor swatches outside the palette.The dot is decorative — pair it with visible text or an
aria-label; colour alone doesn't convey status to assistive tech.
Props
| Prop | Type | Default | Description |
|---|---|---|---|
| color | string | Custom color override. When provided, overrides the variant color. Can be any valid CSS color value. | |
| size | ResponsiveValue<"base" | "2xs" | "xs" | "sm" | "lg" | "xl" | "2xl" | "3xl"> | "base" | Dot size — a single token or a per-breakpoint object like
|
| tone | "neutral" | "brand" | "danger" | "warning" | "success" | "info" | null | undefined |
Also exports
- const
DOT_TONE_BG_CLASSES - interface
DotProps - const
dotVariants
Composition
Used by
Avatar, Button, MenuItem, MobileNavigationRoot, SegmentedControl, Sidebar, Tabs, Tag, TagSelector