Struct SelectState 

pub struct SelectState { /* private fields */ }

State for a Select component.

Implementations

impl SelectState

pub fn new<S: Into<String>>(options: Vec<S>) -> Self

Creates a new select with the given options.

Example

use envision::component::SelectState;

let state = SelectState::new(vec!["Option 1", "Option 2", "Option 3"]);
assert_eq!(state.options().len(), 3);
assert!(state.selected_index().is_none());

pub fn with_selection<S: Into<String>>(options: Vec<S>, selected: usize) -> Self

Creates a new select with the given options and a pre-selected index.

Example

use envision::component::SelectState;

let state = SelectState::with_selection(vec!["A", "B", "C"], 1);
assert_eq!(state.selected_index(), Some(1));

pub fn options(&self) -> &[String]

Returns the options list.

Examples

use envision::prelude::*;

let state = SelectState::new(vec!["Red", "Green", "Blue"]);
assert_eq!(state.options(), &["Red", "Green", "Blue"]);

pub fn set_options<S: Into<String>>(&mut self, options: Vec<S>)

Sets the options list.

Resets selection if the current selected index is out of bounds.

Examples

use envision::prelude::*;

let mut state = SelectState::with_selection(vec!["A", "B"], 1);
state.set_options(vec!["X", "Y", "Z"]);
assert_eq!(state.options(), &["X", "Y", "Z"]);
assert_eq!(state.selected_index(), Some(1));

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

Returns the selected option index.

Examples

use envision::prelude::*;

let state = SelectState::new(vec!["A", "B"]);
assert_eq!(state.selected_index(), None);

let state = SelectState::with_selection(vec!["A", "B"], 0);
assert_eq!(state.selected_index(), Some(0));

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

Alias for selected_index().

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

Returns the selected option value.

Examples

use envision::prelude::*;

let state = SelectState::with_selection(vec!["Red", "Green", "Blue"], 2);
assert_eq!(state.selected_value(), Some("Blue"));

let state = SelectState::new(vec!["Red", "Green", "Blue"]);
assert_eq!(state.selected_value(), None);

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

Returns the selected option value as a string reference.

This is an alias for selected_value() that provides a consistent accessor name across all selection-based components.

Examples

use envision::prelude::*;

let state = SelectState::with_selection(vec!["Red", "Green"], 0);
assert_eq!(state.selected_item(), Some("Red"));

pub fn set_selected(&mut self, index: Option<usize>)

Sets the selected option index.

Examples

use envision::prelude::*;

let mut state = SelectState::new(vec!["A", "B", "C"]);
state.set_selected(Some(2));
assert_eq!(state.selected_value(), Some("C"));

state.set_selected(None);
assert_eq!(state.selected_value(), None);

pub fn is_open(&self) -> bool

Returns true if the dropdown is open.

Examples

use envision::prelude::*;

let mut state = SelectState::new(vec!["A", "B"]);
assert!(!state.is_open());

state.update(SelectMessage::Open);
assert!(state.is_open());

pub fn placeholder(&self) -> &str

Returns the placeholder text.

Examples

use envision::prelude::*;

let state = SelectState::new(vec!["A", "B"]);
assert_eq!(state.placeholder(), "Select...");

pub fn set_placeholder(&mut self, placeholder: impl Into<String>)

Sets the placeholder text.

Examples

use envision::prelude::*;

let mut state = SelectState::new(vec!["A", "B"]);
state.set_placeholder("Pick one...");
assert_eq!(state.placeholder(), "Pick one...");

pub fn with_placeholder(self, placeholder: impl Into<String>) -> Self

Sets the placeholder text (builder pattern).

Example

use envision::component::SelectState;

let state = SelectState::new(vec!["Red", "Green", "Blue"])
    .with_placeholder("Choose a color...");
assert_eq!(state.placeholder(), "Choose a color...");

pub fn update(&mut self, msg: SelectMessage) -> Option<SelectOutput>

Updates the select state with a message, returning any output.

Examples

use envision::prelude::*;

let mut state = SelectState::new(vec!["Apple", "Banana", "Cherry"]);
state.update(SelectMessage::Open);
state.update(SelectMessage::Down);
let output = state.update(SelectMessage::Confirm);
assert_eq!(output, Some(SelectOutput::Selected("Banana".to_string())));

Trait Implementations

impl Clone for SelectState

fn clone(&self) -> SelectState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SelectState

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

Formats the value using the given formatter.

impl Default for SelectState

fn default() -> Self

Creates a default empty select with "Select..." placeholder.

Example

use envision::component::SelectState;

let state = SelectState::default();
assert!(state.options().is_empty());
assert!(state.selected_index().is_none());
assert_eq!(state.placeholder(), "Select...");

impl<'de> Deserialize<'de> for SelectState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SelectState

fn eq(&self, other: &SelectState) -> 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 SelectState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SelectState