Struct CommandDialog 

pub struct CommandDialog { /* private fields */ }

A Command palette in a Dialog, as shadcn’s CommandDialog and the palettes opened with Cmd+K.

The dialog has no title and no close button: Escape and a press on the backdrop close it. It sits at the center horizontally and at the theme’s command_dialog_top below the top edge, so it rests in the upper third of the window as Spotlight does, and does not move when its height changes. It is the theme’s command_dialog_width wide, and narrower in a window with no room for it, with the dialog layer’s margin on both sides.

The search field takes focus when the dialog opens, and focus returns to where it was when it closes. The box is as tall as a palette’s list can be, in every state, so the dialog does not jump while the number of matches changes; the list scrolls inside it. Choosing a command closes the dialog after the state reports CommandEvent::Confirmed.

use gpui_cn::{CommandDialog, CommandState};
use gpui_kit::{Entity, IntoElement};

fn palette(state: &Entity<CommandState>, open: bool) -> impl IntoElement {
    CommandDialog::new("palette", state)
        .open(open)
        .empty("Nothing matches.")
}

The application owns the open state: open sets it, and on_open_change reports Escape, a backdrop press, and a chosen command, which should clear it. The commands, the query, and the placeholder live in the CommandState. The id must be stable across frames.

Implementations

impl CommandDialog

pub fn new(id: impl Into<ElementId>, state: &Entity<CommandState>) -> Self

A closed palette dialog on state, with a stable id.

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

Shows or hides the dialog.

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

The text shown while no command matches. The default is the palette’s own.

pub fn on_open_change( self, handler: impl Fn(bool, &mut Window, &mut App) + 'static, ) -> Self

Called with false when Escape, a press on the backdrop, or a chosen command asks to close the dialog.

Trait Implementations

impl IntoElement for CommandDialog

type Element = ViewElement<CommandDialog>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for CommandDialog

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.