Struct CommandItem 

pub struct CommandItem { /* private fields */ }

One command of a CommandPalette.

Implementations

impl CommandItem

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

A command label identified by key, which CommandPalette::on_select reports. Keys must be unique in the palette.

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

The heading this command is listed under.

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

A secondary line drawn after the label, in the muted colour.

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

An icon before the label: an crate::IconName or any served SVG path.

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

The keys of the command’s shortcut, each drawn as one Kbd (["⌘", "N"]). Display only.

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

Extra words the search matches besides the label and the group.

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

A disabled command is listed dimmed and cannot be highlighted or run.

pub fn key(&self) -> &SharedString

The command’s key.

pub fn label(&self) -> &SharedString

The command’s label.

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.