Components

Popover

An accessible popup anchored to a button

import { Popover } from "@nyte-ai/ui/popover";

A popup anchored to the button that opens it. Reach for it when the content is interactive and belongs next to its trigger.

No Nyte styling here.

Usage

Popover.Positioner places the popup. It defaults to side="bottom" and align="center". Pass sideOffset for the gap between the anchor and the popup.
Popover.Arrow only works inside the positioner. arrowPadding on the positioner keeps the arrow clear of rounded corners.
openOnHover on the trigger opens the popup on hover after delay, which is 300ms. Set closeDelay to hold it open while the pointer travels.
The popover is non-modal by default. With modal={true}, focus trapping turns on only when Popover.Close is rendered inside Popover.Popup.
Popover.Title and Popover.Description name and describe the popup. Render them rather than writing your own ARIA.
Pass open and onOpenChange on Popover.Root to drive it from your own state. With no trigger inside the root, point the positioner at an element with anchor.
Popover.Viewport is only needed when one popup serves several triggers and you animate the content change.
To open from a trigger outside the root, pass one handle from Popover.createHandle() to both the trigger and the root.

Anatomy

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

Examples

A popover that opens on press, offset from its trigger.

<Popover.Root>
  <Popover.Trigger render={<Button variant="outline" />}>Notifications</Popover.Trigger>
  <Popover.Portal>
    <Popover.Positioner sideOffset={6}>
      <Popover.Popup>
        <Popover.Title>Notifications</Popover.Title>
        <Popover.Description>You are all caught up.</Popover.Description>
        <div>
          <Popover.Close render={<Button size="sm" variant="ghost" />}>Close</Popover.Close>
        </div>
      </Popover.Popup>
    </Popover.Positioner>
  </Popover.Portal>
</Popover.Root>

An infotip opens on hover and stays open while the pointer moves to the popup. The trigger is icon-only, so it carries its own label.

<Popover.Trigger openOnHover delay={200} closeDelay={150} aria-label="About rate limits">
  <IconCircleInfo size={14} />
</Popover.Trigger>

One popover driven by two detached triggers, each passing its own payload.

const details = Popover.createHandle<{ name: string }>();

<Popover.Trigger handle={details} payload={{ name: "Ada" }}>Ada</Popover.Trigger>
<Popover.Trigger handle={details} payload={{ name: "Linus" }}>Linus</Popover.Trigger>

<Popover.Root handle={details}>
  {({ payload }) => (
    <Popover.Portal>
      <Popover.Positioner>
        <Popover.Popup>
          <Popover.Title>{payload?.name}</Popover.Title>
        </Popover.Popup>
      </Popover.Positioner>
    </Popover.Portal>
  )}
</Popover.Root>;

Animate the popup's position with CSS transitions on left, right, top, and bottom of the positioner, and its size with width and height on the popup.

Props

The part tables below come from Base UI, MIT, © Material-UI SAS.

Root

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

Root Props:

Prop	Type	Default	Description
defaultOpen	`boolean`	`false`	Whether the popover is initially open. To render a controlled popover, use the `open` prop instead.
open	`boolean`	-	Whether the popover is currently open.
onOpenChange	`((open: boolean, eventDetails: Popover.Root.ChangeEventDetails) => void)`	-	Event handler called when the popover is opened or closed.
actionsRef	`React.RefObject<Popover.Root.Actions \| null>`	-	A ref to imperative actions. `unmount`: Manually unmounts the popover. Call this after any externally controlled closing animation finishes.`close`: Closes the popover imperatively when called.
defaultTriggerId	`string \| null`	-	ID of the trigger that the popover is associated with. This is useful in conjunction with the `defaultOpen` prop to create an initially open popover.
handle	`Popover.Handle<Payload>`	-	A handle to associate the popover with a trigger. If specified, allows external triggers to control the popover's open state.
modal	`boolean \| 'trap-focus'`	`false`	Determines if the popover enters a modal state when open. `true`: user interaction is limited to the popover: document page scroll is locked, and pointer interactions on outside elements are disabled.`false`: user interaction with the rest of the document is allowed.`'trap-focus'`: focus is trapped inside the popover, but document page scroll is not locked and pointer interactions outside of it remain enabled. On touch devices, a `true` modal blocks outside taps but leaves the page scrollable unless the popup spans nearly the full viewport width, matching native iOS behavior. When `modal` is `true`, focus trapping is enabled only if `<Popover.Close>` is rendered inside `<Popover.Popup>`. It can be visually hidden with your own CSS if needed, such as Tailwind's `sr-only` utility. When `modal` is `'trap-focus'`, render `<Popover.Close>` inside `<Popover.Popup>` so touch screen readers can escape the popup.
onOpenChangeComplete	`((open: boolean) => void)`	-	Event handler called after any animations complete when the popover is opened or closed.
triggerId	`string \| null`	-	ID of the trigger that the popover is associated with. This is useful in conjunction with the `open` prop to create a controlled popover. There's no need to specify this prop when the popover is uncontrolled (that is, when the `open` prop is not set).
children	`React.ReactNode \| PayloadChildRenderFunction<Payload>`	-	The content of the popover. This can be a regular React node or a render function that receives the `payload` of the active trigger.

