alpha

NumberField

NumberField allow entering of numbers with steppers to increment and decrement that value.

install	`yarn add @react-spectrum/numberfield`
version	3.0.0-alpha.1
usage	`import {NumberField} from '@react-spectrum/numberfield'`

View repository

GitHub

View package

NPM

Example#

<NumberField label="Name" />

<NumberField label="Name" />

<NumberField label="Name" />

Value#

A NumberField's value is empty by default, but an initial, uncontrolled, value can be provided using the defaultValue prop. Alternatively, a controlled value can be provided using the value prop.

function Example() {
  let [value, setValue] = React.useState(15);

  return (
    <Flex gap="size-150" wrap>
      <NumberField label="Cookies (Uncontrolled)" defaultValue={15} />

      <NumberField
        label="Cookies (Controlled)"
        value={value}
        onChange={setValue}
      />
    </Flex>
  );
}

function Example() {
  let [value, setValue] = React.useState(15);

  return (
    <Flex gap="size-150" wrap>
      <NumberField
        label="Cookies (Uncontrolled)"
        defaultValue={15}
      />

      <NumberField
        label="Cookies (Controlled)"
        value={value}
        onChange={setValue}
      />
    </Flex>
  );
}

function Example() {
  let [
    value,
    setValue
  ] = React.useState(15);

  return (
    <Flex
      gap="size-150"
      wrap>
      <NumberField
        label="Cookies (Uncontrolled)"
        defaultValue={15}
      />

      <NumberField
        label="Cookies (Controlled)"
        value={value}
        onChange={
          setValue
        }
      />
    </Flex>
  );
}

Steps#

A NumberField can have a specified step size, as well as a min and max value. The steps will always start at the minValue or 0 and will not exceed the min or the max if they are specified.

<NumberField label="Cookies" step={3} minValue={-5} maxValue={21} />

<NumberField
  label="Cookies"
  step={3}
  minValue={-5}
  maxValue={21}
/>

<NumberField
  label="Cookies"
  step={3}
  minValue={-5}
  maxValue={21}
/>

Labeling#

A visual label should be provided for the NumberField using the label prop. If the NumberField is required, the isRequired and necessityIndicator props can be used to show a required state.

<Flex gap="size-150" wrap>
  <NumberField label="Cookies" />
  <NumberField label="Cookies" isRequired necessityIndicator="icon" />
  <NumberField label="Cookies" isRequired necessityIndicator="label" />
  <NumberField label="Cookies" necessityIndicator="label" />
</Flex>

<Flex gap="size-150" wrap>
  <NumberField label="Cookies" />
  <NumberField
    label="Cookies"
    isRequired
    necessityIndicator="icon"
  />
  <NumberField
    label="Cookies"
    isRequired
    necessityIndicator="label"
  />
  <NumberField
    label="Cookies"
    necessityIndicator="label"
  />
</Flex>

<Flex
  gap="size-150"
  wrap>
  <NumberField label="Cookies" />
  <NumberField
    label="Cookies"
    isRequired
    necessityIndicator="icon"
  />
  <NumberField
    label="Cookies"
    isRequired
    necessityIndicator="label"
  />
  <NumberField
    label="Cookies"
    necessityIndicator="label"
  />
</Flex>

Accessibility#

If a visible label isn't specified, an aria-label must be provided to the NumberField for accessibility. If the field is labeled by a separate element, an aria-labelledby prop must be provided using the id of the labeling element instead.

Internationalization#

Label

In order to internationalize a NumberField, a localized string should be passed to the label or aria-label prop. When the necessityIndicator prop is set to "label", a localized string will be provided for "(required)" or "(optional)" automatically.

Value

The NumberField value can be formatted by using the formatOptions prop. formatOptions is compatible with the option parameter of Intl.NumberFormat and is applied based on the current locale.

<Flex gap="size-150" wrap>
  <NumberField
    label="Currency"
    formatOptions={{style: 'currency', currency: 'JPY'}}
    defaultValue={60}
  />
  <NumberField
    label="Percent"
    maxValue={1}
    step={0.001}
    formatOptions={{style: 'percent', minimumFractionDigits: 1}}
    defaultValue={0.891}
  />
