Struct CommandItem 

pub struct CommandItem { /* private fields */ }

A single command in a crate::command::Command palette.

Implementations

impl CommandItem

pub fn new() -> Self

Create an empty command item.

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

Set the label to display and search.

pub fn icon(self, icon: impl Into<Icon>) -> Self

Set the leading icon.

pub fn action(self, action: Box<dyn Action>) -> Self

Set the Action dispatched when this item is clicked or confirmed.

The Action’s active keybinding is also shown by the default row.

pub fn checked(self, checked: bool) -> Self

Mark this item as the chosen one, drawing a check at the right end of the row.

A resolved Action binding takes that slot, so an item with one shows no check.

pub fn keywords<I, S>(self, keywords: I) -> Self

where I: IntoIterator<Item = S>, S: Into<SharedString>,

Add extra terms the search matches against, besides the label.

pub fn child<F, E>(self, builder: F) -> Self

where F: Fn(&mut Window, &mut App) -> E + 'static, E: IntoElement,

Replace the row content (icon and label) with a lazily built child.

The builder may run more than once for measurement and rendering, so it must be side-effect-free. Custom children own their complete visual presentation, including any keybinding hint.

Trait Implementations

impl Clone for CommandItem

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for CommandItem

fn default() -> Self

Returns the “default value” for a type.

impl Disableable for CommandItem

fn disabled(self, disabled: bool) -> Self

impl From<CommandItem> for CommandEntry

fn from(item: CommandItem) -> Self

Converts to this type from the input type.