Skip to content
QuickGUI

PopoverMenu

A compact model-driven menu rendered in a native popover window.

#Import

Import ui from github.com/egoist/quickgui/go/ui.

import (
	"fmt"
	"github.com/egoist/quickgui/go/native"
	"github.com/egoist/quickgui/go/ui"
)

#Usage

func PopoverMenuExample() *ui.Element {
	menu := ui.NewPopoverMenu(ui.PopoverMenuRootProps{Items: func() []ui.MenuItemDeclaration {
		return []ui.MenuItemDeclaration{{ID: "copy", Label: "Copy"}, {ID: "paste", Label: "Paste"}}
	}, OnSelect: func(item ui.MenuSelectDetails, _ *native.Event) {
		fmt.Println(item.ID)
	}})
	return menu.Root().Children(
		menu.Trigger().Child("Edit"),
		menu.Popup(),
	)
}

#Anatomy

  • popoverMenu.Root
  • popoverMenu.Trigger
  • popoverMenu.Popup

#API reference

Expand an entry for its description and complete signature. A dash means no declaration default is documented.

NewPopoverMenu

View source
ui.NewPopoverMenu(props ...PopoverMenuRootProps) *PopoverMenuComponent

NewPopoverMenu declares a PopoverMenu instance. Optional props provide initial settings.

ChildrenComponent—

Content mounted inside the component. Compound child callbacks run after the parent context exists.

Component
View source
Itemsfunc() []MenuItemDeclaration—

Items made available to the control. Use stable item values to preserve selection.

func() []MenuItemDeclaration
View source
Appearance*MenuAppearance—

Structural colors and geometry for a core-painted native menu or picker.

*MenuAppearance
View source
Openfunc() bool—

Controlled visibility of the panel or overlay. Pair with the open-change callback.

func() bool
View source
DefaultOpenbool—

Initial visibility when the component owns its open state.

bool
View source
OnOpenChangefunc(bool, PopoverMenuOpenChangeDetails)—

Reports a requested visibility change, including dismissal.

func(bool, PopoverMenuOpenChangeDetails)
View source
OnSelectfunc(MenuSelectDetails, *native.Event)—

Reports the menu entry selected by the core.

func(MenuSelectDetails, *native.Event)
View source
Placementstring—

Requested native child-window placement.

string
View source
Gap*float64—

Space between adjacent children, in logical pixels.

*float64
View source
ViewportMargin*float64—

Minimum space reserved around the surface within the viewport.

*float64
View source
DismissOnEscape*bool—

Allows Escape to dismiss the surface.

*bool
View source
DismissOnPointerOutside*bool—

Allows a pointer press outside the surface to dismiss it.

*bool
View source

PopoverMenu.Items

View source
popoverMenu.Items(value any) *PopoverMenuComponent

Items made available to the control. Use stable item values to preserve selection.

PopoverMenu.Appearance

View source
popoverMenu.Appearance(value *MenuAppearance) *PopoverMenuComponent

Structural colors and geometry for a core-painted native menu or picker.

PopoverMenu.Open

View source
popoverMenu.Open(value any) *PopoverMenuComponent

Controlled visibility of the panel or overlay. Pair with the open-change callback.

PopoverMenu.DefaultOpen

View source
popoverMenu.DefaultOpen(value bool) *PopoverMenuComponent

Initial visibility when the component owns its open state.

PopoverMenu.OnOpenChange

View source
popoverMenu.OnOpenChange(value func(bool, PopoverMenuOpenChangeDetails)) *PopoverMenuComponent

Reports a requested visibility change, including dismissal.

PopoverMenu.OnSelect

View source
popoverMenu.OnSelect(value func(MenuSelectDetails, *native.Event)) *PopoverMenuComponent

Reports the menu entry selected by the core.

PopoverMenu.Placement

View source
popoverMenu.Placement(value string) *PopoverMenuComponent

Requested native child-window placement.

PopoverMenu.Gap

View source
popoverMenu.Gap(value float64) *PopoverMenuComponent

Space between adjacent children, in logical pixels.

PopoverMenu.ViewportMargin

View source
popoverMenu.ViewportMargin(value float64) *PopoverMenuComponent

Minimum space reserved around the surface within the viewport.

PopoverMenu.DismissOnEscape

View source
popoverMenu.DismissOnEscape(value bool) *PopoverMenuComponent

Allows Escape to dismiss the surface.

PopoverMenu.DismissOnPointerOutside

View source
popoverMenu.DismissOnPointerOutside(value bool) *PopoverMenuComponent

Allows a pointer press outside the surface to dismiss it.

PopoverMenu.Root

View source
popoverMenu.Root() *Element

Configures root for this part. The declared type and source define the accepted value.

PopoverMenu.Trigger

View source
popoverMenu.Trigger(options ...PartProps) *Element

Configures trigger for this part. The declared type and source define the accepted value.

Reffunc(*native.Node)—

Receives the retained native node after construction. Keep imperative work in event or lifecycle callbacks.

func(*native.Node)
View source
Styleany—

Reusable layout, typography, color, and interaction-state styles. Build with ui.Style() and compose with Merge.

any
View source
ChildrenPartChildren—

Content mounted inside the component. Compound child callbacks run after the parent context exists.

PartChildren
View source
Disabledany—

Prevents activation and exposes the disabled state to accessibility. Compound parts inherit a disabled root.

any
View source
Rolestring—

Accessibility role override. Prefer the component’s built-in semantics.

string
View source
FocusOnPointerany—

Whether a pointer press moves keyboard focus to the control.

any
View source
Groupany—

Names this element as a group for descendant interaction-state styling.

any
View source
AriaLabelany—

Accessible name, especially for icon-only controls or controls without a visible label.

