Struct Wizard 

pub struct Wizard<Msg> { /* private fields */ }

A flow of pages the user goes through in order: Steps on top, the current step’s page, and a row of buttons.

The application owns the current step and every value. Next sends the next message; the application validates the step there and either advances or returns FormErrors::focus_first, so a broken step blocks the flow with focus on the problem. On the last step Next reads Finish and sends the finish message. Back is shown from the second step on.

Capabilities, each off until asked for: Wizard::on_cancel adds a Cancel button and makes Esc inside the wizard cancel; Wizard::on_step lets people go back by choosing a finished step; Wizard::busy shows Next working and ignores it; Wizard::page_height keeps the buttons in place across pages of different heights.

The buttons are named wizard-cancel, wizard-back and wizard-next, so Command::focus("wizard-next") reaches them. Their words are quvyta.wizard.cancel, back, next and finish.

Implementations

impl<Msg: Clone + 'static> Wizard<Msg>

pub fn new(labels: impl IntoIterator<Item = impl Into<String>>) -> Self

A wizard with steps named labels, on the first step.

pub fn current(self, index: usize) -> Self

The current step.

pub fn on_back(self, message: Msg) -> Self

Message for Back.

pub fn on_next(self, message: Msg) -> Self

Message for Next on every step but the last.

pub fn on_finish(self, message: Msg) -> Self

Message for Finish on the last step.

pub fn on_cancel(self, message: Msg) -> Self

Adds a Cancel button; Esc inside the wizard sends the same message.

pub fn on_step(self, message: impl Fn(usize) -> Msg + 'static) -> Self

Lets finished steps be chosen to go back to them; the message carries the step.

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

Shows Next (or Finish) working and ignores it, e.g. while the last step is applied.

pub fn page_height(self, rows: u16) -> Self

Gives every page exactly rows rows, so the buttons stay put between steps.

pub fn show<'v>( self, ui: &'v mut View<'_, Msg>, page: impl FnOnce(&mut View<'_, Msg>), ) -> NodeMut<'v, Msg>

Adds the wizard to ui with the current step’s page built by page.