BooleanInput

Extends

• ControlInput<{ OPTIONS: BooleanInputOptions; } & ControlInputGenerics<boolean>>

Constructors

Constructor

new BooleanInput(options): BooleanInput;

Parameters

Parameter	Type
options	BooleanInputOptions

Returns

BooleanInput

Overrides

ControlInput<
  {
    OPTIONS: BooleanInputOptions;
  } & ControlInputGenerics<boolean>
>.constructor

Properties

Property	Modifier	Type	Inherited from
control	public	AbstractValueControl<boolean>	ControlInput.control
options	public	BooleanInputOptions & FormInputOptions<any>	ControlInput.options
value	public	boolean	ControlInput.value

Accessors

error

Get Signature

get error(): string;

Returns

string

Inherited from

ControlInput.error

---

label

Get Signature

get label(): string;

Returns

string

Inherited from

ControlInput.label

---

name

Get Signature

get name(): string;

Returns

string

Inherited from

ControlInput.name

---

placeholder

Get Signature

get placeholder(): string;

Returns

string

Inherited from

ControlInput.placeholder

---

valid

Get Signature

get valid(): boolean;

Returns

boolean

Inherited from

ControlInput.valid

---

visible

Get Signature

get visible(): boolean;

Returns

boolean

Inherited from

ControlInput.visible

Methods

dispose()

dispose(): void;

Returns

void

Inherited from

ControlInput.dispose

---

isValid()

isValid(): boolean;

Whether this field is valid. Hidden fields do not block the form.

Returns

boolean

Inherited from

ControlInput.isValid

---

remove()

remove(): void;

Returns

void

Inherited from

ControlInput.remove

---

renderControl()

renderControl(options): Element;

Parameters

Parameter	Type
options	FormInputRenderOptions

Returns

Element

Inherited from

ControlInput.renderControl

---

renderInputWidget()

renderInputWidget(options): Element;

Parameters

Parameter	Type
options	FormInputRenderOptions

Returns

Element

Overrides

ControlInput.renderInputWidget

---

setValue()

setValue(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

ControlInput.setValue

---

update()

update(options): void;

Parameters

Parameter	Type
options	Partial<Omit<T["OPTIONS"], "name" | "value">>

Returns

void

Inherited from

ControlInput.update

---

validate()

validate(): void;

Returns

void

Inherited from

ControlInput.validate