kvision-material/io.kvision.material.menu/MdMenu

MdMenu

open class MdMenu(anchor: String? = null, positioning: MenuPositioning = MenuPositioning.Absolute, quick: Boolean = false, hasOverflow: Boolean = false, xOffset: Int = 0, yOffset: Int = 0, typeaheadDelay: Int = DEFAULT_TYPEAHEAD_DELAY, anchorCorner: Corner = Corner.EndStart, corner: Corner = Corner.StartStart, stayOpenOnOutsideClick: Boolean = false, stayOpenOnFocusout: Boolean = false, skipRestoreFocus: Boolean = false, defaultFocus: FocusState = FocusState.FirstItem, noNavigationWrap: Boolean = false, className: String? = null, init: MdMenu.() -> Unit? = null) : MdListContainer<MdMenuItem> (source)

Menus display a list of choices on a temporary surface.

See https://material-web.dev/components/menu/

Author

Maanrifa Bacar Ali

Constructors

MdMenu

constructor(anchor: String? = null, positioning: MenuPositioning = MenuPositioning.Absolute, quick: Boolean = false, hasOverflow: Boolean = false, xOffset: Int = 0, yOffset: Int = 0, typeaheadDelay: Int = DEFAULT_TYPEAHEAD_DELAY, anchorCorner: Corner = Corner.EndStart, corner: Corner = Corner.StartStart, stayOpenOnOutsideClick: Boolean = false, stayOpenOnFocusout: Boolean = false, skipRestoreFocus: Boolean = false, defaultFocus: FocusState = FocusState.FirstItem, noNavigationWrap: Boolean = false, className: String? = null, init: MdMenu.() -> Unit? = null)

Properties

_archivedState

var _archivedState: dynamic

alignContent

open var alignContent: AlignContent?

alignItems

open var alignItems: AlignItems?

alignSelf

open var alignSelf: AlignItems?

anchor

var anchor: String?

The ID of the element in the same root node in which the menu should align to. Overrides setting anchorElement = elementReference.

anchorCorner

var anchorCorner: Corner

The corner of the anchor which to align the menu in the standard logical property style of - e.g. 'end-start'.

background

open var background: Background?

border

open var border: Border?

borderBottom

open var borderBottom: Border?

borderLeft

open var borderLeft: Border?

borderRadius

open var borderRadius: CssSize?

borderRadiusList

open var borderRadiusList: List<CssSize>?

borderRight

open var borderRight: Border?

borderTop

open var borderTop: Border?

bottom

open var bottom: CssSize?

boxShadow

open var boxShadow: BoxShadow?

boxShadowList

open var boxShadowList: List<BoxShadow>?

clear

open var clear: Clear?

color

open var color: Color?

colorHex

open var colorHex: Int?

colorName

open var colorName: Col?

cursor

open var cursor: Cursor?

defaultFocus

var defaultFocus: FocusState

The element that should be focused by default once opened.

display

open var display: Display?

draggable

var draggable: Boolean?

eventTarget

var eventTarget: Widget?

flexBasis

open var flexBasis: CssSize?

flexDirection

open var flexDirection: FlexDirection?

flexGrow

open var flexGrow: Int?

flexShrink

open var flexShrink: Int?

flexWrap

open var flexWrap: FlexWrap?

float

open var float: PosFloat?

fontFamily

open var fontFamily: String?

fontSize

open var fontSize: CssSize?

fontStyle

open var fontStyle: FontStyle?

fontVariant

open var fontVariant: FontVariant?

fontWeight

open var fontWeight: FontWeight?

gridArea

open var gridArea: String?

gridAutoColumns

open var gridAutoColumns: String?

gridAutoFlow

open var gridAutoFlow: GridAutoFlow?

gridAutoRows

open var gridAutoRows: String?

gridColumnEnd

open var gridColumnEnd: String?

gridColumnGap

open var gridColumnGap: Int?

gridColumnStart

open var gridColumnStart: Int?

gridRowEnd

open var gridRowEnd: String?

gridRowGap

open var gridRowGap: Int?

gridRowStart

open var gridRowStart: Int?

