OverlaysReact

Popover

An accessible popup anchored to a button.

Rendered by React 19.3.1

Loading React…

import { Popover } from '@hamur/react/popover'

export default function PopoverExample() {
  return (
    <Popover.Root>
      <Popover.Trigger className="button">
        Notifications
      </Popover.Trigger>
      <Popover.Portal>
        <Popover.Positioner sideOffset={8}>
          <Popover.Popup className="popover">
            <Popover.Arrow className="arrow" />
            <Popover.Title className="popover-title">
              Notifications
            </Popover.Title>
            <Popover.Description className="muted">
              You are all caught up.
            </Popover.Description>
          </Popover.Popup>
        </Popover.Positioner>
      </Popover.Portal>
    </Popover.Root>
  )
}

996Tests passing in React · 0 failing

48.8 KiBSize

2.10 msOpen

17.4 msClose

25.0 msOpenMutations

20.0 msCloseMutations

1.03 MiBMemory

productdevbook and 22 upstream authors17 commits · last Nov 4

Installation

npm i @hamur/react

Not on npm yet. The package goes out under the chosen name.

Anatomy

Import the component and assemble its parts:

<Popover.Root>
  <Popover.Trigger />
  <Popover.Portal>
    <Popover.Positioner>
      <Popover.Popup>
        <Popover.Arrow />
        <Popover.Title />
        <Popover.Description />
      </Popover.Popup>
    </Popover.Positioner>
  </Popover.Portal>
</Popover.Root>

// Not in this example: Popover.Backdrop, Popover.Close, Popover.Viewport

Examples

openOnHover and delay open the popover when the pointer rests on the trigger.

PopoverOpenOnHover.tsx

import { Popover } from '@hamur/react/popover'

export default function PopoverOpenOnHoverExample() {
  return (
    <Popover.Root>
      <Popover.Trigger openOnHover className="button">
        Notifications
      </Popover.Trigger>
      <Popover.Portal>
        <Popover.Positioner sideOffset={8}>
          <Popover.Popup className="popover">
            <Popover.Arrow className="arrow" />
            <Popover.Title className="popover-title">Notifications</Popover.Title>
            <Popover.Description className="muted">
              You are all caught up. Good job!
            </Popover.Description>
          </Popover.Popup>
        </Popover.Positioner>
      </Popover.Portal>
    </Popover.Root>
  )
}

A trigger outside Root opens it through a handle.

PopoverDetachedTriggersSimple.tsx

import { Popover } from '@hamur/react/popover'

const demoPopover = Popover.createHandle()

export default function PopoverDetachedTriggersSimpleExample() {
  return (
    <>
      <Popover.Trigger className="button" handle={demoPopover}>
        Notifications
      </Popover.Trigger>

      <Popover.Root handle={demoPopover}>
        <Popover.Portal>
          <Popover.Positioner sideOffset={8}>
            <Popover.Popup className="popover">
              <Popover.Arrow className="arrow" />
              <Popover.Title className="popover-title">Notifications</Popover.Title>
              <Popover.Description className="muted">
                You are all caught up. Good job!
              </Popover.Description>
            </Popover.Popup>
          </Popover.Positioner>
        </Popover.Portal>
      </Popover.Root>
    </>
  )
}

open with triggerId lets several triggers share one popover.

PopoverDetachedTriggersControlled.tsx

import * as React from 'react'
import { Popover } from '@hamur/react/popover'

const demoPopover = Popover.createHandle()

