Skip to main content

Number field

The number field component captures numeric input with built-in number validation. Use it to collect quantities, measurements, or other numeric information.

The component supports min/max constraints and step increments for guided numeric entry. For monetary values with currency formatting, use money field.

Support
Targets (24)

Supported targets

Anchor to PropertiesProperties

Configure the following properties on the number field component.

Anchor to autocomplete
autocomplete
AutocompleteField | `${} ${AutocompleteField}` | `${} ${AutocompleteField}` | `${} ${} ${AutocompleteField}` | "on" | "off"
Default: 'on'

A hint about the intended content of the field for browser autofill.

When set to on (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.

When set to off, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.

Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.

Learn more about the set of autocomplete values supported in browsers.

Anchor to controls
controls
'auto' | 'stepper' | 'none'
Default: 'auto'

Sets the type of controls displayed in the field.

  • 'auto': The presence of the controls depends on the surface and context.
  • 'stepper': Displays buttons to increase or decrease the value by the stepping interval defined in the step property. Appropriate mouse and keyboard interactions to control the value are enabled.
  • 'none': No controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.
Anchor to defaultValue
defaultValue
string

The initial value of the field when it first loads. Unlike placeholder, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.

Anchor to disabled
disabled
boolean
Default: false

Whether the field is disabled, preventing any user interaction.

Anchor to error
error
string

An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.

Anchor to icon
icon
['type']
Default: ''

The type of icon to be displayed in the field.

Anchor to id
id
string

A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.

Anchor to inputMode
inputMode
'decimal' | 'numeric'
Default: 'decimal'

Sets the virtual keyboard layout for the field.

  • 'decimal': A numeric keyboard with a decimal point, suitable for decimal numbers.
  • 'numeric': A numeric keyboard without a decimal point, suitable for integers.

Learn more about the inputMode attribute.

Anchor to label
label
string

The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.

Anchor to labelAccessibilityVisibility
labelAccessibilityVisibility
'visible' | 'exclusive'
Default: 'visible'

Controls whether the label is visible to all users or only to screen readers.

  • visible: The label is shown to everyone.
  • exclusive: The label is visually hidden but still announced by screen readers.
Anchor to max
max
number
Default: Infinity

The highest decimal or integer to be accepted for the field. When used with step the value will round down to the max number.

Note: a user can still use the keyboard to input a number higher than the max. It's up to the developer to add appropriate validation.

Anchor to min
min
number
Default: -Infinity

The lowest decimal or integer to be accepted for the field. When used with step the value will round up to the min number.

Note: a user can still use the keyboard to input a number lower than the min. It's up to the developer to add appropriate validation.

Anchor to name
name
string

The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.

Anchor to prefix
prefix
string
Default: ''

A value to be displayed immediately before the editable portion of the field.

This is useful for displaying an implied part of the value, such as "https://" or "+353".

This can't be edited by the user, and it isn't included in the value of the field.

It may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input.

Anchor to readOnly
readOnly
boolean
Default: false

Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.

Anchor to required
required
boolean
Default: false

Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the error property.

Anchor to step
step
number
Default: 1

The amount the value can increase or decrease by. This can be an integer or decimal. If a max or min is specified with step when increasing/decreasing the value via the buttons, the final value will always round to the max or min rather than the closest valid amount.

Anchor to suffix
suffix
string
Default: ''

A value to be displayed immediately after the editable portion of the field.

This is useful for displaying an implied part of the value, such as "@shopify.com", or "%".

This can't be edited by the user, and it isn't included in the value of the field.

It may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input.

Anchor to value
value
string

The current value for the field. If omitted, the field will be empty.

Anchor to EventsEvents

The number field component provides event callbacks for handling user interactions. Learn more about handling events.

Anchor to blur
blur
<typeof tagName>

A callback fired when the number field loses focus.

Learn more about the blur event.

Anchor to change
change
<typeof tagName>

A callback fired when the number field value changes.

Learn more about the change event.

Anchor to focus
focus
<typeof tagName>

A callback fired when the number field receives focus.

Learn more about the focus event.

Anchor to input
input
<typeof tagName>

A callback fired when the user inputs data into the number field.

Learn more about the input event.

Anchor to SlotsSlots

The number field component supports slots for additional content placement within the component. Learn more about using slots.

Anchor to accessory
accessory
HTMLElement

Additional interactive content displayed within the field. Accepts button and clickable components with text content only. Other component types or complex layouts are not supported.

Anchor to ExamplesExamples

Anchor to Adjust a quantity with stepper controlsAdjust a quantity with stepper controls

Add a numeric input with stepper controls for easy quantity adjustment. This example shows a number field with controls, min, max, and a defaultValue.

Adjust a quantity with stepper controls

A numeric input field with a label for entering quantity or amount values.

html

<s-number-field
label="Quantity"
controls="stepper"
defaultValue="1"
step="1"
min="1"
max="100"
></s-number-field>

Anchor to Add a prefix and suffixAdd a prefix and suffix

Add labels before and after the input value for units or symbols. This example shows a number field with a prefix for an approximation symbol and a suffix for a weight unit.

html

<s-number-field label="Weight" prefix="~" suffix="kg" defaultValue="2" step="0.1" min="0"></s-number-field>

Anchor to Show a range validation errorShow a range validation error

Display an error message when the value exceeds the allowed range. This example uses a number field with min, max, and an error message.

html

<s-number-field label="Quantity" min="1" max="10" step="1" defaultValue="1" error="Maximum 10 items per order"></s-number-field>

Anchor to Best practicesBest practices

  • Use stepper controls: Set controls to stepper for fields where customers adjust values incrementally, such as quantities.
  • Label units clearly: Use prefix or suffix to indicate units like "kg" or "cm" so customers know what they're entering.
  • Set reasonable ranges: Use min and max to prevent values outside the acceptable range and provide clear error messages.
  • Match step to precision: Set the step value to match the expected precision, such as 0.1 for decimal weights or 1 for whole quantities.
Was this page helpful?