Struct CommandItem

Source
pub struct CommandItem<A = ()> { /* private fields */ }
Expand description

One searchable command row with an optional action.

Filtering checks trimmed ASCII-lowercased query substrings against title, subtitle, and keywords. Shortcut hints are not searchable. Disabled commands remain visible but keyboard navigation skips them and activation is consumed without closing. Enabled commands close the palette even without an action.

§Examples

use ailloli_ui_widgets::controls::CommandItem;
let item: CommandItem<()> = CommandItem::new("Open file").keyword("search");
let _ = item;

Implementations§

Source§

impl<A: 'static> CommandItem<A>

Source

pub fn new(title: impl Into<String>) -> Self

Creates an enabled command with no optional metadata or action.

§Examples
use ailloli_ui_widgets::controls::CommandItem;
let item: CommandItem<()> = CommandItem::new("Open file");
let _ = item;
Source

pub fn subtitle(self, subtitle: impl Into<String>) -> Self

Sets a searchable subtitle, replacing any previous value.

Empty text remains present and selects the two-line row layout.

§Examples
use ailloli_ui_widgets::controls::CommandItem;
let item: CommandItem<()> = CommandItem::new("Theme").subtitle("Change appearance");
let _ = item;
Source

pub fn shortcut(self, shortcut: impl Into<String>) -> Self

Sets a non-searchable shortcut hint, replacing any previous value.

§Examples
use ailloli_ui_widgets::controls::CommandItem;
let item: CommandItem<()> = CommandItem::new("Open").shortcut("Ctrl+O");
let _ = item;
Source

pub fn keyword(self, keyword: impl Into<String>) -> Self

Appends one searchable keyword without normalization or de-duplication.

§Examples
use ailloli_ui_widgets::controls::CommandItem;
let item: CommandItem<()> = CommandItem::new("Preferences").keyword("settings");
let _ = item;
Source

pub fn keywords( self, keywords: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Appends searchable keywords in iterator order.

Existing keywords remain, and duplicates/empty strings are retained.

§Examples
use ailloli_ui_widgets::controls::CommandItem;
let item: CommandItem<()> = CommandItem::new("Preferences")
    .keywords(["settings", "configuration"]);
let _ = item;
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::CommandItem;
let item: CommandItem<()> = CommandItem::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.

Disabled commands remain searchable and visible but are skipped by navigation and cannot run or close the palette.

§Examples
use ailloli_ui_widgets::controls::CommandItem;
let item: CommandItem<()> = CommandItem::new("Unavailable").disabled(true);
let _ = item;
Source

pub fn on_select(self, action: impl IntoClickAction<A>) -> Self

Installs the action run when this enabled command activates.

A later call replaces it. Enabled activation closes even when no action is installed.

§Examples
use ailloli_ui_widgets::controls::CommandItem;
#[derive(Clone)]
enum Action { Open }
let item = CommandItem::new("Open").on_select(Action::Open);
let _ = item;

Trait Implementations§

Source§

impl<A> Clone for CommandItem<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 CommandItem<A>

§

impl<A = ()> !RefUnwindSafe for CommandItem<A>

§

impl<A = ()> !Send for CommandItem<A>

§

impl<A = ()> !Sync for CommandItem<A>

§

impl<A> Unpin for CommandItem<A>

§

impl<A = ()> !UnwindSafe for CommandItem<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,