Skip to components
DEVELOPER REFERENCE · v4.0.0

Dialog API

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

Dialog7 props1 callbacks0 methods

Props7

Dialog props
NameTypeDescription
openRequiredbooleanExpanded or visible state of the surface or disclosure.
titleRequiredstringHeading or title text used by this component.
closeLabelRequiredstringAccessible text for the close action.
childrenOptional
ComponentChildrenInspect type
Content rendered inside the component. Supply nodes from the framework adapter you are using.
footerOptional
ComponentChildrenInspect type
Content rendered in the footer or after the main component content.
draggableOptionalboolean | undefinedAllows the dialog to be moved using its header.
returnFocusOptional
HTMLElement | undefinedInspect type
Element that receives focus when the dialog closes.

Events and callbacks1

Dialog 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.