Skip to main content

Interface: DurationDisplayProps

Component props for DurationDisplay.

Hierarchy​

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 | SubscribableSet<string>

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

Defined in​

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

options​

• Optional options: Partial<Readonly<DurationDisplayOptions>>

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 = ''

Defined in​

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

ref​

• Optional ref: NodeReference<any>

A reference to the display component.

Inherited from​

ComponentProps.ref

Defined in​

src/sdk/components/FSComponent.ts:125

value​

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

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

Defined in​

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