gridTemplateAreas

open var gridTemplateAreas: List<String>?

gridTemplateColumns

open var gridTemplateColumns: String?

gridTemplateRows

open var gridTemplateRows: String?

hasOverflow

var hasOverflow: Boolean

Displays overflow content like a submenu. Not required in most cases when positioning is MenuPositioning.Popover.

height

open var height: CssSize?

var id: String?

items

val items: Array<MdMenuItem>

Gets the direct items in this list.

justifyContent

open var justifyContent: JustifyContent?

justifyItems

open var justifyItems: JustifyItems?

justifySelf

open var justifySelf: JustifyItems?

kvscope

var kvscope: dynamic

left

open var left: CssSize?

letterSpacing

open var letterSpacing: CssSize?

lineBreak

open var lineBreak: LineBreak?

lineHeight

open var lineHeight: CssSize?

listStyle

open var listStyle: ListStyle?

margin

open var margin: CssSize?

marginBottom

open var marginBottom: CssSize?

marginLeft

open var marginLeft: CssSize?

marginRight

open var marginRight: CssSize?

marginTop

open var marginTop: CssSize?

maxHeight

open var maxHeight: CssSize?

maxWidth

open var maxWidth: CssSize?

menuCorner

var menuCorner: Corner

The corner of the menu which to align the anchor in the standard logical property style of - e.g. 'start-start'.

minHeight

open var minHeight: CssSize?

minWidth

open var minWidth: CssSize?

noNavigationWrap

var noNavigationWrap: Boolean

Turns off navigation wrapping. By default, navigating past the end of the menu items will wrap focus back to the beginning and vice versa. Use this for ARIA patterns that do not wrap focus, like combobox.

opacity

open var opacity: Double?

open

val open: Boolean

Indicates that the menu is in an open state.

order

open var order: Int?

outline

open var outline: Outline?

overflow

open var overflow: Overflow?

overflowWrap

open var overflowWrap: OverflowWrap?

overflowX

open var overflowX: Overflow?

overflowY

open var overflowY: Overflow?

padding

open var padding: CssSize?

paddingBottom

open var paddingBottom: CssSize?

paddingLeft

open var paddingLeft: CssSize?

paddingRight

open var paddingRight: CssSize?

paddingTop

open var paddingTop: CssSize?

parent

open override var parent: Container?

popoverHooksActive

var popoverHooksActive: Boolean

popoverOptions

var popoverOptions: dynamic

position

open var position: Position?

positioning

var positioning: MenuPositioning

Whether the positioning algorithim should calculate relative to the parent of the anchor element (absolute) or relative to the window (fixed).

quick

var quick: Boolean

Skips the opening and closing animations.

resize

open var resize: Resize?

right

open var right: CssSize?

role

var role: String?

skipRestoreFocus

var skipRestoreFocus: Boolean

After closing, does not restore focus to the last focused element before the menu was opened.

stayOpenOnFocusout

var stayOpenOnFocusout: Boolean

Keeps the menu open when focus leaves the menu's composed subtree.

stayOpenOnOutsideClick

var stayOpenOnOutsideClick: Boolean

Keeps the user clicks outside the menu.

tabindex

var tabindex: Int?

textAlign

open var textAlign: TextAlign?

textDecoration

open var textDecoration: TextDecoration?

textDirection

open var textDirection: Direction?

textIndent

open var textIndent: CssSize?

textOverflow

open var textOverflow: TextOverflow?

textShadow

open var textShadow: TextShadow?

textTransform

open var textTransform: TextTransform?

title

var title: String?

tooltipHooksActive

var tooltipHooksActive: Boolean

tooltipOptions

var tooltipOptions: dynamic

top

open var top: CssSize?

transition

open var transition: Transition?

transitionList

open var transitionList: List<Transition>?

typeaheadDelay

var typeaheadDelay: Int

The max time between the keystrokes of the typeahead menu behavior before it clears the typeahead buffer.

unicodeBidi

open var unicodeBidi: UnicodeBidi?

verticalAlign

open var verticalAlign: VerticalAlign?

visible

