• Public
  • Public/Protected
  • All

Interface ITextboxData

Extends the regular control data with additional properties for Textbox




Optional controlID

controlID: string

An id, unique to the session.

Optional cooldown

cooldown: number

In milliseconds, will be converted to a unix timestamp of when this cooldown expires.

Optional cost

cost: number

The spark cost of this textbox. A cost will force a submit 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 hasSubmit

hasSubmit: boolean

Whether the textbox has a submit button.

Optional kind

kind: string

The type of control.

Optional meta

meta: IMeta

The collection of Meta properties for this control.

Optional multiline

multiline: boolean

Whether the textbox supports multiple lines of text.

Optional placeholder

placeholder: string

The text hint inside the textbox.

Optional position

position: IGridPlacement[]

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

Optional submitText

submitText: string

The optional text to replace "Submit" on the submit button.

Generated using TypeDoc