Input API

API reference docs for the React Input component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

import Input from '@mui/joy/Input';
// or
import { Input } from '@mui/joy';

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

Name	Type	Description
className	string	Class name applied to the root element.
color	'danger' \| 'info' \| 'neutral' \| 'primary' \| 'success' \| 'warning' \| string	The color of the component. It supports those theme colors that make sense for this component.
endDecorator	node	Trailing adornment for this input.
error	bool	If `true`, the `input` will indicate an error. The prop defaults to the value (`false`) inherited from the parent FormControl component.
fullWidth	bool	If `true`, the button will take up the full width of its container.
size	'sm' \| 'md' \| 'lg' \| string	The size of the component.
startDecorator	node	Leading adornment for this input.
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	'outlined' \| 'plain' \| 'soft' \| 'solid' \| string	The variant to use.

The ref is forwarded to the root element.