Field

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="field": root · label · control · description · error-text

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-field>
Vue components	XhFieldBoundary XhFieldControl XhFieldDescription XhFieldErrorText XhFieldLabel XhFieldRoot
Composable	useField
State machine	None: connect computes attributes from props directly
Skin	@xihan-ui/styles/field.css

Props

Prop	Type	Required
controlId	string
disabled	boolean
invalid	boolean
parts	FieldRenderedParts
readOnly	boolean
required	boolean

Slots

Only slots with a payload are listed.

Vue component	Slot	Payload
XhFieldControl	default	FieldControlSlotProps
XhFieldRoot	default	—
XhFieldRoot	label	—
XhFieldRoot	control	—
XhFieldRoot	description	—
XhFieldRoot	errorText	—

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
XhFieldBoundary	children	ReactNode
XhFieldControl	asChild	boolean
XhFieldControl	children	SlotChildren<FieldControlSlotProps>
XhFieldRoot	label	ReactNode
XhFieldRoot	control	ReactNode
XhFieldRoot	description	ReactNode
XhFieldRoot	errorText	ReactNode

connect API

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

Member	Type
invalid	boolean
required	boolean
disabled	boolean
readOnly	boolean
controlId	string
labelId	string
getRootProps	() => T['element']
getLabelProps	() => T['label']
getControlProps	() => T['element']
getDescriptionProps	() => T['element']
getErrorTextProps	() => T['element']

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.

No keyboard interaction: the component takes no focus, or focus behavior comes entirely from native elements.

ARIA

These attributes are produced by connect.

Part	Attribute	Value
control	aria-describedby	[ rendered?.description === false ? null : ids.descri…
control	aria-invalid	'true' | 'false'
control	aria-labelledby	undefined | id of the label part
control	aria-readonly	'true' | 'false'
control	aria-required	'true' | 'false'
error-text	aria-atomic	'true'
error-text	aria-live	'polite'
error-text	role	'status'

Style reference

Skin

@xihan-ui/styles/field.css is written against [data-scope="field"][data-part="root"] part selectors; the published build uses the mount class .xh-scope-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-invalid	'' (present only while the condition holds)
root	data-readonly	'' (present only while the condition holds)
root	data-required	'' (present only while the condition holds)
label	data-disabled	'' (present only while the condition holds)
label	data-invalid	'' (present only while the condition holds)
label	data-readonly	'' (present only while the condition holds)
label	data-required	'' (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	'outline'
control	data-xh-field-chrome	''
control	data-xh-field-size	'md'
description	data-disabled	'' (present only while the condition holds)

CSS variables

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

Variable	Part	CSS property	State	Default from
--xh-field-border-invalid	jumper	border-color	user-invalid	--xh-_field-variant-border-invalid
--xh-field-control-bg	control	background-color	xh-field-chrome	--xh-_field-variant-bg-rest
--xh-field-control-bg-disabled	control	background-color	disabled xh-field-chrome	--xh-_field-variant-bg-disabled
--xh-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-field-control-bg-readonly	control	background-color	readonly xh-field-chrome	--xh-_field-variant-bg-read-only
--xh-field-control-border	control	border	xh-field-chrome	--xh-_field-variant-border-rest
--xh-field-control-border-focus	control	border-color box-shadow	disabled focus-within not([data-disabled]) xh-field-chrome	--xh-_field-variant-border-focus
--xh-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-field-control-border-invalid	control	border-color	invalid xh-field-chrome	--xh-_field-variant-border-invalid
--xh-field-control-fg	control	color	xh-field-chrome	--xh-fg-default
--xh-field-control-font-size	control	font-size	default	--xh-text-body-size
--xh-field-control-h	control label root	block-size min-block-size padding-block	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']) layout=horizontal xh-field-chrome xh-field-input xh-field-layout=multi-tag xh-field-layout=single-line xh-field-layout=textarea	--xh-_field-size-control-height --xh-control-h-md
--xh-field-control-px	control	padding-inline	xh-field-chrome	--xh-_field-size-padding-inline
--xh-field-control-radius	control	border-radius	default	--xh-shape-control
--xh-field-control-shadow	control	box-shadow	xh-field-chrome	none
--xh-field-description-fg	description	color	default	--xh-fg-subtle
--xh-field-description-fg-disabled	description	color	disabled	--xh-fg-subtle
--xh-field-description-font-size	description	font-size	default	--xh-text-caption-size
--xh-field-error-fg	error-text	color	default	--xh-fg-danger
--xh-field-error-font-size	error-text root	block-size font-size margin-block-end padding-block-end	default has(> [data-scope='field'][data-part='error-text'][hidden]) not(:has(> [data-scope='field'][data-part='description']:not([hidden])	--xh-text-caption-size
--xh-field-gap	label root	gap margin-block-end	default	--xh-space-0
--xh-field-label-fg	label	color	default	--xh-fg-muted
--xh-field-label-fg-disabled	label	color	disabled	--xh-fg-muted
--xh-field-label-fg-invalid	label	color	invalid	--xh-fg-danger
--xh-field-label-font-size	label root	font-size padding-block	default layout=horizontal	--xh-text-label-size
--xh-field-label-font-weight	label	font-weight	default	--xh-text-label-weight
--xh-field-label-gap	root	column-gap	layout=horizontal	--xh-space-4
--xh-field-label-gap-block	label	margin-block-end	default	--xh-space-2
--xh-field-label-leading	label root	line-height padding-block	layout=horizontal	--xh-leading-normal
--xh-field-label-star	label	color	required	--xh-fg-danger