SNumberField <s-number-field>

A numeric input with optional minimum, maximum and step. SNumberField is the typed Vue 3 wrapper for Shopify's Polaris <s-number-field> web component.

import { SNumberField } from 'polaris-vue-elements'

Best practices

• Keep it to purely numeric values. Reach for it for things like quantities, measurements or percentages. If a value can include letters or symbols, such as a product code or phone number, use STextField instead.
• Show the unit. Use prefix or suffix to say what the number measures, so merchants aren't left guessing whether they're typing dollars, kilograms or a percentage.
• Set limits that match your business rules. Give min and max values that reflect what's actually allowed, which steers merchants toward valid entries before they submit the form.
• Validate and explain errors. Check every numeric entry, and when one fails, use error to say exactly what's wrong and how to fix it rather than showing a generic message.

<SNumberField label="Discount" suffix="%" :min="0" :max="100" />

See Shopify's best practices for <s-number-field> for the full guidance.

Example

Value: 1

<script setup>
import { ref } from 'vue'
import { SNumberField } from 'polaris-vue-elements'

const value = ref('1')
</script>

<template>
  <SNumberField label="Quantity" :min="0" :max="100" :step="1" v-model="value" />
  <p>Value: {{ value }}</p>
</template>

v-model

v-model on <SNumberField> binds to the value property and listens for the input DOM event.

<SNumberField v-model="value" />

is equivalent to:

<SNumberField :value="value" @input="value = $event.target.value" />

Props

Prop	Type	Description
autocomplete	"one-time-code" | "cc-number" | "cc-csc" | "on" | "off" | "shipping one-time-code" | "billing one-time-code" | "shipping cc-number" … (3 more)	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.
defaultValue	string	The default value for the field.
details	any	Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users.
disabled	boolean	Disables the field, disallowing any interaction.
error	any	Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.
id	string	A unique identifier for the element.
inputMode	"decimal" | "numeric"	The type of virtual keyboard to display on mobile devices. - decimal: Shows a numeric keyboard with a decimal point, suitable for prices or measurements. - numeric: Shows a numeric keyboard without a decimal point, suitable for whole numbers like quantities. Learn more about the inputmode attribute.
label	any	Content to use as the field label.
labelAccessibilityVisibility	"visible" | "exclusive"	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.
max	number	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 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.
min	number	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 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.
name	string	An identifier for the field that is unique within the nearest containing form.
placeholder	string	A short hint that describes the expected value of the field.
prefix	string	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.
readOnly	boolean	The field cannot be edited by the user. It is focusable will be announced by screen readers.
required	boolean	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.
step	number	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.
suffix	string	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.
value	string

Some type columns above are truncated for readability; the full union is available in the library's generated TypeScript types (src/lib/generated/types.ts).

Events

Event	Type
blur	FocusEvent
change	Event
focus	FocusEvent
input	Event

Listen for these with @blur-style listeners on <SNumberField>.

Slots

Slot	Description
details
error