NumberField

Data entry component. This page is the API reference, generated from the source code. Usage guidance and live examples are on the Chinese page.

HeadlessStylesVueReactWeb Components

Anatomy

Parts in bold are required.

data-scope="number-field": root · label · control · prefix · input · suffix · increment-trigger · decrement-trigger

API reference

Descriptions of individual props, events and slots are written in Chinese and appear on the Chinese page.

Artifacts

Layer	Value
Custom element	<xh-number-field>
Vue components	XhNumberFieldControl XhNumberFieldDecrementTrigger XhNumberFieldIncrementTrigger XhNumberFieldInput XhNumberFieldLabel XhNumberFieldPrefix XhNumberFieldRoot XhNumberFieldSuffix
Composable	useNumberField
State machine	numberFieldMachine
Skin	@xihan-ui/styles/number-field.css

Props

Prop	Type	Required
labelled	boolean
ariaLabel	string
value	string
defaultValue	string
min	number
max	number
step	number
largeStep	number
disabled	boolean
readOnly	boolean
required	boolean
invalid	boolean
name	string
placeholder	string
changeDelay	number
changeInterval	number
minChangeInterval	number
clampValueOnBlur	boolean
variant	ControlVariant
tone	Tone
size	Size
parse	(text: string) => number
format	(value: number) => string
onValueChange	(details: NumberFieldValueChangeDetails) => void

Events

Custom elements put the payload in detail; Vue emits an event of the same name.

Event	Payload
value-change	NumberFieldValueChangeDetails

Slots

Only slots with a payload are listed.

Vue component	Slot	Payload
XhNumberFieldRoot	default	NumberFieldRootSlotProps
XhNumberFieldRoot	label	—

React adapter props

Only the props each component declares itself: DOM attributes inherited from ComponentPropsWithRef are left out, and root props already listed in the Props table are not repeated. The Vue counterpart is the slot table above.

React component	Prop	Type	Required
XhNumberFieldRoot	label	ReactNode
XhNumberFieldRoot	children	SlotChildren<NumberFieldRootSlotProps>

State

The following names are internal to the state machine.

States: idle · spinning

Events: VALUE.SET · VALUE.STEP · VALUE.TO_MIN · VALUE.TO_MAX · INPUT.BLUR · PRESS.START · PRESS.END · after.changeInterval · FORM.RESET · TRIGGER.PRESS.START · TRIGGER.PRESS.END

Guards: canStep · canPressTrigger

connect API

getXxxProps() returns the host attributes of the matching part.

Member	Type
value	string
valueAsNumber	number
empty	boolean
disabled	boolean
readOnly	boolean
invalid	boolean
canIncrement	boolean
canDecrement	boolean
outOfRange	boolean
setValue	(next: string) => void
increment	() => void
decrement	() => void
getRootProps	() => T['element']
getLabelProps	() => T['label']
getControlProps	() => T['element']
getPrefixProps	() => T['element']
getInputProps	() => T['input']
getSuffixProps	() => T['element']
getIncrementTriggerProps	() => T['button']
getDecrementTriggerProps	() => T['button']

Accessibility

Keyboard

Specification: W3C APG. Each row is a stable behavior id that the conformance tests cover; the conditions and effects are described on the Chinese page.

Keys	Behavior
ArrowUp	number-field.kbd.increment
ArrowDown	number-field.kbd.decrement
PageUp	number-field.kbd.large-increment
PageDown	number-field.kbd.large-decrement
Home	number-field.kbd.min
End	number-field.kbd.max
Enter / Space	number-field.kbd.press

ARIA

These attributes are produced by connect.