</Flex>

<Flex gap="size-150" wrap>
  <NumberField
    label="Currency"
    formatOptions={{style: 'currency', currency: 'JPY'}}
    defaultValue={60}
  />
  <NumberField
    label="Percent"
    maxValue={1}
    step={0.001}
    formatOptions={{
      style: 'percent',
      minimumFractionDigits: 1
    }}
    defaultValue={0.891}
  />
</Flex>

<Flex
  gap="size-150"
  wrap>
  <NumberField
    label="Currency"
    formatOptions={{
      style:
        'currency',
      currency: 'JPY'
    }}
    defaultValue={60}
  />
  <NumberField
    label="Percent"
    maxValue={1}
    step={0.001}
    formatOptions={{
      style: 'percent',
      minimumFractionDigits: 1
    }}
    defaultValue={
      0.891
    }
  />
</Flex>

NumberField also supports three numeral systems, Latin digits, Arabic-Indic digits, and Hanidecimal. Regardless of the locale, these three can be parsed from typed input. In addition, the NumberField will automatically choose the starting numeral system based on the default for the locale.

Events#

NumberField accepts an onChange prop which is triggered whenever the value is edited by the user. For a full list of supported events, see the Props table below.

The example below uses onChange to update a separate pre element with the same text entered into the NumberField.

function Example() {
  let [value, setValue] = React.useState();

  return (
    <Flex direction="column" gap="size-150">
      <NumberField onChange={setValue} label="Number of cookies to buy" />
      <pre>How many cookies you are ordering: {value}</pre>
    </Flex>
  );
}

function Example() {
  let [value, setValue] = React.useState();

  return (
    <Flex direction="column" gap="size-150">
      <NumberField
        onChange={setValue}
        label="Number of cookies to buy"
      />
      <pre>How many cookies you are ordering: {value}</pre>
    </Flex>
  );
}

function Example() {
  let [
    value,
    setValue
  ] = React.useState();

  return (
    <Flex
      direction="column"
      gap="size-150">
      <NumberField
        onChange={
          setValue
        }
        label="Number of cookies to buy"
      />
      <pre>
        How many cookies
        you are ordering:{' '}
        {value}
      </pre>
    </Flex>
  );
}

Validation#

NumberFields can display a validation state to communicate to the user whether the current value is valid or invalid. Implement your own validation logic in your app and pass either "valid" or "invalid" to the NumberField via the validationState prop.

The example below illustrates how one would validate if the user has entered a FizzBuzz number into the NumberField.

function Example() {
  let [value, setValue] = React.useState(15);
  let isValid = React.useMemo(() => value % 3 === 0 && value % 5 === 0, [
    value
  ]);

  return (
    <NumberField
      validationState={isValid ? 'valid' : 'invalid'}
      value={value}
      onChange={setValue}
      label="FizzBuzz values only"
    />
  );
}

function Example() {
  let [value, setValue] = React.useState(15);
  let isValid = React.useMemo(
    () => value % 3 === 0 && value % 5 === 0,
    [value]
  );

  return (
    <NumberField
      validationState={isValid ? 'valid' : 'invalid'}
      value={value}
      onChange={setValue}
      label="FizzBuzz values only"
    />
  );
}

function Example() {
  let [
    value,
    setValue
  ] = React.useState(15);
  let isValid = React.useMemo(
    () =>
      value % 3 === 0 &&
      value % 5 === 0,
    [value]
  );

  return (
    <NumberField
      validationState={
        isValid
          ? 'valid'
          : 'invalid'
      }
      value={value}
      onChange={setValue}
      label="FizzBuzz values only"
    />
  );
}

Props#

