Skip to content

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

import Input from '@mui/joy/Input';
// or
import { Input } from '@mui/joy';
You can learn about the difference by reading this guide on minimizing bundle size.

Props

NameTypeDescription
classNamestring
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. To learn how to add your own colors, check out Themed components—Extend colors.
endDecoratornode
Trailing adornment for this input.
errorbool
If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.
fullWidthbool
If true, the button will take up the full width of its container.
size'sm'
| 'md'
| 'lg'
| string
The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.
startDecoratornode
Leading adornment for this input.
sxArray<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 global variant to use. To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

Theme default props

You can use JoyInput to change the default props of this component with the theme.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

NameDefault classDefault HTML tagDescription
root.MuiInput-root'div'The component that renders the root.
input.MuiInput-input'input'The component that renders the input.
startDecorator.MuiInput-startDecorator'div'The component that renders the start decorator.
endDecorator.MuiInput-endDecorator'div'The component that renders the end decorator.

You can override the style of the component using one of these customization options:

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

Global classDescription
.Mui-disabled
STATE
Class name applied to the root element if disabled={true}.
.Mui-error
STATE
State class applied to the root element if error={true}.
.Mui-focused
STATE
Class name applied to the root element if the component is focused.
.MuiInput-colorContextClass name applied to the root element when color inversion is triggered.
.MuiInput-colorDangerClass name applied to the root element if color="danger".
.MuiInput-colorInfoClass name applied to the root element if color="info".
.MuiInput-colorNeutralClass name applied to the root element if color="neutral".
.MuiInput-colorPrimaryClass name applied to the root element if color="primary".
.MuiInput-colorSuccessClass name applied to the root element if color="success".
.MuiInput-colorWarningClass name applied to the root element if color="warning".
.MuiInput-formControlClass name applied to the root element if the component is a descendant of FormControl.
.MuiInput-fullWidthClass name applied to the root element if fullWidth={true}.
.MuiInput-sizeLgClass name applied to the root element if size="lg".
.MuiInput-sizeMdClass name applied to the root element if size="md".
.MuiInput-sizeSmClass name applied to the root element if size="sm".
.MuiInput-variantOutlinedClass name applied to the root element if variant="outlined".
.MuiInput-variantPlainClass name applied to the root element if variant="plain".
.MuiInput-variantSoftClass name applied to the root element if variant="soft".
.MuiInput-variantSolidClass name applied to the root element if variant="solid".