Flex

Layout 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="flex": root · split

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-flex>
Vue components	XhFlex XhFlexSplit
State machine	None: connect computes attributes from props directly
Skin	@xihan-ui/styles/flex.css

Props

Prop	Type	Required
align	FlexResponsive<FlexAlign>
gap	FlexResponsive<FlexGap>
inline	boolean
justify	FlexResponsive<FlexJustify>
orientation	FlexResponsive<Orientation>
wrap	boolean

Slots

Only slots with a payload are listed.

Vue component	Slot	Payload
XhFlex	default	—
XhFlex	split	—

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
XhFlex	split	ReactNode

connect API

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

Member	Type
getRootProps	() => T['element']
getSplitProps	() => 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
split	aria-hidden	'true'

Style reference

Skin

@xihan-ui/styles/flex.css is written against [data-scope="flex"][data-part="root"] part selectors; the published build uses the mount class .xh-scope-flex 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-align	align.base
root	data-align-lg	align.lg
root	data-align-md	align.md
root	data-align-sm	align.sm
root	data-align-xl	align.xl
root	data-gap	gap.base
root	data-gap-lg	gap.lg
root	data-gap-md	gap.md
root	data-gap-sm	gap.sm
root	data-gap-xl	gap.xl
root	data-inline	'' (present only while the condition holds)
root	data-justify	justify.base
root	data-justify-lg	justify.lg
root	data-justify-md	justify.md
root	data-justify-sm	justify.sm
root	data-justify-xl	justify.xl
root	data-orientation	orientation.base
root	data-orientation-lg	orientation.lg
root	data-orientation-md	orientation.md
root	data-orientation-sm	orientation.sm
root	data-orientation-xl	orientation.xl
root	data-wrap	'' (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-flex-gap	root	gap	@media (min-width: 1024px) @media (min-width: 1280px) @media (min-width: 640px) @media (min-width: 768px) default gap-lg=lg gap-lg=md gap-lg=sm gap-lg=xl gap-lg=xs gap-md=lg gap-md=md gap-md=sm gap-md=xl gap-md=xs gap-sm=lg gap-sm=md gap-sm=sm gap-sm=xl gap-sm=xs gap-xl=lg gap-xl=md gap-xl=sm gap-xl=xl gap-xl=xs gap=lg gap=md gap=sm gap=xl gap=xs	--xh-layout-gap-lg --xh-layout-gap-md --xh-layout-gap-sm --xh-layout-gap-xl --xh-layout-gap-xs --xh-space-0