Choose a version:

NumberField
component

Use a number field to conveniently and accurately capture numerical values.

Anchor to numberfieldNumberField

Anchor to label label string required: The content to use as the field label.
Anchor to inputMode inputMode "decimal" | "numeric"
Anchor to max max number
Anchor to min min number
Anchor to disabled disabled boolean: Whether the field can be modified.
Anchor to error error string: Indicates an error to the user. The field is given specific stylistic treatment to communicate problems that have to be resolved immediately.
Anchor to onBlur onBlur () => void: The callback when focus is removed.
Anchor to onChange onChange (value: string) => void: The callback when the user has finished editing a field.
Anchor to onFocus onFocus () => void: The callback when input is focused.
Anchor to onInput onInput (value: string) => void: Callback when the user makes any changes in the field. As noted in the documentation for onChange, you must not use this to update value — use the onChange callback for that purpose. Use the onInput prop when you need to do something as soon as the user makes a change, like clearing validation errors that apply to the field as soon as the user begins making the necessary adjustments.
Anchor to placeholder placeholder string: A short hint that describes the expected value of the field.
Anchor to required required boolean: Whether the field needs a value.
Anchor to value value string: The current value for the field. Defaults to now. You should update this value in response to the onChange callback.
Anchor to helpText helpText string: The label under the text field which provides guidance or instructions that assist users.
Anchor to action action: A button under the text field to provide extra functionality.
Anchor to maxLength maxLength number: The maximum number of characters allowed in the input field.

NumberFieldProps

inputMode
```
"decimal" | "numeric"
```
max
```
number
```
min
```
number
```
disabled
Whether the field can be modified.
```
boolean
```
error
Indicates an error to the user. The field is given specific stylistic treatment to communicate problems that have to be resolved immediately.
```
string
```
label
The content to use as the field label.
```
string
```
onBlur
The callback when focus is removed.
```
() => void
```
onChange
The callback when the user has finished editing a field.
```
(value: string) => void
```
onFocus
The callback when input is focused.
```
() => void
```
onInput
Callback when the user makes any changes in the field. As noted in the documentation for `onChange`, you **must not** use this to update `value` — use the `onChange` callback for that purpose. Use the `onInput` prop when you need to do something as soon as the user makes a change, like clearing validation errors that apply to the field as soon as the user begins making the necessary adjustments.
```
(value: string) => void
```
placeholder
A short hint that describes the expected value of the field.
```
string
```
required
Whether the field needs a value.
```
boolean
```
value
The current value for the field. Defaults to now. You should update this value in response to the `onChange` callback.
```
string
```
helpText
The label under the text field which provides guidance or instructions that assist users.
```
string
```
action
A button under the text field to provide extra functionality.
```
InputAction
```
maxLength
The maximum number of characters allowed in the input field.
```
number
```

export interface NumberFieldProps extends InputProps {
  inputMode?: 'decimal' | 'numeric';
  max?: number;
  min?: number;
}

InputAction

label
The text displayed in the button.
```
string
```
onPress
A callback to be performed.
```
() => void
```
disabled
Whether the button can be pressed.
```
boolean
```

export interface InputAction {
  /**
   * The text displayed in the button.
   */
  label: string;
  /**
   * A callback to be performed.
   */
  onPress: () => void;
  /**
   * Whether the button can be pressed.
   */
  disabled?: boolean;
}

Was this section helpful?

Number input

import React, {useState} from 'react';

import {

NumberField,

Screen,

ScrollView,

Navigator,

Text,

reactExtension,

} from '@shopify/ui-extensions-react/point-of-sale';

const SmartGridModal = () => {

const [number, setNumber] = useState('');

return (

<NumberField

label="Number"

placeholder="1234"

helpText="Enter a numeric value."

value={number}

onChange={setNumber}

required={true}

action={{

label: 'Clear',

onPress: () => setNumber(''),

}}

<Text>Entered Value: {number}</Text>

</ScrollView>

</Screen>

</Navigator>

);

};

export default reactExtension('pos.home.modal.render', () => (

));

examples

Number input

React

import React, {useState} from 'react';
import {
  NumberField,
  Screen,
  ScrollView,
  Navigator,
  Text,
  reactExtension,
} from '@shopify/ui-extensions-react/point-of-sale';

const SmartGridModal = () => {
  const [number, setNumber] = useState('');
  return (
    <Navigator>
      <Screen name="NumberField" title="NumberField Example">
        <ScrollView>
          <NumberField
            label="Number"
            placeholder="1234"
            helpText="Enter a numeric value."
            value={number}
            onChange={setNumber}
            required={true}
            action={{
              label: 'Clear',
              onPress: () => setNumber(''),
            }}
          />
          <Text>Entered Value: {number}</Text>
        </ScrollView>
      </Screen>
    </Navigator>
  );
};

export default reactExtension('pos.home.modal.render', () => (
  <SmartGridModal />
));

TS

import {
  Navigator,
  Screen,
  ScrollView,
  Text,
  NumberField,
  extension,
} from '@shopify/ui-extensions/point-of-sale';

export default extension('pos.home.modal.render', (root, api) => {
  const clearHandler = () => {
    numberField.updateProps({value: ''});
    textBox.replaceChildren('');
  };
  const numberField = root.createComponent(NumberField, {
    label: 'Number',
    placeholder: '1234',
    helpText: 'Enter a numeric value.',
    value: '',
    action: {label: 'Clear', onPress: clearHandler},
  });

  const textBox = root.createComponent(Text);

  const onChangeHandler = (newValue: string) => {
    numberField.updateProps({value: newValue});

    const textContent = `Selected Date: ${newValue}`;
    textBox.replaceChildren(textContent);
  };

  numberField.updateProps({onChange: onChangeHandler});

  const scrollView = root.createComponent(ScrollView);
  scrollView.append(numberField);
  scrollView.append(textBox);

  const screen = root.createComponent(Screen, {
    name: 'NumberField',
    title: 'Number Field Example',
  });
  screen.append(scrollView);

  const navigator = root.createComponent(Navigator);
  navigator.append(screen);

  root.append(navigator);
});

NumberFieldcomponent

Anchor to numberfieldNumberField

NumberFieldProps

InputAction

examples

Number input

React

TS

Preview

NumberField
component