PCUI API Reference - v5.2.0
    Preparing search index...

    Interface TextAreaInputArgs

    The arguments for the TextAreaInput constructor.

    interface TextAreaInputArgs {
        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;
        resizable?: "both" | "none" | "horizontal" | "vertical";
        style?: string;
        tabIndex?: number;
        value?: any;
        values?: any[];
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    binding?: BindingBase

    A binding to use with this Element.

    blurOnEnter?: boolean

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

    blurOnEscape?: boolean

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

    class?: string | string[]

    The class attribute of this Element's HTMLElement.

    dom?: string | HTMLElement

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

    enabled?: boolean

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

    error?: boolean

    Sets whether the Element is in an error state.

    height?: number

    Sets the initial height of the Element.

    hidden?: boolean

    Sets whether this Element is hidden. Defaults to false.

    id?: string

    The id attribute of this Element's HTMLElement.

    ignoreParent?: boolean

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

    input?: HTMLInputElement

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

    isRoot?: boolean

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

    keyChange?: boolean

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

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

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

    onChange?: (value: any) => void

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

    onClick?: () => void

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

    onRemove?: () => void

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

    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.

    parent?: Element

    Sets the parent Element.

    placeholder?: string

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

    readOnly?: boolean

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

    renderChanges?: boolean

    If true each input will flash on changes.

    resizable?: "both" | "none" | "horizontal" | "vertical"

    Sets which directions the text area can be resized in. One of 'both', 'horizontal', 'vertical' or 'none'. Defaults to 'none'.

    style?: string

    Sets an initial value for Element.dom.style.

    tabIndex?: number

    Sets the tabIndex of the Element.

    value?: any

    Sets the value of the Element.

    values?: any[]

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

    width?: number

    Sets the initial width of the Element.

    Settings

    Member Visibility

    On This Page

    Properties