Number field API

Import

import { NumberField } from '@cimpress-ui/react';

Controlled/uncontrolled usage

This component can be used in a controlled or uncontrolled way.

In the controlled way, this component doesn’t maintain its own internal state, and its value is provided by the parent component. Use the controlled way when you need to be able to change the state of this component in other parts of your application.

In the uncontrolled way, this component maintains its own internal state, and can optionally notify the parent component when its internal state changes. Use the uncontrolled way when you don’t need to change the state of this component in other parts of your application.

Preview
Code

Width (controlled)

Width (uncontrolled)

import { NumberField, Stack } from '@cimpress-ui/react';
import { useState } from 'react';

export default function Demo() {
  const [value, setValue] = useState<number | null>(10);

  return (
    <Stack gap={32}>
      <NumberField label="Width (controlled)" value={value} onChange={setValue} />
      <NumberField label="Width (uncontrolled)" defaultValue={10} />
    </Stack>
  );
}

Imperative API

This component exposes an imperative API through the apiRef prop. This API allows triggering behaviors that can’t be expressed by props.

Preview
Code

Width

import { Button, NumberField, type NumberFieldApi, Stack } from '@cimpress-ui/react';
import { useRef } from 'react';

export default function Demo() {
  const apiRef = useRef<NumberFieldApi>(null);

  return (
    <Stack gap={16}>
      <NumberField label="Width" defaultValue={10} apiRef={apiRef} />

      <Stack gap={16} direction={{ md: 'horizontal' }}>
        <Button onPress={() => apiRef.current?.focus()}>Focus</Button>
        <Button onPress={() => apiRef.current?.select()}>Select text</Button>
      </Stack>
    </Stack>
  );
}

Accessibility notes

Number field follows the ARIA spinbutton pattern. See the linked page for a list of available keyboard interactions.

NumberField requires a textual label to remain accessible to assistive technologies. See our accessibility guide for more details.

Value formatting

Number field displays its value as a decimal number by default. This can be overridden using the formatOptions prop. This prop has the same syntax as the options parameter of the Intl.NumberFormat constructor, with the following limitations:

notation property only supports the 'standard' value

The following example demonstrates a number field that displays a percentage value:

Preview
Code

Tax

import { NumberField } from '@cimpress-ui/react';

export default function Demo() {
  return (
    <NumberField
      label="Tax"
      defaultValue={0.05}
      minValue={0}
      formatOptions={{
        style: 'percent',
      }}
    />
  );
}

Forms

Number field can integrate with native HTML forms. See our forms guide to learn how to work with forms.

`onChange` behavior

Unlike TextField, NumberField does not trigger onChange while typing. Instead, it triggers onChange when:

Using keyboard arrow keys or a mouse scroll wheel to increment/decrement the value
Pressing the Enter key
Blurring (leaving) the input
Clicking the spin buttons

This behavior ensures proper handling of validation constraints like minValue and maxValue. For example, if a user types “-200” when minValue is -100, the value will be clamped to -100 only after one of the above actions occurs, rather than during typing which could interfere with input.

API reference

NumberField

Allows users to edit a number with a keyboard or increment/decrement buttons.

See number field usage guidelines.

ref Section titled “ ref ” Ref<HTMLDivElement>: The ref type for this component.

NumberFieldProps

value Section titled “ value ” number | null: The current value (controlled). A null value means an empty field.
defaultValue Section titled “ defaultValue ” number | null: The default value (uncontrolled). A null value means an empty field.
onChange Section titled “ onChange ” (value: number | null) => void: Handler that is called when the value changes. A null value means an empty field.
id Section titled “ id ” string: The element's unique identifier. See MDN.
data-cim-style-root Section titled “ data-cim-style-root ” boolean: Use this attribute to "claim" the component tree for exclusive Cimpress UI usage.
UNSAFE_className Section titled “ UNSAFE_className ” string: Sets the CSS className for the element. Only use as a last resort. Use style props instead.

See styling guide.
UNSAFE_style Section titled “ UNSAFE_style ” CSSProperties: Sets the CSS style for the element. Only use as a last resort. Use style props instead.