Part	Attribute	Value
prefix	aria-hidden	'true'
input	aria-invalid	'true' | 'false'
input	aria-label	props.ariaLabel
input	aria-labelledby	id of the label part | undefined
input	aria-valuemax	props.max
input	aria-valuemin	props.min
input	aria-valuenow	undefined | decodeNumber(value, { parse: prop('parse'), format: p…
input	role	'spinbutton'
suffix	aria-hidden	'true'
increment-trigger	aria-hidden	'true'
decrement-trigger	aria-hidden	'true'

Style reference

Skin

@xihan-ui/styles/number-field.css is written against [data-scope="number-field"][data-part="root"] part selectors; the published build uses the mount class .xh-scope-number-field in place of data-scope (same specificity) and sits in the xihan.components layer. Put overrides in xihan.overrides; the part selectors work as usual.

Data attributes

Produced by connect; valueless attributes are omitted while their condition does not hold.

Part	Attribute	Value
root	data-disabled	'' (present only while the condition holds)
root	data-empty	'' (present only while the condition holds)
root	data-invalid	'' (present only while the condition holds)
root	data-out-of-range	'' (present only while the condition holds)
root	data-readonly	'' (present only while the condition holds)
root	data-size	props.size
root	data-tone	props.tone
root	data-variant	props.variant
label	data-disabled	'' (present only while the condition holds)
control	data-disabled	'' (present only while the condition holds)
control	data-invalid	'' (present only while the condition holds)
control	data-readonly	'' (present only while the condition holds)
control	data-variant	props.variant
control	data-xh-action-owner	''
control	data-xh-field-chrome	''
control	data-xh-field-size	props.size
prefix	data-disabled	'' (present only while the condition holds)
prefix	data-xh-field-affix	'prefix'
input	data-disabled	'' (present only while the condition holds)
input	data-invalid	'' (present only while the condition holds)
input	data-readonly	'' (present only while the condition holds)
input	data-xh-field-input	''
input	data-xh-field-layout	'single-line'
suffix	data-disabled	'' (present only while the condition holds)
suffix	data-xh-field-affix	'suffix'
increment-trigger	data-disabled	'' (present only while the condition holds)
increment-trigger	data-pressed	'' (present only while the condition holds)
increment-trigger	data-xh-action-control	''
increment-trigger	data-xh-action-display	'hover-focus'
increment-trigger	data-xh-action-profile	'field-inset'
increment-trigger	data-xh-action-size	props.size
increment-trigger	data-xh-action-variant	'ghost'
decrement-trigger	data-disabled	'' (present only while the condition holds)
decrement-trigger	data-pressed	'' (present only while the condition holds)
decrement-trigger	data-xh-action-control	''
decrement-trigger	data-xh-action-display	'hover-focus'
decrement-trigger	data-xh-action-profile	'field-inset'
decrement-trigger	data-xh-action-size	props.size
decrement-trigger	data-xh-action-variant	'ghost'

CSS variables

The public override slots, generated from what the standalone skin actually consumes.

Variable	Part	CSS property	State	Default from
--xh-number-field-affix-fg	prefix suffix	color	xh-field-affix	--xh-fg-muted
--xh-number-field-affix-fg-disabled	prefix suffix	color	disabled xh-field-affix	--xh-fg-disabled
--xh-number-field-affix-font-size	prefix suffix	font-size	xh-field-affix	--xh-_number-field-font-size
--xh-number-field-control-bg	control	background-color	xh-field-chrome	--xh-_field-variant-bg-rest
--xh-number-field-control-bg-disabled	control	background-color	disabled xh-field-chrome	--xh-_field-variant-bg-disabled
--xh-number-field-control-bg-hover	control	background-color	disabled hover invalid loading not(:focus-within) not([data-disabled]) not([data-invalid]) not([data-loading]) not([data-readonly]) readonly xh-field-chrome	--xh-_field-variant-bg-hover
--xh-number-field-control-bg-readonly	control	background-color	readonly xh-field-chrome	--xh-_field-variant-bg-read-only
--xh-number-field-control-border	control	border	xh-field-chrome	--xh-_field-variant-border-rest
--xh-number-field-control-border-focus	control	border-color box-shadow	disabled focus-within not([data-disabled]) xh-field-chrome	--xh-_field-variant-border-focus
--xh-number-field-control-border-hover	control	border-color	disabled hover invalid loading not(:focus-within) not([data-disabled]) not([data-invalid]) not([data-loading]) not([data-readonly]) readonly xh-field-chrome	--xh-_field-variant-border-hover
--xh-number-field-control-border-invalid	control	border-color	invalid xh-field-chrome	--xh-_field-variant-border-invalid
--xh-number-field-control-fg	control	color	xh-field-chrome	--xh-fg-default
--xh-number-field-control-gap	control	gap	xh-field-chrome	--xh-_number-field-gap
--xh-number-field-control-h	control	block-size min-block-size	has([data-xh-field-input][data-xh-field-layout='multi-tag']) has([data-xh-field-input][data-xh-field-layout='single-line']) has([data-xh-field-input][data-xh-field-layout='textarea']) xh-field-chrome xh-field-input xh-field-layout=multi-tag xh-field-layout=single-line xh-field-layout=textarea	--xh-_number-field-h
--xh-number-field-control-min-w	control root	min-inline-size	default xh-field-chrome	--xh-control-min-w
--xh-number-field-control-px	control	padding-inline	xh-field-chrome	0
--xh-number-field-control-radius	control	border-radius	xh-field-chrome	--xh-shape-control
--xh-number-field-control-shadow	control	box-shadow	xh-field-chrome	none
--xh-number-field-control-w	root	inline-size min-inline-size	default	--xh-control-w
--xh-number-field-gap	label root	gap margin-block-end	default	--xh-space-1
--xh-number-field-icon-size	control root	--xh-icon-size	default size=lg size=sm xh-field-chrome	--xh-_field-size-glyph-size --xh-glyph-size-lg --xh-glyph-size-md --xh-glyph-size-sm
--xh-number-field-input-align	control input	text-align	default	start
--xh-number-field-input-autofill-bg	control input	box-shadow	-webkit-autofill autofill xh-field-input	--xh-bg-canvas
--xh-number-field-input-autofill-fg	control input	-webkit-text-fill-color	-webkit-autofill autofill xh-field-input	--xh-fg-default
--xh-number-field-input-fg	control input	color	xh-field-input	--xh-fg-default
--xh-number-field-input-font-size	control input	font-size	xh-field-input	--xh-_number-field-font-size
--xh-number-field-input-px	control input	padding-inline	default	--xh-_number-field-px
--xh-number-field-input-w	control input	inline-size	default	5em
--xh-number-field-label-fg	label	color	default	--xh-fg-muted
--xh-number-field-label-fg-disabled	label	color	disabled	--xh-fg-muted
--xh-number-field-label-font-size	label	font-size	default	--xh-text-label-size
--xh-number-field-label-font-weight	label	font-weight	default	--xh-text-label-weight
--xh-number-field-label-gap	label	margin-block-end	default	--xh-space-2
--xh-number-field-placeholder-fg	control input	color	placeholder xh-field-input	--xh-fg-subtle
--xh-number-field-stepper-bg	control decrement-trigger increment-trigger	--xh-ink-surface background-color	@media (hover: hover) and (pointer: fine) disabled xh-ink-surface	--xh-bg-subtle
--xh-number-field-stepper-bg-hover	control decrement-trigger increment-trigger	background-color	@media (hover: hover) and (pointer: fine) disabled hover loading not([data-disabled]) not([data-loading])	--xh-bg-subtle-hover
--xh-number-field-stepper-inset	control decrement-trigger increment-trigger	block-size inset-block-end inset-block-start inset-inline-end padding-inline-end	@media (hover: hover) and (pointer: fine) has([data-part='increment-trigger'], [data-part='decrement-trigger'])	--xh-_number-field-stepper-inset
--xh-number-field-stepper-w	control decrement-trigger increment-trigger	inline-size padding-inline-end	@media (hover: hover) and (pointer: fine) has([data-part='increment-trigger'], [data-part='decrement-trigger'])	--xh-control-indicator-lg
--xh-number-field-trigger-bg-active	control decrement-trigger increment-trigger	background-color	@media (hover: hover) and (pointer: fine) disabled is(:active, [data-pressed]) loading not([data-disabled]) not([data-loading]) pressed	--xh-_action-variant-bg-pressed --xh-bg-subtle-active
--xh-number-field-trigger-fg	control decrement-trigger increment-trigger	color	default	--xh-fg-muted
--xh-number-field-trigger-fg-hover	control decrement-trigger increment-trigger	color	disabled hover loading not([data-disabled]) not([data-loading])	--xh-fg-default
--xh-number-field-trigger-font-size	control decrement-trigger increment-trigger	font-size	default	--xh-_number-field-trigger-font-size
--xh-number-field-trigger-radius	control decrement-trigger increment-trigger	border-radius	default	--xh-shape-inset
--xh-number-field-trigger-size	control decrement-trigger increment-trigger	block-size inline-size min-inline-size	default xh-action-profile=field-inset	--xh-_action-profile-visual-size