Class: BlazeInput
ui/input.BlazeInput
Hierarchy
BlazeElement<HTMLDivElement>↳
BlazeInput
Constructors
constructor
• new BlazeInput(name, placeholder, size)
Create a BlazeInput.
Parameters
| Name | Type | Description |
|---|---|---|
name | string | The input's name attribute |
placeholder | string | The input's placeholder |
size | number | The input's font size in rem units |
Overrides
Defined in
src/ui/input.ts:28
Properties
element
• Readonly element: HTMLDivElement
Inherited from
Defined in
src/ui/element.ts:9
input
• Private input: HTMLInputElement
Defined in
src/ui/input.ts:13
keys
• Readonly keys: KeyboardHandler
Inherited from
Defined in
src/ui/element.ts:11
label
• Private label: BlazeText<HTMLParagraphElement>
Defined in
src/ui/input.ts:14
mouse
• Readonly mouse: MouseHandler
Inherited from
Defined in
src/ui/element.ts:10
name
• Private name: string
Defined in
src/ui/input.ts:7
onInput
• onInput: (value: string) => void
Type declaration
▸ (value): void
Callback that is fired whenever the input's value changes.
Parameters
| Name | Type |
|---|---|
value | string |
Returns
void
Defined in
src/ui/input.ts:19
placeholder
• Private placeholder: string
Defined in
src/ui/input.ts:8
size
• Private size: number
Defined in
src/ui/input.ts:9
touch
• Readonly touch: TouchHandler
Inherited from
Defined in
src/ui/element.ts:12
value
• Private value: string
Defined in
src/ui/input.ts:11
Methods
addLabel
▸ addLabel(label, aside?): void
Add a label above or to the side of the input.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
label | string | undefined | The label's text |
aside | boolean | false | Wether the label is above or to the side of the input |
Returns
void
Defined in
src/ui/input.ts:134
getName
▸ getName(): string
Gets the input's name attribute.
Returns
string
The input's name attribute
Defined in
src/ui/input.ts:86
getPlaceholder
▸ getPlaceholder(): string
Gets the input's placeholder attribute.
Returns
string
The input's placeholder attribute
Defined in
src/ui/input.ts:105
getSize
▸ getSize(): number
Gets the input's font size.
Returns
number
The input's font size in rem units
Defined in
src/ui/input.ts:124
getValue
▸ getValue(): string
Gets the input's current value.
Returns
string
The input's current value
Defined in
src/ui/input.ts:67
removeLabel
▸ removeLabel(): void
Remove the input's label.
Returns
void
Defined in
src/ui/input.ts:153
setName
▸ setName(name): void
Sets the input's name.
Parameters
| Name | Type | Description |
|---|---|---|
name | string | The input's new name attribute |
Returns
void
Defined in
src/ui/input.ts:76
setPlaceholder
▸ setPlaceholder(placeholder): void
Sets the input's placeholder.
Parameters
| Name | Type |
|---|---|
placeholder | string |
Returns
void
Defined in
src/ui/input.ts:95
setSize
▸ setSize(size): void
Sets the input's font size.
Parameters
| Name | Type | Description |
|---|---|---|
size | number | The input's font size in rem units |
Returns
void
Defined in
src/ui/input.ts:114
setValue
▸ setValue(value): void
Sets the input's value.
Parameters
| Name | Type | Description |
|---|---|---|
value | string | The input's new value |
Returns
void
Defined in
src/ui/input.ts:55