Button API
Documentação da API para o componente React Button . Aprenda sobre as propriedades disponíveis e a API CSS.
Importação
import Button from '@mui/material/Button';
// ou
import { Button } from '@mui/material';
Nome do componente
The nameMuiButton
can be used when providing default props or style overrides in the theme.Propriedades
Propriedades do componente ButtonBase também estão disponíveis.
Nome | Tipo | Padrão | Descrição |
---|---|---|---|
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. | |
color | 'inherit' | 'primary' | 'secondary' | 'success' | 'error' | 'info' | 'warning' | string | 'primary' | The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. |
component | elementType | The component used for the root node. Either a string to use a HTML element or a component. | |
disabled | bool | false | Se true , o componente está desabilitado. |
disableElevation | bool | false | If true , no elevation is used. |
disableFocusRipple | bool | false | If true , the keyboard focus ripple is disabled. |
disableRipple | bool | false | If true , the ripple effect is disabled.⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the focusVisibleClassName . |
endIcon | node | Elemento colocado depois dos filhos. | |
fullWidth | bool | false | Se true , o botão ocupará toda a largura de seu contêiner. |
href | string | The URL to link to when the button is clicked. If defined, an a element will be used as the root node. | |
size | 'small' | 'medium' | 'large' | string | 'medium' | The size of the button. small is equivalent to the dense button styling. |
startIcon | node | Elemento colocado antes dos filhos. | |
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 | 'contained' | 'outlined' | 'text' | string | 'text' | A variante a usar. |
O
ref
é encaminhado para o elemento raiz.Herança
While not explicitly documented above, the props of the ButtonBase component are also available on Button. You can take advantage of this to target nested components.CSS
Nome da regra | Classe global | Descrição |
---|---|---|
root | .MuiButton-root | Estilos aplicados ao elemento raiz. |
text | .MuiButton-text | Estilos aplicados para o elemento raiz se variant="text" . |
textInherit | .MuiButton-textInherit | Estilos aplicados para o elemento raiz se variant="text" and color="inherit" . |
textPrimary | .MuiButton-textPrimary | Estilos aplicados para o elemento raiz se variant="text" and color="primary" . |
textSecondary | .MuiButton-textSecondary | Estilos aplicados para o elemento raiz se variant="text" and color="secondary" . |
textSuccess | .MuiButton-textSuccess | Styles applied to the root element if variant="text" and color="success" . |
textError | .MuiButton-textError | Styles applied to the root element if variant="text" and color="error" . |
textInfo | .MuiButton-textInfo | Styles applied to the root element if variant="text" and color="info" . |
textWarning | .MuiButton-textWarning | Styles applied to the root element if variant="text" and color="warning" . |
outlined | .MuiButton-outlined | Estilos aplicados para o elemento raiz se variant="outlined" . |
outlinedInherit | .MuiButton-outlinedInherit | Estilos aplicados para o elemento raiz se variant="outlined" and color="inherit" . |
outlinedPrimary | .MuiButton-outlinedPrimary | Estilos aplicados para o elemento raiz se variant="outlined" and color="primary" . |
outlinedSecondary | .MuiButton-outlinedSecondary | Estilos aplicados para o elemento raiz se variant="outlined" and color="secondary" . |
outlinedSuccess | .MuiButton-outlinedSuccess | Styles applied to the root element if variant="outlined" and color="success" . |
outlinedError | .MuiButton-outlinedError | Styles applied to the root element if variant="outlined" and color="error" . |
outlinedInfo | .MuiButton-outlinedInfo | Styles applied to the root element if variant="outlined" and color="info" . |
outlinedWarning | .MuiButton-outlinedWarning | Styles applied to the root element if variant="outlined" and color="warning" . |
contained | .MuiButton-contained | Estilos aplicados para o elemento raiz se variant="contained" . |
containedInherit | .MuiButton-containedInherit | Estilos aplicados para o elemento raiz se variant="contained" and color="inherit" . |
containedPrimary | .MuiButton-containedPrimary | Estilos aplicados para o elemento raiz se variant="contained" and color="primary" . |
containedSecondary | .MuiButton-containedSecondary | Estilos aplicados para o elemento raiz se variant="contained" and color="secondary" . |
containedSuccess | .MuiButton-containedSuccess | Styles applied to the root element if variant="contained" and color="success" . |
containedInfo | .MuiButton-containedInfo | Styles applied to the root element if variant="contained" and color="info" . |
containedError | .MuiButton-containedError | Styles applied to the root element if variant="contained" and color="error" . |
containedWarning | .MuiButton-containedWarning | Styles applied to the root element if variant="contained" and color="warning" . |
disableElevation | .MuiButton-disableElevation | Estilos aplicados para o elemento raiz se disableElevation={true} . |
focusVisible | .Mui-focusVisible | Pseudo-class aplicada a o elemento raiz ButtonBase se o botão está focado no teclado. |
disabled | .Mui-disabled | Pseudo-class aplicada a o elemento raiz se disabled={true} . |
colorInherit | .MuiButton-colorInherit | Estilos aplicados para o elemento raiz se color="inherit" . |
textSizeSmall | .MuiButton-textSizeSmall | Estilos aplicados para o elemento raiz se size="small" and variant="text" . |
textSizeMedium | .MuiButton-textSizeMedium | Estilos aplicados para o elemento raiz se size="medium" and variant="text" . |
textSizeLarge | .MuiButton-textSizeLarge | Estilos aplicados para o elemento raiz se size="large" and variant="text" . |
outlinedSizeSmall | .MuiButton-outlinedSizeSmall | Estilos aplicados para o elemento raiz se size="small" and variant="outlined" . |
outlinedSizeMedium | .MuiButton-outlinedSizeMedium | Estilos aplicados para o elemento raiz se size="medium" and variant="outlined" . |
outlinedSizeLarge | .MuiButton-outlinedSizeLarge | Estilos aplicados para o elemento raiz se size="large" and variant="outlined" . |
containedSizeSmall | .MuiButton-containedSizeSmall | Estilos aplicados para o elemento raiz se size="small" and variant="contained" . |
containedSizeMedium | .MuiButton-containedSizeMedium | Estilos aplicados para o elemento raiz se size="small" and variant="contained" . |
containedSizeLarge | .MuiButton-containedSizeLarge | Estilos aplicados para o elemento raiz se size="large" and variant="contained" . |
sizeSmall | .MuiButton-sizeSmall | Estilos aplicados para o elemento raiz se size="small" . |
sizeMedium | .MuiButton-sizeMedium | Estilos aplicados para o elemento raiz se size="medium" . |
sizeLarge | .MuiButton-sizeLarge | Estilos aplicados para o elemento raiz se size="large" . |
fullWidth | .MuiButton-fullWidth | Estilos aplicados para o elemento raiz se fullWidth={true} . |
startIcon | .MuiButton-startIcon | Estilos aplicados para the startIcon element se fornecido. |
endIcon | .MuiButton-endIcon | Estilos aplicados para the endIcon element se supplied. |
iconSizeSmall | .MuiButton-iconSizeSmall | Estilos aplicados para o elemento ícone se supplied and size="small" . |
iconSizeMedium | .MuiButton-iconSizeMedium | Estilos aplicados para the icon element se supplied and size="medium" . |
iconSizeLarge | .MuiButton-iconSizeLarge | Estilos aplicados para the icon element se supplied and size="large" . |
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.