API Reference

TimeStringProps

interface

Full props for the TimeString component.

Renders as <span> by default. Use the render prop to override.

Prop Type Default Description

render ReactElement | ((props: HTMLProps<span>, state: TimeStringState) => ReactElement) — Custom render function or element. Receives HTML props for <span> and component state.

locales string | string[] — BCP 47 locale(s) for time formatting. Falls back to the Root locale.

options Intl.DateTimeFormatOptions — Intl.DateTimeFormat options for customizing the output.

Prop	Type	Default	Description
render	ReactElement \| ((props: HTMLProps<span>, state: TimeStringState) => ReactElement)	—	Custom render function or element. Receives HTML props for <span> and component state.
locales	string \| string[]	—	BCP 47 locale(s) for time formatting. Falls back to the Root `locale`.
options	Intl.DateTimeFormatOptions	—	`Intl.DateTimeFormat` options for customizing the output.