{
"hookDescription": "",
"parametersDescriptions": {
"children": { "description": "A single child content element." },
"closeAfterTransition": {
"description": "When set to true the Modal waits until a nested Transition is completed before closing."
},
"container": {
"description": "An HTML element or function that returns one. The container will have the portal children appended to it.
You can also provide a callback, which is called in a React layout effect. This lets you set the container from a ref, and also makes server-side rendering possible.
By default, it uses the body of the top-level document object, so it's simply document.body most of the time."
},
"disableEscapeKeyDown": {
"description": "If true, hitting escape will not fire the onClose callback."
},
"disableScrollLock": { "description": "Disable the scroll lock behavior." },
"onClose": {
"description": "Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose."
},
"onTransitionEnter": { "description": "A function called when a transition enters." },
"onTransitionExited": { "description": "A function called when a transition has exited." },
"open": { "description": "If true, the component is shown." }
},
"returnValueDescriptions": {
"exited": {
"description": "If true, the exiting transition finished (to be used for unmounting the component)."
},
"getBackdropProps": { "description": "Resolver for the backdrop slot's props." },
"getRootProps": { "description": "Resolver for the root slot's props." },
"getTransitionProps": { "description": "Resolver for the transition related props." },
"hasTransition": {
"description": "If true, the component's child is transition component."
},
"isTopModal": { "description": "If true, the modal is the top most one." },
"portalRef": { "description": "A ref to the component's portal DOM element." },
"rootRef": { "description": "A ref to the component's root DOM element." }
}
}