Struct StepIndicatorState 

pub struct StepIndicatorState { /* private fields */ }

State for a StepIndicator component.

Implementations

impl StepIndicatorState

pub fn new(steps: Vec<Step>) -> Self

Creates a new step indicator with the given steps.

Example

use envision::component::step_indicator::{Step, StepStatus};
use envision::component::StepIndicatorState;

let steps = vec![
    Step::new("Step 1").with_status(StepStatus::Completed),
    Step::new("Step 2").with_status(StepStatus::Active),
    Step::new("Step 3"),
];
let state = StepIndicatorState::new(steps);
assert_eq!(state.steps().len(), 3);

pub fn with_orientation(self, orientation: StepOrientation) -> Self

Sets the orientation (builder pattern).

Example

use envision::component::step_indicator::{Step, StepOrientation};
use envision::component::StepIndicatorState;

let state = StepIndicatorState::new(vec![Step::new("A")])
    .with_orientation(StepOrientation::Vertical);
assert_eq!(state.orientation(), &StepOrientation::Vertical);

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

Sets the title (builder pattern).

Example

use envision::component::step_indicator::Step;
use envision::component::StepIndicatorState;

let state = StepIndicatorState::new(vec![Step::new("A")])
    .with_title("Pipeline");
assert_eq!(state.title(), Some("Pipeline"));

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

Sets the connector string (builder pattern).

Example

use envision::component::step_indicator::Step;
use envision::component::StepIndicatorState;

let state = StepIndicatorState::new(vec![Step::new("A")])
    .with_connector("-->");
assert_eq!(state.connector(), "-->");

pub fn with_show_descriptions(self, show: bool) -> Self

Sets whether descriptions are shown (builder pattern).

pub fn with_show_border(self, show: bool) -> Self

Sets whether the border is shown (builder pattern).

Defaults to true. When set to false, the StepIndicator renders its steps directly into the full widget area with no surrounding box — useful for inline breadcrumbs and single-row layouts.

Title interaction

When the border is hidden, the state’s title is not rendered. The title is drawn as part of the border block, so disabling the border silently suppresses it. If you want this to be explicit, set the title to None.

Example

use envision::component::step_indicator::Step;
use envision::component::StepIndicatorState;

let state = StepIndicatorState::new(vec![Step::new("A")])
    .with_show_border(false);
assert!(!state.show_border());

pub fn steps(&self) -> &[Step]

Returns the steps.

pub fn step(&self, index: usize) -> Option<&Step>

Returns a specific step, if it exists.

Example

use envision::component::step_indicator::Step;
use envision::component::StepIndicatorState;

let state = StepIndicatorState::new(vec![Step::new("Build"), Step::new("Test")]);
assert_eq!(state.step(0).unwrap().label(), "Build");
assert!(state.step(99).is_none());

pub fn orientation(&self) -> &StepOrientation

Returns the orientation.

pub fn focused_index(&self) -> usize

Returns the focused step index.

Example

use envision::component::step_indicator::Step;
use envision::component::StepIndicatorState;

let state = StepIndicatorState::new(vec![Step::new("A"), Step::new("B")]);
assert_eq!(state.focused_index(), 0);

pub fn active_step_index(&self) -> Option<usize>

Returns the index of the currently active step, if any.

Example

use envision::component::step_indicator::{Step, StepStatus};
use envision::component::StepIndicatorState;

let state = StepIndicatorState::new(vec![
    Step::new("Build").with_status(StepStatus::Completed),
    Step::new("Test").with_status(StepStatus::Active),
    Step::new("Deploy"),
]);
assert_eq!(state.active_step_index(), Some(1));

pub fn is_all_completed(&self) -> bool

Returns true if all steps are completed.

Example

use envision::component::step_indicator::{Step, StepStatus};
use envision::component::StepIndicatorState;

let state = StepIndicatorState::new(vec![
    Step::new("Build").with_status(StepStatus::Completed),
    Step::new("Test").with_status(StepStatus::Completed),
]);
assert!(state.is_all_completed());

pub fn connector(&self) -> &str

Returns the connector string.

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

Returns the title, if any.

pub fn set_title(&mut self, title: impl Into<String>)

Sets the title.

Example

use envision::component::StepIndicatorState;
use envision::component::step_indicator::Step;

let mut state = StepIndicatorState::new(vec![Step::new("Step 1")]);
state.set_title("Progress");
assert_eq!(state.title(), Some("Progress"));

pub fn show_descriptions(&self) -> bool

Returns whether descriptions are shown.

Example

use envision::component::StepIndicatorState;

let state = StepIndicatorState::default();
assert!(!state.show_descriptions());

pub fn show_border(&self) -> bool

Returns whether the border is shown.

Example

use envision::component::StepIndicatorState;

let state = StepIndicatorState::default();
assert!(state.show_border());

pub fn set_show_descriptions(&mut self, show: bool)

Sets whether descriptions are shown.

Example

use envision::component::StepIndicatorState;
use envision::component::step_indicator::Step;

let mut state = StepIndicatorState::new(vec![Step::new("A"), Step::new("B")]);
state.set_show_descriptions(true);
assert!(state.show_descriptions());

pub fn set_orientation(&mut self, orientation: StepOrientation)

Sets the orientation.

Example

use envision::component::StepIndicatorState;
use envision::component::step_indicator::{Step, StepOrientation};

let mut state = StepIndicatorState::new(vec![Step::new("A"), Step::new("B")]);
state.set_orientation(StepOrientation::Vertical);
assert_eq!(state.orientation(), &StepOrientation::Vertical);

pub fn set_show_border(&mut self, show: bool)

Sets whether the border is shown.

See with_show_border for the title interaction when show is false.

Example

use envision::component::StepIndicatorState;
use envision::component::step_indicator::Step;

let mut state = StepIndicatorState::new(vec![Step::new("A")]);
state.set_show_border(false);
assert!(!state.show_border());

pub fn update( &mut self, msg: StepIndicatorMessage, ) -> Option<StepIndicatorOutput>

Updates the state with a message, returning any output.

Example

use envision::component::{StepIndicatorState, StepIndicatorMessage, StepIndicatorOutput};
use envision::component::step_indicator::{Step, StepStatus};

let steps = vec![
    Step::new("Build").with_status(StepStatus::Active),
    Step::new("Test"),
];
let mut state = StepIndicatorState::new(steps);
let output = state.update(StepIndicatorMessage::CompleteActive);
assert!(matches!(output, Some(StepIndicatorOutput::StatusChanged { .. })));

Trait Implementations

impl Clone for StepIndicatorState

fn clone(&self) -> StepIndicatorState

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StepIndicatorState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StepIndicatorState

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StepIndicatorState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StepIndicatorState

fn eq(&self, other: &StepIndicatorState) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for StepIndicatorState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for StepIndicatorState

impl StructuralPartialEq for StepIndicatorState