Widgets

ContextMenu

ContextMenu

ContextMenu control. Build it with the context_menu helper.

Example

context_menu(
  content: text("ContextMenu"),
  expand: true,
  width: 240,
  height: 120,
  on_animation_end: ->(event) {}
)

Properties

  • content — The single child control rendered inside this control.
  • items — Sets the items property.
  • primary_items — Sets the primary items property.
  • primary_trigger — Sets the primary trigger property.
  • secondary_items — Sets the secondary items property.
  • secondary_trigger — Sets the secondary trigger property.
  • tertiary_items — Sets the tertiary items property.
  • tertiary_trigger — Sets the tertiary trigger property.

Common layout and animation properties

  • align — Alignment of the control within its parent.
  • animate_align — Animates alignment changes.
  • animate_margin — Animates margin changes.
  • animate_offset — Animates offset changes.
  • animate_opacity — Animates opacity changes.
  • animate_position — Animates position changes.
  • animate_rotation — Animates rotation changes.
  • animate_scale — Animates scale changes.
  • animate_size — Animates size changes.
  • aspect_ratio — Width-to-height ratio to maintain.
  • badge — Badge drawn on the corner of the control.
  • bottom — Bottom offset when positioned inside a stack.
  • col — Responsive column span (1-12) per breakpoint.
  • data — Arbitrary value you can attach to the control and read back in handlers.
  • disabled — Disables interaction when true.
  • expand — Fills the available space along the parent's main axis when true.
  • expand_loose — Like expand, but only grows up to the child's natural size.
  • height — Fixed height in logical pixels.
  • key — Stable identity used to preserve state across rebuilds.
  • left — Left offset when positioned inside a stack.
  • margin — Outer spacing around the control.
  • offset — Translation offset applied to the control.
  • opacity — Opacity from 0.0 (transparent) to 1.0 (opaque).
  • right — Right offset when positioned inside a stack.
  • rotate — Rotation applied to the control.
  • rtl — Renders right-to-left when true.
  • scale — Scale transform applied to the control.
  • size_change_interval — Throttle interval for on_size_change, in ms.
  • tooltip — Text shown on hover/long-press.
  • top — Top offset when positioned inside a stack.
  • visible — Hides the control when false.
  • width — Fixed width in logical pixels.

Events

  • on_animation_end — Fired when an animation completes.
  • on_dismiss — Fired when the control is dismissed.
  • on_select — Fired when a selection is made.
  • on_size_change — Fired when the control's size changes.

Methods

  • open(position: ..., timeout: ..., on_result: ...)

Reference

  • Family: materials
  • Widget type: contextmenu
  • Helpers: context_menu, contextmenu