Popover

Usage

Popover is more complex and customizable alternative to Tooltip component.

import { useState } from 'react';
import { Popover, Text, Button, Image } from '@mantine/core';

function Demo() {
  const [opened, setOpened] = useState(false);
  return (
    <Popover
      opened={opened}
      onClose={() => setOpened(false)}
      target={<Button onClick={() => setOpened((o) => !o)}>Toggle popover</Button>}
      width={260}
      position="bottom"
      withArrow
    >
      <div style={{ display: 'flex' }}>
        <Image
          src="./logo.svg"
          width={30}
          height={30}
          sx={{ minWidth: 30 }}
          mr="md"
        />
        <Text size="sm">Thanks for stopping by and checking Mantine, you are awesome!</Text>
      </div>
    </Popover>
  );
}

Examples

Show on focus

This example uses onFocusCapture and onBlurCapture events on Popover component to determine if any element inside has focus:

With form

By default focus trap inside popover is active, you can place forms inside and focus will be kept inside popover:

Show on hover

To show popover on hover add onMouseEnter and onMouseLeave handlers to element that should trigger popover. Note that in this case you have to disable focus trap with noFocusTrap prop:

import React, { useState } from 'react';
import { Popover, Badge, Image, Text } from '@mantine/core';

function Demo() {
  const [opened, setOpened] = useState(false);

  return (
    <Popover
      opened={opened}
      onClose={() => setOpened(false)}
      position="bottom"
      placement="center"
      withArrow
      noFocusTrap
      noEscape
      transition="pop-top-left"
      width={260}
      styles={{ body: { pointerEvents: 'none' } }}
      target={
        <Badge onMouseEnter={() => setOpened(true)} onMouseLeave={() => setOpened(false)}>
          Hover badge to see popover
        </Badge>
      }
    >
      <div style={{ display: 'flex' }}>
        <Image
          src="./logo.svg"
          width={30}
          height={30}
          sx={{ minWidth: 30 }}
          mr="md"
        />
        <Text size="sm">Thanks for stopping by and checking Mantine, you are awesome!</Text>
      </div>
    </Popover>
  );
}

Position and placement

Popover position relative to target element is defined by:

• position – popover side – top, bottom, right or left, defaults to top
• placement – popover placement relative to position – start, center or end, defaults to center
• gutter – space between popover and target element in px, defaults to 10px

<Popover position="bottom" placement="end" gutter={10} />

All positions and placement:

Control behavior

By default popover:

• has focus trap
• closes when escape key is pressed
• closes when outside click is registered

Usually it is a good idea to turn these settings off, if you show popover on focus or hover:

<Popover
  noFocusTrap // -> disable focus trap
  noEscape // -> disable escape key press handling
  noClickOutside // -> disable outside click handling
/>

Close button and title

Popover includes optional close button and title:

• set withCloseButton prop to show close button, add closeButtonLabel to set aria-label attribute on close button
• set title prop to add title at the top of popover

<Popover title="Popover title" withCloseButton closeButtonLabel="Close popover" />

Control appearance

To change popover appearance use:

• radius – applies border-radius from theme.radius
• spacing – adds padding to all sides of popover from theme.spacing
• shadow – add box-shadow from theme.shadows

<Popover
  opened
  target={<Badge>Badge with popover</Badge>}
 
>
  {/* children */}
</Popover>

For additional modifications of popover body styles use bodyClassName or bodyStyle props:

// Add inline styles to popover body
<Popover bodyStyle={{ width: 200, pointerEvents: 'none' }} />

// Or with className
<Popover bodyClassName="my-class-name" />

Initial focus

Popover uses use-focus-trap to manage focus. To specify initial focus element add data-autofocus attribute:

<Popover>
  <input />
  {/* Second input in modal will have initial focus */}
  <input data-autofocus />
  <input />
</Popover>

Usage with other overlays

Popover listens for outside clicks with use-click-outside hook. This means that it is not possible to use elements that render overlays within Portal inside Popover. To use components like Autocomplete, Menu, DatePicker portal feature should be disabled for these components:

<Popover>
  <Menu withinPortal={false} />
  <Autocomplete withinPortal={false} />
  <DatePicker withinPortal={false} />
</Popover>