Class: BlazeDropdown
ui/dropdown.BlazeDropdown
Hierarchy
BlazeElement<HTMLDivElement>↳
BlazeDropdown
Constructors
constructor
• new BlazeDropdown(selected, options, size)
Create a BlazeDropdown.
Parameters
| Name | Type | Description |
|---|---|---|
selected | string | The initially selected option |
options | string[] | The options in the dropdown |
size | number | The dropdown's font size in rem units |
Overrides
Defined in
src/ui/dropdown.ts:27
Properties
element
• Readonly element: HTMLDivElement
Inherited from
Defined in
src/ui/element.ts:9
keys
• Readonly keys: KeyboardHandler
Inherited from
Defined in
src/ui/element.ts:11
label
• Private label: BlazeText<HTMLParagraphElement>
Defined in
src/ui/dropdown.ts:13
mouse
• Readonly mouse: MouseHandler
Inherited from
Defined in
src/ui/element.ts:10
onSelect
• onSelect: (selected: string) => void
Type declaration
▸ (selected): void
Callback that is called whenever the dropdown's selected option changes.
Parameters
| Name | Type |
|---|---|
selected | string |
Returns
void
Defined in
src/ui/dropdown.ts:18
options
• Private options: string[]
Defined in
src/ui/dropdown.ts:10
select
• Private select: HTMLSelectElement
Defined in
src/ui/dropdown.ts:12
selected
• Private selected: string
Defined in
src/ui/dropdown.ts:9
size
• Private size: number
Defined in
src/ui/dropdown.ts:7
touch
• Readonly touch: TouchHandler
Inherited from
Defined in
src/ui/element.ts:12
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/dropdown.ts:129
addOption
▸ addOption(option): void
Adds an option to the dropdown.
Parameters
| Name | Type | Description |
|---|---|---|
option | string | The option to add |
Returns
void
Defined in
src/ui/dropdown.ts:99
getOptions
▸ getOptions(): string[]
Gets the dropdown's options.
Returns
string[]
The dropdown's options
Defined in
src/ui/dropdown.ts:90
getSelected
▸ getSelected(): string
Gets the dropdown's currently selected option.
Returns
string
The dropdown's currently selected option
Defined in
src/ui/dropdown.ts:63
getSize
▸ getSize(): number
Gets the dropdown's font size.
Returns
number
The dropdown's font size in rem units
Defined in
src/ui/dropdown.ts:119
removeLabel
▸ removeLabel(): void
Remove the input's label.
Returns
void
Defined in
src/ui/dropdown.ts:148
setOptions
▸ setOptions(options): void
Sets the options in the dropdown.
Parameters
| Name | Type | Description |
|---|---|---|
options | string[] | The dropdown's new options |
Returns
void
Defined in
src/ui/dropdown.ts:72
setSelected
▸ setSelected(selected): void
Sets the dropdown's selected option.
Parameters
| Name | Type | Description |
|---|---|---|
selected | string | The dropdown's new selected option |
Returns
void
Defined in
src/ui/dropdown.ts:51
setSize
▸ setSize(size): void
Sets the dropdown's font size.
Parameters
| Name | Type | Description |
|---|---|---|
size | number | The dropdown's font size in rem units |
Returns
void
Defined in
src/ui/dropdown.ts:109