Sparkline new

Charts 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="sparkline": root · summary · band · reference-line · area-fill · line · bar · dot

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-sparkline>
Vue components	XhSparkline
Composable	useSparkline
State machine	sparklineMachine
Skin	@xihan-ui/styles/sparkline.css

Props

Prop	Type	Required
data	readonly (number | null | undefined)[] | readonly ChartRow[]
x	string
y	string
variant	SparklineVariant
curve	SparklineCurve
markers	SparklineMarkers
band	readonly [number, number]
reference	SparklineReference
tone	Tone
format	NumberFormatSpec | ((value: number) => string)
animated	boolean
locale	string
translations	Partial<SparklineTranslations>

State

Public state is written to data-state.

Part	Values
root	'error' | 'empty' | undefined

The following names are internal to the state machine.

States: idle

Events: RESIZE · METRICS · SCENE.FRAME

connect API

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

Member	Type
model	SparklineModel
scene	Scene
measured	boolean
empty	boolean
summary	string
getRootProps	() => T['element']
getSummaryProps	() => T['element']
getMarkProps	(mark: Mark) => 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
root	aria-describedby	id of the summary part
root	role	'img'

Style reference

Skin

@xihan-ui/styles/sparkline.css is written against [data-scope="sparkline"][data-part="root"] part selectors; the published build uses the mount class .xh-scope-sparkline 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-state	'error' | 'empty' | undefined
root	data-tone	props.tone
root	data-variant	props.variant

CSS variables

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

Variable	Part	CSS property	State	Default from
--xh-sparkline-accent-color	bar dot root	fill	default marker not([data-tone='neutral']) tone tone=neutral	--xh-_tone --xh-chart-categorical-1
--xh-sparkline-band-bg	band	fill	default	--xh-bg-subtle
--xh-sparkline-bar-max	root	--xh-_chart-metric-bar-max	default	--xh-chart-bar-max
--xh-sparkline-bar-radius	root	--xh-_chart-metric-radius	default	--xh-shape-inset
--xh-sparkline-color	area-fill bar line root	fill stroke	default not([data-tone='neutral']) tone tone=neutral	--xh-_tone --xh-chart-deemphasis
--xh-sparkline-height	root	block-size	default	--xh-text-body-line-h 1lh
--xh-sparkline-line-width	legend-swatch line root tooltip-swatch	--xh-_chart-dash background block-size stroke-width	@media (forced-colors: active) @media print default mark=line where([data-xh-chart-patterns]) xh-chart-pattern xh-chart-pattern=2 xh-chart-pattern=3 xh-chart-pattern=4 xh-chart-pattern=5 xh-chart-pattern=6 xh-chart-pattern=7 xh-chart-pattern=8 xh-chart-patterns	--xh-chart-line-width
--xh-sparkline-marker-size	legend-swatch root tooltip-swatch	background	@media (forced-colors: active) @media print where([data-xh-chart-patterns]) xh-chart-pattern xh-chart-pattern=1 xh-chart-pattern=2 xh-chart-pattern=3 xh-chart-pattern=4 xh-chart-pattern=5 xh-chart-pattern=6 xh-chart-pattern=7 xh-chart-pattern=8 xh-chart-patterns	--xh-chart-point-size
--xh-sparkline-reference-color	reference-line	stroke	default	--xh-chart-label
--xh-sparkline-width	root	inline-size	default	6rem