Interface TextInputArgs

The arguments for the TextInput constructor.

interface TextInputArgs {
    binding?: BindingBase;
    blurOnEnter?: boolean;
    blurOnEscape?: boolean;
    class?: string | string[];
    dom?: string | HTMLElement;
    enabled?: boolean;
    error?: boolean;
    height?: number;
    hidden?: boolean;
    id?: string;
    ignoreParent?: boolean;
    input?: HTMLInputElement;
    isRoot?: boolean;
    keyChange?: boolean;
    link?: { observer: Observer | Observer[]; path: string | string[] };
    onChange?: (value: any) => void;
    onClick?: () => void;
    onRemove?: () => void;
    onValidate?: (value: string) => boolean;
    parent?: Element;
    placeholder?: string;
    readOnly?: boolean;
    renderChanges?: boolean;
    style?: string;
    tabIndex?: number;
    value?: any;
    values?: any[];
    width?: number;
}

Hierarchy (View Summary)

Properties

binding? blurOnEnter? blurOnEscape? class? dom? enabled? error? height? hidden? id? ignoreParent? input? isRoot? keyChange? link? onChange? onClick? onRemove? onValidate? parent? placeholder? readOnly? renderChanges? style? tabIndex? value? values? width?

Properties

Optionalbinding

binding?: BindingBase

A binding to use with this Element.

OptionalblurOnEnter

blurOnEnter?: boolean

Sets whether pressing Enter will blur (unfocus) the field. Defaults to true.

OptionalblurOnEscape

blurOnEscape?: boolean

Sets whether pressing Escape will blur (unfocus) the field. Defaults to true.

Optionalclass

class?: string | string[]

The class attribute of this Element's HTMLElement.

Optionaldom

dom?: string | HTMLElement

The HTMLElement to create this Element with. If not provided this Element will create one.

Optionalenabled

enabled?: boolean

Sets whether it is possible to interact with this Element and its children.

Optionalerror

error?: boolean

Sets whether the Element is in an error state.

Optionalheight

height?: number

Sets the initial height of the Element.

Optionalhidden

hidden?: boolean

Sets whether this Element is hidden. Defaults to false.

Optionalid

id?: string

The id attribute of this Element's HTMLElement.

OptionalignoreParent

ignoreParent?: boolean

If true, this Element will ignore its parent's enabled value when determining whether this element is enabled. Defaults to false.

Optionalinput

input?: HTMLInputElement

The input element to associate this InputElement with. If not supplied one will be created instead.

OptionalisRoot

isRoot?: boolean

Sets whether this Element is at the root of the hierarchy.

OptionalkeyChange

keyChange?: boolean

Sets whether any key up event will cause a change event to be fired.

Optionallink

link?: { observer: Observer | Observer[]; path: string | string[] }

Links the observer attribute at the path location in the given observer to this Element.

OptionalonChange

onChange?: (value: any) => void

If provided and the Element is changeable, this function will be called each time the element value is changed.

OptionalonClick

onClick?: () => void

If provided and the Element is clickable, this function will be called each time the element is clicked.

OptionalonRemove

onRemove?: () => void

If provided and the Element is removable, this function will be called each time the element is removed.

OptionalonValidate

onValidate?: (value: string) => boolean

A function that validates the value that is entered into the input and returns true if it is valid or false otherwise. If false then the input will be set in an error state and the value will not propagate to the binding.

Optionalparent

parent?: Element

Sets the parent Element.

Optionalplaceholder

placeholder?: string

Sets the placeholder label that appears on the right of the input.

OptionalreadOnly

readOnly?: boolean

Whether this Element is read only or not. Defaults to false.

OptionalrenderChanges

renderChanges?: boolean

If true each input will flash on changes.

Optionalstyle

style?: string

Sets an initial value for Element.dom.style.

OptionaltabIndex

tabIndex?: number

Sets the tabIndex of the Element.

Optionalvalue

value?: any

Sets the value of the Element.

Optionalvalues

values?: any[]

Sets multiple values to the Element. It is up to the Element to determine how to display them.

Optionalwidth

width?: number

Sets the initial width of the Element.

Settings

Member Visibility

On This Page

Properties