API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

interfaceTextInputOptions

@codexo/exojs / ui / stable

Options for TextInput.

props

methods

events

Import

import { TextInputOptions } from '@codexo/exojs'

Options for TextInput.

Properties12

What the field's confirm key should be labelled as.

filter?: (candidate: string) => boolean

Gate on the value an edit would produce. An edit whose resulting value is rejected does not happen at all - a refused paste is dropped whole.

height?: number

Visible height in pixels. Default 36.

What kind of content the field holds, so mobile keyboards can adapt.

maskChar?: string

When set, every grapheme of the value renders as this character; clipboard reads are refused.

maxLength?: number

Maximum value length in UTF-16 code units. Unlimited when absent.

multiline?: boolean

Whether newlines are accepted. Default false.

placeholder?: string

Hint shown while the field holds no text. Default ''.

readOnly?: boolean

When set, the field renders and takes focus but rejects every edit. Default false.

textStyle?: TextStyleOptionsConstruction-time options for a TextStyle. All properties are optional; defaults match the TextStyle constructor.

Text style overrides on top of the surface skin's.

value?: string

Initial value. Default ''.

width?: number

Visible width in pixels. Default 200.

Source