Popover - Tamagui — ContextQMD

tsx

Popovers are a great way to show content that's only visible when trigger is pressed, floating above the current content. They automatically stack above other content. Be sure to open the code example above for a copy-paste implementation.

<Notice> Note: Popovers are not a recommended pattern for mobile apps. Instead you can use Adapt and render them as a Sheet, or just conditionally render them to some native UI. </Notice>

Installation

Popover is already installed in tamagui, or you can install it independently:

bash

npm install @tamagui/popover

<Notice theme="blue"> For native apps, we recommend [setting up native portals](/docs/components/portal#native-portal-setup-recommended) to preserve React context inside Popover content. </Notice>

Anatomy

tsx

import { Popover, Adapt, Sheet } from 'tamagui' // or '@tamagui/popover'

export default () => (
  <Popover>
    <Popover.Trigger />
    <Popover.FocusScope loop trapped focusOnIdle={true}>
      <Popover.Content>
        <Popover.Arrow />
        <Popover.Close />
        <Popover.ScrollView></Popover.ScrollView>
      </Popover.Content>
    </Popover.FocusScope>
    <Adapt when="max-md">
      <Sheet>
        <Sheet.Overlay />
        <Sheet.Frame>
          <Sheet.ScrollView>
            <Adapt.Contents />
          </Sheet.ScrollView>
        </Sheet.Frame>
      </Sheet>
    </Adapt>
  </Popover>
)

Scoping

Popover supports scoping which lets you mount one or more Popover instances at the root of your app, while having a deeply nested child Trigger or Content attach to the proper parent Popover instance.

In performance sensitive areas you may want to take advantage of this as it allows you to only render the Popover.Trigger inside the sensitive area. Popover isn't the cheapest component - it has a lot of functionality inside of it like scroll management, focus management, and tracking position.

Here's the basic anatomy of using scope and placing your Popover higher up for performance:

tsx

import { Popover } from 'tamagui'

// in your root layout:
export default ({ children }) => (
  <Popover scope="user-avatar">
    <Popover.Content>
      <Popover.Arrow />
      <Popover.Close />
      <Popover.ScrollView></Popover.ScrollView>
    </Popover.Content>
    {children}
  </Popover>
)

tsx

export default () => (
  <Popover.Trigger scope="user-avatar">
    <Avatar />
  </Popover.Trigger>
)

Note that the Trigger scope ties to the Popover scope.

API Reference

Contains every component for the popover.

<PropsTable data={[ { name: 'children', type: 'React.ReactNode', required: true, description: Must contain Popover.Content, }, { name: 'size', type: 'SizeTokens', required: false, description: Passes size down to all sub-components when set for padding, arrow, borderRadius., }, { name: 'placement', type: 'Placement', required: false, description: 'top' | 'right' | 'bottom' | 'left' | 'top-start' | 'top-end' | 'right-start' | 'right-end' | 'bottom-start' | 'bottom-end' | 'left-start' | 'left-end', }, { name: 'open', type: 'boolean', required: false, description: Controlled open state of the popover., }, { name: 'defaultOpen', type: 'boolean', required: false, description: Initial open state when uncontrolled., }, { name: 'onOpenChange', type: (open: boolean, via?: 'hover' | 'press') => void, required: false, description: Called when the popover opens or closes. The optional second argument indicates how it was triggered - 'hover' for hover events (when using the hoverable prop) or 'press' for click/press events., }, { name: 'keepChildrenMounted', type: 'boolean | "lazy"', required: false, description: By default, Popover removes children from DOM/rendering when fully hidden. Setting true will keep children mounted even when hidden. This can be beneficial for performance if your popover content is expensive to render. The "lazy" value will only initially mount the children after a React startTransition, and then keep them mounted thereafter., }, { name: 'disableDismissable', type: 'boolean', required: false, description: Disables the dismissable layer (escape key, outside click handling). Useful when using keepChildrenMounted for popovers that stay mounted but are visually hidden - set this to true when the popover is hidden to prevent it from capturing escape key presses., }, { name: 'stayInFrame', type: 'ShiftProps | boolean', required: false, default: '{ padding: 10 }', description: Shifts the popover horizontally to stay within viewport bounds. Pass an object to customize shift behavior (mainAxis, crossAxis, padding)., }, { name: 'allowFlip', type: 'FlipProps | boolean', required: false, description: Moves the Popover to other sides when space allows it, see floating-ui flip()., }, { name: 'offset', type: 'OffsetOptions', required: false, description: Determines the distance the Popover appears from the target, see floating-ui offset()., }, { name: 'hoverable', type: 'boolean | UseFloatingProps', required: false, description: Allows hovering on the trigger to open the popover. See UseFloatingProps from floating-ui: accepts boolean or object of { delay: number, restMs: number, handleClose: Function, mouseOnly: boolean, move: boolean }, }, { name: 'resize', type: 'SizeProps | boolean', required: false, description: Will set maxWidth and maxHeight of Content to fit inside outer window when it won't fit, see floating-ui size()., }, { name: 'zIndex', type: 'number', required: false, description: Override the automatic z-index stacking. By default, Tamagui automatically stacks overlays so later-opened content appears above earlier content. Only set this if you need to override the automatic behavior., }, ]} />

For most of these properties, you'll want to reference the floating-ui docs.

<Notice> If using `modal={true}` (which is `true` by default), refer to the [PortalProvider installation](#portalprovider) for more information. </Notice>

Popover.Arrow can be used to show an arrow that points at the Trigger element. In order for the Arrow to show you must have a Trigger element within your Popover. Arrows extend YStack, see Stacks.

Popover.Trigger

Used to trigger opening of the popover when uncontrolled, just renders a YStack, see Stacks.

Extends PopperContent which extends SizableStack which extends a YStack (see Stacks). Used to display the content of the popover.

Popover.Anchor

Renders as YStack, see Stacks.

When you want the Trigger to be in another location from where the Popover attaches, use Anchor. When used, Anchor is where the Popover will attach, while Trigger will open it.

Sheet (with Adapt)

When used with Adapt, you can render a Sheet when that breakpoint is active. Import Sheet directly from tamagui or @tamagui/sheet.

See Sheet for more props.

Must use Adapt.Contents inside the Sheet.Frame to insert the contents given to Popover.Content

Provides access to the underlying FocusScope component used by Popover for focus management. Can be used to control focus behavior from a parent component.

<PropsTable data={[ { name: 'enabled', type: 'boolean', default: 'true', description: Whether focus management is enabled, }, { name: 'loop', type: 'boolean', default: 'false', description: When true, tabbing from last item will focus first tabbable and shift+tab from first item will focus last tabbable, }, { name: 'trapped', type: 'boolean', default: 'false', description: When true, focus cannot escape the focus scope via keyboard, pointer, or programmatic focus, }, { name: 'focusOnIdle', type: 'boolean | number', default: 'false', description: When true, waits for idle before focusing. When a number, waits that many ms. This prevents reflows during animations, }, { name: 'onMountAutoFocus', type: '(event: Event) => void', description: Event handler called when auto-focusing on mount. Can be prevented, }, { name: 'onUnmountAutoFocus', type: '(event: Event) => void', description: Event handler called when auto-focusing on unmount. Can be prevented, }, ]} />

Must be nested inside Content. Renders as a plain React Native ScrollView. If used alongside <Adapt /> and Sheet, Tamagui will automatically know to remove this ScrollView when swapping into the Sheet, as the Sheet must use its own ScrollView that handles special logic for interactions with dragging.

Utility Functions

These functions allow you to programmatically manage open popovers.

tsx

import {
  closeOpenPopovers,
  closeLastOpenedPopover,
  hasOpenPopovers,
} from '@tamagui/popover'

closeOpenPopovers

Closes all currently open popovers. Returns true if any popovers were closed, false if none were open.

tsx

const didClose = closeOpenPopovers()

closeLastOpenedPopover

Closes only the most recently opened popover. Returns true if a popover was closed, false if none were open.

tsx

const didClose = closeLastOpenedPopover()

hasOpenPopovers

Returns true if there are any open popovers, false otherwise.

tsx

if (hasOpenPopovers()) {
  // handle open popovers
}