Trigger

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

Trigger Props:

Prop	Type	Default	Description
handle	`Popover.Handle<Payload>`	-	A handle to associate the trigger with a popover.
nativeButton	`boolean`	`true`	Whether the component renders a native `<button>` element when replacing it via the `render` prop. Set to `false` if the rendered element is not a button (for example, `<div>`).
payload	`Payload`	-	A payload to pass to the popover when it is opened.
openOnHover	`boolean`	`false`	Whether the popover should also open when the trigger is hovered.
delay	`number`	`300`	How long to wait before the popover may be opened on hover. Specified in milliseconds. Requires the `openOnHover` prop.
closeDelay	`number`	`0`	How long to wait before closing the popover that was opened on hover. Specified in milliseconds. Requires the `openOnHover` prop.
id	`string`	-	ID of the trigger. In addition to being forwarded to the rendered element, it is also used to specify the active trigger for the popover in controlled mode (with the Popover.Root `triggerId` prop).
className	`string \| ((state: Popover.Trigger.State) => string \| undefined)`	-	CSS class applied to the element, or a function that returns a class based on the component's state.
style	`React.CSSProperties \| ((state: Popover.Trigger.State) => React.CSSProperties \| undefined)`	-	Style applied to the element, or a function that returns a style object based on the component's state.
render	`ReactElement \| ((props: HTMLProps, state: Popover.Trigger.State) => ReactElement)`	-	Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render.

Trigger Data Attributes:

Attribute	Type	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.

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> element.

Portal Props:

Prop	Type	Default	Description
container	`HTMLElement \| ShadowRoot \| React.RefObject<HTMLElement \| ShadowRoot \| null> \| null`	-	A parent element to render the portal element into.
className	`string \| ((state: Popover.Portal.State) => string \| undefined)`	-	CSS class applied to the element, or a function that returns a class based on the component's state.
style	`React.CSSProperties \| ((state: Popover.Portal.State) => React.CSSProperties \| undefined)`	-	Style applied to the element, or a function that returns a style object based on the component's state.
keepMounted	`boolean`	`false`	Whether to keep the portal mounted in the DOM while the popup is hidden.
render	`ReactElement \| ((props: HTMLProps, state: Popover.Portal.State) => ReactElement)`	-	Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render.

Backdrop

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

Backdrop Props:

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

Backdrop Data Attributes:

Attribute	Type	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.

Positioner

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

Positioner Props:

