Components
This page catalogs every component that @ada-cx/lovelace exports, grouped by role. Each entry names the component’s purpose and its most important props, and pairs them with a copyable example. Prop types ship with the package as TypeScript declarations, so your editor completes and checks every prop.
Live component gallery
Every component in this catalog renders live below, including each icon glyph. The gallery follows the theme you configure in the theme playground: pick a preset or a scheme on either page, and both pages stay in sync. Overlay components, such as DialogOverlay and SheetOverlay, open from a button inside a contained preview frame in their tile.
The live component gallery could not load in this view. The catalog below describes every component.
Shared conventions
All components follow the same contract:
- Every component accepts
classNameandstyle, and takesrefas a regular prop (React 19). - Interactive components extend the matching React Aria Components props. Use
onPressinstead ofonClick, andisDisabledinstead ofdisabled. - Interactive states render as
data-*attributes:data-hovered,data-pressed,data-focus-visible,data-disabled,data-selected. Extend styling by targeting those attributes, not pseudo-classes. - Compound components attach their parts with dot notation, for example
Input.FieldandDialog.Title. The parts are not separate exports. - Icon-only controls require a
labelprop. It becomes the accessible name.
Conversation
Components that render the conversation itself. The chat composer is not a separate export: it is the Input component’s "composer" variant, with a send Input.Button — see Input.
AgentMessage
A single agent message: an avatar bubble beside the message text. Key props: initials, children.
UserMessage
The end user’s outbound message bubble, with an optional failed-to-send retry affordance. Key props: children, error, onRetry.
PictureMessage
An image message frame with a built-in “image unavailable” placeholder. Key props: src, alt, aspectRatio ("16:9" | "4:3" | "1:1" | "3:4" | "9:16"), unavailable, onLoadingStatusChange.
ProactiveMessage
A proactive greeting card shown outside the conversation window. Key props: children.
Divider
A transcript separator: a plain rule, a labeled marker (for example “1 unread message”), or a centered system message. Key props: variant ("line" | "label" | "message"), heading, children.
ScrollMarker
A floating jump-to-bottom control; shows an unread pill when messages wait below the fold. Key props: unreadCount, color ("default" | "brand"), onPress, children.
Header
The conversation header bar. Compound: Header.Title.
Actions
Buttons and links that trigger an action.
Button
The standard action button. Key props: variant ("primary" | "secondary" | "tertiary"), size ("md" | "sm"), destructive, onPress, isDisabled.
IconButton
An icon-only button. Key props: label (required), variant ("primary" | "secondary" | "tertiary"), size ("md" | "sm" | "xs"), destructive, children (a single icon).
PillButton
A pill-shaped secondary action button. Key props: size ("md" | "sm"), onPress, isDisabled.
Link
An inline text link, with optional external-link icon and download semantics. Key props: href, underlined, showIcon, download.
Forms and selection
Form and selection controls, including the chat composer.
Input
The text field and chat composer. Compound: Input.Label, Input.Field, Input.Control (single line), Input.TextArea (auto-growing multi-line), Input.HelperText, Input.Button. Key props — root: variant ("default" | "composer"), value, onChange, isDisabled, isInvalid; Input.TextArea: minRows, maxRows.
The composer variant adds the send button and an auto-growing text area:
Checkbox
A checkbox with an optional inline label. Key props: isSelected, onChange, children.
Radio and RadioGroup
RadioGroup groups Radio options with keyboard navigation. Key props — RadioGroup: value, onChange, aria-label, children; Radio: value, children.
Toggle
An on/off switch. Track-only: name it with aria-label. Key props: isSelected, onChange, aria-label.
Chip
A toggle chip for quick replies and filters. Key props: variant ("text" | "icon" | "number"), size ("md" | "lg"), isSelected, onChange, children.
SurveyRating
A numeric or icon rating scale (for example CSAT 1 to 5). Key props: options, aria-label (required), showLabels, selectedKey, onChange.
SurveySelect
A chip group for single or multiple choice survey questions. Key props: options, aria-label (required), selectionMode ("single" | "multiple"), disallowEmptySelection, selectedKeys, onChange.
Feedback and status
Components that report what the system is doing.
Banner
Reports a condition for as long as the condition holds, such as an outage, a lost connection, or a failed send. It never queues and never times out, so nothing transient pushes it out of view. Mount it once and drive it with visible. Give its container overflow: hidden, because the banner slides in from the container’s leading edge. Show one banner at a time. Key props: message, status, visible, revision, onDismiss, dismissLabel.
Pass onDismiss only when the reader can act on the condition. Pass revision when the same condition can repeat with the same wording, so a screen reader hears each repeat.
Spinner
A loading spinner for inline or region loading states. Key props: size ("sm" | "lg"), background ("default" | "accent"), label.
ThinkingShimmer
An animated shimmer label shown while the AI Agent generates a reply. Key props: label.
ToastNotification
The status card that Banner and ToastRegion render. It carries no live region of its own, so it announces nothing when you render it alone. Use it directly only inside a container that owns the announcement. Key props: status ("success" | "warning" | "error"), onDismiss, dismissLabel, dismissDisabled, messageProps, children.
ToastRegion
Shows the toasts on a queue as a labelled landmark region. The region owns announcement, dismissal timing, and focus. It names the dismiss button in the reader’s own language. It holds each countdown while the reader hovers or focuses the region. It keeps the region reachable with F6. The region shows no toast while a modal overlay is open. It holds each toast on the queue and shows it after the overlay closes. Create one queue for each surface. Give the region’s container overflow: hidden, because a toast slides in from the region’s leading edge. Key props: queue, aria-label.
TypingIndicator
An animated three-dot bubble shown while a human agent types. Use ThinkingShimmer for AI generation instead. Key props: aria-label, aria-live.
Overlays and menus
Modal and floating surfaces. The overlay components own presentation (scrim, focus trap, dismissal); the content components own layout.
BubbleOverlay
A non-dimming modal bubble near the bottom edge; the chat behind it stays visible. Key props: isOpen, onOpenChange, isDismissable, aria-label.
DialogOverlay
A centered modal dialog presentation with a scrim. Key props: isOpen, onOpenChange, isDismissable, role ("dialog" | "alertdialog").
FullscreenOverlay
A modal surface that fills the window. Key props: isOpen, onOpenChange, isDismissable.
SheetOverlay
A dimming, slide-up modal bottom-sheet presentation. Key props: isOpen, onOpenChange, isDismissable, aria-label.
Dialog
Dialog content: icon, title, body, and action buttons. Compound: Dialog.Icon, Dialog.Content, Dialog.Title, Dialog.Body, Dialog.Actions. Wrap in DialogOverlay for the modal presentation.
Sheet
Bottom-sheet content. Compound: Sheet.Header, Sheet.Body, Sheet.Actions. Wrap in SheetOverlay for the modal presentation.
Menu and MenuItem
Menu is a role="menu" collection with arrow-key navigation and typeahead; MenuItem is one row (compound: MenuItem.Label, plus MenuItem.Checkbox / MenuItem.Radio / MenuItem.Toggle for a selection indicator). Row content is ordered by child position around the label. Key props — Menu: aria-label, onAction, children; MenuItem: children.
Tooltip and TooltipTrigger
Tooltip is an inverse-surface tooltip with a directional arrow; TooltipTrigger (re-exported from React Aria Components) associates it with a focusable trigger. Key props — Tooltip: placement ("top" | "bottom" | "left" | "right"), children; TooltipTrigger: delay, children.
Primitives
Low-level building blocks the other components compose.
Avatar
A circular avatar bubble holding initials, an Icon, or an Image. Key props: size ("sm" | "md" | "lg" | "xl"), label (or aria-hidden), showAvatar, children.
AvatarPlaceholder
An empty avatar bubble for loading or anonymous states. Key props: size.
Icon
Wraps one icon glyph and standardizes its size and accessible name. Key props: label, children.
Image
An image with load-state tracking and a fallback slot. Key props: src, alt (required), fallback, onLoadingStatusChange.
Icon glyphs
The package also exports a set of ready-made glyph components, including ArrowDown, Checkmark, ChevronLeft, CloudUpload, Email, Paperclip, SendFill, ThumbsDown, and ThumbsUp. Each glyph wraps itself for correct sizing, so you can pass one directly wherever a component asks for an icon:
The full glyph list is in the package’s TypeScript declarations, and every glyph renders in the live component gallery.