AnchoredOverlay

Use anchored overlay to provide an anchor that will open a floating overlay positioned relative to the anchor. The overlay can be opened and navigated using keyboard or mouse.

Alpha
Not reviewed for accessibility

An AnchoredOverlay provides an anchor that will open a floating overlay positioned relative to the anchor. The overlay can be opened and navigated using keyboard or mouse.

Examples

<State default={false}>
  {([isOpen, setIsOpen]) => {
    const openOverlay = React.useCallback(() => setIsOpen(true), [setIsOpen])
    const closeOverlay = React.useCallback(() => setIsOpen(false), [setIsOpen])
    return (
      <AnchoredOverlay
        renderAnchor={anchorProps => (
          <Button {...anchorProps} trailingAction={TriangleDownIcon}>
            Click me to open
          </Button>
        )}
        open={isOpen}
        onOpen={openOverlay}
        onClose={closeOverlay}
      >
        <Box display="flex" flexDirection="column" maxWidth="300px" padding={2}>
          <p>
            This menu automatically receives a focus trap and focus zone. Use up/down keys to navigate between buttons
          </p>
          <Button mb={1}>Button 1</Button>
          <Button mb={1}>Button 2</Button>
          <Button>Button 3</Button>
        </Box>
      </AnchoredOverlay>
    )
  }}
</State>

<State default={false}>
  {([isOpen, setIsOpen]) => {
    const openOverlay = React.useCallback(() => setIsOpen(true), [setIsOpen])
    const closeOverlay = React.useCallback(() => setIsOpen(false), [setIsOpen])
    return (
      <AnchoredOverlay
        renderAnchor={anchorProps => (
          <Button {...anchorProps} trailingAction={TriangleDownIcon}>
            Click me to open
          </Button>
        )}
        open={isOpen}
        onOpen={openOverlay}
        onClose={closeOverlay}
      >
        <Box display="flex" flexDirection="column" maxWidth="300px" padding={2}>
          <p>
            This menu automatically receives a focus trap and focus zone. Use up/down keys to navigate between buttons
          </p>
          <Button mb={1}>Button 1</Button>
          <Button mb={1}>Button 2</Button>
          <Button>Button 3</Button>
        </Box>
      </AnchoredOverlay>
    )
  }}
</State>

Props

Name	Type	Default	Description
open	boolean	false	Determines whether the overlay portion of the component should be shown or not.
onOpen	(gesture: 'anchor-click' \| 'anchor-key-press') => unknown		A callback that is called whenever the overlay is currently closed and an "open gesture" is detected.
onClose	(gesture: 'anchor-click' \| 'click-outside' \| 'escape') => unknown		A callback that is called whenever the overlay is currently open and a "close gesture" is detected.
renderAnchor	<T extends React.HTMLAttributes<HTMLElement>>(props: T) => JSX.Element		A custom function component used to render the anchor element. When renderAnchor is null, an anchorRef is required.
anchorRef	React.RefObject<HTMLElement>		An override to the internal `renderAnchor` ref that will be used to position the overlay. When `renderAnchor` is `null`, this can be used to make an anchor that is detached from `AnchoredOverlay`.
anchorId	string		An override to the internal id that will be passed to the anchor.
side	\| 'inside-top' \| 'inside-bottom' \| 'inside-left' \| 'inside-right' \| 'inside-center' \| 'outside-top' \| 'outside-bottom' \| 'outside-left' \| 'outside-right'	'outside-bottom'
align	'start' \| 'center' \| 'end'	'start'
alignmentOffset	number	4	An additional offset, in pixels, to move the floating element from the aligning edge. Positive values move the floating element in the direction of center-alignment. Negative values move the floating element away from center-alignment. When align is `'center`, positive offsets move the floating element right (top or bottom anchor side) or down (left or right anchor side). If using outside positioning, or if `align` is set to `'center'`, this defaults to `0` instead of `4`.
anchorOffset	number	4	The number of pixels between the anchor edge and the floating element. Positive values move the floating element farther from the anchor element (for outside positioning) or further inside the anchor element (for inside positioning). Negative values have the opposite effect. If `side` is set to `'inside-center'`, this defaults to `0` instead of `4`.
overlayProps	Partial<OverlayProps>		Props to be spread on the internal `Overlay` component.
focusTrapSettings	Partial<FocusTrapHookSettings>		Settings to apply to the focus trap on the internal `Overlay` component.
focusZoneSettings	Partial<FocusZoneHookSettings>		Settings to apply to the focus zone on the internal `Overlay` component.

