Struct ContextMenu 

pub struct ContextMenu { /* private fields */ }

A secondary-click menu over child. See the module docs.

Implementations

impl ContextMenu

pub fn new( id: impl Into<ElementId>, child: impl IntoElement, items: Vec<MenuItem>, ) -> Self

A context menu with items over the child area. id keys the menu’s state; give every instance its own.

pub fn recipe(self, name: impl Into<SharedString>) -> Self

Named theme overlay from herogpui_theme::ComponentThemes::menu, forwarded onto the painted Menu as crate::Dropdown::recipe forwards it. Stackable; a missing name adds no override.

pub fn item_content( self, render: impl Fn(&SharedString, InteractiveState) -> AnyElement + 'static, ) -> Self

Replaces each item’s label, forwarded onto the painted Menu. See Menu::item_content.

pub fn item_start_content( self, render: impl Fn(&SharedString, InteractiveState) -> Option<AnyElement> + 'static, ) -> Self

The leading element of each row, forwarded onto the painted Menu. See Menu::item_start_content.

pub fn on_action( self, f: impl Fn(&SharedString, &mut Window, &mut App) + 'static, ) -> Self

Runs with the chosen item’s key; the menu then closes.

pub fn on_open_change( self, f: impl Fn(&bool, &mut Window, &mut App) + 'static, ) -> Self

Reports every open and close.

pub fn disabled_keys( self, keys: impl IntoIterator<Item = impl Into<SharedString>>, ) -> Self

Items that render dimmed and cannot be chosen or focused.

pub fn is_disabled(self, v: bool) -> Self

A disabled context menu ignores secondary clicks; the area still renders and receives every other event.

Trait Implementations

impl IntoElement for ContextMenu

type Element = ViewElement<ContextMenu>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for ContextMenu

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.