Toolbar

Navigation 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="toolbar": root · group · item · separator · overflow-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-toolbar>
Vue components	XhToolbarGroup XhToolbarItem XhToolbarOverflowTrigger XhToolbarRoot XhToolbarSeparator
Composable	useToolbar
State machine	toolbarMachine
Skin	@xihan-ui/styles/toolbar.css

Props

Prop	Type	Required
orientation	Orientation
dir	Direction
loop	boolean
disabled	boolean
variant	ControlVariant
size	Size
translations	Partial<ToolbarTranslations>
itemIcons	Readonly<Record<string, IconRecord>>

Slots

Only slots with a payload are listed.

Vue component	Slot	Payload
XhToolbarRoot	default	ToolbarRootSlotProps

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
XhToolbarItem	value	string	Yes
XhToolbarItem	disabled	boolean
XhToolbarItem	iconOnly	boolean
XhToolbarItem	as	ElementType
XhToolbarRoot	children	SlotChildren<ToolbarRootSlotProps>

State

The following names are internal to the state machine.

States: idle

Events: ITEM.FOCUS · OVERFLOW_TRIGGER.FOCUS · TOOLBAR.BLUR · PRESS.START · PRESS.END · OVERFLOW.SELECT

Guards: canPress

connect API

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

Member	Type
focusedValue	string | null
orientation	Orientation
separatorOrientation	Orientation
disabled	boolean
overflowItems	readonly ToolbarOverflowItem[]
getRootProps	() => T['element']
getGroupProps	() => T['element']
getItemProps	(props: ToolbarItemProps) => T['element']
getSeparatorProps	() => T['element']
getOverflowTriggerProps	() => 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
Tab / Shift+Tab	toolbar.kbd.tab
ArrowRight / ArrowDown	toolbar.kbd.next
ArrowLeft / ArrowUp	toolbar.kbd.prev
Home	toolbar.kbd.first
End	toolbar.kbd.last
Enter / Space	toolbar.kbd.press
Enter / Space / ArrowDown / ArrowUp	toolbar.kbd.overflow-open
Escape	toolbar.kbd.overflow-close
both arrow keys of the cross axis	toolbar.kbd.cross-axis

ARIA

These attributes are produced by connect.

