kvision-material/io.kvision.material.select

Package-level declarations

Material web select components (filled, outlined, select option).

Types

open class MdFilledSelect(label: String? = null, quick: Boolean = false, disabled: Boolean = false, required: Boolean = false, errorText: String? = null, supportingText: String? = null, error: Boolean = false, menuPositioning: SelectMenuPositioning = SelectMenuPositioning.Popover, typeaheadDelay: Int = DEFAULT_TYPEAHEAD_DELAY, selectedIndex: Int = -1, name: String? = null, value: String? = null, validationMessage: String? = null, className: String? = null, init: MdFilledSelect.() -> Unit? = null) : MdSelect

Filled select type.

MdOutlinedSelect

open class MdOutlinedSelect(label: String? = null, quick: Boolean = false, disabled: Boolean = false, required: Boolean = false, errorText: String? = null, supportingText: String? = null, error: Boolean = false, menuPositioning: SelectMenuPositioning = SelectMenuPositioning.Popover, typeaheadDelay: Int = DEFAULT_TYPEAHEAD_DELAY, selectedIndex: Int = -1, name: String? = null, value: String? = null, validationMessage: String? = null, className: String? = null, init: MdOutlinedSelect.() -> Unit? = null) : MdSelect

Outlined select type.

MdSelect

open class MdSelect : MdFormInputWidget<String?> , MdListWidgetContainer<MdSelectOption>

Select menus display a list of choices on temporary surfaces and display the currently selected menu item above the menu.

MdSelectOption

open class MdSelectOption(value: String? = null, disabled: Boolean = false, selected: Boolean = false, typeaheadText: String? = null, className: String? = null, init: MdSelectOption.() -> Unit? = null) : MdItemWidget, HasHeadlineSlot, HasLeadingSlot, HasSupportingTextSlot, HasTrailingSlot

Select options are element that belongs to a select.

SelectMenuPositioning

enum SelectMenuPositioning : Enum<SelectMenuPositioning>

Functions

closed

fun <Error class: unknown class><MdSelect>.closed(block: (<Error class: unknown class>) -> Unit)

Fired when the select's menu has finished animations and closed.

closeMenu

fun <Error class: unknown class><MdSelectOption>.closeMenu(block: (CloseMenuEvent<MdSelectOption>) -> Unit)

Closes the encapsulating menu on closable interaction. CustomEvent.bubbles, CustomEvent.composed

closing

fun <Error class: unknown class><MdSelect>.closing(block: (<Error class: unknown class>) -> Unit)

Fired when the select's menu is about to close.

filledSelect

fun <Error class: unknown class>.filledSelect(label: String? = null, quick: Boolean = false, disabled: Boolean = false, required: Boolean = false, errorText: String? = null, supportingText: String? = null, error: Boolean = false, menuPositioning: SelectMenuPositioning = SelectMenuPositioning.Popover, typeaheadDelay: Int = DEFAULT_TYPEAHEAD_DELAY, selectedIndex: Int = -1, name: String? = null, value: String? = null, validationMessage: String? = null, className: String? = null, init: MdFilledSelect.() -> Unit? = null): <Error class: unknown class>

opened

fun <Error class: unknown class><MdSelect>.opened(block: (<Error class: unknown class>) -> Unit)

Fired when the select's menu has finished animations and opened.

opening

fun <Error class: unknown class><MdSelect>.opening(block: (<Error class: unknown class>) -> Unit)

Fired when the select's menu is about to open.

outlinedSelect

fun <Error class: unknown class>.outlinedSelect(label: String? = null, quick: Boolean = false, disabled: Boolean = false, required: Boolean = false, errorText: String? = null, supportingText: String? = null, error: Boolean = false, menuPositioning: SelectMenuPositioning = SelectMenuPositioning.Popover, typeaheadDelay: Int = DEFAULT_TYPEAHEAD_DELAY, selectedIndex: Int = -1, name: String? = null, value: String? = null, validationMessage: String? = null, className: String? = null, init: MdOutlinedSelect.() -> Unit? = null): <Error class: unknown class>

requestDeselection

fun <Error class: unknown class><MdSelectOption>.requestDeselection(block: (<Error class: unknown class>) -> Unit)

Requests the parent md-select to deselect this element when selected changed to false.

requestSelection

fun <Error class: unknown class><MdSelectOption>.requestSelection(block: (<Error class: unknown class>) -> Unit)

Requests the parent md-select to select this element (and deselect others if single-selection) when selected changed to true.

selectOption

fun MdSelect.selectOption(value: String? = null, disabled: Boolean = false, selected: Boolean = false, typeaheadText: String? = null, className: String? = null, init: MdSelectOption.() -> Unit? = null): <Error class: unknown class>