Class TextInput

A text input element for an HTML form.

Hierarchy

FormControl<"input", TextInputOptions>
- TextInput

Index

Constructors

Properties

control options?

Methods

addEventListener getElement getLabelText getValue setLabelText setValue

Constructors

constructor

new TextInput(options?: TextInputOptions): TextInput
Parameters
- Optionaloptions: TextInputOptions
Returns TextInput
Overrides FormControl<'input', TextInputOptions>.constructor

Properties

`Protected` `Readonly`control

control: HTMLInputElement

The form control element.

`Protected` `Optional` `Readonly`options

options?: TextInputOptions

Data options for this form input.

Methods

addEventListener

addEventListener<K extends keyof HTMLElementEventMap>(
type: K,
listener: () => void,
): void
Add an event listener to the control element.
Type Parameters
- K extends keyof HTMLElementEventMap
Parameters
- type: K
  The type of event listener
- listener: () => void
  A function to callback every time the event is raised
Returns void
Inherited from FormControl.addEventListener

getElement

getElement(): HTMLDivElement
Get the parent element to append onto the form.

Returns HTMLDivElement
The container <div> element

Inherited from FormControl.getElement

getLabelText

getLabelText(): string
Get the text of the associated label.

Returns string
The current text value

Inherited from FormControl.getLabelText

getValue

getValue(): string
Get the value of this input.

Returns string
The current value

setLabelText

setLabelText(text: string): void
Set the text of the associated label.
Parameters
- text: string
  The new text value
Returns void
Inherited from FormControl.setLabelText

setValue

setValue(value: string): void
Set the value of this input.
Parameters
- value: string
  The new value
Returns void