See styling guide.
label Section titled “ label ” string: The content to display as the label.
aria-label Section titled “ aria-label ” string: Defines a string value that labels the current element.
aria-labelledby Section titled “ aria-labelledby ” string: Identifies the element (or elements) that labels the current element.
aria-describedby Section titled “ aria-describedby ” string: Identifies the element (or elements) that describes the object.
aria-details Section titled “ aria-details ” string: Identifies the element (or elements) that provide a detailed, extended description for the object.
form Section titled “ form ” string: The <form> element to associate the input with. The value of this attribute must be the id of a <form> in the same document. See MDN.
name Section titled “ name ” string: The name of the input element, used when submitting an HTML form. See MDN.
description Section titled “ description ” string: A description for the field. Provides a hint such as specific requirements for what to choose.
error Section titled “ error ” FieldError: An error message for the field.
validate Section titled “ validate ” (value: number) => string | true | string[] | undefined: A function that returns an error message (or true) if a given value is invalid. Validation errors are displayed to the user when the form is submitted. For real-time validation, use the error prop instead.
placeholder Section titled “ placeholder ” string: The placeholder text displayed in the input field.
apiRef Section titled “ apiRef ” RefObject<NumberFieldApi | null>: A React ref that allows access to the imperative API of this component.
formatOptions Section titled “ formatOptions ” NumberFormatOptions: Formatting options for the value displayed in the number field. This also affects what characters are allowed to be typed by the user.
onKeyDown Section titled “ onKeyDown ” (e: KeyboardEvent) => void: Handler that is called when a key is pressed.
onFocus Section titled “ onFocus ” (e: FocusEvent<Element>) => void: Handler that is called when the element receives focus.
onBlur Section titled “ onBlur ” (e: FocusEvent<Element>) => void: Handler that is called when the element loses focus.
autoFocus Section titled “ autoFocus ” boolean: Whether the element should receive focus on render.
isRequired Section titled “ isRequired ” boolean: Whether user input is required on the input before form submission.
isInvalid Section titled “ isInvalid ” boolean: Whether the input value is invalid.
isDisabled Section titled “ isDisabled ” boolean: Whether the input is disabled.
isReadOnly Section titled “ isReadOnly ” boolean: Whether the input can be selected but not changed by the user.
minValue Section titled “ minValue ” number: The smallest value allowed for the input.
maxValue Section titled “ maxValue ” number: The largest value allowed for the input.
step Section titled “ step ” number: The amount that the input value changes with each increment or decrement "tick".

StyleProps

margin Section titled “ margin ” Responsive<Spacing | "auto">: The amount of margin applied to all edges of this component.
marginX Section titled “ marginX ” Responsive<Spacing | "auto">: The amount of margin applied to the left and right edges of this component. Takes priority over margin.
marginY Section titled “ marginY ” Responsive<Spacing | "auto">: The amount of margin applied to the top and bottom edges of this component. Takes priority over margin.
marginTop Section titled “ marginTop ” Responsive<Spacing | "auto">: The amount of margin applied to the top edge of this component. Takes priority over marginY and margin.
marginRight Section titled “ marginRight ” Responsive<Spacing | "auto">: The amount of margin applied to the right edge of this component. Takes priority over marginX and margin.
marginBottom Section titled “ marginBottom ” Responsive<Spacing | "auto">: The amount of margin applied to the bottom edge of this component. Takes priority over marginY and margin.
marginLeft Section titled “ marginLeft ” Responsive<Spacing | "auto">: The amount of margin applied to the left edge of this component. Takes priority over marginX and margin.

Number field API

Import

Controlled/uncontrolled usage

Imperative API

Accessibility notes

Value formatting

Forms

onChange behavior

API reference

NumberField

ref

value

defaultValue

onChange

id

data-cim-style-root

UNSAFE_className

UNSAFE_style

label

aria-label

aria-labelledby

aria-describedby

aria-details

form

name

description

error

validate

placeholder

apiRef

formatOptions

onKeyDown

onFocus

onBlur

autoFocus

isRequired

isInvalid

isDisabled

isReadOnly

minValue

maxValue

step

margin

marginX

marginY

marginTop

marginRight

marginBottom

marginLeft

`onChange` behavior