Skip to main content

CommandPalette

Struct CommandPalette 

Source
pub struct CommandPalette<'a, Id, Message> { /* private fields */ }
Available on crate feature command-palette only.
Expand description

A command palette builder. Convert it into an Element to render.

Implementations§

Source§

impl<'a, Id, Message> CommandPalette<'a, Id, Message>

Source

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

The dialog title on the first page. Nested pages show their own.

Source

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

The search field’s placeholder, unless the page sets its own.

Source

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

Text shown when nothing matches the query.

Source

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

Shows that a background search is still running.

Source

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

Caps the list’s height in pixels. It shrinks around a few results.

Source

pub fn size(self, size: Size) -> Self

The dialog’s maximum width. Defaults to dialog::Size::Md.

Source

pub fn keymap(self, keymap: Keymap<Action>) -> Self

Replaces the default_keymap: the toggle chords and Back.

Source

pub fn command_keymap(self, keymap: Keymap<Action>) -> Self

Replaces the command list keys.

Source

pub fn dialog_keymap(self, keymap: Keymap<Action>) -> Self

Replaces the dialog keys.

Source

pub fn on_event(self, on_event: impl Fn(Event<Id>) -> Message + 'a) -> Self

Trait Implementations§

Source§

impl<Id: Debug, Message> Debug for CommandPalette<'_, Id, Message>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'a, Id, Message> From<CommandPalette<'a, Id, Message>> for Element<'a, Message>
where Id: Clone + PartialEq + 'a, Message: Clone + 'a,

Source§

fn from(palette: CommandPalette<'a, Id, Message>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<'a, Id, Message> !RefUnwindSafe for CommandPalette<'a, Id, Message>

§

impl<'a, Id, Message> !Send for CommandPalette<'a, Id, Message>

§

impl<'a, Id, Message> !Sync for CommandPalette<'a, Id, Message>

§

impl<'a, Id, Message> !UnwindSafe for CommandPalette<'a, Id, Message>

§

impl<'a, Id, Message> Freeze for CommandPalette<'a, Id, Message>
where &'a State<Id>: Freeze, Element<'a, Message, Theme, ()>: Freeze, Option<Box<dyn Fn(Event<Id>) -> Message + 'a>>: Freeze,

§

impl<'a, Id, Message> Unpin for CommandPalette<'a, Id, Message>
where &'a State<Id>: Unpin, Element<'a, Message, Theme, ()>: Unpin, Option<Box<dyn Fn(Event<Id>) -> Message + 'a>>: Unpin,

§

impl<'a, Id, Message> UnsafeUnpin for CommandPalette<'a, Id, Message>
where &'a State<Id>: UnsafeUnpin, Element<'a, Message, Theme, ()>: UnsafeUnpin, Option<Box<dyn Fn(Event<Id>) -> Message + 'a>>: UnsafeUnpin,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<State, Message> IntoBoot<State, Message> for State

Source§

fn into_boot(self) -> (State, Task<Message>)

Turns some type into the initial state of some Application.
Source§

impl<T> MaybeClone for T

Source§

impl<T> MaybeDebug for T

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more