export default function PopoverDetachedTriggersControlledExample() {
  const [open, setOpen] = React.useState(false)
  const [triggerId, setTriggerId] = React.useState<string | null>(null)

  const handleOpenChange = (isOpen: boolean, eventDetails: Popover.Root.ChangeEventDetails) => {
    setOpen(isOpen)
    setTriggerId(eventDetails.trigger?.id ?? null)
  }

  return (
    <>
      <div className="row">
        <Popover.Trigger className="button" handle={demoPopover} id="trigger-1">
          Trigger 1
        </Popover.Trigger>

        <Popover.Trigger className="button" handle={demoPopover} id="trigger-2">
          Trigger 2
        </Popover.Trigger>

        <Popover.Trigger className="button" handle={demoPopover} id="trigger-3">
          Trigger 3
        </Popover.Trigger>

        <button
          type="button"
          className="button"
          onClick={() => {
            setTriggerId('trigger-2')
            setOpen(true)
          }}
        >
          Open programmatically
        </button>
      </div>

      <Popover.Root
        handle={demoPopover}
        open={open}
        onOpenChange={handleOpenChange}
        triggerId={triggerId}
      >
        <Popover.Portal>
          <Popover.Positioner sideOffset={8}>
            <Popover.Popup className="popover">
              <Popover.Arrow className="arrow" />
              <Popover.Title className="popover-title">Notifications</Popover.Title>
              <Popover.Description className="muted">
                You are all caught up. Good job!
              </Popover.Description>
            </Popover.Popup>
          </Popover.Positioner>
        </Popover.Portal>
      </Popover.Root>
    </>
  )
}

Viewport animates the content when another trigger opens the same popover.

PopoverDetachedTriggersFull.tsx

import { Popover } from '@hamur/react/popover'

const demoPopover = Popover.createHandle<string>()

// An inline image keeps the example off the network; use your own URL in an app.
const avatar =
  "data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 48 48'%3E%3Crect width='48' height='48' fill='%232457d6'/%3E%3Ccircle cx='24' cy='19' r='8' fill='white'/%3E%3Cpath d='M8 48a16 16 0 0 1 32 0' fill='white'/%3E%3C/svg%3E"

export default function PopoverDetachedTriggersFullExample() {
  return (
    <div className="row">
      <Popover.Trigger className="button" handle={demoPopover} payload="notifications">
        Notifications
      </Popover.Trigger>

      <Popover.Trigger className="button" handle={demoPopover} payload="activity">
        Activity
      </Popover.Trigger>

      <Popover.Trigger className="button" handle={demoPopover} payload="profile">
        Profile
      </Popover.Trigger>

      <Popover.Root handle={demoPopover}>
        {({ payload }) => (
          <Popover.Portal>
            <Popover.Positioner sideOffset={8} className="popup-morph-positioner">
              <Popover.Popup className="popover popup-morph">
                <Popover.Arrow className="arrow" />

                <Popover.Viewport className="popup-morph-viewport">
                  {payload === 'notifications' && <NotificationsPanel />}
                  {payload === 'activity' && <ActivityPanel />}
                  {payload === 'profile' && <ProfilePanel />}
                </Popover.Viewport>
              </Popover.Popup>
            </Popover.Positioner>
          </Popover.Portal>
        )}
      </Popover.Root>
    </div>
  )
}

function NotificationsPanel() {
  return (
    <div className="popover-panel">
      <Popover.Title className="popover-title">Notifications</Popover.Title>
      <Popover.Description className="muted">You are all caught up. Good job!</Popover.Description>
    </div>
  )
}

function ProfilePanel() {
  return (
    <div className="popover-profile">
      <Popover.Title className="popover-title">Jason Eventon</Popover.Title>
      <img src={avatar} width="48" height="48" alt="" className="popover-profile-avatar" />
      <span className="muted">Pro plan</span>
      <div className="popover-profile-actions">
        <a href="#top">Profile settings</a>
        <a href="#top">Log out</a>
      </div>
    </div>
  )
}

function ActivityPanel() {
  return (
    <div className="popover-panel">
      <Popover.Title className="popover-title">Activity</Popover.Title>
      <Popover.Description className="muted">
        Nothing interesting happened recently.
      </Popover.Description>
    </div>
  )
}

API reference

35 props across 11 parts, in React syntax. className, style, render are listed once, under Shared props.

