• Public
  • Public/Protected
  • All

Interface IButtonData

Extends the regular control data with additional properties for Buttons




Optional accentColor

accentColor: string

The progress bar & cooldown spinner color for the button.

Optional backgroundColor

backgroundColor: string

The background color of the button.

Optional borderColor

borderColor: string

The color of the border.

Optional controlID

controlID: string

An id, unique to the session.

Optional cooldown

cooldown: number

A unix timestamp of when this button's cooldown will expire.

Optional cost

cost: number

The spark cost of this button.

Optional disabled

disabled: boolean

Wether or not this control is disabled.

Optional etag

etag: ETag

etags are no longer used, you can always omit/ignore this

Optional focusColor

focusColor: string

The hover & Focus border color of the button.

Optional keyCode

keyCode: number

A JavaScript keycode which participants can use to activate this button.

Optional kind

kind: string

The type of control.

Optional meta

meta: IMeta

The collection of Meta properties for this control.

Optional position

position: IGridPlacement[]

A collection of grid placements controlling where the control is positioned on screen.

Optional progress

progress: number

The progress bar value of this button. 0 - 1.

Optional text

text: string

The text displayed on the button.

Optional textColor

textColor: string

The color of the text.

Optional textSize

textSize: string

The size of the text.

Optional tooltip

tooltip: string

The tooltip text displayed when the participant hovers over the button.

Generated using TypeDoc