Part	Attribute	Value
root	aria-disabled	'true' | 'false'
root	aria-orientation	props.orientation
root	role	'toolbar'
group	role	'group'
item	aria-disabled	'true' | 'false'
separator	aria-orientation	'vertical' | 'horizontal'
separator	role	'separator'
overflow-trigger	aria-disabled	'true' | 'false'
overflow-trigger	aria-label	resolveTranslations(TOOLBAR_EN_US, prop('translations…

Style reference

Skin

@xihan-ui/styles/toolbar.css is written against [data-scope="toolbar"][data-part="root"] part selectors; the published build uses the mount class .xh-scope-toolbar 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-orientation	props.orientation
root	data-size	props.size
root	data-variant	props.variant
group	data-disabled	'' (present only while the condition holds)
group	data-orientation	props.orientation
item	data-disabled	'' (present only while the condition holds)
item	data-icon-only	'' (present only while the condition holds)
item	data-pressed	'' (present only while the condition holds)
item	data-xh-action-control	''
item	data-xh-action-display	'always'
item	data-xh-action-profile	'icon' | 'text'
item	data-xh-action-size	props.size
item	data-xh-action-variant	'ghost'
separator	data-orientation	'vertical' | 'horizontal'
overflow-trigger	data-disabled	'' (present only while the condition holds)
overflow-trigger	data-xh-action-control	''
overflow-trigger	data-xh-action-display	'always'
overflow-trigger	data-xh-action-profile	'icon'
overflow-trigger	data-xh-action-size	props.size
overflow-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-toolbar-bg	root	background	default	--xh-_toolbar-root-bg
--xh-toolbar-bg-disabled	root	background	disabled	--xh-_toolbar-root-bg-disabled
--xh-toolbar-border	root	border	default	--xh-_toolbar-root-border
--xh-toolbar-fg	root	color	default	--xh-fg-default
--xh-toolbar-gap	root	gap	default	--xh-_toolbar-gap
--xh-toolbar-group-gap	group	gap	default	--xh-space-0
--xh-toolbar-icon-size	root	--xh-icon-size	default size=lg size=sm	--xh-glyph-size-lg --xh-glyph-size-md --xh-glyph-size-sm
--xh-toolbar-item-bg	group item	--xh-ink-surface background-color	default not([aria-pressed='true']) xh-ink-surface	--xh-_action-variant-bg-rest --xh-bg-subtle
--xh-toolbar-item-bg-active	item	background-color	disabled is(:active, [data-pressed]) loading not([data-disabled]) not([data-loading]) pressed	--xh-_action-variant-bg-pressed
--xh-toolbar-item-bg-disabled	group item	--xh-ink-surface background-color	disabled not([aria-pressed='true']) xh-ink-surface	--xh-_action-variant-bg-disabled --xh-bg-subtle
--xh-toolbar-item-bg-hover	item	background-color	disabled hover loading not([data-disabled]) not([data-loading])	--xh-_action-variant-bg-hover
--xh-toolbar-item-bg-pressed	item	--xh-ink-surface background-color border border-color	default disabled focus-visible hover is(:active, [data-pressed]) loading not([data-disabled]) not([data-loading]) pressed xh-ink-surface	--xh-bg-brand
--xh-toolbar-item-bg-pressed-active	item	background-color	disabled is(:active, [data-pressed]) loading not([data-disabled]) not([data-loading]) pressed	--xh-bg-brand-active
--xh-toolbar-item-bg-pressed-disabled	item	--xh-ink-surface background-color	disabled xh-ink-surface	--xh-toolbar-item-bg-pressed
--xh-toolbar-item-bg-pressed-hover	item	background-color	disabled hover loading not([data-disabled]) not([data-loading])	--xh-bg-brand-hover
--xh-toolbar-item-fg	item	color	@media print default disabled hover is(:active, [data-pressed]) loading not([data-disabled]) not([data-loading]) pressed	--xh-_action-variant-fg-hover --xh-_action-variant-fg-pressed --xh-_action-variant-fg-rest --xh-fg-default
--xh-toolbar-item-fg-pressed	item	color	default disabled focus-visible hover is(:active, [data-pressed]) loading not([data-disabled]) not([data-loading]) pressed	--xh-fg-on-brand
--xh-toolbar-item-font-size	item	font-size	default	--xh-_action-profile-font-size
--xh-toolbar-item-font-weight	item	font-weight	default	--xh-text-label-weight
--xh-toolbar-item-gap	item	gap	default	--xh-_action-profile-gap
--xh-toolbar-item-h	item	block-size inline-size min-inline-size	default icon-only orientation=vertical xh-action-profile=icon	--xh-_action-profile-visual-size
--xh-toolbar-item-px	item	padding-inline	default	--xh-_action-profile-padding-inline
--xh-toolbar-item-radius	group item	border-end-end-radius border-end-start-radius border-radius border-start-end-radius border-start-start-radius	default first-of-type last-of-type not(:has(~ [data-scope='toolbar'][data-part='item']:not([hidden]) not([hidden]) orientation=horizontal orientation=vertical	--xh-_action-profile-radius --xh-shape-control
--xh-toolbar-px	root	padding-inline	default	--xh-_toolbar-root-p
--xh-toolbar-py	root	padding-block	default	--xh-_toolbar-root-p
--xh-toolbar-radius	root	border-radius	default variant=outline	--xh-shape-surface
--xh-toolbar-separator-color	group separator	background	default	--xh-border-default --xh-fg-default
--xh-toolbar-separator-gap	separator	margin-block margin-inline	orientation=horizontal orientation=vertical	--xh-space-3
--xh-toolbar-separator-inset	separator	margin-block margin-inline	orientation=horizontal orientation=vertical	--xh-space-0
--xh-toolbar-separator-opacity	group separator	opacity	default	--xh-control-separator-opacity
--xh-toolbar-separator-radius	separator	border-radius	default	--xh-shape-pill
--xh-toolbar-separator-thickness	group separator	block-size inline-size margin-block margin-inline	orientation=horizontal orientation=vertical	--xh-stroke-thin
--xh-toolbar-shadow	root	box-shadow	variant=outline	none