Interface: TimeDisplayProps
Component props for TimeDisplay.
Hierarchy
ComponentProps↳
TimeDisplayProps
Properties
children
• Optional children: DisplayChildren[]
The children of the display component.
Inherited from
ComponentProps.children
Defined in
src/sdk/components/FSComponent.ts:122
class
• Optional class: string | ToggleableClassNameRecord | SubscribableSet<string>
CSS class(es) to apply to the root of the component.
Defined in
src/garminsdk/components/common/TimeDisplay.tsx:46
format
• format: TimeDisplayFormat | Subscribable<TimeDisplayFormat>
The display format.
Defined in
src/garminsdk/components/common/TimeDisplay.tsx:26
hideSuffixWhenNaN
• Optional hideSuffixWhenNaN: boolean
Whether to hide the suffix when the displayed time is equal to NaN. Defaults to false.
Defined in
src/garminsdk/components/common/TimeDisplay.tsx:43
localOffset
• localOffset: number | Subscribable<number>
The local time offset, in milliseconds.
Defined in
src/garminsdk/components/common/TimeDisplay.tsx:29
padHour
• Optional padHour: boolean | Subscribable<boolean>
Whether to the pad the hour text with leading zeroes (up to two digits). Defaults to true.
Defined in
src/garminsdk/components/common/TimeDisplay.tsx:32
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
ComponentProps.ref
Defined in
src/sdk/components/FSComponent.ts:125
suffixFormatter
• Optional suffixFormatter: (format: TimeDisplayFormat, isAm: boolean) => string
A function which formats suffixes to append to the displayed time. If not defined, then the suffix will be
will be formatted as 'UTC' if the display format is TimeDisplayFormat.UTC, 'LCL' if the display format
is TimeDisplayFormat.Local24, and either 'AM' or 'PM' if the display format is
TimeDisplayFormat.Local12.
Type declaration
▸ (format, isAm): string
A function which formats suffixes to append to the displayed time. If not defined, then the suffix will be
will be formatted as 'UTC' if the display format is TimeDisplayFormat.UTC, 'LCL' if the display format
is TimeDisplayFormat.Local24, and either 'AM' or 'PM' if the display format is
TimeDisplayFormat.Local12.
Parameters
| Name | Type |
|---|---|
format | TimeDisplayFormat |
isAm | boolean |
Returns
string
Defined in
src/garminsdk/components/common/TimeDisplay.tsx:40
time
• time: number | Subscribable<number>
The time to display, as a UNIX timestamp in milliseconds.
Defined in
src/garminsdk/components/common/TimeDisplay.tsx:23