Name	Type	Default	Description
`isQuiet`	`boolean`	—	Whether the numberfield should be displayed with a quiet style.
`hideStepper`	`boolean`	—	Whether to hide the step buttons on the side of the input.
`formatOptions`	`Intl.NumberFormatOptions`	—	The display format of the value.
`decrementAriaLabel`	`string`	—	Accessible label for the decrement button.
`incrementAriaLabel`	`string`	—	Accessible label for the increment button.
`isDisabled`	`boolean`	—	Whether the input is disabled.
`isReadOnly`	`boolean`	—	Whether the input can be selected but not changed by the user.
`validationState`	`ValidationState`	—	Whether the input should display its "valid" or "invalid" visual styling.
`isRequired`	`boolean`	—	Whether user input is required on the input before form submission. Often paired with the `necessityIndicator` prop to add a visual indicator to the input.
`autoFocus`	`boolean`	—	Whether the element should receive focus on render.
`placeholder`	`string`	—	Temporary text that occupies the text input when it is empty.
`value`	`number`	—	The current value (controlled).
`defaultValue`	`number`	—	The default value (uncontrolled).
`minValue`	`number`	—	The smallest value allowed for the input.
`maxValue`	`number`	—	The largest value allowed for the input.
`step`	`number`	—	The amount that the input value changes with each increment or decrement "tick".
`label`	`ReactNode`	—	The content to display as the label.
`labelPosition`	`LabelPosition`	`'top'`	The label's overall position relative to the element it is labeling.
`labelAlign`	`Alignment`	`'start'`	The label's horizontal alignment relative to the element it is labeling.
`necessityIndicator`	`NecessityIndicator`	`'icon'`	Whether the required state should be shown as an icon or text.

Events

Name	Type	Default	Description
`onFocus`	`( (e: FocusEvent )) => void`	—	Handler that is called when the element receives focus.
`onBlur`	`( (e: FocusEvent )) => void`	—	Handler that is called when the element loses focus.
`onFocusChange`	`( (isFocused: boolean )) => void`	—	Handler that is called when the element's focus status changes.
`onKeyDown`	`( (e: KeyboardEvent )) => void`	—	Handler that is called when a key is pressed.
`onKeyUp`	`( (e: KeyboardEvent )) => void`	—	Handler that is called when a key is released.
`onChange`	`( (value: number )) => void`	—	Handler that is called when the value changes.

Layout

Name	Type	Default	Description
`flex`	`string \| number \| boolean`	—	When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
`flexGrow`	`number`	—	When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
`flexShrink`	`number`	—	When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
`flexBasis`	`number \| string`	—	When used in a flex layout, specifies the initial main size of the element. See MDN.
`alignSelf`	`'auto' \| 'normal' \| 'start' \| 'end' \| 'center' \| 'flex-start' \| 'flex-end' \| 'self-start' \| 'self-end' \| 'stretch'`	—	Overrides the `alignItems` property of a flex or grid container. See MDN.
`justifySelf`	`'auto' \| 'normal' \| 'start' \| 'end' \| 'flex-start' \| 'flex-end' \| 'self-start' \| 'self-end' \| 'center' \| 'left' \| 'right' \| 'stretch'`	—	Specifies how the element is justified inside a flex or grid container. See MDN.
`order`	`number`	—	The layout order for the element within a flex or grid container. See MDN.
`gridArea`	`string`	—	When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
`gridColumn`	`string`	—	When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
`gridRow`	`string`	—	When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
`gridColumnStart`	`string`	—	When used in a grid layout, specifies the starting column to span within the grid. See MDN.
`gridColumnEnd`	`string`	—	When used in a grid layout, specifies the ending column to span within the grid. See MDN.
`gridRowStart`	`string`	—	When used in a grid layout, specifies the starting row to span within the grid. See MDN.
`gridRowEnd`	`string`	—	When used in a grid layout, specifies the ending row to span within the grid. See MDN.

Spacing

Name	Type	Default	Description
`margin`	`DimensionValue`	—	The margin for all four sides of the element. See MDN.
`marginTop`	`DimensionValue`	—	The margin for the top side of the element. See MDN.
`marginBottom`	`DimensionValue`	—	The margin for the bottom side of the element. See MDN.
`marginStart`	`DimensionValue`	—	The margin for the logical start side of the element, depending on layout direction. See MDN.
`marginEnd`	`DimensionValue`	—	The margin for the logical end side of an element, depending on layout direction. See MDN.
`marginX`	`DimensionValue`	—	The margin for both the left and right sides of the element. See MDN.
`marginY`	`DimensionValue`	—	The margin for both the top and bottom sides of the element. See MDN.

