Skip to content
Estella

TextInputOptions

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

Properties

Section titled “Properties”

backgroundColor?

Section titled “backgroundColor?”

optional backgroundColor?: Color

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

color?

Section titled “color?”

optional color?: Color

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

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

disabled?

Section titled “disabled?”

optional disabled?: boolean

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

events

Section titled “events”

events: EntityEventQueue

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

fontFamily?

Section titled “fontFamily?”

optional fontFamily?: string

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

fontSize?

Section titled “fontSize?”

optional fontSize?: number

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

Default: the theme’s label size.

maxLength?

Section titled “maxLength?”

optional maxLength?: number

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

0 = unlimited.

multiline?

Section titled “multiline?”

optional multiline?: boolean

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

node?

Section titled “node?”

optional node?: UINodeInit

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

CSS-box layout. Default: 220×32.

onChange?

Section titled “onChange?”

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

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

Fires on every edit.

Parameters

Section titled “Parameters”
value
Section titled “value”

string

entity
Section titled “entity”

number

Returns

Section titled “Returns”

void

onSubmit?

Section titled “onSubmit?”

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

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

Fires on Enter (single-line).

Parameters

Section titled “Parameters”
value
Section titled “value”

string

entity
Section titled “entity”

number

Returns

Section titled “Returns”

void

padding?

Section titled “padding?”

optional padding?: number

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

Inner horizontal padding in px. Default 6.

parent?

Section titled “parent?”

optional parent?: number

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

password?

Section titled “password?”

optional password?: boolean

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

placeholder?

Section titled “placeholder?”

optional placeholder?: string

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

placeholderColor?

Section titled “placeholderColor?”

optional placeholderColor?: Color

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

readOnly?

Section titled “readOnly?”

optional readOnly?: boolean

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

renderMode?

Section titled “renderMode?”

optional renderMode?: TextRenderMode

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

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

tabIndex?

Section titled “tabIndex?”

optional tabIndex?: number

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

value?

Section titled “value?”

optional value?: string

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

world

Section titled “world”

world: World

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