open override var visible: Boolean

whiteSpace

open var whiteSpace: WhiteSpace?

width

open var width: CssSize?

wordBreak

open var wordBreak: WordBreak?

wordSpacing

open var wordSpacing: CssSize?

xOffset

var xOffset: Int

Offsets the menu's inline alignment from the anchor by the given number in pixels. This value is direction aware and will follow the LTR / RTL direction.

yOffset

var yOffset: Int

Offsets the menu's block alignment from the anchor by the given number in pixels.

zIndex

open var zIndex: Int?

Functions

activateNextItem

fun activateNextItem(): MdMenuItem?

Activates the next item in the list. If at the end of the list, the first item will be activated.

activatePreviousItem

fun activatePreviousItem(): MdMenuItem?

Activates the previous item in the list. If at the start of the list, the last item will be activated.

add

open override fun add(child: Component)

open override fun add(position: Int, child: Component)

addAfterCreateHook

open override fun addAfterCreateHook(hook: (VNode) -> Unit): Boolean

addAfterDestroyHook

open override fun addAfterDestroyHook(hook: () -> Unit): Boolean

addAfterInsertHook

open override fun addAfterInsertHook(hook: (VNode) -> Unit): Boolean

addAll

open override fun addAll(children: List<Component>)

addBeforeDisposeHook

open override fun addBeforeDisposeHook(hook: () -> Unit): Boolean

addCssClass

open override fun addCssClass(css: String)

addCssStyle

open override fun addCssStyle(css: Style)

addSurroundingCssClass

open override fun addSurroundingCssClass(css: String)

addSurroundingCssStyle

open override fun addSurroundingCssStyle(css: Style)

blur

open fun blur()

brandedFab

fun Container.brandedFab(label: String? = null, size: FabSize = FabSize.Medium, lowered: Boolean = false, touchTarget: TouchTarget? = null, className: String? = null, init: MdBrandedFab.() -> Unit? = null): MdBrandedFab

checkbox

fun Container.checkbox(checked: Boolean = false, disabled: Boolean = false, indeterminate: Boolean = false, required: Boolean = false, value: String = "on", name: String? = null, touchTarget: TouchTarget? = TouchTarget.Wrapper, validationMessage: String? = null, className: String? = null, init: MdCheckbox.() -> Unit? = null): MdCheckbox

chipSet

fun Container.chipSet(className: String? = null, init: MdChipSet.() -> Unit? = null): MdChipSet

circularProgress

fun Container.circularProgress(value: Number = 0, max: Number = 1, indeterminate: Boolean = false, fourColor: Boolean = false, className: String? = null, init: MdCircularProgress.() -> Unit? = null): MdCircularProgress

clearAfterCreateHooks

open override fun clearAfterCreateHooks()

clearAfterDestroyHooks

open override fun clearAfterDestroyHooks()

clearAfterInsertHooks

open override fun clearAfterInsertHooks()

clearBeforeDisposeHooks

open override fun clearBeforeDisposeHooks()

clearDragDropData

open fun clearDragDropData()

clearParent

open override fun clearParent()

fun close()

Closes the menu.

dialog

fun Container.dialog(returnValue: String? = null, type: DialogType? = null, className: String? = null, init: MdDialog.() -> Unit? = null): MdDialog

dispatchEvent

open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?

dispose

open override fun dispose()

disposeAll

open override fun disposeAll()

divider

fun Container.divider(inset: Boolean = false, insetStart: Boolean = false, insetEnd: Boolean = false, className: String? = null, init: MdDivider.() -> Unit? = null): MdDivider

elevatedButton

fun Container.elevatedButton(text: String? = null, disabled: Boolean = false, href: String? = null, target: LinkTarget? = null, trailingIcon: Boolean = false, type: ButtonType = ButtonType.Submit, value: String? = null, name: String? = null, className: String? = null, init: MdElevatedButton.() -> Unit? = null): MdElevatedButton

fab

fun Container.fab(label: String? = null, variant: FabVariant = FabVariant.Surface, size: FabSize = FabSize.Medium, lowered: Boolean = false, touchTarget: TouchTarget? = null, className: String? = null, init: MdFab.() -> Unit? = null): MdFab