Arrow`Popover.Arrow`

Displays an element positioned against the popover anchor. Renders a <div>.

Arrow data attributes
Data attribute	Description
`data-open`	Present when the popup is open.
`data-closed`	Present when the popup is closed.
`data-side`	Indicates which side the popup is positioned relative to the trigger.
`data-align`	Indicates how the popup is aligned relative to specified side.
`data-uncentered`	Present when the popover arrow is uncentered.

Backdrop`Popover.Backdrop`

An overlay displayed beneath the popover. Renders a <div>.

Backdrop data attributes
Data attribute	Description
`data-open`	Present when the popup is open.
`data-closed`	Present when the popup is closed.
`data-starting-style`	Present when the popup begins animating in.
`data-ending-style`	Present when the popup is animating out.

Close`Popover.Close`

A button that closes the popover. Renders a <button>.

Close props
Prop	Type	Default
`nativeButton`Whether the component renders a native `<button>` element when replacing it	`boolean`	`true`

Description`Popover.Description`

A paragraph with additional information about the popover. Renders a <p>.

Popup`Popover.Popup`

A container for the popover contents. Renders a <div>.

Popup props
Prop	Type	Default
`initialFocus`Determines the element to focus when the popover is opened.	`boolean \| React.RefObject<HTMLElement \| null> \| ((openType: InteractionType) => boolean \| void \| HTMLElement \| null)`	`—`
`finalFocus`Determines the element to focus when the popover is closed.	`boolean \| React.RefObject<HTMLElement \| null> \| ((closeType: InteractionType) => boolean \| void \| HTMLElement \| null)`	`—`

Popup data attributes
Data attribute	Description
`data-open`	Present when the popup is open.
`data-closed`	Present when the popup is closed.
`data-starting-style`	Present when the popup begins animating in.
`data-ending-style`	Present when the popup is animating out.
`data-side`	Indicates which side the popup is positioned relative to the trigger.
`data-align`	Indicates how the popup is aligned relative to specified side.
`data-instant`	Present if animations should be instant.

Popup CSS variables
CSS variable	Description
`--popup-width`	The width of the popup.
`--popup-height`	The height of the popup.

Portal`Popover.Portal`

A portal element that moves the popup to a different part of the DOM. By default, the portal element is appended to <body>. Renders a <div>.

Portal props
Prop	Type	Default
`container`A parent element to render the portal element into.	`HTMLElement \| ShadowRoot \| React.RefObject<HTMLElement \| ShadowRoot \| null> \| null`	`—`
`keepMounted`Whether to keep the portal mounted in the DOM while the popup is hidden.	`boolean`	`false`

Positioner`Popover.Positioner`

Positions the popover against the trigger. Renders a <div>.

Positioner props
Prop	Type	Default
`disableAnchorTracking`Whether to disable the popup from tracking any layout shift of its positioning anchor.	`boolean`	`false`
`align`How to align the popup relative to the specified side.	`Align`	`'center'`
`alignOffset`Additional offset along the alignment axis in pixels.	`number \| OffsetFunction`	`0`
`side`Which side of the anchor element to align the popup against.	`Side`	`'bottom'`
`sideOffset`Distance between the anchor and the popup in pixels.	`number \| OffsetFunction`	`0`
`arrowPadding`Minimum distance to maintain between the arrow and the edges of the popup.	`number`	`5`
`anchor`An element to position the popup against.	`Element \| VirtualElement \| React.RefObject<Element \| null> \| (() => Element \| VirtualElement \| null) \| null`	`—`
`collisionAvoidance`Determines how to handle collisions when positioning the popup.	`CollisionAvoidance`	`—`
`collisionBoundary`An element or a rectangle that delimits the area that the popup is confined to.	`Boundary`	`'clipping-ancestors'`
`collisionPadding`Additional space to maintain from the edge of the collision boundary.	`Padding`	`5`
`sticky`Whether to maintain the popup in the viewport after	`boolean`	`false`
`positionMethod`Determines which CSS `position` property to use.	`"absolute" \| "fixed"`	`'absolute'`