Name

Type

Default

Description

open

boolean

false

Determines whether the overlay portion of the component should be shown or not.

onOpen

(gesture: 'anchor-click' | 'anchor-key-press') => unknown

A callback that is called whenever the overlay is currently closed and an "open gesture" is detected.

onClose

(gesture: 'anchor-click' | 'click-outside' | 'escape') => unknown

A callback that is called whenever the overlay is currently open and a "close gesture" is detected.

renderAnchor

<T extends React.HTMLAttributes<HTMLElement>>(props: T) => JSX.Element

A custom function component used to render the anchor element. When renderAnchor is null, an anchorRef is required.

anchorRef

React.RefObject<HTMLElement>

An override to the internal renderAnchor ref that will be used to position the overlay. When renderAnchor is null, this can be used to make an anchor that is detached from AnchoredOverlay.

anchorId

string

An override to the internal id that will be passed to the anchor.

side

| 'inside-top' | 'inside-bottom' | 'inside-left' | 'inside-right' | 'inside-center' | 'outside-top' | 'outside-bottom' | 'outside-left' | 'outside-right'

'outside-bottom'

align

'start' | 'center' | 'end'

'start'

alignmentOffset

number

An additional offset, in pixels, to move the floating element from the aligning edge. Positive values move the floating element in the direction of center-alignment. Negative values move the floating element away from center-alignment. When align is 'center, positive offsets move the floating element right (top or bottom anchor side) or down (left or right anchor side). If using outside positioning, or if align is set to 'center', this defaults to 0 instead of 4.

anchorOffset

number

The number of pixels between the anchor edge and the floating element. Positive values move the floating element farther from the anchor element (for outside positioning) or further inside the anchor element (for inside positioning). Negative values have the opposite effect. If side is set to 'inside-center', this defaults to 0 instead of 4.

overlayProps

Partial<OverlayProps>

Props to be spread on the internal Overlay component.

focusTrapSettings

Partial<FocusTrapHookSettings>

Settings to apply to the focus trap on the internal Overlay component.

focusZoneSettings

Partial<FocusZoneHookSettings>

Settings to apply to the focus zone on the internal Overlay component.

Status

Component props and basic example usage of the component are documented on primer.style/react.

Component does not have any unnecessary third-party dependencies.

Component can adapt to different themes.

Component can adapt to different screen sizes.

Component has robust unit test coverage (100% where achievable).

Component has visual regression coverage of its default and interactive states.

Component does not introduce any axe violations.

Component has been manually reviewed by the accessibility team and any resulting issues have been addressed.

Component is used in a production application.

Common usage examples are documented on primer.style/react.

Common usage examples are documented in storybook stories.

Component has been reviewed by a systems designer and any resulting issues have been addressed.

Component does not introduce any performance regressions.

Component API has been stable with no breaking changes for at least one month.

Feedback on API usability has been sought from developers using the component and any resulting issues have been addressed.

Component has corresponding design guidelines documented in the interface guidelines.

Component has corresponding Figma component in the Primer Web library.

Tooling (such as linters, codemods, etc.) exists to prevent further use of alternatives.

Primer Design System

Site navigation

On this page

AnchoredOverlay

Examples

Props

AnchoredOverlay

Status

Alpha

Beta

Stable