Struct CalendarState 

pub struct CalendarState { /* private fields */ }

State for a Calendar component.

Example

use envision::component::CalendarState;

let state = CalendarState::new(2026, 3)
    .with_selected_day(15)
    .with_title("Events");
assert_eq!(state.year(), 2026);
assert_eq!(state.month(), 3);
assert_eq!(state.selected_day(), Some(15));
assert_eq!(state.month_name(), "March");

Implementations

impl CalendarState

pub fn new(year: i32, month: u32) -> Self

Creates a new calendar for the given year and month.

Example

use envision::component::CalendarState;

let state = CalendarState::new(2026, 3);
assert_eq!(state.year(), 2026);
assert_eq!(state.month(), 3);
assert_eq!(state.selected_day(), None);

pub fn with_selected_day(self, day: u32) -> Self

Sets the initially selected day (builder method).

Example

use envision::component::CalendarState;

let state = CalendarState::new(2026, 3).with_selected_day(15);
assert_eq!(state.selected_day(), Some(15));

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

Sets the title (builder method).

Example

use envision::component::CalendarState;

let state = CalendarState::new(2026, 3).with_title("My Calendar");

pub fn with_event(self, year: i32, month: u32, day: u32, color: Color) -> Self

Adds an event marker (builder method).

Example

use envision::component::CalendarState;
use ratatui::style::Color;

let state = CalendarState::new(2026, 3)
    .with_event(2026, 3, 15, Color::Green);
assert!(state.has_event(2026, 3, 15));

pub fn year(&self) -> i32

Returns the current year.

Example

use envision::component::CalendarState;

let state = CalendarState::new(2026, 3);
assert_eq!(state.year(), 2026);

pub fn month(&self) -> u32

Returns the current month (1-12).

Example

use envision::component::CalendarState;

let state = CalendarState::new(2026, 3);
assert_eq!(state.month(), 3);

pub fn selected_day(&self) -> Option<u32>

Returns the currently selected day, if any.

Example

use envision::component::CalendarState;

let state = CalendarState::new(2026, 3).with_selected_day(20);
assert_eq!(state.selected_day(), Some(20));

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

Returns the title, if set.

Example

use envision::component::CalendarState;

let state = CalendarState::new(2026, 3).with_title("My Calendar");
assert_eq!(state.title(), Some("My Calendar"));

let state2 = CalendarState::new(2026, 3);
assert_eq!(state2.title(), None);

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

Sets the title.

Example

use envision::component::CalendarState;

let mut state = CalendarState::new(2026, 3);
state.set_title("Events");
assert_eq!(state.title(), Some("Events"));

pub fn set_selected_day(&mut self, day: Option<u32>)

Sets the selected day.

Example

use envision::component::CalendarState;

let mut state = CalendarState::new(2026, 3);
state.set_selected_day(Some(15));
assert_eq!(state.selected_day(), Some(15));
state.set_selected_day(None);
assert_eq!(state.selected_day(), None);

pub fn month_name(&self) -> &str

Returns the name of the current month.

Example

use envision::component::CalendarState;

let state = CalendarState::new(2026, 1);
assert_eq!(state.month_name(), "January");

pub fn add_event(&mut self, year: i32, month: u32, day: u32, color: Color)

Adds an event marker for the given date with the given color.

Example

use envision::component::CalendarState;
use ratatui::style::Color;

let mut state = CalendarState::new(2026, 3);
state.add_event(2026, 3, 15, Color::Red);
assert!(state.has_event(2026, 3, 15));

pub fn clear_events(&mut self)

Removes all event markers.

Example

use envision::component::CalendarState;
use ratatui::style::Color;

let mut state = CalendarState::new(2026, 3);
state.add_event(2026, 3, 15, Color::Red);
state.clear_events();
assert!(!state.has_event(2026, 3, 15));

pub fn has_event(&self, year: i32, month: u32, day: u32) -> bool

Returns whether there is an event marker for the given date.

Example

use envision::component::CalendarState;
use ratatui::style::Color;

let state = CalendarState::new(2026, 3)
    .with_event(2026, 3, 15, Color::Green);
assert!(state.has_event(2026, 3, 15));
assert!(!state.has_event(2026, 3, 16));

pub fn update(&mut self, msg: CalendarMessage) -> Option<CalendarOutput>

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

Example

use envision::component::{CalendarMessage, CalendarOutput, CalendarState};

let mut state = CalendarState::new(2026, 3);
let output = state.update(CalendarMessage::NextMonth);
assert_eq!(output, Some(CalendarOutput::MonthChanged(2026, 4)));

Trait Implementations

impl Clone for CalendarState

fn clone(&self) -> CalendarState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CalendarState

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

Formats the value using the given formatter.

impl Default for CalendarState

fn default() -> Self

Returns a calendar for January 1970 with no selected day, no events, and no title.

This mirrors the conventional Unix epoch default used by date libraries like chrono’s NaiveDate::default(). For meaningful UI, construct state with CalendarState::new for the desired year and month.

Example

use envision::component::CalendarState;

let state = CalendarState::default();
assert_eq!(state.year(), 1970);
assert_eq!(state.month(), 1);
assert_eq!(state.selected_day(), None);

impl<'de> Deserialize<'de> for CalendarState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CalendarState

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

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 CalendarState