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:

Input

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

Name	Type	Default	Description
className	string	-	Class name applied to the root element.
color	'danger' \| 'neutral' \| 'primary' \| 'success' \| 'warning' \| string	'neutral'	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.
endDecorator	node	-	Trailing adornment for this input.
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.
size	'sm' \| 'md' \| 'lg' \| string	'md'	The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.
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	'outlined'	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.

Slot name	Class name	Default component	Description
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.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.Mui-disabled		Class name applied to the root element if `disabled={true}`.
.Mui-error		State class applied to the root element if `error={true}`.
.Mui-focused		Class name applied to the root element if the component is focused.
.MuiInput-colorContext	colorContext	Class name applied to the root element when color inversion is triggered.
.MuiInput-colorDanger	colorDanger	Class name applied to the root element if `color="danger"`.
.MuiInput-colorNeutral	colorNeutral	Class name applied to the root element if `color="neutral"`.
.MuiInput-colorPrimary	colorPrimary	Class name applied to the root element if `color="primary"`.
.MuiInput-colorSuccess	colorSuccess	Class name applied to the root element if `color="success"`.
.MuiInput-colorWarning	colorWarning	Class name applied to the root element if `color="warning"`.
.MuiInput-formControl	formControl	Class name applied to the root element if the component is a descendant of `FormControl`.
.MuiInput-fullWidth	fullWidth	Class name applied to the root element if `fullWidth={true}`.
.MuiInput-sizeLg	sizeLg	Class name applied to the root element if `size="lg"`.
.MuiInput-sizeMd	sizeMd	Class name applied to the root element if `size="md"`.
.MuiInput-sizeSm	sizeSm	Class name applied to the root element if `size="sm"`.
.MuiInput-variantOutlined	variantOutlined	Class name applied to the root element if `variant="outlined"`.
.MuiInput-variantPlain	variantPlain	Class name applied to the root element if `variant="plain"`.
.MuiInput-variantSoft	variantSoft	Class name applied to the root element if `variant="soft"`.
.MuiInput-variantSolid	variantSolid	Class name applied to the root element if `variant="solid"`.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.