Skip to content
+

Number Input

The Number Input component provides users with a field for integer values, and buttons to increment or decrement the value.

Component demosComponents APIHooks API

NumberInput API

Import

import { Unstable_NumberInput as NumberInput } from '@mui/base/Unstable_NumberInput';
// or
import { Unstable_NumberInput as NumberInput } from '@mui/base';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

defaultValue

The default value. Use when the component is not controlled.

Type:any

disabled

If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.

Type:bool

endAdornment

Trailing adornment for this input.

Type:node

error

If true, the input will indicate an error by setting the aria-invalid attribute on the input and the baseui--error class on the root element.

Type:bool

id

The id of the input element.

Type:string

max

The maximum value.

Type:number

min

The minimum value.

Type:number

onChange

Callback fired after the value is clamped and changes - when the input is blurred or when the stepper buttons are triggered. Called with undefined when the value is unset.

Type:func

Signature:
function(event: React.FocusEvent | React.PointerEvent | React.KeyboardEvent, value: number | undefined) => void
  • event The event source of the callback
  • value The new value of the component
onInputChange

Callback fired when the input value changes after each keypress, before clamping is applied. Note that event.target.value may contain values that fall outside of min and max or are otherwise "invalid".

Type:func

Signature:
function(event: React.ChangeEvent) => void
  • event The event source of the callback.
placeholder

The short hint displayed in the input before the user enters a value.

Type:string

readOnly

If true, the input element becomes read-only. The stepper buttons remain active, with the addition that they are now keyboard focusable.

Type:bool

Default:false

required

If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.

Type:bool

shiftMultiplier

Multiplier applied to step if the shift key is held while incrementing or decrementing the value. Defaults to 10.

Type:number

slotProps

The props used for each slot inside the NumberInput.

Type:{ decrementButton?: func
| object, incrementButton?: func
| object, input?: func
| object, root?: func
| object }

Default:{}

slots

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.

Type:{ decrementButton?: elementType, incrementButton?: elementType, input?: elementType, root?: elementType }

Default:{}

startAdornment

Leading adornment for this input.

Type:node

step

The amount that the value changes on each increment or decrement.

Type:number

value

The current value. Use when the component is controlled.

Type:number


The ref is forwarded to the root element.

Slots

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

root

The component that renders the root.

Class name: .base-NumberInput-root

Default component: 'div'

input

The component that renders the input.

Class name: .base-NumberInput-input

Default component: 'input'

incrementButton

The component that renders the increment button.

Class name: .base-NumberInput-incrementButton

Default component: 'button'

decrementButton

The component that renders the decrement button.

Class name: .base-NumberInput-decrementButton

Default component: 'button'

CSS classes

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

.base--disabledSTATE

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

.base--errorSTATE

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

.base--focusedSTATE

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

.base--readOnlySTATE

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

.base-NumberInput-adornedEnd

Class name applied to the root element if endAdornment is provided.

.base-NumberInput-adornedStart

Class name applied to the root element if startAdornment is provided.

.base-NumberInput-formControl

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