Sizing

Name	Type	Default	Description
`width`	`DimensionValue`	—	The width of the element. See MDN.
`minWidth`	`DimensionValue`	—	The minimum width of the element. See MDN.
`maxWidth`	`DimensionValue`	—	The maximum width of the element. See MDN.
`height`	`DimensionValue`	—	The height of the element. See MDN.
`minHeight`	`DimensionValue`	—	The minimum height of the element. See MDN.
`maxHeight`	`DimensionValue`	—	The maximum height of the element. See MDN.

Positioning

Name	Type	Default	Description
`position`	`'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky'`	—	Specifies how the element is positioned. See MDN.
`top`	`DimensionValue`	—	The top position for the element. See MDN.
`bottom`	`DimensionValue`	—	The bottom position for the element. See MDN.
`left`	`DimensionValue`	—	The left position for the element. See MDN. Consider using `start` instead for RTL support.
`right`	`DimensionValue`	—	The right position for the element. See MDN. Consider using `start` instead for RTL support.
`start`	`DimensionValue`	—	The logical start position for the element, depending on layout direction. See MDN.
`end`	`DimensionValue`	—	The logical end position for the element, depending on layout direction. See MDN.
`zIndex`	`number`	—	The stacking order for the element. See MDN.
`isHidden`	`boolean`	—	Hides the element.

Accessibility

Name	Type	Default	Description
`id`	`string`	—	The element's unique identifier. See MDN.
`aria-label`	`string`	—	Defines a string value that labels the current element.
`aria-labelledby`	`string`	—	Identifies the element (or elements) that labels the current element.
`aria-describedby`	`string`	—	Identifies the element (or elements) that describes the object.
`aria-details`	`string`	—	Identifies the element (or elements) that provide a detailed, extended description for the object.

Advanced

Name	Type	Default	Description
`UNSAFE_className`	`string`	—	Sets the CSS className for the element. Only use as a last resort. Use style props instead.
`UNSAFE_style`	`CSSProperties`	—	Sets inline style for the element. Only use as a last resort. Use style props instead.

Visual options#

Quiet#

<NumberField label="Cookies" isQuiet />

<NumberField label="Cookies" isQuiet />

<NumberField
  label="Cookies"
  isQuiet
/>

Hidden Steppers#

NumberField stepper buttons are optional.

<NumberField label="Cookies" hideStepper />

<NumberField label="Cookies" hideStepper />

<NumberField
  label="Cookies"
  hideStepper
/>

Disabled#

<NumberField label="Cookies" isDisabled />

<NumberField label="Cookies" isDisabled />

<NumberField
  label="Cookies"
  isDisabled
/>

Read only#

The isReadOnly boolean prop makes the NumberField's text content immutable. Unlike isDisabled the NumberField remains focusable and the contents can still be copied. See the MDN docs for more information.

<NumberField label="Cookies" defaultValue="abc@adobe.com" isReadOnly />

<NumberField
  label="Cookies"
  defaultValue="abc@adobe.com"
  isReadOnly
/>

<NumberField
  label="Cookies"
  defaultValue="abc@adobe.com"
  isReadOnly
/>

Label alignment and position#

View guidelines

By default, the label is positioned above the NumberField. The labelPosition prop can be used to position the label to the side. The labelAlign prop can be used to align the label as "start" or "end". For left-to-right (LTR) languages, "start" refers to the left most edge of the NumberField and "end" refers to the right most edge. For right-to-left (RTL) languages, this is flipped.

<NumberField label="Cookies" labelPosition="side" labelAlign="end" />

<NumberField
  label="Cookies"
  labelPosition="side"
  labelAlign="end"
/>

<NumberField
  label="Cookies"
  labelPosition="side"
  labelAlign="end"
/>

Custom width#

View guidelines

<NumberField label="Cookies" width="size-3600" maxWidth="100%" />

<NumberField
  label="Cookies"
  width="size-3600"
  maxWidth="100%"
/>

<NumberField
  label="Cookies"
  width="size-3600"
  maxWidth="100%"
/>