Struct ContextMenuItem

Source
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>

Source

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");
Source

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"));
Source

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;
Source

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());
Source

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;
Source

pub fn submenu( self, entries: impl IntoIterator<Item = ContextMenuEntry<A>>, ) -> Self

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);
Source

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());
Source

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(), "");
Source

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(""));
Source

pub fn submenu_entries(&self) -> &[ContextMenuEntry<A>]

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§

Source§

impl<A> Clone for ContextMenuItem<A>

Source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<A> IntoClickAction<A> for A
where A: Clone + 'static,

§

fn into_click_action(self) -> ClickAction<A>

Implements the into_click_action helper used by this module.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> Props for T
where T: Clone + 'static,