Props

This determines which anchor prop to refer to to set the position of the popover.

Set to 'auto' to automatically calculate transition time based on height.

Props applied to the Paper element.

The component used for the transition. Follow this guide to learn more about the requirements for this component.

Props applied to the Transition element.

A ref for imperative actions. It currently only supports updatePosition() action.

A HTML element, or a function that returns it. It's used to set the position of the popover.

This is the point on the anchor where the popover's anchorEl will attach to. This is not used when the anchorReference is 'anchorPosition'.

Options: vertical: [top, center, bottom]; horizontal: [left, center, right].

This is the position that may be used to set the position of the popover. The coordinates are relative to the application's client area.

The content of the component.

Override or extend the styles applied to the component. See CSS API below for more details.

A HTML element, component instance, or function that returns either. The container will passed to the Modal component.

By default, it uses the body of the anchorEl's top-level document object, so it's simply document.body most of the time.

The elevation of the popover.

This function is called in order to retrieve the content anchor element. It's the opposite of the anchorEl prop. The content anchor element should be an element inside the popover. It's used to correctly scroll and set the position of the popover. The positioning strategy tries to make the content anchor element just above the anchor element.

Specifies how close to the edge of the window the popover can appear.

Callback fired when the component requests to be closed.

If true, the popover is visible.

This is the point on the popover which will attach to the anchor's origin.

Options: vertical: [top, center, bottom, x(px)]; horizontal: [left, center, right, x(px)].

Callback fired before the component is entering.

Callback fired when the component has entered.

Callback fired when the component is entering.

Callback fired before the component is exiting.

Callback fired when the component has exited.

Callback fired when the component is exiting.