DialogDescription

Dialog

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)}>
  <DialogDescription>Description</DialogDescription>
</Dialog>
const [open, setOpen] = useState(false);

<Dialog open={open} onClose={() => setOpen(false)}>
  <DialogDescription>Description</DialogDescription>
</Dialog>

Optional Props

`render`

RenderProp<React.HTMLAttributes<any> & { ref?: React.Ref<any> | undefined; }> | React.ReactElement<any, string | React.JSXElementConstructor<any>> | undefined
RenderProp<React.HTMLAttributes<any> & { ref?: React.Ref<any> | undefined; }> | 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.

`store`

DialogStore | undefined
DialogStore | undefined

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

DialogDescription

Code examples

Optional Props

render

store

Stay tuned

`render`

`store`