Prop	Type	Default	Description
disableAnchorTracking	`boolean`	`false`	Whether to disable the popup from tracking any layout shift of its positioning anchor.
align	`Align`	`'center'`	How to align the popup relative to the specified side.
alignOffset	`number \| OffsetFunction`	`0`	Additional offset along the alignment axis in pixels. Also accepts a function that returns the offset to read the dimensions of the anchor and positioner elements, along with its side and alignment. The function takes a `data` object parameter with the following properties: `data.anchor`: the dimensions of the anchor element with properties `width` and `height`.`data.positioner`: the dimensions of the positioner element with properties `width` and `height`.`data.side`: which side of the anchor element the positioner is aligned against.`data.align`: how the positioner is aligned relative to the specified side.
side	`Side`	`'bottom'`	Which side of the anchor element to align the popup against. May automatically change to avoid collisions.
sideOffset	`number \| OffsetFunction`	`0`	Distance between the anchor and the popup in pixels. Also accepts a function that returns the distance to read the dimensions of the anchor and positioner elements, along with its side and alignment. The function takes a `data` object parameter with the following properties: `data.anchor`: the dimensions of the anchor element with properties `width` and `height`.`data.positioner`: the dimensions of the positioner element with properties `width` and `height`.`data.side`: which side of the anchor element the positioner is aligned against.`data.align`: how the positioner is aligned relative to the specified side.
arrowPadding	`number`	`5`	Minimum distance to maintain between the arrow and the edges of the popup. Use it to prevent the arrow element from hanging out of the rounded corners of a popup.
anchor	`Element \| VirtualElement \| React.RefObject<Element \| null> \| (() => Element \| VirtualElement \| null) \| null`	-	An element to position the popup against. By default, the popup will be positioned against the trigger.
collisionAvoidance	`CollisionAvoidance`	-	Determines how to handle collisions when positioning the popup. `side` controls overflow on the preferred placement axis (`top`/`bottom` or `left`/`right`): `'flip'`: keep the requested side when it fits; otherwise try the opposite side (`top` and `bottom`, or `left` and `right`).`'shift'`: never change side; keep the requested side and move the popup within the clipping boundary so it stays visible.`'none'`: do not correct side-axis overflow. `align` controls overflow on the alignment axis (`start`/`center`/`end`): `'flip'`: keep side, but swap `start` and `end` when the requested alignment overflows.`'shift'`: keep side and requested alignment, then nudge the popup along the alignment axis to fit.`'none'`: do not correct alignment-axis overflow. `fallbackAxisSide` controls fallback behavior on the perpendicular axis when the preferred axis cannot fit: `'start'`: allow perpendicular fallback and try the logical start side first (`top` before `bottom`, or `left` before `right` in LTR).`'end'`: allow perpendicular fallback and try the logical end side first (`bottom` before `top`, or `right` before `left` in LTR).`'none'`: do not fallback to the perpendicular axis. When `side` is `'shift'`, explicitly setting `align` only supports `'shift'` or `'none'`. If `align` is omitted, it defaults to `'flip'`.
collisionBoundary	`Boundary`	`'clipping-ancestors'`	An element or a rectangle that delimits the area that the popup is confined to.
collisionPadding	`Padding`	`5`	Additional space to maintain from the edge of the collision boundary.
sticky	`boolean`	`false`	Whether to maintain the popup in the viewport after the anchor element was scrolled out of view.
positionMethod	`'absolute' \| 'fixed'`	`'absolute'`	Determines which CSS `position` property to use.
className	`string \| ((state: Popover.Positioner.State) => string \| undefined)`	-	CSS class applied to the element, or a function that returns a class based on the component's state.
style	`React.CSSProperties \| ((state: Popover.Positioner.State) => React.CSSProperties \| undefined)`	-	Style applied to the element, or a function that returns a style object based on the component's state.
render	`ReactElement \| ((props: HTMLProps, state: Popover.Positioner.State) => ReactElement)`	-	Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render.

alignOffset Prop Example:

<Positioner
  alignOffset={({ side, align, anchor, positioner }) => {
    return side === 'top' || side === 'bottom' ? anchor.width : anchor.height;
  }}
/>

sideOffset Prop Example:

<Positioner
  sideOffset={({ side, align, anchor, positioner }) => {
    return side === 'top' || side === 'bottom' ? anchor.height : anchor.width;
  }}
/>

collisionAvoidance Prop Example:

<Positioner
  collisionAvoidance={{
    side: 'shift',
    align: 'shift',
    fallbackAxisSide: 'none',
  }}
/>

Positioner Data Attributes:

Attribute	Type	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-align	`'start' \| 'center' \| 'end'`	Indicates how the popup is aligned relative to specified side.
data-side	`'top' \| 'bottom' \| 'left' \| 'right' \| 'inline-end' \| 'inline-start'`	Indicates which side the popup is positioned relative to the trigger.

Positioner CSS Variables:

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

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

Popup Props:

Prop	Type	Default	Description
initialFocus	`boolean \| React.RefObject<HTMLElement \| null> \| ((openType: InteractionType) => boolean \| void \| HTMLElement \| null)`	-	Determines the element to focus when the popover is opened. By default, focus moves to the first tabbable element inside the popup, except when the popover is opened by touch — then the popup itself is focused to avoid opening the virtual keyboard. `false`: Do not move focus.`true`: Move focus based on the default behavior (first tabbable element or popup).`RefObject`: Move focus to the ref element.`function`: Called with the interaction type (`mouse`, `touch`, `pen`, or `keyboard`). Return an element to focus, `true` to use the default behavior, `null` to fall back to the default behavior, or `false`/`undefined` to do nothing.
finalFocus	`boolean \| React.RefObject<HTMLElement \| null> \| ((closeType: InteractionType) => boolean \| void \| HTMLElement \| null)`	-	Determines the element to focus when the popover is closed. `false`: Do not move focus.`true`: Move focus based on the default behavior (trigger or previously focused element).`RefObject`: Move focus to the ref element.`function`: Called with the interaction type (`mouse`, `touch`, `pen`, or `keyboard`). Return an element to focus, `true` to use the default behavior, `null` to fall back to the default behavior, or `false`/`undefined` to do nothing.
className	`string \| ((state: Popover.Popup.State) => string \| undefined)`	-	CSS class applied to the element, or a function that returns a class based on the component's state.
style	`React.CSSProperties \| ((state: Popover.Popup.State) => React.CSSProperties \| undefined)`	-	Style applied to the element, or a function that returns a style object based on the component's state.
render	`ReactElement \| ((props: HTMLProps, state: Popover.Popup.State) => ReactElement)`	-	Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render.