filledButton

fun Container.filledButton(text: String? = null, disabled: Boolean = false, href: String? = null, target: LinkTarget? = null, trailingIcon: Boolean = false, type: ButtonType = ButtonType.Submit, value: String? = null, name: String? = null, className: String? = null, init: MdFilledButton.() -> Unit? = null): MdFilledButton

filledIconButton

fun Container.filledIconButton(disabled: Boolean = false, flipIconInRtl: Boolean = false, href: String? = null, target: LinkTarget? = null, ariaLabelSelected: String? = null, toggle: Boolean = false, selected: Boolean = false, type: IconButtonType = IconButtonType.Submit, value: String? = null, name: String? = null, className: String? = null, init: MdFilledIconButton.() -> Unit? = null): MdFilledIconButton

filledSelect

fun Container.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): MdFilledSelect

filledTextField

fun Container.filledTextField(disabled: Boolean = false, error: Boolean = false, errorText: String? = null, label: String? = null, required: Boolean = false, value: String? = null, prefixText: String? = null, suffixText: String? = null, supportingText: String? = null, rows: Int = 2, cols: Int = 20, inputMode: TextFieldInputMode? = null, max: TextFieldRangeConstraint? = null, maxLength: Int = -1, min: TextFieldRangeConstraint? = null, minLength: Int = -1, pattern: String? = null, placeholder: String? = null, readOnly: Boolean = false, multiple: Boolean = false, step: Number? = null, type: TextFieldInputType = TextFieldInputType.Text, autoComplete: Autocomplete? = null, name: String? = null, validationMessage: String? = null, className: String? = null, init: MdFilledTextField.() -> Unit? = null): MdFilledTextField

filledTonalButton

fun Container.filledTonalButton(text: String? = null, disabled: Boolean = false, href: String? = null, target: LinkTarget? = null, trailingIcon: Boolean = false, type: ButtonType = ButtonType.Submit, value: String? = null, name: String? = null, className: String? = null, init: MdFilledTonalButton.() -> Unit? = null): MdFilledTonalButton

filledTonalIconButton

fun Container.filledTonalIconButton(disabled: Boolean = false, flipIconInRtl: Boolean = false, href: String? = null, target: LinkTarget? = null, ariaLabelSelected: String? = null, toggle: Boolean = false, selected: Boolean = false, type: IconButtonType = IconButtonType.Submit, value: String? = null, name: String? = null, className: String? = null, init: MdFilledTonalIconButton.() -> Unit? = null): MdFilledTonalIconButton

focus

open fun focus()

getAttribute

open override fun getAttribute(name: String): String?

getChildren

open override fun getChildren(): List<Component>

getElement

open override fun getElement(): HTMLElement?

getElementD

open override fun getElementD(): dynamic

getRoot

open override fun getRoot(): Root?

getSnStyle

open fun getSnStyle(): dynamic

getStyle

fun getStyle(name: String): String?

hasCssClass

open override fun hasCssClass(css: String): Boolean

hide

open fun hide()

icon

fun Container.icon(name: String, className: String? = null, init: MdIcon.() -> Unit? = null): MdIcon

iconButton

fun Container.iconButton(disabled: Boolean = false, flipIconInRtl: Boolean = false, href: String? = null, target: LinkTarget? = null, ariaLabelSelected: String? = null, toggle: Boolean = false, selected: Boolean = false, type: IconButtonType = IconButtonType.Submit, value: String? = null, name: String? = null, className: String? = null, init: MdIconButton.() -> Unit? = null): MdIconButton

invoke

open operator fun invoke(vararg children: Component)

linearProgress

fun Container.linearProgress(buffer: Number = 1, value: Number = 0, max: Number = 1, indeterminate: Boolean = false, fourColor: Boolean = false, className: String? = null, init: MdLinearProgress.() -> Unit? = null): MdLinearProgress

list

fun Container.list(className: String? = null, init: MdList.() -> Unit? = null): MdList

listItem

