blizz-ui 3.0.0-dev.11

Self-rendering terminal UI components for the blizz wizard
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

#![allow(unexpected_cfgs)]

use std::io;
use std::io::Write;
use std::time::Duration;

use rand::rngs::ThreadRng;

pub mod decode;
pub mod input_buffer;
pub mod layout;
pub mod prompt;
pub mod select_option;
pub mod style;

pub mod components;

#[cfg(not(tarpaulin_include))]
mod wizard_composer;

#[cfg(not(tarpaulin_include))]
pub use wizard_composer::{WizardPromptRefs, render_wizard_prompt_layer};

pub use layout::Size;
pub use select_option::SelectOption;

/// Terminal dimensions and timing context shared across all components.
pub struct RenderContext {
  pub terminal_size: Size,
  pub elapsed: Duration,
}

/// A self-rendering UI element.
///
/// Each component owns its visual state (positions, reveal progress, etc.)
/// and knows how to draw itself into a terminal writer. The wizard loop
/// acts as a thin compositor, calling `render` on each component in
/// z-order.
pub trait Component {
  fn render<W: Write>(
    &self,
    writer: &mut W,
    ctx: &RenderContext,
    rng: &mut ThreadRng,
  ) -> io::Result<()>;
}