Skip to main content

Command

Struct Command 

Source
pub struct Command { /* private fields */ }
Expand description

Command palette component

§Example

use armas_basic::components::Command;

let mut cmd = Command::new().placeholder("Type a command...");
let response = cmd.show(ui, |builder| {
    builder.item("open", "Open File");
    builder.item("save", "Save");
    builder.item("quit", "Quit");
});
if let Some(id) = response.executed {
    // handle executed command id
}

Implementations§

Source§

impl Command

Source

pub fn new() -> Self

Create a new command palette

Source

pub fn id(self, id: impl Into<Id>) -> Self

Set a custom ID for state persistence

Source

pub fn placeholder(self, placeholder: impl Into<String>) -> Self

Set placeholder text for the search input

Source

pub const fn trigger(self, key: Key, modifiers: Modifiers) -> Self

Set the keyboard shortcut to trigger the command palette

Source

pub const fn width(self, width: f32) -> Self

Set the panel width

Source

pub const fn max_height(self, max_height: f32) -> Self

Set the panel max height

Source

pub fn show<R>( &mut self, ui: &mut Ui, content: impl FnOnce(&mut CommandBuilder<'_>) -> R, ) -> CommandResponse

Show the command palette

Trait Implementations§

Source§

impl Default for Command

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.