freya_components/

select.rs

use freya_animation::prelude::*;
use freya_core::prelude::*;
use torin::prelude::*;

use crate::{
    define_theme,
    get_theme,
    icons::arrow::ArrowIcon,
    menu::MenuGroup,
};

define_theme! {
    %[component]
    pub Select {
        %[fields]
        width: Size,
        margin: Gaps,
        select_background: Color,
        background_button: Color,
        hover_background: Color,
        border_fill: Color,
        focus_border_fill: Color,
        arrow_fill: Color,
        color: Color,
    }
}

#[derive(Debug, Default, PartialEq, Clone, Copy)]
pub enum SelectStatus {
    #[default]
    Idle,
    Hovering,
}

/// Select between different items component.
///
/// # Example
///
/// ```rust
/// # use freya::prelude::*;
/// fn app() -> impl IntoElement {
///     let values = use_hook(|| {
///         vec![
///             "Rust".to_string(),
///             "Turbofish".to_string(),
///             "Crabs".to_string(),
///         ]
///     });
///     let mut selected_select = use_state(|| 0);
///
///     Select::new()
///         .selected_item(values[selected_select()].to_string())
///         .children(values.iter().enumerate().map(|(i, val)| {
///             MenuItem::new()
///                 .selected(selected_select() == i)
///                 .on_press(move |_| selected_select.set(i))
///                 .child(val.to_string())
///                 .into()
///         }))
/// }
///
/// # use freya_testing::prelude::*;
/// # use std::time::Duration;
/// # launch_doc(|| {
/// #   rect().center().expanded().child(app())
/// # }, "./images/gallery_select.png").with_hook(|t| { t.move_cursor((125., 125.)); t.click_cursor((125., 125.)); t.poll(Duration::from_millis(1), Duration::from_millis(350)); }).with_scale_factor(1.).render();
/// ```
///
/// # Preview
/// ![Select Preview][select]
#[cfg_attr(feature = "docs",
    doc = embed_doc_image::embed_image!("select", "images/gallery_select.png")
)]
#[derive(Clone, PartialEq)]
pub struct Select {
    pub(crate) theme: Option<SelectThemePartial>,
    selected_item: Option<Element>,
    children: Vec<Element>,
    cursor_icon: CursorIcon,
    key: DiffKey,
}

impl ChildrenExt for Select {
    fn get_children(&mut self) -> &mut Vec<Element> {
        &mut self.children
    }
}

impl KeyExt for Select {
    fn write_key(&mut self) -> &mut DiffKey {
        &mut self.key
    }
}

impl Default for Select {
    fn default() -> Self {
        Self::new()
    }
}

impl Select {
    pub fn new() -> Self {
        Self {
            theme: None,
            selected_item: None,
            children: Vec::new(),
            cursor_icon: CursorIcon::default(),
            key: DiffKey::None,
        }
    }

    pub fn theme(mut self, theme: SelectThemePartial) -> Self {
        self.theme = Some(theme);
        self
    }

    pub fn selected_item(mut self, item: impl Into<Element>) -> Self {
        self.selected_item = Some(item.into());
        self
    }

    /// Override the cursor icon shown when hovering over this component.
    pub fn cursor_icon(mut self, cursor_icon: impl Into<CursorIcon>) -> Self {
        self.cursor_icon = cursor_icon.into();
        self
    }
}

