Struct DateRangePickerState 

pub struct DateRangePickerState { /* private fields */ }

Selection, date restrictions, visible month, and input mode for a date range.

A range includes both endpoints. Date restrictions apply to its endpoints; unavailable dates between them do not split the selected range.

Implementations

impl DateRangePickerState

pub fn new( start: Option<CalendarDate>, end: Option<CalendarDate>, displayed_month: Option<YearMonth>, year_range: RangeInclusive<i32>, is_selectable_date: Option<CallbackWith<CalendarDate, bool>>, is_selectable_year: Option<CallbackWith<i32, bool>>, display_mode: DatePickerDisplayMode, ) -> Self

Creates a range picker. Invalid initial endpoints are discarded.

pub fn selected_start_date(&self) -> Option<CalendarDate>

Returns the inclusive start date, including an unfinished selection.

pub fn selected_end_date(&self) -> Option<CalendarDate>

Returns the inclusive end date when the selection is complete.

pub fn is_complete(&self) -> bool

Returns whether both endpoints are selected.

pub fn set_selection( &mut self, start: Option<CalendarDate>, end: Option<CalendarDate>, ) -> bool

Sets both endpoints atomically, returning false without changing an invalid range.

An end requires a start on or before it. Both endpoints must be selectable.

pub fn select_date(&mut self, date: CalendarDate) -> bool

Selects the next endpoint, restarting after a complete range or an earlier date.

pub fn clear_selection(&mut self)

Clears both endpoints without moving the calendar.

pub fn is_date_selectable(&self, date: CalendarDate) -> bool

Returns whether the date can be used as an endpoint.

pub fn year_range(&self) -> &RangeInclusive<i32>

Returns the allowed year range.

pub fn set_year_range(&mut self, range: RangeInclusive<i32>)

Updates the year range, clearing endpoints that are no longer selectable.

pub fn set_is_selectable_date( &mut self, predicate: Option<CallbackWith<CalendarDate, bool>>, )

Updates endpoint date restrictions, clearing invalid selections.

pub fn set_is_selectable_year( &mut self, predicate: Option<CallbackWith<i32, bool>>, )

Updates endpoint year restrictions, clearing invalid selections.

pub fn displayed_month(&self) -> YearMonth

Returns the first visible calendar month.

pub fn set_displayed_month(&mut self, month: YearMonth)

Scrolls to a month, clamped to the allowed year range.

pub fn display_mode(&self) -> DatePickerDisplayMode

Returns the calendar or manual-input mode.

pub fn set_display_mode(&mut self, mode: DatePickerDisplayMode)

Changes input mode, showing the selected start month when returning to the calendar.

pub fn toggle_display_mode(&mut self)

Switches between calendar and manual input.

Trait Implementations

impl Default for DateRangePickerState

fn default() -> Self

Returns the “default value” for a type.