Struct ThemePicker 

pub struct ThemePicker { /* private fields */ }

Pick a theme while its preview shows a sample rendered in it (#460). Returns the theme’s name.

Themes come from anywhere: a configuration file’s [themes.NAME], a plugin’s (ExtensionRegistry::theme), or code. Each is layered over the extended theme, so a theme that sets only a few names previews with the rest at their defaults.

use rich::{Style, Theme};
use rich_interact::components::ThemePicker;
use rich_interact::headless::{self, Script};

let mut night = Theme::new();
night.insert("info", Style::parse("bold blue").unwrap());
let picker = ThemePicker::new("Theme", [("default", Theme::new()), ("night", night)]);
let (outcome, record) = headless::run(picker, Script::new().keys("down enter"), 80, 14);
assert_eq!(outcome.unwrap().value().as_deref(), Some("night"));
assert!(record.frames[0].contains("Theme preview"));

Implementations

impl ThemePicker

pub fn new<I, S>(prompt: impl Into<String>, themes: I) -> ThemePicker

where I: IntoIterator<Item = (S, Theme)>, S: Into<String>,

Pick one of themes, by name, previewing THEME_SAMPLE.

pub fn with_sample<I, S>( prompt: impl Into<String>, themes: I, sample: Arc<dyn Renderable + Send + Sync>, ) -> ThemePicker

where I: IntoIterator<Item = (S, Theme)>, S: Into<String>,

Pick one of themes, previewing sample in each.

pub fn from_registry( prompt: impl Into<String>, registry: &ExtensionRegistry, ) -> ThemePicker

Pick one of the themes plugins registered in registry (theme packs), after rich’s own default theme, listed as default.

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

Show at most rows themes at once (default 10).

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

Where the preview goes (default: beside the list from 72 columns).

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

Rows the preview takes when it is below the list (default 10).

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

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

Focus the theme called name first; it is also the answer without a terminal.

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

Report the mouse: see Select::with_mouse.

pub fn names(&self) -> Vec<&str>

The themes’ names, in order.

Trait Implementations

impl Component for ThemePicker

type Output = String

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 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 tick(&self) -> Option<Duration>

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

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 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 prompt( &mut self, io: &mut dyn LineIo, ) -> Result<Option<String>, NotInteractive>

Ask for the value line by line, for when the terminal is not interactive and the policy asks for a prompt. The default says the component has no line-based form.

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