<!-- Generated by scripts/gen-docs.mts from the JSDoc in registry/. Do not edit; run `pnpm run docs`. -->

# UnreadDot

The dot that marks something unread: a small round dot in the theme's primary color, with a spoken label. ConversationList and Command draw it for their unread rows; use it for an unread mark of your own, such as a chat row's mark slot.

```tsx
import { UnreadDot } from "@/components/ouro/unread-dot/unread-dot";
```

## Example

```tsx
<UnreadDot label="Unread" />
```

## Use instead when

- Use `Avatar`'s `presence` instead when the dot says whether a person is online, and `Badge` for a count.

## Props

Type: `UnreadDotProps`.

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `dot` | `boolean` | `true` | Draws the dot. Pass `false` where a mark takes the dot's place: screen readers still hear `label`, and nothing is drawn. |
| `label` (required) | `string` |  | What screen readers hear for the dot, such as "Unread". A required prop. |

## Native attributes

Also accepts the attributes in React's `HTMLAttributes` (`id`, `aria-*`, event handlers), passed to the rendered element, except those named on this page.
