Renders a description in a dialog. This component must be wrapped with Dialog so the aria-describedby prop is properly set on the dialog element.

Code examples

const [open, setOpen] = useState(false);
<Dialog open={open} onClose={() => setOpen(false)}>

Optional Props


RenderProp<React.HTMLAttributes<any> & React.RefAttributes<any>> | React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined

Allows the component to be rendered as a different HTML element or React component. The value can be a React element or a function that takes in the original component props and gives back a React element with the props merged.

Check out the Composition guide for more details.


DialogStore | undefined

Object returned by the useDialogStore hook. If not provided, the closest Dialog component's context will be used.

Follow updates

Join 1,000+ subscribers and receive monthly updates with the latest improvements on API Reference.

Read latest issue

No Spam. Unsubscribe at any time.