Skip to content
Edit this page

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';
Learn about the difference by reading this guide on minimizing bundle size.

Props

className

Class name applied to the root element.

Type:

string
color

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.

Type:

'danger' | 'neutral' | 'primary' | 'success' | 'warning' | string
endDecorator

Trailing adornment for this input.

Type:

node
error

If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.

Type:

bool
fullWidth

If true, the input will take up the full width of its container.

Type:

bool
size

The size of the component.

To learn how to add custom sizes to the component, check out Themed components—Extend sizes.

Type:

'sm' | 'md' | 'lg' | string
startDecorator

Leading adornment for this input.

Type:

node
sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object
variant

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

Type:

'outlined' | 'plain' | 'soft' | 'solid' | string
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.

root

The component that renders the root.

Default: 'div'

Global class: .MuiInput-root

input

The component that renders the input.

Default: 'input'

Global class: .MuiInput-input

startDecorator

The component that renders the start decorator.

Default: 'div'

Global class: .MuiInput-startDecorator

endDecorator

The component that renders the end decorator.

Default: 'div'

Global class: .MuiInput-endDecorator

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.

.Mui-disabledSTATE

Class name applied to the root element if disabled={true}.

.Mui-errorSTATE

State class applied to the root element if error={true}.

.Mui-focusedSTATE

Class name applied to the root element if the component is focused.

.MuiInput-colorContext

Class name applied to the root element when color inversion is triggered.

.MuiInput-colorDanger

Class name applied to the root element if color="danger".

.MuiInput-colorNeutral

Class name applied to the root element if color="neutral".

.MuiInput-colorPrimary

Class name applied to the root element if color="primary".

.MuiInput-colorSuccess

Class name applied to the root element if color="success".

.MuiInput-colorWarning

Class name applied to the root element if color="warning".

.MuiInput-formControl

Class name applied to the root element if the component is a descendant of FormControl.

.MuiInput-fullWidth

Class name applied to the root element if fullWidth={true}.

.MuiInput-sizeLg

Class name applied to the root element if size="lg".

.MuiInput-sizeMd

Class name applied to the root element if size="md".

.MuiInput-sizeSm

Class name applied to the root element if size="sm".

.MuiInput-variantOutlined

Class name applied to the root element if variant="outlined".

.MuiInput-variantPlain

Class name applied to the root element if variant="plain".

.MuiInput-variantSoft

Class name applied to the root element if variant="soft".

.MuiInput-variantSolid

Class name applied to the root element if variant="solid".