CommandPalette

Struct CommandPalette 

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

Command Palette widget

Implementations§

Source§

impl CommandPalette

Source

pub fn new() -> Self

Create a new command palette

Source

pub fn command(self, command: Command) -> Self

Add a command

Source

pub fn commands(self, commands: Vec<Command>) -> Self

Add multiple commands

Source

pub fn width(self, width: u16) -> Self

Set width

Source

pub fn max_visible(self, max: u16) -> Self

Set max visible items

Source

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

Set placeholder

Source

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

Set title

Source

pub fn show_descriptions(self, show: bool) -> Self

Show/hide descriptions

Source

pub fn show_shortcuts(self, show: bool) -> Self

Show/hide shortcuts

Source

pub fn show_icons(self, show: bool) -> Self

Show/hide icons

Source

pub fn colors(self, bg: Color, border: Color, selected: Color) -> Self

Set colors

Source

pub fn show(&mut self)

Show the palette

Source

pub fn hide(&mut self)

Hide the palette

Source

pub fn toggle(&mut self)

Toggle visibility

Source

pub fn is_visible(&self) -> bool

Check if visible

Source

pub fn get_query(&self) -> &str

Get current query

Source

pub fn set_query(&mut self, query: impl Into<String>)

Set query

Source

pub fn select_next(&mut self)

Select next item

Source

pub fn select_prev(&mut self)

Select previous item

Source

pub fn selected_command(&self) -> Option<&Command>

Get selected command

Source

pub fn selected_id(&self) -> Option<&str>

Get selected command ID

Source

pub fn execute(&mut self) -> Option<String>

Execute selected (returns command ID)

Source

pub fn input(&mut self, ch: char)

Handle text input

Source

pub fn backspace(&mut self)

Handle backspace

Source

pub fn clear_query(&mut self)

Clear query

Source

pub fn handle_key(&mut self, key: &Key) -> bool

Handle key input

Source

pub fn add_command(&mut self, command: Command)

Add command dynamically

Source

pub fn remove_command(&mut self, id: &str)

Remove command by ID

Source

pub fn clear_commands(&mut self)

Clear all commands

Source

pub fn mark_recent(&mut self, id: &str)

Mark command as recent

Source§

impl CommandPalette

Source

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

Set element ID for CSS selector (#id)

Source

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

Add a CSS class

Source

pub fn classes<I, S>(self, classes: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Add multiple CSS classes

Trait Implementations§

Source§

impl Default for CommandPalette

Source§

fn default() -> Self

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

impl StyledView for CommandPalette

Source§

fn set_id(&mut self, id: impl Into<String>)

Set element ID
Source§

fn add_class(&mut self, class: impl Into<String>)

Add a CSS class
Source§

fn remove_class(&mut self, class: &str)

Remove a CSS class
Source§

fn toggle_class(&mut self, class: &str)

Toggle a CSS class
Source§

fn has_class(&self, class: &str) -> bool

Check if has class
Source§

impl View for CommandPalette

Source§

fn id(&self) -> Option<&str>

Get element ID (for CSS #id selectors)
Source§

fn classes(&self) -> &[String]

Get CSS classes (for CSS .class selectors)
Source§

fn meta(&self) -> WidgetMeta

Get widget metadata for DOM
Source§

fn render(&self, ctx: &mut RenderContext<'_>)

Render the view
Source§

fn widget_type(&self) -> &'static str

Get widget type name (for CSS type selectors)
Source§

fn children(&self) -> &[Box<dyn View>]

Get child views (for container widgets) 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> 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<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
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.
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