Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduces date selector to xilem #567

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions xilem/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ crate-type = ["cdylib"]
[[example]]
name = "calc"

[[example]]
name = "calendar"

[[example]]
name = "calc_android"
path = "examples/calc.rs"
Expand Down Expand Up @@ -66,11 +69,9 @@ vello.workspace = true
smallvec.workspace = true
accesskit.workspace = true
tokio = { version = "1.39.1", features = ["rt", "rt-multi-thread", "time"] }

[dev-dependencies]
# Used for `variable_clock`
time = { workspace = true, features = ["local-offset"] }

[dev-dependencies]
# Make wgpu use tracing for its spans.
profiling = { version = "1.0.15", features = ["profile-with-tracing"] }

Expand Down
70 changes: 70 additions & 0 deletions xilem/examples/calendar.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
// Copyright 2024 the Xilem Authors
// SPDX-License-Identifier: Apache-2.0
use masonry::widget::{CrossAxisAlignment, MainAxisAlignment};
use time::{Date, OffsetDateTime};
use winit::error::EventLoopError;
use xilem::{
view::{button, flex, label, Axis, DatePicker, DatePickerMessage},
EventLoop, WidgetView, Xilem,
};
use xilem_core::{adapt, MessageResult};

struct Calendar {
selected_date: Date,
date: DatePicker,
}

impl Calendar {
fn new() -> Self {
let now = OffsetDateTime::now_utc();
Self {
selected_date: now.date(),
date: DatePicker::new(now.month(), now.year()),
}
}
}
fn selected_date(selected_date: Date) -> impl WidgetView<Calendar> {
flex((label("Selected date:"), label(format!("{selected_date}")))).direction(Axis::Horizontal)
}

/// A component to make a bigger than usual button
fn external_controls() -> impl WidgetView<Calendar> {
flex((
button("Today", |data: &mut Calendar| {
data.selected_date = OffsetDateTime::now_utc().date();
}),
button("Tomorrow", |data: &mut Calendar| {
data.selected_date = OffsetDateTime::now_utc().date().next_day().unwrap();
}),
))
.direction(Axis::Horizontal)
}

fn app_logic(data: &mut Calendar) -> impl WidgetView<Calendar> {
flex((
selected_date(data.selected_date),
external_controls(),
adapt(
data.date.view(&mut data.selected_date),
|state: &mut Calendar, thunk| match thunk.call(&mut state.date) {
MessageResult::Action(DatePickerMessage::Select(date)) => {
state.selected_date = date;
MessageResult::Action(())
}
MessageResult::Action(DatePickerMessage::Nop) => MessageResult::Nop,
MessageResult::Action(DatePickerMessage::ChangeView) => MessageResult::Action(()),
message_result => message_result.map(|_| ()),
},
),
))
.direction(Axis::Vertical)
.cross_axis_alignment(CrossAxisAlignment::Center)
.main_axis_alignment(MainAxisAlignment::Center)
}

fn main() -> Result<(), EventLoopError> {
let data = Calendar::new();
let app = Xilem::new(data, app_logic);
app.run_windowed(EventLoop::with_user_event(), "Calendar".into())?;
Ok(())
}
120 changes: 120 additions & 0 deletions xilem/src/view/date_picker.rs
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if this should live in a components folder? From a developer of Xilem perspective, there is a meaningful difference between "raw" views and composed components. But from an end-user perspective, they are the same.

I don't know what the right answer is here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am going to actually create an RFC to discuss this among ither things that i have in mind. For now I would suggest to do both. In the internal folder organisation there should be a primitives folder and a components folder but at the tip the should all be re-exported together. Does this sound reasonable?

Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
use masonry::widget::{Axis, CrossAxisAlignment, MainAxisAlignment};
use time::{Date, Month, OffsetDateTime};

use crate::{view::sized_box, WidgetView};

use super::{button, flex, FlexSpacer};

pub enum DatePickerMessage {
Select(Date),
ChangeView,
Nop,
}

pub struct DatePicker {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should have some docs here.

previous_date: Date,
month: Month,
year: i32,
}

impl DatePicker {
pub fn new(month: Month, year: i32) -> Self {
let previous_date = OffsetDateTime::now_utc().date();
Self {
previous_date,
month,
year,
}
}

pub fn view(
&mut self,
selected_date: &mut Date,
) -> impl WidgetView<DatePicker, DatePickerMessage> {
if self.previous_date != *selected_date {
self.month = selected_date.month();
self.year = selected_date.year();
self.previous_date = selected_date.clone();
}
flex((self.date_controls(), self.date_grid(selected_date)))
.direction(Axis::Vertical)
.cross_axis_alignment(CrossAxisAlignment::Center)
.main_axis_alignment(MainAxisAlignment::Center)
}

fn date_controls(&self) -> impl WidgetView<DatePicker, DatePickerMessage> {
let month = self.month;
let year = self.year;

flex((
button("<", |data: &mut DatePicker| {
data.month = data.month.previous();
DatePickerMessage::ChangeView
}),
sized_box(button(format!("{month}"), |_| DatePickerMessage::Nop)).width(100.),
button(">", |data: &mut DatePicker| {
data.month = data.month.next();
DatePickerMessage::ChangeView
}),
FlexSpacer::Fixed(40.),
button("<", |data: &mut DatePicker| {
data.year -= 1;
DatePickerMessage::ChangeView
}),
button(format!("{year}"), |_| DatePickerMessage::Nop),
button(">", |data: &mut DatePicker| {
data.year += 1;
DatePickerMessage::ChangeView
}),
))
.direction(Axis::Horizontal)
.main_axis_alignment(MainAxisAlignment::Center)
}

// The selected_date in the interface is needed to highlight the currently selected date
// It is currently not implemented
fn date_grid(
&self,
_selected_date: &mut Date,
) -> impl WidgetView<DatePicker, DatePickerMessage> {
const COLUMNS: u8 = 7;
const ROWS: u8 = 5;
let mut date = Date::from_calendar_date(self.year, self.month, 1).unwrap();
let days_from_monday = date.weekday().number_days_from_monday();

for _day in 0..days_from_monday {
date = date.previous_day().unwrap();
}

let mut rows = Vec::new();
for _row in 0..ROWS {
let mut columns = Vec::new();
for _column in 0..COLUMNS {
// Add buttons of each row into columns vec
let day_number = date.day();
columns.push(
sized_box(button(
format!("{day_number}"),
move |data: &mut DatePicker| {
// Set the selected_date
data.previous_date = date;
DatePickerMessage::Select(date)
},
))
.width(50.),
);
date = date.next_day().unwrap();
}
// Add column vec into flex with horizontal axis
// Add flex into rows vec
rows.push(
flex(columns)
.direction(Axis::Horizontal)
.main_axis_alignment(MainAxisAlignment::Center)
.gap(10.),
);
}
// Add row vec into flex with vertical axis
flex(rows).direction(Axis::Vertical)
}
}
3 changes: 3 additions & 0 deletions xilem/src/view/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,6 @@ pub use textbox::*;

mod portal;
pub use portal::*;

mod date_picker;
pub use date_picker::*;
Loading