NumberInput

The NumberInput component is similar to the Input, but it has controls for incrementing or decrementing numeric values.

It follows the WAI-ARIA authoring practices for the Spinbutton widget.

🚨 Version (v0.4.0) introduced a change to this component's API. Kindly update accordingly.

Import#

Chakra UI exports 5 components for the NumberInput.

  • NumberInput: The wrapper that provides context and logic to the components.
  • NumberInputField: The input field itself.
  • NumberInputStepper: The wrapper for the input's stepper buttons.
  • NumberIncrementStepper: The button to increment the value of the input.
  • NumberDecrementStepper: The button to decrement the value of the input.

Usage#

The NumberInput is composed of smaller components to give you control of the styling of each part.

Editable Example

Setting a minimum and minimum value#

Simply pass the min prop or max prop to set an upper and lower limit for the input. By default, the input will restrict the value to stay within the specified range.

Editable Example

Setting the step size#

Simply pass the step prop to change the step size when you increment or decrement the value. By default, the value is rounded to match the number of decimals in the step.

Editable Example

Adjusting the precision of the value#

In some cases, you might need the value to be rounded to specific decimal points. Simply pass the precision prop and set it to the number of decimal points.

Editable Example

Clamp value when user blurs the input#

In most cases, users can type custom values in the input field. If the typed value is greater than the max, the value is reset to max when the user blur out of the input.

To disable this behavior, pass clampValueOnBlur and set to false.

In this example, try to type a value greater than the max, it won't reset the value on blur.

Editable Example

Allowing out of range values#

In some scenarios, you might not want to block out of range values. Simple pass keepWithinRange and clampValueOnBlur and set them to false to support this use case.

The NumberInput will be set isInvalid to true internally when the value is out of range. Out of range means that the value is great than max or less than min.

Editable Example

Changing the size of the input#

Just like the Input component, you can pass the size prop to change the size of the input.

Editable Example

Changing the styles#

You can change the style of any part of the components using style props. You can also change the icons used in the steppers

Editable Example

Combining it with a Slider#

A common use case is to combine the NumberInput with a Slider. Here's an example of how to do that.

Editable Example

Accessibility#

Aria Roles#

  • The input has role set to spinbutton to denote that users are to select from a range of discrete values using an up and down arrows on the keyboard.
  • The input as aria-valuemin set to the minimum value allowed for the spinbutton.
  • The input as aria-valuemax set to the maximum value allowed for the spinbutton. attribute should be applied to the spinbutton.
  • The input as aria-valuenow set to the current value of the input.
  • The custom spinner (up and down buttons) havearia-hidden set to true to make them invisible to screen readers.

Keyboard Navigation#

  • When you hit the or key, the input value will be increased or decreased by step
  • Holding down Shift and pressing or will update the value by 10 * step
  • Holding down Ctrl or , and pressing or will update the value by `0.1 * step`
  • Long press the Up and down stepper buttons will update the value at intervals.

Props#

NumberInput Props#

NumberInput composes Flex with some additional props listed below.

NameTypeDefaultDescription
valuenumberThe value of the input for controlled usage. Should be less than max and greater than min
defaultValuenumberThe initial value of the input. Should be less than max and greater than min
onChange(value: number) => voidThe callback fired when the value changes
minnumber-InfinityThe maximum value of the input
maxnumberInfinityThe minimum value of the input
stepnumber1The step used to increment or decrement the value
precisionnumberThe number of decimal points used to round the value
isReadOnlybooleanIf true, the input will be in readonly mode
isInvalidbooleanIf true, the input will have aria-invalid set to true
isDisabledbooleanIf true, the input will be disabled
keepWithinRangebooleantrueIf true and you use the stepper or up/down arrow keys, the value will not exceed the max or go lower than min
clampValueOnBlurbooleantrueIf true and the value is greater than max, the value will be reset to max
focusInputOnChangebooleantrueIf true, the input will be focused as you increment or decrement the value with the stepper
getAriaValueText(value: number) => stringtrueIt is used to set the aria-valuetext property of the input

NumberInputField Props#

NumberInput composes Input so you can pass all Input props.

NumberInputStepper Props#

NumberInputStepper composes Flex so you can pass all Flex props.

NumberDecrementStepper and NumberIncrementStepper Props#

NumberDecrementStepper and NumberIncrementStepper composes the PseudoBox props so you can pass all PseudoBox props.

Proudly made in 🇳🇬

Released under the MIT License.

Copyright © 2019 Segun Adebayo