MenuFlyout

Elevated Menu with showAt / isOpen helpers.

import QWinUI3.Extras · src/extras/QWinUI3/Extras/MenuFlyout.qml

Category: Dialogs & flyouts · Library: v2.80

← Component index

Gallery: MenuFlyout — src/gallery/pages/MenuFlyoutPage.qml

Extends Menu.

Example

MenuFlyout {
    id: menuFlyout
    MenuFlyoutItem { text: qsTr("Copy"); symbol: FluentIcons.Copy }
}

// --- API ---
// methods: openMenu(), closeMenu(), showAt(targetItem, offsetX, offsetY),
//          popupAtGlobal(overlay, globalX, globalY), hide()
// menuFlyout.openMenu()
// menuFlyout.closeMenu()
// menuFlyout.showAt(targetItem, offsetX, offsetY)
// menuFlyout.hide()
// inherits Menu (+ Qt Quick Controls base API)

Notes

Menu-styled Flyout; host MenuFlyoutItem / Separator / Header children. contentMaxHeight (WinUI MenuFlyoutPresenter.MaxHeight) enables scroll when content is taller. shouldConstrainToRootBounds clamps into the window overlay (default true). title comes from Menu (FINAL) — set title: for screen-reader chrome; MenuItem carries Accessible. Keyboard (Menu): arrows move; Enter/Space activate; Esc / light-dismiss closes. Prefer keyboardAcceleratorText on MenuFlyoutItem for visible chord hints. Long menus: snapshot dynamic labels when opening; set contentMaxHeight for scroll. Context menu at cursor: popupAtGlobal(Overlay.overlay, mouse.x, mouse.y) — docs/recipes.md.

API

Properties

Name	Type	Description
placement	int	Popup / flyout placement
preferredPlacement	alias	Preferred flyout placement
isLightDismissEnabled	bool	Close on outside click / Esc
isOpen	bool	Open / visible state
contentMaxHeight	real	(cannot redeclare Popup.maxHeight which is FINAL)
shouldConstrainToRootBounds	bool	WinUI ShouldConstrainToRootBounds — clamp popup into window overlay

Signals

No custom signals (use inherited signals from the base type).

Methods

Signature	Description
openMenu()	Open the menu
closeMenu()	Dismiss the menu
showAt(targetItem, offsetX, offsetY)	Show anchored at the given point or item
popupAtGlobal(overlay, globalX, globalY)	overlay: ApplicationWindow Overlay.overlay (or any Item in window coords).
hide()	Hide the control

---

Generated from module sources by scripts/generate_component_docs.py — do not edit by hand.