Positioner data attributes
Data attribute	Description
`data-open`	Present when the popup is open.
`data-closed`	Present when the popup is closed.
`data-anchor-hidden`	Present when the anchor is hidden.
`data-side`	Indicates which side the popup is positioned relative to the trigger.
`data-align`	Indicates how the popup is aligned relative to specified side.

Positioner CSS variables
CSS variable	Description
`--available-width`	The available width between the trigger and the edge of the viewport.
`--available-height`	The available height between the trigger and the edge of the viewport.
`--anchor-width`	The anchor's width.
`--anchor-height`	The anchor's height.
`--transform-origin`	The coordinates that this element is anchored to. Used for animations and transitions.
`--positioner-width`	The width of the popover's positioner. It is important to set `width` to this value when using CSS to animate size changes.
`--positioner-height`	The height of the popover's positioner. It is important to set `height` to this value when using CSS to animate size changes.

Root`Popover.Root`

Groups all parts of the popover. Doesn’t render its own element.

Root props
Prop	Type	Default
`defaultOpen`Whether the popover is initially open.	`boolean`	`false`
`open`Whether the popover is currently open.	`boolean`	`—`
`onOpenChange`Event handler called when the popover is opened or closed.	`((open: boolean, eventDetails: PopoverRootChangeEventDetails) => void)`	`—`
`actionsRef`A ref to imperative actions.	`React.RefObject<PopoverRootActions \| null>`	`—`
`defaultTriggerId`ID of the trigger that the popover is associated with.	`string \| null`	`—`
`handle`A handle to associate the popover with a trigger.	`PopoverHandle<Payload>`	`—`
`modal`Determines if the popover enters a modal state when open.	`boolean \| "trap-focus"`	`false`
`onOpenChangeComplete`Event handler called after any animations complete when the popover is opened or closed.	`((open: boolean) => void)`	`—`
`triggerId`ID of the trigger that the popover is associated with.	`string \| null`	`—`
`children`The content of the popover.	`React.ReactNode \| PayloadChildRenderFunction<Payload>`	`—`

Title`Popover.Title`

A heading that labels the popover. Renders a <h2>.

Trigger`Popover.Trigger`

A button that opens the popover. Renders a <button>.

Trigger props
Prop	Type	Default
`handle`A handle to associate the trigger with a popover.	`PopoverHandle<Payload>`	`—`
`nativeButton`Whether the component renders a native `<button>` element when replacing it	`boolean`	`true`
`payload`A payload to pass to the popover when it is opened.	`Payload`	`—`
`openOnHover`Whether the popover should also open when the trigger is hovered.	`boolean`	`false`
`delay`How long to wait before the popover may be opened on hover.	`number`	`300`
`closeDelay`How long to wait before closing the popover that was opened on hover.	`number`	`0`
`id`ID of the trigger.	`string`	`—`

Trigger data attributes
Data attribute	Description
`data-popup-open`	Present when the corresponding popover is open.
`data-pressed`	Present when the trigger is pressed.
`data-disabled`	Present when the trigger is disabled.

Viewport`Popover.Viewport`

A viewport for displaying content transitions. This component is only required if one popup can be opened by multiple triggers, its content changes based on the trigger, and switching between them is animated. Renders a <div>.

Viewport props
Prop	Type	Default
`children`The content to render inside the transition container.	`React.ReactNode`	`—`

Viewport data attributes
Data attribute	Description
`data-current`	Applied to the direct child of the viewport when no transitions are present or the new content when it's entering.
`data-previous`	Applied to the direct child of the viewport that contains the exiting content when transitions are present.
`data-activation-direction`	Indicates the direction from which the popup was activated. This can be used to create directional animations based on how the popup was triggered. Contains space-separated values for both horizontal and vertical axes.
`data-transitioning`	Indicates that the viewport is currently transitioning between old and new content.
`data-instant`	Present if animations should be instant.

