Struct Steps 

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

Where a sequence of steps stands: finished steps carry a check in the success colour, the current step is bold with an accent marker, and upcoming steps are faint. Steps are set apart by space and tone; nothing connects them.

Steps sit in a row by default. When the row does not fit, only the markers stay, followed by the current step’s label. Steps::vertical puts one step on each line.

With Steps::on_select finished steps can be chosen to go back to them: by click, or by focusing the steps, moving with the arrow keys and pressing Enter or Space. The application owns the current step.

Style keys: step (bg, pillar) with hover and focus for choosable steps; step-marker and step-label (fg, bold) with checked for finished steps and active for the current one, and variants running and failed for the current step. Icons: check, dot, dot-outline, error.

Implementations

impl<Msg: 'static> Steps<Msg>

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

Steps named labels, the first one current.

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

The current step. Steps before it are finished; a value past the last step shows every step finished.

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

One step per line instead of a row.

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

The current step is being worked on: its marker breathes.

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

The current step failed: its marker becomes the error icon in the danger colour.

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

Makes finished steps choosable; the message carries the chosen step.

Trait Implementations

impl<Msg: 'static> Widget<Msg> for Steps<Msg>

fn measure(&self, cx: &mut MeasureCx<'_>, available: Size) -> Size

The size the widget wants when it may use up to available.

fn paint(&self, cx: &mut PaintCx<'_>, area: Rect)

Draws the widget into area.

fn event(&self, cx: &mut EventCx<'_, Msg>, event: &Event) -> bool

Handles input. Returns true when the event was used; unused key and scroll events bubble to the parent widget.

fn focusable(&self) -> bool

Whether the widget can take keyboard focus.

fn paint_overlay(&self, _cx: &mut PaintCx<'_>, _anchor: Rect)

Draws the widget’s overlay after the whole view was painted, when it asked for one with PaintCx::request_overlay. anchor is the area the widget was painted in.

fn children(&self) -> &[Node<Msg>]

Child nodes, for widgets that contain other widgets.

fn children_mut(&mut self) -> &mut [Node<Msg>]

Mutable child nodes, used to assign ids.