Struct CommandItem 

#[non_exhaustive]
pub struct CommandItem { /* private fields */ }

One command: a key the palette reports it by, a label, and what it does.

Implementations

impl CommandItem

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

A command with a key that is stable across renders and a label.

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

The icon before the label.

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

Words the query matches besides the label, such as “shell” for a terminal.

pub fn action(self, action: impl Action) -> Self

Dispatches action when the command is chosen, and shows the action’s shortcut at the end of the row.

pub fn action_context(self, focus_handle: &FocusHandle) -> Self

The element the action goes to, and whose key bindings its shortcut shows. Without one it goes up from the palette’s search field.

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

Whether the command can be chosen. A disabled row shows muted and the keyboard passes over it.

pub fn render<E: IntoElement>( self, render: impl Fn(CommandRow, &mut Window, &mut App) -> E + 'static, ) -> Self

Draws the inside of the row in place of the icon, the label, and the shortcut. The palette keeps the row’s frame: its padding, its highlight, and the pointer and the keyboard. The label is still what the query matches and what assistive technology reads. The renderer runs each time the row is drawn, so it must not change anything.

pub fn key(&self) -> &SharedString

The key the palette reports this command by.

pub fn label(&self) -> &SharedString

The text of the row.

pub fn is_disabled(&self) -> bool

Whether the command is disabled.

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 From<CommandItem> for CommandEntry

fn from(item: CommandItem) -> Self

Converts to this type from the input type.