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>

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

anchor

var anchor: <Error class: unknown class>

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

anchorCorner

var anchorCorner: <Error class: unknown class>

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

defaultFocus

var defaultFocus: <Error class: unknown class>

The element that should be focused by default once opened.

hasOverflow

var hasOverflow: <Error class: unknown class>

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

items

val items: Array<MdMenuItem>

Gets the direct items in this list.

menuCorner

var menuCorner: <Error class: unknown class>

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

noNavigationWrap

var noNavigationWrap: <Error class: unknown class>

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.

open

val open: Boolean

Indicates that the menu is in an open state.

positioning

var positioning: <Error class: unknown class>

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

quick

var quick: <Error class: unknown class>

Skips the opening and closing animations.

skipRestoreFocus

var skipRestoreFocus: <Error class: unknown class>

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

stayOpenOnFocusout

var stayOpenOnFocusout: <Error class: unknown class>

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

stayOpenOnOutsideClick

var stayOpenOnOutsideClick: <Error class: unknown class>

Keeps the user clicks outside the menu.

typeaheadDelay

var typeaheadDelay: <Error class: unknown class>

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

xOffset

var xOffset: <Error class: unknown class>

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: <Error class: unknown class>

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

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.

buildAttributeSet

open fun buildAttributeSet(attributeSetBuilder: <Error class: unknown class>)

fun close()

Closes the menu.

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): <Error class: unknown class>

open

fun open()

Shows the menu.

render

open fun render(): <Error class: unknown class>

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): <Error class: unknown class>

toggle

fun toggle()

Toggles the menu open state.