Pular para o conteúdo

Modal API

Documentação da API para o componente React Modal . Aprenda sobre as propriedades disponíveis e a API CSS.

Importação

import Modal from '@mui/material/Modal';
// ou
import { Modal } from '@mui/material';
Você pode aprender sobre a diferença lendo este guia sobre como minimizar o tamanho do pacote.

Modal is a lower-level construct that is leveraged by the following components:

If you are creating a modal dialog, you probably want to use the Dialog component rather than directly using Modal.

This component shares many concepts with react-overlays.

Nome do componente

The name MuiModal can be used when providing default props or style overrides in the theme.

Propriedades

Props of the nativo component are also available.

NomeTipoPadrãoDescrição
children*element
A single child content element.
⚠️ Needs to be able to hold a ref.
open*boolfalse
Control the popup` open state.
BackdropComponentelementTypestyled(Backdrop, { name: 'MuiModal', slot: 'Backdrop', overridesResolver: (props, styles) => { return styles.backdrop; }, })({ zIndex: -1, })
A backdrop component. This prop enables custom backdrop rendering.
BackdropPropsobject
Props applied to the Backdrop element.
classesobject
Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes.
closeAfterTransitionboolfalse
When set to true the Modal waits until a nested Transition is completed before closing.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
components{ Root?: elementType }{}
The components used for each slot inside the Modal. Either a string to use a HTML element or a component.
componentsPropsobject{}
The props used for each slot inside the Modal.
containerHTML element
| func
A HTML element or function that returns one. The container will have the portal children appended to it.
By default, it uses the body of the top-level document object, so it's simply document.body most of the time.
disableAutoFocusboolfalse
If true, the modal will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any modal children that have the disableAutoFocus prop.
Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers.
disableEnforceFocusboolfalse
If true, the modal will not prevent focus from leaving the modal while open.
Generally this should never be set to true as it makes the modal less accessible to assistive technologies, like screen readers.
disableEscapeKeyDownboolfalse
If true, hitting escape will not fire the onClose callback.
disablePortalboolfalse
The children will be inside the DOM hierarchy of the parent component.
disableRestoreFocusboolfalse
If true, the modal will not restore focus to previously focused element once modal is hidden.
disableScrollLockboolfalse
Disable the scroll lock behavior.
hideBackdropboolfalse
If true, the backdrop is not rendered.
keepMountedboolfalse
Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal.
onBackdropClickfunc
Callback fired when the backdrop is clicked.
onClosefunc
Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.

Signature:
function(event: object, reason: string) => void
event: The event source of the callback.
reason: Can be: "escapeKeyDown", "backdropClick".
sxfunc
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

O ref é encaminhado para o elemento raiz.

CSS

Nome da regraClasse globalDescrição
root.MuiModal-rootEstilos aplicados ao elemento raiz.
hidden.MuiModal-hiddenEstilos aplicados para o elemento raiz se the Modal has exited.

Você pode sobrescrever o estilo do componente usando uma dessas opções de customização:

Demonstrações