InputBase API
Documentação da API para o componente React InputBase . Aprenda sobre as propriedades disponíveis e a API CSS.
Demonstrações
For examples and details on the usage of this React component, visit the component demo pages:
Importação
import InputBase from '@mui/material/InputBase';
// ou
import { InputBase } from '@mui/material';InputBase contains as few styles as possible.
It aims to be a simple building block for creating an input.
It contains a load of style reset and some state logic.
Nome do componente
The nameMuiInputBase can be used when providing default props or style overrides in the theme.Propriedades
Propriedades do componente nativo também estão disponíveis.
| Nome | Tipo | Padrão | Descrição |
|---|---|---|---|
| autoComplete | string | This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification. | |
| autoFocus | bool | false | If true, the input element is focused during the first mount. |
| classes | object | Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes. | |
| color | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string | The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. The prop defaults to the value ( 'primary') inherited from the parent FormControl component. | |
| components | { Input?: elementType, Root?: elementType } | {} | The components used for each slot inside the InputBase. Either a string to use a HTML element or a component. |
| componentsProps | { input?: object, root?: object } | {} | The props used for each slot inside the Input. |
| defaultValue | any | The default input value. Use when the component is not controlled. | |
| disabled | bool | false | If true, the input element is disabled. The prop defaults to the value (false) inherited from the parent FormControl component. |
| disableInjectingGlobalStyles | bool | false | If true, GlobalStyles for the auto-fill keyframes will not be injected/removed on mount/unmount. Make sure to inject them at the top of your application. This option is intended to help with boosting the initial rendering performance if you are loading a big amount of Input components at once. |
| endAdornment | node | End InputAdornment for this component. | |
| error | bool | false | If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component. |
| fullWidth | bool | false | If true, the input will take up the full width of its container. |
| id | string | The id of the input element. | |
| inputComponent | element type | 'input' | The component used for the input element. Either a string to use a HTML element or a component.⚠️ Needs to be able to hold a ref. |
| inputProps | object | {} | Attributes applied to the input element. |
| inputRef | ref | Pass a ref to the input element. | |
| margin | 'dense' | 'none' | If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value ('none') inherited from the parent FormControl component. | |
| maxRows | number | string | Maximum number of rows to display when multiline option is set to true. | |
| minRows | number | string | Minimum number of rows to display when multiline option is set to true. | |
| multiline | bool | false | If true, a TextareaAutosize element is rendered. |
| name | string | Name attribute of the input element. | |
| onBlur | func | Callback fired when the input is blurred.Notice that the first argument (event) might be undefined. | |
| onChange | func | Callback fired when the value is changed. Signature: function(event: object) => voidevent: The event source of the callback. You can pull out the new value by accessing event.target.value (string). | |
| onInvalid | func | ||
| placeholder | string | The short hint displayed in the input before the user enters a value. | |
| readOnly | bool | false | It prevents the user from changing the value of the field (not from interacting with the field). |
| required | bool | false | If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component. |
| rows | number | string | Number of rows to display when multiline option is set to true. | |
| size | 'medium' | 'small' | string | The size of the autocomplete. | |
| slotProps | { input?: object, root?: object } | {} | |
| slots | { input?: elementType, root?: elementType } | {} | |
| startAdornment | node | Start InputAdornment for this component. | |
| 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. | |
| type | string | 'text' | Type of the input element. It should be a valid HTML5 input type. |
| value | any | The value of the input element, required for a controlled component. |
O
ref é encaminhado para o elemento raiz.CSS
| Nome da regra | Classe global | Descrição |
|---|---|---|
| root | .MuiInputBase-root | Estilos aplicados ao elemento raiz. |
| formControl | .MuiInputBase-formControl | Estilos aplicados para o elemento raiz se the component is a descendant of FormControl. |
| focused | .Mui-focused | Estilos aplicados para o elemento raiz se the component is focused. |
| disabled | .Mui-disabled | Estilos aplicados para o elemento raiz se disabled={true}. |
| adornedStart | .MuiInputBase-adornedStart | Estilos aplicados para o elemento raiz se startAdornment is provided. |
| adornedEnd | .MuiInputBase-adornedEnd | Estilos aplicados para o elemento raiz se endAdornment is provided. |
| error | .Mui-error | Pseudo-class aplicada a o elemento raiz se error={true}. |
| sizeSmall | .MuiInputBase-sizeSmall | Estilos aplicados para the input element se size="small". |
| multiline | .MuiInputBase-multiline | Estilos aplicados para o elemento raiz se multiline={true}. |
| colorSecondary | .MuiInputBase-colorSecondary | Estilos aplicados para o elemento raiz se the color is secondary. |
| fullWidth | .MuiInputBase-fullWidth | Estilos aplicados para o elemento raiz se fullWidth={true}. |
| hiddenLabel | .MuiInputBase-hiddenLabel | Estilos aplicados para o elemento raiz se hiddenLabel={true}. |
| readOnly | .MuiInputBase-readOnly | State class applied to the root element if readOnly={true}. |
| input | .MuiInputBase-input | Estilos aplicados a the input element. |
| inputSizeSmall | .MuiInputBase-inputSizeSmall | Estilos aplicados para the input element se size="small". |
| inputMultiline | .MuiInputBase-inputMultiline | Estilos aplicados para the input element se multiline={true}. |
| inputTypeSearch | .MuiInputBase-inputTypeSearch | Estilos aplicados para the input element se type="search". |
| inputAdornedStart | .MuiInputBase-inputAdornedStart | Estilos aplicados para the input element se startAdornment is provided. |
| inputAdornedEnd | .MuiInputBase-inputAdornedEnd | Estilos aplicados para the input element se endAdornment is provided. |
| inputHiddenLabel | .MuiInputBase-inputHiddenLabel | Estilos aplicados para the input element se hiddenLabel={true}. |
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
styleOverridesproperty in a custom theme.