Interface IListBox

List Box

Hierarchy

IBase<IListBoxProps>
- IListBox

Index

Properties

el getValue props setOptions setValue

Methods

configureParent hide show

Properties

el

el: HTMLElement

The element.

getValue

getValue: (() => IDropdownItem[])

Type declaration

- (): IDropdownItem[]
- The selected listbox items.
  
  Returns IDropdownItem[]

props

props: IListBoxProps

The component properties

setOptions

setOptions: ((items) => void)

Type declaration

- (items): void
- Sets the options
  Parameters
  - items: IDropdownItem[]
  Returns void

setValue

setValue: ((value?) => void)

Type declaration

- (value?): void
- Sets the listbox value.
  Parameters
  - Optional value: string | string[] | IDropdownItem[]
  Returns void

Methods

configureParent

configureParent(): HTMLElement
Internal method to configure the parent element.

Returns HTMLElement
Inherited from IBase.configureParent
- Defined in node_modules/.pnpm/gd-bs@6.6.68/node_modules/gd-bs/src/components/types.d.ts:6

hide

hide(): void
Hides the component.

Returns void
Inherited from IBase.hide
- Defined in node_modules/.pnpm/gd-bs@6.6.68/node_modules/gd-bs/src/components/types.d.ts:12

show

show(): void
Shows the component.

Returns void
Inherited from IBase.show
- Defined in node_modules/.pnpm/gd-bs@6.6.68/node_modules/gd-bs/src/components/types.d.ts:18

Generated using TypeDoc