Unstyled Input

The Unstyled Input component provides users with a field to enter and edit text.

Introduction

An input is a UI element that accepts text data from the user. The Unstyled Input component replaces the native HTML <input> tag, and offers expanded customization and accessibility features. It can also be transformed into a <textarea> as needed.

Component

Usage

After installation, you can start building with this component using the following basic elements:

import InputUnstyled from '@mui/base/InputUnstyled';

export default function MyApp() {
  return <InputUnstyled />;
}

Basics

Unstyled Input behaves similarly to the native HTML <input>, except that it's nested inside of a root <div>—see Anatomy for details.

The following demo shows how to create and style an input component, including placeholder text:

Anatomy

The Unstyled Input component is composed of a root <div> slot that houses one interior <input> slot:

<div class="MuiInput-root">
  <input class="MuiInput-input" />
</div>

Slot props

Use the component prop to override the root slot with a custom element:

<InputUnstyled component="aside" />

Use the slots prop to override any interior slots in addition to the root:

<InputUnstyled slots={{ root: 'aside' }} />

Use the slotProps prop to pass custom props to internal slots. The following code snippet applies a CSS class called my-input to the input slot:

<InputUnstyled slotProps={{ input: { className: 'my-input' } }} />

Hook

import useInput from '@mui/base/useInput';

The useInput hook lets you apply the functionality of an input to a fully custom component. It returns props to be placed on the custom component, along with fields representing the component's internal state.

Hooks do not support slot props, but they do support customization props.

The demo below shows how to use the useInput hook to create a custom input component that receives all the necessary props:

Customization

Adornments

You can use the startAdornment and endAdornment props to add a prefix, suffix, or an action to an input. Common use cases of adornments include:

when an input receives a specific unit of measure (like weight or currency)
when an icon button toggles hiding/showing a password

The following demo shows examples of both of these use cases:

Multiline

The multiline prop transforms the <input> field into a <textarea> element, as shown below:

<CustomInput aria-label="Demo input" multiline placeholder="Type something…" />

<CustomInput aria-label="Demo input" multiline placeholder="Type something…" />

Press Enter to start editing

If you want the <textarea> to grow with the content, you can use the Textarea Autosize component within the input.

When using Textarea Autosize, the height of the <textarea> element dynamically matches its content unless you set the rows prop. To set minimum and maximum sizes, add the minRows and maxRows props.

The following demo shows how to insert a Textarea Autosize component into an Unstyled Input so that its height grows with the length of the content:

<CustomInput aria-label="Demo input" multiline placeholder="Type something…" />

<CustomInput aria-label="Demo input" multiline placeholder="Type something…" />

Press Enter to start editing

InputUnstyled API

Import

import InputUnstyled from '@mui/base/InputUnstyled';
// or
import { InputUnstyled } from '@mui/base';

You can learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

Name	Type	Default	Description
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		If `true`, the `input` element is focused during the first mount.
className	string		Class name applied to the root element.
component	elementType		The component used for the root node. Either a string to use a HTML element or a component.
defaultValue	any		The default value. Use when the component is not controlled.
disabled	bool		If `true`, the component is disabled. The prop defaults to the value (`false`) inherited from the parent FormControl component.
endAdornment	node		Trailing adornment for this input.
error	bool		If `true`, the `input` will indicate an error by setting the `aria-invalid` attribute on the input and the `Mui-error` class on the root element. The prop defaults to the value (`false`) inherited from the parent FormControl component.
id	string		The id of the `input` element.
maxRows	number		Maximum number of rows to display when multiline option is set to true.
minRows	number		Minimum number of rows to display when multiline option is set to true.
multiline	bool	false	If `true`, a `textarea` element is rendered.
name	string		Name attribute of the `input` element.
placeholder	string		The short hint displayed in the `input` before the user enters a value.
readOnly	bool		It prevents the user from changing the value of the field (not from interacting with the field).
required	bool		If `true`, the `input` element is required. The prop defaults to the value (`false`) inherited from the parent FormControl component.
rows	number		Number of rows to display when multiline option is set to true.
slotProps	{ input?: func \| object, root?: func \| object }	{}	The props used for each slot inside the Input.
slots	{ input?: elementType, root?: elementType, textarea?: elementType }	{}	The components used for each slot inside the InputBase. Either a string to use a HTML element or a component. See Slots API below for more details.
startAdornment	node		Leading adornment for this input.
type	'button' \| 'checkbox' \| 'color' \| 'date' \| 'datetime-local' \| 'email' \| 'file' \| 'hidden' \| 'image' \| 'month' \| 'number' \| 'password' \| 'radio' \| 'range' \| 'reset' \| 'search' \| 'submit' \| 'tel' \| 'text' \| 'time' \| 'url' \| 'week'	'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.

The ref is forwarded to the root element.

Slots

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

Name	Default class	Default HTML tag	Description
root	.MuiInput-root	'div'	The component that renders the root.
input	.MuiInput-input	'input'	The component that renders the input.
textarea		'textarea'	The component that renders the textarea.

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.

CSS classes

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

Global class	Description
.Mui-disabled STATE	State class applied to the root element if `disabled={true}`.
.Mui-error STATE	State class applied to the root element if `error={true}`.
.Mui-focused STATE	State class applied to the root element if the component is focused.
.MuiInput-adornedEnd	Class name applied to the root element if `endAdornment` is provided.
.MuiInput-adornedStart	Class name applied to the root element if `startAdornment` is provided.
.MuiInput-formControl	Class name applied to the root element if the component is a descendant of `FormControl`.
.MuiInput-inputMultiline	Class name applied to the input element if `multiline={true}`.
.MuiInput-inputTypeSearch	Class name applied to the input element if `type="search"`.
.MuiInput-multiline	Class name applied to the root element if `multiline={true}`.

useInput API

Import

import useInput from '@mui/base/useInput';
// or
import { useInput } from '@mui/base';

You can learn about the difference by reading this guide on minimizing bundle size.

Parameters

Name	Type	Description
defaultValue	unknown	The default value. Use when the component is not controlled.
disabled	boolean	If `true`, the component is disabled. The prop defaults to the value (`false`) inherited from the parent FormControl component.
error	boolean	If `true`, the `input` will indicate an error by setting the `aria-invalid` attribute. The prop defaults to the value (`false`) inherited from the parent FormControl component.
inputRef	React.Ref<HTMLInputElement>
onBlur	React.FocusEventHandler
onChange	React.ChangeEventHandler<HTMLInputElement>
onClick	React.MouseEventHandler
onFocus	React.FocusEventHandler
required	boolean	If `true`, the `input` element is required. The prop defaults to the value (`false`) inherited from the parent FormControl component.
value	unknown

Return value

Name	Type	Default	Description
disabled	boolean	false	If `true`, the component will be disabled.
error	boolean	false	If `true`, the `input` will indicate an error by setting the `aria-invalid` attribute.
focused	boolean	false	If `true`, the `input` will be focused.
formControlContext	FormControlUnstyledState \| undefined		Return value from the `useFormControlUnstyledContext` hook.
getInputProps	<TOther extends Record<string, any> = {}>(externalProps?: TOther) => UseInputInputSlotProps<TOther>		Resolver for the input slot's props.
getRootProps	<TOther extends Record<string, any> = {}>(externalProps?: TOther) => UseInputRootSlotProps<TOther>		Resolver for the root slot's props.
required	boolean	false	If `true`, the `input` will indicate that it's required.
value	unknown		The `value` of the `input` element.