any
View source
TabIndex*float64—

Controls sequential keyboard focus order. Omit to retain the component’s default focus behavior.

*float64
View source
OnClickfunc(*native.Event)—

Called after QuickGUI resolves an activation, including supported keyboard activation.

func(*native.Event)
View source
OnDoubleClickfunc(*native.Event)—

Callback for double click. The signature below lists the event payload.

func(*native.Event)
View source
OnContextMenufunc(*native.Event)—

Callback for context menu. The signature below lists the event payload.

func(*native.Event)
View source
OnPointerfunc(*native.Event)—

Callback for pointer. The signature below lists the event payload.

func(*native.Event)
View source
OnMouseEnterfunc(*native.Event)—

Callback for mouse enter. The signature below lists the event payload.

func(*native.Event)
View source
OnMouseLeavefunc(*native.Event)—

Callback for mouse leave. The signature below lists the event payload.

func(*native.Event)
View source
OnMouseDownfunc(*native.Event)—

Callback for mouse down. The signature below lists the event payload.

func(*native.Event)
View source
OnMouseUpfunc(*native.Event)—

Callback for mouse up. The signature below lists the event payload.

func(*native.Event)
View source
OnKeyDownfunc(*native.Event)—

Callback for key down. The signature below lists the event payload.

func(*native.Event)
View source
OnKeyUpfunc(*native.Event)—

Callback for key up. The signature below lists the event payload.

func(*native.Event)
View source
OnFocusfunc(*native.Event)—

Callback for focus. The signature below lists the event payload.

func(*native.Event)
View source
OnBlurfunc(*native.Event)—

Callback for blur. The signature below lists the event payload.

func(*native.Event)
View source

PopoverMenu.Popup

View source
popoverMenu.Popup(options ...PopoverMenuPopupProps) *Element

Configures popup for this part. The declared type and source define the accepted value.

Reffunc(*native.Node)—

Receives the retained native node after construction. Keep imperative work in event or lifecycle callbacks.

func(*native.Node)
View source
Styleany—

Reusable layout, typography, color, and interaction-state styles. Build with ui.Style() and compose with Merge.

any
View source
ChildrenPartChildren—

Content mounted inside the component. Compound child callbacks run after the parent context exists.

PartChildren
View source
Disabledany—

Prevents activation and exposes the disabled state to accessibility. Compound parts inherit a disabled root.

any
View source
Rolestring—

Accessibility role override. Prefer the component’s built-in semantics.

string
View source
FocusOnPointerany—

Whether a pointer press moves keyboard focus to the control.

any
View source
Groupany—

Names this element as a group for descendant interaction-state styling.

any
View source
AriaLabelany—

Accessible name, especially for icon-only controls or controls without a visible label.

any
View source
TabIndex*float64—

Controls sequential keyboard focus order. Omit to retain the component’s default focus behavior.

*float64
View source
OnClickfunc(*native.Event)—

Called after QuickGUI resolves an activation, including supported keyboard activation.

func(*native.Event)
View source
OnDoubleClickfunc(*native.Event)—

Callback for double click. The signature below lists the event payload.

func(*native.Event)
View source
OnContextMenufunc(*native.Event)—

Callback for context menu. The signature below lists the event payload.

func(*native.Event)
View source
OnPointerfunc(*native.Event)—

Callback for pointer. The signature below lists the event payload.

func(*native.Event)
View source
OnMouseEnterfunc(*native.Event)—

Callback for mouse enter. The signature below lists the event payload.

func(*native.Event)
View source
OnMouseLeavefunc(*native.Event)—

Callback for mouse leave. The signature below lists the event payload.

func(*native.Event)
View source
OnMouseDownfunc(*native.Event)—

Callback for mouse down. The signature below lists the event payload.

func(*native.Event)
View source
OnMouseUpfunc(*native.Event)—

Callback for mouse up. The signature below lists the event payload.

func(*native.Event)
View source
OnKeyDownfunc(*native.Event)—

Callback for key down. The signature below lists the event payload.

func(*native.Event)
View source
OnKeyUpfunc(*native.Event)—

Callback for key up. The signature below lists the event payload.

func(*native.Event)
View source
OnFocusfunc(*native.Event)—

Callback for focus. The signature below lists the event payload.

func(*native.Event)
View source
OnBlurfunc(*native.Event)—

Callback for blur. The signature below lists the event payload.

func(*native.Event)
View source
Width*float64—

Declared logical width.

*float64
View source
OnSelectfunc(*native.Event)—

Reports the menu entry selected by the core.

func(*native.Event)
View source
OnDismissfunc(*native.Event)—

Reports toast identifiers dismissed by the core.

func(*native.Event)
View source

Element

View source
part.Child(content).Style(style)

Every part returns a fluent element. Strings, numbers, elements, and deferred child factories compose directly.

ChildChild(child any) *Element—

Child appends content and returns this element. Content can be an element, native node, scalar, accessor, or node-returning construction callback. 

Child(child any) *Element
View source
ChildrenChildren(children ...any) *Element—

Children appends multiple children in order without replacing existing content. It also accepts []any, []*Element, and []*native.Node slices as arguments. Read the retained child nodes through element.Node.Children. 

Children(children ...any) *Element
View source
StyleStyle(style StyleBuilder) *Element—

Style merges a reusable style. Scalar accessors retain independent native bindings. 

Style(style StyleBuilder) *Element
View source
OnClickOnClick(handler func()) *Element—

OnClick handles a click without an unused event parameter. 

OnClick(handler func()) *Element
View source
RefRef(handler func(*native.Node)) *Element—

Ref exposes the native handle once at this point in the declaration chain. 

Ref(handler func(*native.Node)) *Element
View source