fun Container.listItem(text: String? = null, type: ListItemType = ListItemType.Text, disabled: Boolean = false, href: String? = null, target: LinkTarget? = null, className: String? = null, init: MdListItem.() -> Unit? = null): MdListItem

fun Container.menu(anchor: String? = null, positioning: MenuPositioning = MenuPositioning.Absolute, quick: Boolean = false, hasOverflow: Boolean = false, xOffset: Int = 0, yOffset: Int = 0, typeaheadDelay: Int = DEFAULT_TYPEAHEAD_DELAY, anchorCorner: Corner = Corner.EndStart, corner: Corner = Corner.StartStart, stayOpenOnOutsideClick: Boolean = false, stayOpenOnFocusout: Boolean = false, skipRestoreFocus: Boolean = false, defaultFocus: FocusState = FocusState.FirstItem, noNavigationWrap: Boolean = false, className: String? = null, init: MdMenu.() -> Unit? = null): MdMenu

menuAnchor

fun <W : Widget> Container.menuAnchor(anchor: W, position: Position = Position.RELATIVE, initMenu: SimplePanel.() -> MdMenu): MenuAnchor<W>

Factory for obtaining an instance of MenuAnchor. The returned component is added to this Container.

menuItem

fun MdMenu.menuItem(disabled: Boolean = false, type: MenuItemType = MenuItemType.MenuItem, href: String? = null, target: LinkTarget? = null, keepOpen: Boolean = false, selected: Boolean = false, typeaheadText: String? = null, className: String? = null, init: MdMenuItem.() -> Unit? = null): MdMenuItem

open

fun open()

Shows the menu.

outlinedButton

fun Container.outlinedButton(text: String? = null, disabled: Boolean = false, href: String? = null, target: LinkTarget? = null, trailingIcon: Boolean = false, type: ButtonType = ButtonType.Submit, value: String? = null, name: String? = null, className: String? = null, init: MdOutlinedButton.() -> Unit? = null): MdOutlinedButton

outlinedIconButton

fun Container.outlinedIconButton(disabled: Boolean = false, flipIconInRtl: Boolean = false, href: String? = null, target: LinkTarget? = null, ariaLabelSelected: String? = null, toggle: Boolean = false, selected: Boolean = false, type: IconButtonType = IconButtonType.Submit, value: String? = null, name: String? = null, className: String? = null, init: MdOutlinedIconButton.() -> Unit? = null): MdOutlinedIconButton

outlinedSelect

fun Container.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): MdOutlinedSelect

outlinedTextField

fun Container.outlinedTextField(disabled: Boolean = false, error: Boolean = false, errorText: String? = null, label: String? = null, required: Boolean = false, value: String? = null, prefixText: String? = null, suffixText: String? = null, supportingText: String? = null, rows: Int = 2, cols: Int = 20, inputMode: TextFieldInputMode? = null, max: TextFieldRangeConstraint? = null, maxLength: Int = -1, min: TextFieldRangeConstraint? = null, minLength: Int = -1, pattern: String? = null, placeholder: String? = null, readOnly: Boolean = false, multiple: Boolean = false, step: Number? = null, type: TextFieldInputType = TextFieldInputType.Text, autoComplete: Autocomplete? = null, name: String? = null, validationMessage: String? = null, className: String? = null, init: MdOutlinedTextField.() -> Unit? = null): MdOutlinedTextField

radio

fun Container.radio(id: String? = null, checked: Boolean = false, disabled: Boolean = false, required: Boolean = false, value: String = "on", name: String? = null, touchTarget: TouchTarget? = TouchTarget.Wrapper, validationMessage: String? = null, className: String? = null, init: MdRadio.() -> Unit? = null): MdRadio

rangeSlider

fun Container.rangeSlider(disabled: Boolean = false, min: Number = 0, max: Number = 100, valueStart: Number? = null, valueEnd: Number? = null, step: Number = 1, ticks: Boolean = false, labeled: Boolean = false, valueLabelStart: String? = null, valueLabelEnd: String? = null, ariaLabelStart: String? = null, ariaValueTextStart: String? = null, ariaLabelEnd: String? = null, ariaValueTextEnd: String? = null, name: String? = null, nameStart: String? = null, nameEnd: String? = null, className: String? = null, init: MdRangeSlider.() -> Unit? = null): MdRangeSlider

