Pular para o conteúdo
Ajude a traduzir esta página

Alert API

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

Importação

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

Nome do componente

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

Propriedades

Props of the Paper component are also available.

NomeTipoPadrãoDescrição
actionnode
A ação a exibir. Ela renderiza após a mensagem, no final do alerta.
childrennode
O conteúdo do componente.
classesobject
Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes.
closeTextstring'Close'
Sobrescreve o rótulo padrão do popup de fechamento do botão de ícone.
Para fins de localização, você pode usar as localizações fornecidas.
color'error'
| 'info'
| 'success'
| 'warning'
| string
A cor principal do alerta. Caso não seja fornecida, o valor é determinado com base na propriedade severity.
iconnode
Sobrescreve o ícone exibido antes do elemento filho. Caso não seja fornecida, o ícone é determinado com base na propriedade severity.
iconMapping{ error?: node, info?: node, success?: node, warning?: node }
O componente mapeia a propriedade severity para um intervalo de diferentes ícones, por exemplo, sucesso é mapeado para <SuccessOutlined>. Se você deseja alterar este mapeamento, você pode fornecer o seu próprio. Alternativamente, você pode usar a propriedade icon para sobrescrever o ícone exibido.
onClosefunc
Callback disparado quando o componente e requisitado a ser fechado. Quando fornecido e a propriedade action nao é definida, um botão de ícone fechar é exibido para acionar o callback quando clicado.

Assinatura:
function(event: object) => void
event: A fonte do evento de callback.
rolestring'alert'
O atributo de regra ARIA do elemento.
severity'error'
| 'info'
| 'success'
| 'warning'		'success'
A severidade do alerta. Isso define a cor e o ícone usado.
sxfunc
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
variant'filled'
| 'outlined'
| 'standard'
| string		'standard'
A variante a usar.

O ref é encaminhado para o elemento raiz.

Herança

Embora não explicitamente documentado acima, as propriedades do componente Paper também estão disponíveis em Alert. Você pode tirar vantagem disso para manipular componentes aninhados.

CSS

Nome da regraClasse globalDescrição
root.MuiAlert-rootEstilos aplicados ao elemento raiz.
filled.MuiAlert-filledEstilos aplicados para o elemento raiz se variant="filled".
outlined.MuiAlert-outlinedEstilos aplicados para o elemento raiz se variant="outlined".
standard.MuiAlert-standardEstilos aplicados para o elemento raiz se variant="standard".
standardSuccess.MuiAlert-standardSuccessEstilos aplicados para o elemento raiz se variant="standard" e color="success".
standardInfo.MuiAlert-standardInfoEstilos aplicados para o elemento raiz se variant="standard" e color="info".
standardWarning.MuiAlert-standardWarningEstilos aplicados para o elemento raiz se variant="standard" e color="warning".
standardError.MuiAlert-standardErrorEstilos aplicados para o elemento raiz se variant="standard" e color="error".
outlinedSuccess.MuiAlert-outlinedSuccessEstilos aplicados para o elemento raiz se variant="outlined" e color="success".
outlinedInfo.MuiAlert-outlinedInfoEstilos aplicados para o elemento raiz se variant="outlined" e color="info".
outlinedWarning.MuiAlert-outlinedWarningEstilos aplicados para o elemento raiz se variant="outlined" e color="warning".
outlinedError.MuiAlert-outlinedErrorEstilos aplicados para o elemento raiz se variant="outlined" e color="error".
filledSuccess.MuiAlert-filledSuccessEstilos aplicados para o elemento raiz se variant="filled" e color="success".
filledInfo.MuiAlert-filledInfoEstilos aplicados para o elemento raiz se variant="filled" e color="info".
filledWarning.MuiAlert-filledWarningEstilos aplicados para o elemento raiz se variant="filled" e color="warning".
filledError.MuiAlert-filledErrorEstilos aplicados para o elemento raiz se variant="filled" e color="error".
icon.MuiAlert-iconEstilos aplicados a o elemento encapsulador do ícone.
message.MuiAlert-messageEstilos aplicados a o elemento encapsulador da mensagem.
action.MuiAlert-actionEstilos aplicados para o elemento encapsulador da ação se action é fornecida.

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

Demonstrações