Alert API
Importação
import Alert from '@mui/material/Alert';
// ou
import { Alert } from '@mui/material';
Nome do componente
The nameMuiAlert
can be used when providing default props or style overrides in the theme.Propriedades
Propriedades do componente Paper também estão disponíveis.
Nome | Tipo | Padrão | Descrição |
---|---|---|---|
action | node | A ação a exibir. Ela renderiza após a mensagem, no final do alerta. | |
children | node | O conteúdo do componente. | |
classes | object | Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes. | |
closeText | string | 'Close' | Override the default label for the close popup icon button. For localization purposes, you can use the provided translations. |
color | 'error' | 'info' | 'success' | 'warning' | string | The color of the component. Unless provided, the value is taken from the severity prop. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. | |
components | { CloseButton?: elementType, CloseIcon?: elementType } | {} | |
componentsProps | { closeButton?: object, closeIcon?: object } | {} | |
icon | node | 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. | |
onClose | func | 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. | |
role | string | '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. |
slotProps | { closeButton?: object, closeIcon?: object } | {} | |
slots | { closeButton?: elementType, closeIcon?: elementType } | {} | |
sx | Array<func | object | bool> | func | 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
While not explicitly documented above, the props of the Paper component are also available on Alert. You can take advantage of this to target nested components.CSS
Nome da regra | Classe global | Descrição |
---|---|---|
root | .MuiAlert-root | Estilos aplicados ao elemento raiz. |
filled | .MuiAlert-filled | Estilos aplicados para o elemento raiz se variant="filled" . |
outlined | .MuiAlert-outlined | Estilos aplicados para o elemento raiz se variant="outlined" . |
standard | .MuiAlert-standard | Estilos aplicados para o elemento raiz se variant="standard" . |
standardSuccess | .MuiAlert-standardSuccess | Estilos aplicados para o elemento raiz se variant="standard" e color="success" . |
standardInfo | .MuiAlert-standardInfo | Estilos aplicados para o elemento raiz se variant="standard" e color="info" . |
standardWarning | .MuiAlert-standardWarning | Estilos aplicados para o elemento raiz se variant="standard" e color="warning" . |
standardError | .MuiAlert-standardError | Estilos aplicados para o elemento raiz se variant="standard" e color="error" . |
outlinedSuccess | .MuiAlert-outlinedSuccess | Estilos aplicados para o elemento raiz se variant="outlined" e color="success" . |
outlinedInfo | .MuiAlert-outlinedInfo | Estilos aplicados para o elemento raiz se variant="outlined" e color="info" . |
outlinedWarning | .MuiAlert-outlinedWarning | Estilos aplicados para o elemento raiz se variant="outlined" e color="warning" . |
outlinedError | .MuiAlert-outlinedError | Estilos aplicados para o elemento raiz se variant="outlined" e color="error" . |
filledSuccess | .MuiAlert-filledSuccess | Estilos aplicados para o elemento raiz se variant="filled" e color="success" . |
filledInfo | .MuiAlert-filledInfo | Estilos aplicados para o elemento raiz se variant="filled" e color="info" . |
filledWarning | .MuiAlert-filledWarning | Estilos aplicados para o elemento raiz se variant="filled" e color="warning" . |
filledError | .MuiAlert-filledError | Estilos aplicados para o elemento raiz se variant="filled" e color="error" . |
icon | .MuiAlert-icon | Estilos aplicados a o elemento encapsulador do ícone. |
message | .MuiAlert-message | Estilos aplicados a o elemento encapsulador da mensagem. |
action | .MuiAlert-action | Estilos 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:
- With a global class name.
- With a rule name as part of the component's
styleOverrides
property in a custom theme.