refresh

open override fun refresh()

remove

open override fun remove(child: Component)

removeAfterCreateHook

open override fun removeAfterCreateHook(hook: (VNode) -> Unit): Boolean

removeAfterDestroyHook

open override fun removeAfterDestroyHook(hook: () -> Unit): Boolean

removeAfterInsertHook

open override fun removeAfterInsertHook(hook: (VNode) -> Unit): Boolean

removeAll

open override fun removeAll()

removeAt

open override fun removeAt(position: Int)

removeAttribute

open override fun removeAttribute(name: String)

removeBeforeDisposeHook

open override fun removeBeforeDisposeHook(hook: () -> Unit): Boolean

removeCssClass

open override fun removeCssClass(css: String)

removeCssStyle

open override fun removeCssStyle(css: Style)

removeEventListener

open fun removeEventListener(id: Int)

removeEventListeners

open fun removeEventListeners()

removeStyle

fun removeStyle(name: String)

removeSurroundingCssClass

open override fun removeSurroundingCssClass(css: String)

removeSurroundingCssStyle

open override fun removeSurroundingCssStyle(css: Style)

renderVNode

open override fun renderVNode(): VNode

ripple

fun Container.ripple(disabled: Boolean = false, htmlFor: String? = null, control: HTMLElement? = null, className: String? = null, init: MdRipple.() -> Unit? = null): MdRipple

setAttribute

open override fun setAttribute(name: String, value: String)

setDragDropData

open fun setDragDropData(format: String, data: String)

setDropTarget

open fun setDropTarget(format: String, callback: (DragEvent) -> Unit)

open fun setDropTarget(formats: Set<String>?, callback: (DragEvent) -> Unit)

setDropTargetData

open fun setDropTargetData(format: String, callback: (String?) -> Unit)

setEventListener

open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Int

setStyle

fun setStyle(name: String, value: String)

show

open fun show()

singleRender

open override fun <T> singleRender(block: () -> T): T

singleRenderAsync

open override fun singleRenderAsync(block: () -> Unit)

slider

fun Container.slider(disabled: Boolean = false, min: Number = 0, max: Number = 100, value: Number? = null, step: Number = 1, valueLabel: String? = null, ticks: Boolean = false, labeled: Boolean = false, name: String? = null, className: String? = null, init: MdSlider.() -> Unit? = null): MdSlider

submenu

fun MdMenu.submenu(anchorCorner: Corner = Corner.EndStart, corner: Corner = Corner.StartStart, hoverOpenDelay: Int = DEFAULT_HOVER_OPEN_DELAY, hoverCloseDelay: Int = DEFAULT_HOVER_CLOSE_DELAY, className: String? = null, init: MdSubMenu.() -> Unit? = null): MdSubMenu

switch

fun Container.switch(selected: Boolean = false, disabled: Boolean = false, icons: Boolean = false, showOnlySelectedIcon: Boolean = false, required: Boolean = false, value: String = "on", name: String? = null, validationMessage: String? = null, className: String? = null, init: MdSwitch.() -> Unit? = null): MdSwitch

tabs

fun Container.tabs(autoActivate: Boolean = false, activeTabIndex: Int = -1, className: String? = null, init: MdTabs.() -> Unit? = null): MdTabs

textButton

fun Container.textButton(text: String? = null, disabled: Boolean = false, href: String? = null, target: LinkTarget? = null, trailingIcon: Boolean = false, type: ButtonType = ButtonType.Submit, value: String? = null, name: String? = null, className: String? = null, init: MdTextButton.() -> Unit? = null): MdTextButton

toggle

fun toggle()

Toggles the menu open state.

toggleVisible

open fun toggleVisible()

translate

open fun translate(text: String): String

open fun translate(text: String?): String?

unaryPlus

open operator fun String.unaryPlus()

useSnabbdomDistinctKey

open fun useSnabbdomDistinctKey()