Struct CommandState 

pub struct CommandState { /* private fields */ }

The commands of a Command palette, its query, and its highlight.

Owned by the view that shows the palette, which observes it so a change renders. The query filters the commands by label and keywords as a fuzzy subsequence, ignoring case, and puts the highlight on the first match; Up and Down move it, and Enter chooses it. Choosing a command, or submitting a query, clears the query for the next time.

Implementations

impl CommandState

pub fn new( placeholder: impl Into<SharedString>, window: &mut Window, cx: &mut Context<'_, Self>, ) -> Self

A palette with no commands, whose search field shows placeholder.

pub fn with_entries( self, entries: impl IntoIterator<Item = impl Into<CommandEntry>>, ) -> Self

Seeds the commands.

pub fn with_search_handler( self, handler: impl Fn(SharedString, &mut Context<'_, Self>) -> Task<Vec<CommandEntry>> + 'static, cx: &mut Context<'_, Self>, ) -> Self

Answers the query with handler in place of the local filter: for each change, and for the empty query when set, it gets the query and returns a task with the commands to show. The task can match on a background thread, fuzzily, or ask a server; a newer query cancels the task before it. The commands shown stay until the answer arrives.

use gpui_cn::{CommandEntry, CommandItem, CommandState};
use gpui_kit::{AppContext as _, Context, Window};

fn files(window: &mut Window, cx: &mut Context<CommandState>) -> CommandState {
    CommandState::new("Open any file", window, cx).with_search_handler(|query, cx| {
        let paths = cx.background_spawn(async move {
            // Any search: fuzzy, indexed, or a request.
            vec![format!("src/{query}.rs")]
        });
        cx.spawn(async move |_, _| {
            paths
                .await
                .into_iter()
                .map(|path| CommandEntry::from(CommandItem::new(path.clone(), path)))
                .collect()
        })
    }, cx)
}

pub fn is_searching(&self) -> bool

Whether a search handler is still answering the query.

pub fn set_entries( &mut self, entries: impl IntoIterator<Item = impl Into<CommandEntry>>, cx: &mut Context<'_, Self>, )

Replaces the commands, as an answer to the query. The highlight stays on the command with the same key when there is one, and a search handler’s answer still on its way is dropped, so it cannot replace these commands.

pub fn query(&self, cx: &App) -> SharedString

The search query.

pub fn set_query( &mut self, query: impl Into<SharedString>, window: &mut Window, cx: &mut Context<'_, Self>, )

Replaces the search query.

pub fn highlighted(&self) -> Option<SharedString>

The key of the command the keyboard or the pointer is on.

pub fn matched_count(&self) -> usize

How many commands match the query.

Trait Implementations

impl EventEmitter<CommandEvent> for CommandState

impl Focusable for CommandState

The search field’s focus, which holds the keyboard for the palette.

fn focus_handle(&self, cx: &App) -> FocusHandle

Returns the focus handle associated with this view.