Viewport CSS variables
CSS variable	Description
`--popup-width`	The width of the parent popup. This variable is placed on the 'previous' container and stores the width of the popup when the previous content was rendered. It can be used to freeze the dimensions of the popup when animating between different content.
`--popup-height`	The height of the parent popup. This variable is placed on the 'previous' container and stores the height of the popup when the previous content was rendered. It can be used to freeze the dimensions of the popup when animating between different content.

Shared props

Every part that renders an element takes these.

Shared props
Prop	Type
`className`CSS class applied to the element, or a function that returns a class based on the component's state.	`string \| ((state: State) => string \| undefined)`
`style`Style applied to the element, or a function that returns a style object based on the component's state.	`React.CSSProperties \| ((state: State) => React.CSSProperties \| undefined)`
`render`Allows you to replace the component's HTML element with a different tag, or compose it with another component.	`React.ReactElement<unknown, string \| React.JSXElementConstructor<any>> \| ComponentRenderFn<HTMLProps, State>`

Keyboard and accessibility

Keyboard

Keyboard
Keys	Does	Part
`EnterSpace`	Opens and closes the popover, also when Trigger renders an element other than `<button>`	Trigger
`Escape`	Closes the popover	Popup
`Tab`	From the last element in the popup, moves on to the element after the trigger	Popup
`ShiftTab`	From the popup, moves back to the trigger	Popup

Accessibility

What the parts set
Part	Sets	So that
Trigger	`aria-haspopup="dialog"`, `aria-expanded`, `aria-controls`	a screen reader says the button opens a popup and whether it is open
Popup	`role="dialog"`, `aria-labelledby` to Title, `aria-describedby` to Description	the popup is announced with its heading and description
Popup	sits right after the trigger in the tab order, wherever it is portaled	keyboard users reach the content from the button that opened it
Arrow	`aria-hidden="true"`	the decorative arrow is not read
Backdrop	`role="presentation"`	the overlay is not read

Focus order

Opening with a click or a key moves focus into Popup, or to initialFocus; opening on hover leaves focus where it was.
Tab moves through the popup and then to the element after Trigger; Shift+Tab goes back to Trigger.
Closing returns focus to Trigger, or to finalFocus.

Popover

Installation

Anatomy

Examples

Open On Hover

Detached Triggers Simple

Detached Triggers Controlled

Detached Triggers Full

API reference

Arrow`Popover.Arrow`

Backdrop`Popover.Backdrop`

Close`Popover.Close`

Description`Popover.Description`

Portal`Popover.Portal`

Positioner`Popover.Positioner`

Root`Popover.Root`

Title`Popover.Title`

Trigger`Popover.Trigger`

Viewport`Popover.Viewport`

Shared props

Keyboard and accessibility

Keyboard

Accessibility

Focus order

Installation

Anatomy

Examples

Open On Hover

Detached Triggers Simple

Detached Triggers Controlled

Detached Triggers Full

API reference

ArrowPopover.Arrow

BackdropPopover.Backdrop

ClosePopover.Close

DescriptionPopover.Description

PopupPopover.Popup

PortalPopover.Portal

PositionerPopover.Positioner

RootPopover.Root

TitlePopover.Title

TriggerPopover.Trigger

ViewportPopover.Viewport

Shared props

Keyboard and accessibility

Keyboard

Accessibility

Focus order

Arrow`Popover.Arrow`

Backdrop`Popover.Backdrop`

Close`Popover.Close`

Description`Popover.Description`

Popup`Popover.Popup`

Portal`Popover.Portal`

Positioner`Popover.Positioner`

Root`Popover.Root`

Title`Popover.Title`

Trigger`Popover.Trigger`

Viewport`Popover.Viewport`