Struct AssetPicker 

pub struct AssetPicker { /* private fields */ }

Pick an emoji, a box style or a spinner. Returns the emoji, or the style’s or spinner’s name.

Implementations

impl AssetPicker

pub fn new(prompt: impl Into<String>, kind: AssetKind) -> AssetPicker

pub fn kind(&self) -> AssetKind

pub fn height(self, rows: usize) -> Self

Show at most rows at once (default 10).

pub fn preview(self, layout: PreviewLayout) -> Self

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

Start with this filter text.

pub fn default(self, name: &str) -> Self

The asset with this name (an emoji’s shortcode name, a style’s or spinner’s name) is focused first, and returned without a terminal.

pub fn theme(self, theme: Theme) -> Self

pub fn actions(self, actions: Actions) -> Self

Actions offered on every asset (#491).

pub fn menu_key(self, key: Key) -> Self

pub fn with_mouse(self, on: bool) -> Self

Report the mouse: see Select::with_mouse.

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

pub fn items(&self) -> &[Item<String>]

Trait Implementations

impl Component for AssetPicker

fn prompt( &mut self, io: &mut dyn LineIo, ) -> Result<Option<String>, NotInteractive>

Without a terminal: a name, the best fuzzy match answering. The list is too long to print, so it is not listed.

type Output = String

fn handle(&mut self, event: &Event, context: &Context<'_>) -> Flow<String>

Handle one event. Ctrl+C never arrives here: the event loop ends the component with Outcome::Interrupted.

fn render(&self, context: &Context<'_>) -> View

Render the current state.

fn mouse(&self) -> bool

Whether the component wants mouse events (#476): clicks, drags and the wheel. Off by default, since reporting the mouse takes text selection away from the terminal; a component turns it on when its caller opts in, and run then enables mouse reporting for the session.

fn keymap(&self) -> Keymap

The bindings this component has right now, for a help overlay, a shortcut list or status-bar hints to read (see keymap). A container’s include its focused child’s, before its own. The default declares none.

fn default_value(&self) -> Option<String>

The value to return when the terminal is not interactive and the policy asks for defaults. None: there is none.

fn start(&mut self, context: &Context<'_>) -> Flow<Self::Output>

Called once, before the component is first painted, with the terminal’s size: for work that needs it, such as rendering content at the width. Returning Done or Cancel finishes the component without waiting for an event. The default does nothing.

fn tick(&self) -> Option<Duration>

How often the component wants Event::Tick, for a spinner or a countdown. None (the default): never.

fn focusable(&self) -> bool

Whether the component takes focus in a container: Tab stops on it and keys go to it. The default: yes. A label, or a component that has finished, says no.

fn focus_step(&mut self, forward: bool) -> bool

Move focus to the next (forward) or previous focus stop inside this component, for Tab and Shift+Tab. false when there is none after the current one, so the container moves on to its next child. The default, for a component that is one stop: false.

fn focus_enter(&mut self, forward: bool) -> bool

Take focus from outside: at the first stop inside when forward, at the last otherwise. false when nothing in it can take focus. The default: whether the component is focusable.