Class: TextInput

components~TextInput(formElementId, inputAttributesopt, optionsopt)

An input field conceived for the representation of the JSON Schema string type.

Constructor

new TextInput(formElementId, inputAttributesopt, optionsopt)

Parameters:
Name Type Attributes Default Description
formElementId string

The id of the form element.
inputAttributes object <optional>
 {}

The parameters to consider as attributes for the HTML <input> element.

Properties
Name Type Attributes Default Description
disabled boolean <optional>
 false

Flag indicating whether the input field should be disabled at initialization.
form string <optional>

The id of the <form> element with which the input control is associated.
maxlength number <optional>

The maximum string length allowed as input value.
minlength number <optional>

The minimum string length allowed as input value.
pattern RegExp <optional>

A regular expression which the input value should match.
placeholder string <optional>

Text appearing when the input field is empty.
options object <optional>
 {}

Parameters considered to generate the component.

Properties
Name Type Attributes Description
bootstrap string <optional>

If given, it indicates the Bootstrap version which the component should be built for.
Implements:
Source:

Members

domElement :HTMLDivElement

Reference to the DOM object that contains the HTML structure of the component.

Type:
  • HTMLDivElement
Inherited From:
Implements:
Source:

input :HTMLInputElement

Reference to the DOM object representing the <input> element.

Type:
  • HTMLInputElement
Source:

Methods

disable()

Disables the component.

Inherited From:
Implements:
Source:

enable()

Enables the component.

Inherited From:
Implements:
Source:

getId() → {any}

Returns the id of the input control element.

Implements:
Source:
Returns:

The value taken by the component.

Type
any

getValue() → {any}

Returns the value assigned to the component.

Implements:
Source:
Returns:

The value taken by the component.

Type
any