Number field
The number field component captures numeric input with built-in number validation. Use it to collect quantities, prices, 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.
Supported targets
- customer-account.
footer. render-after - customer-account.
order-index. announcement. render - customer-account.
order-index. block. render - customer-account.
order-status. announcement. render - customer-account.
order-status. block. render - customer-account.
order-status. cart-line-item. render-after - customer-account.
order-status. cart-line-list. render-after - customer-account.
order-status. customer-information. render-after - customer-account.
order-status. fulfillment-details. render-after - customer-account.
order-status. payment-details. render-after - customer-account.
order-status. return-details. render-after - customer-account.
order-status. unfulfilled-items. render-after - customer-account.
order. action. menu-item. render - customer-account.
order. action. render - customer-account.
order. page. render - customer-account.
page. render - customer-account.
profile. addresses. render-after - customer-account.
profile. announcement. render - customer-account.
profile. block. render - customer-account.
profile. company-details. render-after - customer-account.
profile. company-location-addresses. render-after - customer-account.
profile. company-location-payment. render-after - customer-account.
profile. company-location-staff. render-after - customer-account.
profile. payment. render-after
Supported targets
- customer-account.
footer. render-after - customer-account.
order-index. announcement. render - customer-account.
order-index. block. render - customer-account.
order-status. announcement. render - customer-account.
order-status. block. render - customer-account.
order-status. cart-line-item. render-after - customer-account.
order-status. cart-line-list. render-after - customer-account.
order-status. customer-information. render-after - customer-account.
order-status. fulfillment-details. render-after - customer-account.
order-status. payment-details. render-after - customer-account.
order-status. return-details. render-after - customer-account.
order-status. unfulfilled-items. render-after - customer-account.
order. action. menu-item. render - customer-account.
order. action. render - customer-account.
order. page. render - customer-account.
page. render - customer-account.
profile. addresses. render-after - customer-account.
profile. announcement. render - customer-account.
profile. block. render - customer-account.
profile. company-details. render-after - customer-account.
profile. company-location-addresses. render-after - customer-account.
profile. company-location-payment. render-after - customer-account.
profile. company-location-staff. render-after - customer-account.
profile. payment. render-after
Anchor to propertiesProperties
- Anchor to autocompleteautocompleteautocompleteAutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | "on" | "off"AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | "on" | "off"Default: 'on' for everything elseDefault: 'on' for everything else
A hint as to the intended content of the field.
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.
- Anchor to controlscontrolscontrols'auto' | 'stepper' | 'none''auto' | 'stepper' | 'none'Default: 'auto'Default: 'auto'
Sets the type of controls displayed in the field.
stepper: displays buttons to increase or decrease the value of the field by the stepping interval defined in thestepproperty. Appropriate mouse and keyboard interactions to control the value of the field 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.auto: the presence of the controls depends on the surface and context.
- Anchor to defaultValuedefaultValuedefaultValuestringstring
The default value for the field.
- Anchor to disableddisableddisabledbooleanbooleanDefault: falseDefault: false
Disables the field, disallowing any interaction.
- Anchor to errorerrorerrorstringstring
Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.
- Anchor to iconiconiconDefault: ''Default: ''
The type of icon to be displayed in the field.
- Anchor to idididstringstring
A unique identifier for the element.
- Anchor to inputModeinputModeinputMode'decimal' | 'numeric''decimal' | 'numeric'Default: 'decimal'Default: 'decimal'
Sets the virtual keyboard.
- Anchor to labellabellabelstringstring
Content to use as the field label.
- Anchor to labelAccessibilityVisibilitylabelAccessibilityVisibilitylabelAccessibilityVisibility'visible' | 'exclusive''visible' | 'exclusive'Default: 'visible'Default: 'visible'
Changes the visibility of the component's label.
visible: the label is visible to all users.exclusive: the label is visually hidden but remains in the accessibility tree.
- Anchor to maxmaxmaxnumbernumberDefault: InfinityDefault: Infinity
The highest decimal or integer to be accepted for the field. When used with
stepthe value will round down to the max number.Note: a user will still be able to use the keyboard to input a number higher than the max. It is up to the developer to add appropriate validation.
- Anchor to minminminnumbernumberDefault: -InfinityDefault: -Infinity
The lowest decimal or integer to be accepted for the field. When used with
stepthe value will round up to the min number.Note: a user will still be able to use the keyboard to input a number lower than the min. It is up to the developer to add appropriate validation.
- Anchor to namenamenamestringstring
An identifier for the field that is unique within the nearest containing form.
- Anchor to prefixprefixprefixstringstringDefault: ''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 cannot 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 readOnlyreadOnlyreadOnlybooleanbooleanDefault: falseDefault: false
The field cannot be edited by the user. It is focusable will be announced by screen readers.
- Anchor to requiredrequiredrequiredbooleanbooleanDefault: falseDefault: 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
errorproperty.- Anchor to stepstepstepnumbernumberDefault: 1Default: 1
The amount the value can increase or decrease by. This can be an integer or decimal. If a
maxorminis specified withstepwhen increasing/decreasing the value via the buttons, the final value will always round to themaxorminrather than the closest valid amount.- Anchor to suffixsuffixsuffixstringstringDefault: ''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 cannot 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 valuevaluevaluestringstring
The current value for the field. If omitted, the field will be empty.
AutocompleteSection
The “section” scopes the autocomplete data that should be inserted to a specific area of the page. Commonly used when there are multiple fields with the same autocomplete needs in the same page. For example: 2 shipping address forms in the same page.
`section-${string}`AutocompleteGroup
The contact information group the autocomplete data should be sourced from.
"shipping" | "billing"Anchor to eventsEvents
Learn more about registering events.
- Anchor to blurblurblurCallbackEventListener<typeof tagName>CallbackEventListener<typeof tagName>
Callback when the element loses focus.
- Anchor to changechangechangeCallbackEventListener<typeof tagName>CallbackEventListener<typeof tagName>
Callback when the user has finished editing a field, e.g. once they have blurred the field.
- Anchor to focusfocusfocusCallbackEventListener<typeof tagName>CallbackEventListener<typeof tagName>
Callback when the element receives focus.
- Anchor to inputinputinputCallbackEventListener<typeof tagName>CallbackEventListener<typeof tagName>
Callback when the user makes any changes in the field.
CallbackEventListener
(EventListener & {
(event: CallbackEvent<TTagName, Event> & TData): void;
}) | nullCallbackEvent
TEvent & {
currentTarget: HTMLElementTagNameMap[TTagName];
}Anchor to slotsSlots
Learn more about component slots.
- Anchor to accessoryaccessoryaccessoryHTMLElementHTMLElement
Additional content to be displayed in the field. Commonly used to display an icon that activates a tooltip providing more information.
Preview

Examples
Code
Default
<s-number-field label="Quantity" controls="stepper" defaultValue="1" step={1} min={0} max={100} ></s-number-field>