Skip to content

TextInputOptions

Defined in: ui/widgets/text-input.ts:16

optional backgroundColor?: Color

Defined in: ui/widgets/text-input.ts:42


optional color?: Color

Defined in: ui/widgets/text-input.ts:41

Text / background / placeholder color overrides (theme roles otherwise).


optional disabled?: boolean

Defined in: ui/widgets/text-input.ts:45


events: EntityEventQueue

Defined in: ui/widgets/text-input.ts:18


optional fontFamily?: string

Defined in: ui/widgets/text-input.ts:27


optional fontSize?: number

Defined in: ui/widgets/text-input.ts:29

Default: the theme’s label size.


optional maxLength?: number

Defined in: ui/widgets/text-input.ts:31

0 = unlimited.


optional multiline?: boolean

Defined in: ui/widgets/text-input.ts:33


optional node?: UINodeInit

Defined in: ui/widgets/text-input.ts:21

CSS-box layout. Default: 220×32.


optional onChange?: (value, entity) => void

Defined in: ui/widgets/text-input.ts:49

Fires on every edit.

string

number

void


optional onSubmit?: (value, entity) => void

Defined in: ui/widgets/text-input.ts:51

Fires on Enter (single-line).

string

number

void


optional padding?: number

Defined in: ui/widgets/text-input.ts:36

Inner horizontal padding in px. Default 6.


optional parent?: number

Defined in: ui/widgets/text-input.ts:19


optional password?: boolean

Defined in: ui/widgets/text-input.ts:32


optional placeholder?: string

Defined in: ui/widgets/text-input.ts:24


optional placeholderColor?: Color

Defined in: ui/widgets/text-input.ts:43


optional placeholderI18nKey?: string

Defined in: ui/widgets/text-input.ts:26

Catalog key for the empty-field hint; requires a Localization resource.


optional readOnly?: boolean

Defined in: ui/widgets/text-input.ts:34


optional renderMode?: TextRenderMode

Defined in: ui/widgets/text-input.ts:38

Glyph pipeline for the field text. Default Auto (bitmap unscaled, SDF scaled).


optional tabIndex?: number

Defined in: ui/widgets/text-input.ts:46


optional value?: string

Defined in: ui/widgets/text-input.ts:23


world: World

Defined in: ui/widgets/text-input.ts:17