Modal dialog window displayed above the page.
This component inherits props from the Dialog primitive.
Note that this dialog is designed around the modal pattern, so the modal
prop is unavailable.
Contains all the parts of a dialog.
Wraps the control that will open the dialog.
Contains the content of the dialog. This component is based on the div
element.
An accessible title that is announced when the dialog is opened. This part is based on the Heading component with a pre-defined font size and leading trim on top.
An optional accessible description that is announced when the dialog is opened. This part is based on the Text component with a pre-defined font size.
If you want to remove the description entirely, remove this part and pass aria-describedby={undefined}
to Content
.
Wraps the control that will close the dialog.
Use the size
prop to control size of the dialog. It will affect the padding
and border-radius
of the Content.
Use it in conjunction with the width
, minWidth
and maxWidth
props to control the width of the dialog.
Use the Inset component to align content flush with the sides of the dialog.