DocsDocs

Popover

A floating panel beside its trigger, for details or a small form.

StableSince 1.0.0
On this page

Overview

Show code, DocumentDetails.tsx

Variants

Widths

A popover is as wide as its content, within its width's range.

Medium

Details and a field or two. The default.

Large

A longer form.

Sides

A popover opens below its trigger, above it or beside it, lined up with the trigger's start, center or end, and flips where there is no room.

Still picture, not live

Show code, FieldHelp.tsx

Anatomy

  1. Popover

  2. Title

  3. Content

  4. Trigger

Show code, PopoverAnatomy.tsx

Behaviour

Focus

Popover takes focus as it opens, and also closes when focus leaves it.

  • It isn't modal, so the page stays usable.

A small form

An action inside the popover closes it once its work is done, such as Rename.

Show code, RenameInPlace.tsx

Rules

A popover is small, named, and never the only place for what matters.

Use it when

  • Details people open on demand, such as a document's history
  • A small form beside the control it changes, such as a rename
  • An explanation behind a help mark beside a value

Fields

One to three fields at most, with the action last.

Names

Give every popover a title, or a name for assistive technology where a title would repeat its trigger.

  • Name an icon-only trigger after what the popover holds, such as About billing periods.

Accessibility

KeyAction
Enter or Space on the triggerOpens the popover and moves focus in; on an open popover's trigger, closes it.
Tab, Shift+TabMoves through the popover; past its last element it closes and moves on.
EscCloses the popover and returns focus to the trigger.