API reference

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

interfaceTextAreaOptions

@codexo/exojs / ui / stable

Options for TextArea.

props

methods

events

Import

import { TextAreaOptions } from '@codexo/exojs'

Options for TextArea.

Properties11

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.

maxLength?: number

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

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.

scrollbar?: boolean

Whether a scrollbar appears along the right edge once the value is taller than the field. Default true.

scrollbarThickness?: number

Scrollbar width in pixels. Default 10.

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.

wrap?: boolean

Whether a line too long for the field breaks at a word boundary instead of scrolling horizontally. Default true.

Source