Skip to components
DEVELOPER REFERENCE · v4.0.0

Popover API

Props, callbacks and methods. Select an underlined type to explore its fields, allowed values and callback arguments.

Popover9 props1 callbacks0 methods

Props9

Popover props
NameTypeDescription
openRequiredbooleanExpanded or visible state of the surface or disclosure.
anchorRequired
HTMLElement | nullInspect type
DOM element used as the positioning reference for the floating surface.
appendToOptional
HTMLElement | undefinedInspect type
Optional mount scope for inherited theme tokens and text direction.
closeOnOutsideOptionalboolean | undefinedClose on pointer presses outside the anchor and content. Defaults to true.
closeOnEscapeOptionalboolean | undefinedClose on Escape. Defaults to true.
childrenOptional
ComponentChildrenInspect type
Content rendered inside the component. Supply nodes from the framework adapter you are using.
labelOptionalstring | undefinedLabel content or accessible name for the component, as rendered by this control.
classNameOptionalstring | undefinedAdditional CSS classes applied to the component root.
roleOptional"dialog" | "menu" | undefinedAccessibility role used by the rendered element.

Events and callbacks1

Popover events and callbacks
NameTypeDescription
onCloseRequired
() => voidInspect type
Requests that the parent close the surface or picker.

Methods0

No component-specific imperative methods. Use props and callbacks to control this component.