Popup Data Attributes:

Attribute	Type	Description
data-open	-	Present when the popup is open.
data-closed	-	Present when the popup is closed.
data-align	`'start' \| 'center' \| 'end'`	Indicates how the popup is aligned relative to specified side.
data-instant	`'click' \| 'dismiss' \| 'focus' \| 'trigger-change'`	Present if animations should be instant.
data-side	`'top' \| 'bottom' \| 'left' \| 'right' \| 'inline-end' \| 'inline-start'`	Indicates which side the popup is positioned relative to the trigger.
data-starting-style	-	Present when the popup begins animating in.
data-ending-style	-	Present when the popup is animating out.

Popup CSS Variables:

Variable	Type	Description
`--popup-height`	``	The height of the popup.
`--popup-width`	``	The width of the popup.

Arrow

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

Arrow Props:

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

Arrow Data Attributes:

Attribute	Type	Description
data-open	-	Present when the popup is open.
data-closed	-	Present when the popup is closed.
data-uncentered	-	Present when the popover arrow is uncentered.
data-align	`'start' \| 'center' \| 'end'`	Indicates how the popup is aligned relative to specified side.
data-side	`'top' \| 'bottom' \| 'left' \| 'right' \| 'inline-end' \| 'inline-start'`	Indicates which side the popup is positioned relative to the trigger.

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> element.

Viewport Props:

Prop	Type	Default	Description
children	`React.ReactNode`	-	The content to render inside the transition container.
className	`string \| ((state: Popover.Viewport.State) => string \| undefined)`	-	CSS class applied to the element, or a function that returns a class based on the component's state.
style	`React.CSSProperties \| ((state: Popover.Viewport.State) => React.CSSProperties \| undefined)`	-	Style applied to the element, or a function that returns a style object based on the component's state.
render	`ReactElement \| ((props: HTMLProps, state: Popover.Viewport.State) => ReactElement)`	-	Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render.

Viewport Data Attributes:

Attribute	Type	Description
data-activation-direction	`${'left' \| 'right' \| ''} ${'down' \| 'up' \| ''}`	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-current	-	Applied to the direct child of the viewport when no transitions are present or the new content when it's entering.
data-instant	`'click' \| 'dismiss' \| 'focus' \| 'trigger-change'`	Present if animations should be instant.
data-previous	-	Applied to the direct child of the viewport that contains the exiting content when transitions are present.
data-transitioning	-	Indicates that the viewport is currently transitioning between old and new content.

Viewport CSS Variables:

Variable	Type	Description
`--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.
`--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.

Title

A heading that labels the popover. Renders an <h2> element.

Title Props:

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

Description

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

Description Props:

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

Close

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

Close Props:

Prop	Type	Default	Description
nativeButton	`boolean`	`true`	Whether the component renders a native `<button>` element when replacing it via the `render` prop. Set to `false` if the rendered element is not a button (for example, `<div>`).
className	`string \| ((state: Popover.Close.State) => string \| undefined)`	-	CSS class applied to the element, or a function that returns a class based on the component's state.
style	`React.CSSProperties \| ((state: Popover.Close.State) => React.CSSProperties \| undefined)`	-	Style applied to the element, or a function that returns a style object based on the component's state.
render	`ReactElement \| ((props: HTMLProps, state: Popover.Close.State) => ReactElement)`	-	Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render.

Accessibility

The trigger carries data-popup-open while the popup is open, and data-pressed while it is pressed.
Popover.Title renders an <h2> that labels the popup. Popover.Description renders a <p> that describes it.
Escape closes the popup. Outside press closes it. Focus leaving the popup closes it.
Focus moves to the first tabbable element inside the popup on open, except when the popover was opened by touch, where the popup itself takes focus. initialFocus and finalFocus on the popup override this.
On close, focus returns to the trigger or to the previously focused element.
Render Popover.Close inside the popup when modal is true or 'trap-focus' so touch screen reader users can leave it.