Toggle

General 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="toggle": root

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-toggle>
Vue components	XhToggle
Composable	useToggle
State machine	toggleMachine
Skin	@xihan-ui/styles/toggle.css

Props

Prop	Type	Required
pressed	boolean
defaultPressed	boolean
disabled	boolean
variant	ActionVariant
tone	Tone
size	Size
iconOnly	boolean
fullWidth	boolean
onPressedChange	(details: TogglePressedChangeDetails) => void

Events

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

Event	Payload
pressed-change	TogglePressedChangeDetails

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
XhToggle	children	ReactNode

State

Public state is written to data-state.

Part	Values
root	'on' | 'off'

The following names are internal to the state machine.

States: off · on

Events: TOGGLE · CONTROLLED.ON · CONTROLLED.OFF · PRESS.START · PRESS.END

Guards: isPressedControlled · canPress

connect API

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

Member	Type
pressed	boolean
setPressed	(next: boolean) => void
getRootProps	() => 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
Space / Enter	toggle.kbd.toggle
Space / Enter	toggle.kbd.press

ARIA

These attributes are produced by connect.

Part	Attribute	Value
root	aria-pressed	'true' | 'false'

Style reference

Skin

@xihan-ui/styles/toggle.css is written against [data-scope="toggle"][data-part="root"] part selectors; the published build uses the mount class .xh-scope-toggle 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-full-width	'' (present only while the condition holds)
root	data-icon-only	'' (present only while the condition holds)
root	data-pressed	'' (present only while the condition holds)
root	data-size	props.size
root	data-state	'on' | 'off'
root	data-tone	props.tone
root	data-variant	props.variant
root	data-xh-action-control	''
root	data-xh-action-display	'always'
root	data-xh-action-profile	'icon' | 'text'
root	data-xh-action-size	props.size
root	data-xh-action-variant	'solid' | 'ghost' | props.variant
root	data-xh-ink-surface	'' (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-toggle-bg	root	--xh-ink-surface background-color	default focus-visible xh-ink-surface	--xh-_action-variant-bg-focus-visible --xh-_action-variant-bg-rest
--xh-toggle-bg-active	root	background-color	disabled is(:active, [data-pressed]) loading not([data-disabled]) not([data-loading]) pressed	--xh-_action-variant-bg-pressed
--xh-toggle-bg-disabled	root	--xh-ink-surface background-color	disabled xh-ink-surface	--xh-_action-variant-bg-disabled
--xh-toggle-bg-hover	root	background-color	disabled hover loading not([data-disabled]) not([data-loading])	--xh-_action-variant-bg-hover
--xh-toggle-bg-on	root	--xh-ink-surface background-color	disabled focus-visible not([data-variant='solid']) state=on variant=solid xh-ink-surface	--xh-_tone
--xh-toggle-bg-on-active	root	background-color	disabled is(:active, [data-pressed]) loading not([data-disabled]) not([data-loading]) not([data-variant='solid']) pressed state=on variant=solid	--xh-_tone-active
--xh-toggle-bg-on-disabled	root	--xh-ink-surface background-color	disabled not([data-variant='solid']) state=on variant=solid xh-ink-surface	--xh-_action-variant-bg-rest --xh-_toggle-bg-on
--xh-toggle-bg-on-hover	root	background-color	disabled hover loading not([data-disabled]) not([data-loading]) not([data-variant='solid']) state=on variant=solid	--xh-_tone-hover
--xh-toggle-border	root	border border-color	default disabled focus-visible hover is(:active, [data-pressed]) loading not([data-disabled]) not([data-loading]) pressed	--xh-_action-variant-border-focus-visible --xh-_action-variant-border-hover --xh-_action-variant-border-pressed --xh-_action-variant-border-rest
--xh-toggle-border-disabled	root	border-color	disabled	--xh-_action-variant-border-disabled
--xh-toggle-border-on	root	border border-color	disabled focus-visible hover is(:active, [data-pressed]) loading not([data-disabled]) not([data-loading]) not([data-variant='solid']) pressed state=on variant=solid	--xh-_tone
--xh-toggle-fg	root	color	@media print default disabled focus-visible hover is(:active, [data-pressed]) loading not([data-disabled]) not([data-loading]) pressed state=on	--xh-_action-variant-fg-focus-visible --xh-_action-variant-fg-hover --xh-_action-variant-fg-pressed --xh-_action-variant-fg-rest --xh-fg-default
--xh-toggle-fg-disabled	root	color	disabled	--xh-_action-variant-fg-disabled
--xh-toggle-fg-on	root	color	disabled focus-visible hover is(:active, [data-pressed]) loading not([data-disabled]) not([data-loading]) not([data-variant='solid']) pressed state=on variant=solid	--xh-_tone-on
--xh-toggle-fg-on-disabled	root	color	disabled not([data-variant='solid']) state=on variant=solid	--xh-_action-variant-fg-rest --xh-_toggle-fg-on
--xh-toggle-font-size	root	font-size	default	--xh-_action-profile-font-size
--xh-toggle-font-weight	root	font-weight	default	--xh-text-label-weight
--xh-toggle-gap	root	gap	default	--xh-_action-profile-gap
--xh-toggle-h	root	block-size inline-size	default xh-action-profile=icon	--xh-_action-profile-visual-size
--xh-toggle-icon-size	* root	--xh-icon-size block-size inline-size	default	--xh-_action-profile-glyph-size
--xh-toggle-px	root	padding-inline	default	--xh-_action-profile-padding-inline
--xh-toggle-radius	root	border-radius	default	--xh-shape-control
--xh-toggle-shadow	root	box-shadow	disabled hover is(:active, [data-pressed]) loading not([data-disabled]) not([data-loading]) pressed state=on	--xh-_highlight-tone