Skip to main content

Interface: DurationDisplayProps

Defined in: src/sdk/components/common/DurationDisplay.tsx:68

Component props for DurationDisplay.

Extends​

Properties​

children?​

optional children: DisplayChildren[]

Defined in: src/sdk/components/FSComponent.ts:122

The children of the display component.

Inherited from​

ComponentProps.children

class?​

optional class: string | SubscribableSet<string>

Defined in: src/sdk/components/common/DurationDisplay.tsx:85

CSS class(es) to add to the root of the icon component.

options?​

optional options: Partial<Readonly<DurationDisplayOptions>>

Defined in: src/sdk/components/common/DurationDisplay.tsx:82

Formatting options. Options not explicitly defined will be set to the following default values:

  • pad = 0
  • format = DurationDisplayFormat.hh_mm_ss
  • delim = DurationDisplayDelim.Colon
  • showUnits = false
  • useMinusSign = false
  • forceSign = false
  • nanString = ''

ref?​

optional ref: NodeReference<any>

Defined in: src/sdk/components/FSComponent.ts:125

A reference to the display component.

Inherited from​

ComponentProps.ref

value​

value: NumberUnitInterface<Duration, Unit<Duration>> | Subscribable<NumberUnitInterface<Duration, Unit<Duration>>>

Defined in: src/sdk/components/common/DurationDisplay.tsx:70

The duration to display, or a subscribable which provides it.