pub struct ContextMenuItem<A = ()> { /* private fields */ }Expand description
A context-menu row with optional metadata, action, or submenu.
A leaf item closes the complete menu after activation even when it has no action. Disabled items remain visible but cannot be highlighted or activated. The current controller opens one submenu tier; submenu entries that themselves contain a submenu are displayed with a chevron but are not opened.
§Examples
use ailloli_ui_widgets::controls::{ContextMenuEntry, ContextMenuItem};
let item: ContextMenuItem<()> = ContextMenuItem::new("More")
.submenu([ContextMenuEntry::Item(ContextMenuItem::new("Details"))]);
assert_eq!(item.label(), "More");
assert_eq!(item.submenu_entries().len(), 1);Implementations§
Source§impl<A: 'static> ContextMenuItem<A>
impl<A: 'static> ContextMenuItem<A>
Sourcepub fn new(label: impl Into<String>) -> Self
pub fn new(label: impl Into<String>) -> Self
Creates an enabled leaf item without icon, shortcut, or action.
§Examples
use ailloli_ui_widgets::controls::ContextMenuItem;
let item: ContextMenuItem<()> = ContextMenuItem::new("Copy");
assert_eq!(item.label(), "Copy");Sourcepub fn shortcut(self, shortcut: impl Into<String>) -> Self
pub fn shortcut(self, shortcut: impl Into<String>) -> Self
Sets the right-aligned display-only shortcut hint.
§Examples
use ailloli_ui_widgets::controls::ContextMenuItem;
let item: ContextMenuItem<()> = ContextMenuItem::new("Copy").shortcut("Ctrl+C");
assert_eq!(item.shortcut_label(), Some("Ctrl+C"));Sourcepub fn leading_icon(self, icon: IconId) -> Self
pub fn leading_icon(self, icon: IconId) -> Self
Sets the leading icon, replacing any previous icon.
§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::controls::ContextMenuItem;
let item: ContextMenuItem<()> = ContextMenuItem::new("History").leading_icon(IconId::History);
let _ = item;Sourcepub fn disabled(self, disabled: impl Into<Binding<bool>>) -> Self
pub fn disabled(self, disabled: impl Into<Binding<bool>>) -> Self
Sets static or reactive disabled state.
§Examples
use ailloli_ui_widgets::controls::ContextMenuItem;
let item: ContextMenuItem<()> = ContextMenuItem::new("Unavailable").disabled(true);
assert!(item.is_disabled());Sourcepub fn on_select(self, action: impl IntoClickAction<A>) -> Self
pub fn on_select(self, action: impl IntoClickAction<A>) -> Self
Sets the leaf action, replacing any previous action.
Items with non-empty submenus open the submenu instead of running this action.
§Examples
use ailloli_ui_widgets::controls::ContextMenuItem;
#[derive(Clone)]
enum Action { Copy }
let item = ContextMenuItem::new("Copy").on_select(Action::Copy);
let _ = item;Replaces the submenu entries with values collected in iterator order.
An empty iterator restores leaf behavior. Only one interactive submenu tier is currently supported.
§Examples
use ailloli_ui_widgets::controls::{ContextMenuEntry, ContextMenuItem};
let item: ContextMenuItem<()> = ContextMenuItem::new("More").submenu([
ContextMenuEntry::Item(ContextMenuItem::new("Details")),
ContextMenuEntry::Separator,
]);
assert_eq!(item.submenu_entries().len(), 2);Sourcepub fn is_disabled(&self) -> bool
pub fn is_disabled(&self) -> bool
Reads the current static or reactive disabled value.
§Examples
use ailloli_ui_widgets::controls::ContextMenuItem;
let item: ContextMenuItem<()> = ContextMenuItem::new("Delete").disabled(true);
assert!(item.is_disabled());Sourcepub fn label(&self) -> &str
pub fn label(&self) -> &str
Returns the label exactly as supplied.
§Examples
use ailloli_ui_widgets::controls::ContextMenuItem;
let item: ContextMenuItem<()> = ContextMenuItem::new("");
assert_eq!(item.label(), "");Sourcepub fn shortcut_label(&self) -> Option<&str>
pub fn shortcut_label(&self) -> Option<&str>
Returns the optional shortcut hint; empty text remains Some("").
§Examples
use ailloli_ui_widgets::controls::ContextMenuItem;
let item: ContextMenuItem<()> = ContextMenuItem::new("Copy").shortcut("");
assert_eq!(item.shortcut_label(), Some(""));Borrows submenu entries in their display order.
§Examples
use ailloli_ui_widgets::controls::ContextMenuItem;
let item: ContextMenuItem<()> = ContextMenuItem::new("Leaf");
assert!(item.submenu_entries().is_empty());Trait Implementations§
Auto Trait Implementations§
impl<A> Freeze for ContextMenuItem<A>
impl<A = ()> !RefUnwindSafe for ContextMenuItem<A>
impl<A = ()> !Send for ContextMenuItem<A>
impl<A = ()> !Sync for ContextMenuItem<A>
impl<A> Unpin for ContextMenuItem<A>
impl<A = ()> !UnwindSafe for ContextMenuItem<A>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<A> IntoClickAction<A> for Awhere
A: Clone + 'static,
impl<A> IntoClickAction<A> for Awhere
A: Clone + 'static,
§fn into_click_action(self) -> ClickAction<A>
fn into_click_action(self) -> ClickAction<A>
Implements the into_click_action helper used by this module.