impl Component for Select {
    fn render(&self) -> impl IntoElement {
        let theme = get_theme!(&self.theme, SelectThemePreference, "select");
        let a11y_id = use_a11y();
        let focus = use_focus(a11y_id);
        let mut status = use_state(SelectStatus::default);
        let mut open = use_state(|| false);
        use_provide_context(|| MenuGroup { group_id: a11y_id });

        let animation = use_animation(move |conf| {
            conf.on_change(OnChange::Rerun);
            conf.on_creation(OnCreation::Finish);

            let scale = AnimNum::new(0.9, 1.)
                .time(125)
                .ease(Ease::Out)
                .function(Function::Quart);
            let opacity = AnimNum::new(0., 1.)
                .time(125)
                .ease(Ease::Out)
                .function(Function::Quart);
            let offset_y = AnimNum::new(-8., 1.)
                .time(125)
                .ease(Ease::Out)
                .function(Function::Quart);
            if open() {
                (scale, opacity, offset_y)
            } else {
                (
                    scale.into_reversed(),
                    opacity.into_reversed(),
                    offset_y.into_reversed(),
                )
            }
        });

        let cursor_icon = self.cursor_icon;
        use_drop(move || {
            if status() == SelectStatus::Hovering {
                Cursor::set(CursorIcon::default());
            }
        });

        // Close the select when the focused accessibility node changes and its not the select or any of its children
        use_side_effect(move || {
            let platform = Platform::get();
            if *platform.navigation_mode.read() == NavigationMode::Keyboard {
                let should_close = platform
                    .focused_accessibility_node
                    .read()
                    .member_of()
                    .is_none_or(|member_of| member_of != a11y_id);
                if should_close {
                    open.set_if_modified(false);
                }
            }
        });

        let on_press = move |e: Event<PressEventData>| {
            a11y_id.request_focus();
            open.toggle();
            // Prevent global mouse up
            e.prevent_default();
            e.stop_propagation();
        };

        let on_pointer_enter = move |_| {
            *status.write() = SelectStatus::Hovering;
            Cursor::set(cursor_icon);
        };

        let on_pointer_leave = move |_| {
            *status.write() = SelectStatus::Idle;
            Cursor::set(CursorIcon::default());
        };

        // Close the select if clicked anywhere
        let on_global_pointer_press = move |_: Event<PointerEventData>| {
            open.set_if_modified(false);
        };

        let on_global_key_down = move |e: Event<KeyboardEventData>| match e.key {
            Key::Named(NamedKey::Escape) => {
                open.set_if_modified(false);
            }
            Key::Named(NamedKey::Enter) if a11y_id.is_focused() => {
                open.toggle();
            }
            _ => {}
        };

        let (scale, opacity, offset_y) = animation.read().value();

        let background = match *status.read() {
            SelectStatus::Hovering => theme.hover_background,
            SelectStatus::Idle => theme.background_button,
        };

        let border = if focus() == Focus::Keyboard {
            Border::new()
                .fill(theme.focus_border_fill)
                .width(2.)
                .alignment(BorderAlignment::Inner)
        } else {
            Border::new()
                .fill(theme.border_fill)
                .width(1.)
                .alignment(BorderAlignment::Inner)
        };

        rect()
            .child(
                rect()
                    .a11y_id(a11y_id)
                    .a11y_member_of(a11y_id)
                    .a11y_role(AccessibilityRole::ListBox)
                    .a11y_focusable(Focusable::Enabled)
                    .on_pointer_enter(on_pointer_enter)
                    .on_pointer_leave(on_pointer_leave)
                    .on_press(on_press)
                    .on_global_key_down(on_global_key_down)
                    .on_global_pointer_press(on_global_pointer_press)
                    .width(theme.width)
                    .margin(theme.margin)
                    .background(background)
                    .padding((8., 18., 8., 18.))
                    .border(border)
                    .horizontal()
                    .center()
                    .color(theme.color)
                    .corner_radius(8.)
                    .maybe_child(self.selected_item.clone())
                    .child(
                        ArrowIcon::new()
                            .margin((0., 0., 0., 8.))
                            .rotate(0.)
                            .fill(theme.arrow_fill),
                    ),
            )
            .maybe_child((open() || opacity > 0.).then(|| {
                rect().height(Size::px(0.)).width(Size::px(0.)).child(
                    rect()
                        .width(Size::window_percent(100.))
                        .margin(Gaps::new(4., 0., 0., 0.))
                        .offset_y(offset_y)
                        .child(
                            rect()
                                .layer(Layer::Overlay)
                                .border(
                                    Border::new()
                                        .fill(theme.border_fill)
                                        .width(1.)
                                        .alignment(BorderAlignment::Inner),
                                )
                                .overflow(Overflow::Clip)
                                .corner_radius(8.)
                                .background(theme.select_background)
                                .padding(4.)
                                .content(Content::Fit)
                                .opacity(opacity)
                                .scale(scale)
                                .children(self.children.clone()),
                        ),
                )
            }))
    }

    fn render_key(&self) -> DiffKey {
        self.key.clone().or(self.default_key())
    }
}