dioxus/packages/dioxus-tui/tests/events.rs

use crossterm::event::{Event, KeyCode, KeyEvent, KeyModifiers, MouseButton, MouseEvent};
use dioxus::prelude::*;
use dioxus_html::input_data::keyboard_types::Code;
use dioxus_tui::TuiContext;
use std::future::Future;
use std::pin::Pin;
use std::task::{Context, Poll};

/// The tui renderer will look for any event that has occured or any future that has resolved in a loop.
/// It will resolve at most one event per loop.
/// This future will resolve after a certain number of polls. If the number of polls is greater than the number of events triggered, and the event has not been recieved there is an issue with the event system.
struct PollN(usize);
impl PollN {
    fn new(n: usize) -> Self {
        PollN(n)
    }
}
impl Future for PollN {
    type Output = ();

    fn poll(mut self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Self::Output> {
        if self.0 == 0 {
            Poll::Ready(())
        } else {
            self.0 -= 1;
            Poll::Pending
        }
    }
}

#[test]
fn key_down() {
    dioxus_tui::launch_cfg(app, dioxus_tui::Config::new().with_headless());

    fn app(cx: Scope) -> Element {
        let render_count = use_state(cx, || 0);
        let tui_ctx: TuiContext = cx.consume_context().unwrap();
        let render_count_handle = render_count.clone();
        cx.spawn(async move {
            PollN::new(3).await;
            render_count_handle.modify(|x| *x + 1);
        });
        if *render_count.get() > 2 {
            panic!("Event was not received");
        }
        // focus the element
        tui_ctx.inject_event(Event::Key(KeyEvent {
            code: KeyCode::Tab,
            modifiers: KeyModifiers::NONE,
            kind: crossterm::event::KeyEventKind::Press,
            state: crossterm::event::KeyEventState::NONE,
        }));
        tui_ctx.inject_event(Event::Key(KeyEvent {
            code: KeyCode::Char('a'),
            modifiers: KeyModifiers::NONE,
            kind: crossterm::event::KeyEventKind::Press,
            state: crossterm::event::KeyEventState::NONE,
        }));
        cx.render(rsx! {
            div {
                width: "100%",
                height: "100%",
                onkeydown: move |evt| {
                    assert_eq!(evt.data.code(), Code::KeyA);
                    tui_ctx.quit();
                }
            }
        })
    }
}

#[test]
fn mouse_down() {
    dioxus_tui::launch_cfg(app, dioxus_tui::Config::new().with_headless());

    fn app(cx: Scope) -> Element {
        let render_count = use_state(cx, || 0);
        let tui_ctx: TuiContext = cx.consume_context().unwrap();
        let render_count_handle = render_count.clone();
        cx.spawn(async move {
            PollN::new(2).await;
            render_count_handle.modify(|x| *x + 1);
        });
        if *render_count.get() > 2 {
            panic!("Event was not received");
        }
        tui_ctx.inject_event(Event::Mouse(MouseEvent {
            column: 0,
            row: 0,
            kind: crossterm::event::MouseEventKind::Down(MouseButton::Left),
            modifiers: KeyModifiers::NONE,
        }));
        cx.render(rsx! {
            div {
                width: "100%",
                height: "100%",
                onmousedown: move |evt| {
                    assert!(
                        evt.data.held_buttons().contains(dioxus_html::input_data::MouseButton::Primary)
                    );
                    tui_ctx.quit();
                }
            }
        })
    }
}

#[test]
fn mouse_up() {
    dioxus_tui::launch_cfg(app, dioxus_tui::Config::new().with_headless());

    fn app(cx: Scope) -> Element {
        let render_count = use_state(cx, || 0);
        let tui_ctx: TuiContext = cx.consume_context().unwrap();
        let render_count_handle = render_count.clone();
        cx.spawn(async move {
            PollN::new(3).await;
            render_count_handle.modify(|x| *x + 1);
        });
        if *render_count.get() > 2 {
            panic!("Event was not received");
        }
        tui_ctx.inject_event(Event::Mouse(MouseEvent {
            column: 0,
            row: 0,
            kind: crossterm::event::MouseEventKind::Down(MouseButton::Left),
            modifiers: KeyModifiers::NONE,
        }));
        tui_ctx.inject_event(Event::Mouse(MouseEvent {
            column: 0,
            row: 0,
            kind: crossterm::event::MouseEventKind::Up(MouseButton::Left),
            modifiers: KeyModifiers::NONE,
        }));
        cx.render(rsx! {
            #[dxfmt::skip]
            div {
                width: "100%",
                height: "100%",
                onmouseup: move |_| {
                    tui_ctx.quit();
                }
            }
        })
    }
}

#[test]
fn mouse_enter() {
    dioxus_tui::launch_cfg(app, dioxus_tui::Config::new().with_headless());

    fn app(cx: Scope) -> Element {
        let render_count = use_state(cx, || 0);
        let tui_ctx: TuiContext = cx.consume_context().unwrap();
        let render_count_handle = render_count.clone();
        cx.spawn(async move {
            PollN::new(3).await;
            render_count_handle.modify(|x| *x + 1);
        });
        if *render_count.get() > 2 {
            panic!("Event was not received");
        }
        tui_ctx.inject_event(Event::Mouse(MouseEvent {
            column: 100,
            row: 100,
            kind: crossterm::event::MouseEventKind::Moved,
            modifiers: KeyModifiers::NONE,
        }));
        tui_ctx.inject_event(Event::Mouse(MouseEvent {
            column: 0,
            row: 0,
            kind: crossterm::event::MouseEventKind::Moved,
            modifiers: KeyModifiers::NONE,
        }));
        cx.render(rsx! {
            #[dxfmt::skip]
            div {
                width: "50%",
                height: "50%",
                onmouseenter: move |_| {
                    tui_ctx.quit();
                }
            }
        })
    }
}

#[test]
fn mouse_exit() {
    dioxus_tui::launch_cfg(app, dioxus_tui::Config::new().with_headless());

    fn app(cx: Scope) -> Element {
        let render_count = use_state(cx, || 0);
        let tui_ctx: TuiContext = cx.consume_context().unwrap();
        let render_count_handle = render_count.clone();
        cx.spawn(async move {
            PollN::new(3).await;
            render_count_handle.modify(|x| *x + 1);
        });
        if *render_count.get() > 2 {
            panic!("Event was not received");
        }
        tui_ctx.inject_event(Event::Mouse(MouseEvent {
            column: 0,
            row: 0,
            kind: crossterm::event::MouseEventKind::Moved,
            modifiers: KeyModifiers::NONE,
        }));
        tui_ctx.inject_event(Event::Mouse(MouseEvent {
            column: 100,
            row: 100,
            kind: crossterm::event::MouseEventKind::Moved,
            modifiers: KeyModifiers::NONE,
        }));
        cx.render(rsx! {
            #[dxfmt::skip]
            div {
                width: "50%",
                height: "50%",
                onmouseenter: move |_| {
                    tui_ctx.quit();
                }
            }
        })
    }
}

#[test]
fn mouse_move() {
    dioxus_tui::launch_cfg(app, dioxus_tui::Config::new().with_headless());

    fn app(cx: Scope) -> Element {
        let render_count = use_state(cx, || 0);
        let tui_ctx: TuiContext = cx.consume_context().unwrap();
        let render_count_handle = render_count.clone();
        cx.spawn(async move {
            PollN::new(3).await;
            render_count_handle.modify(|x| *x + 1);
        });
        if *render_count.get() > 2 {
            panic!("Event was not received");
        }
        tui_ctx.inject_event(Event::Mouse(MouseEvent {
            column: 40,
            row: 40,
            kind: crossterm::event::MouseEventKind::Moved,
            modifiers: KeyModifiers::NONE,
        }));
        tui_ctx.inject_event(Event::Mouse(MouseEvent {
            column: 60,
            row: 60,
            kind: crossterm::event::MouseEventKind::Moved,
            modifiers: KeyModifiers::NONE,
        }));
        cx.render(rsx! {
            #[dxfmt::skip]
            div {
                width: "100%",
                height: "100%",
                onmousemove: move |_| {
                    tui_ctx.quit();
                }
            }
        })
    }
}

#[test]
fn wheel() {
    dioxus_tui::launch_cfg(app, dioxus_tui::Config::new().with_headless());

    fn app(cx: Scope) -> Element {
        let render_count = use_state(cx, || 0);
        let tui_ctx: TuiContext = cx.consume_context().unwrap();
        let render_count_handle = render_count.clone();
        cx.spawn(async move {
            PollN::new(3).await;
            render_count_handle.modify(|x| *x + 1);
        });
        if *render_count.get() > 2 {
            panic!("Event was not received");
        }
        tui_ctx.inject_event(Event::Mouse(MouseEvent {
            column: 50,
            row: 50,
            kind: crossterm::event::MouseEventKind::Moved,
            modifiers: KeyModifiers::NONE,
        }));
        tui_ctx.inject_event(Event::Mouse(MouseEvent {
            column: 50,
            row: 50,
            kind: crossterm::event::MouseEventKind::ScrollDown,
            modifiers: KeyModifiers::NONE,
        }));
        cx.render(rsx! {
            div {
                width: "100%",
                height: "100%",
                onwheel: move |evt| {
                    assert!(evt.data.delta().strip_units().y > 0.0);
                    tui_ctx.quit();
                }
            }
        })
    }
}

#[test]
fn click() {
    dioxus_tui::launch_cfg(app, dioxus_tui::Config::new().with_headless());

    fn app(cx: Scope) -> Element {
        let render_count = use_state(cx, || 0);
        let tui_ctx: TuiContext = cx.consume_context().unwrap();
        let render_count_handle = render_count.clone();
        cx.spawn(async move {
            PollN::new(3).await;
            render_count_handle.modify(|x| *x + 1);
        });
        if *render_count.get() > 2 {
            panic!("Event was not received");
        }
        tui_ctx.inject_event(Event::Mouse(MouseEvent {
            column: 50,
            row: 50,
            kind: crossterm::event::MouseEventKind::Down(MouseButton::Left),
            modifiers: KeyModifiers::NONE,
        }));
        tui_ctx.inject_event(Event::Mouse(MouseEvent {
            column: 50,
            row: 50,
            kind: crossterm::event::MouseEventKind::Up(MouseButton::Left),
            modifiers: KeyModifiers::NONE,
        }));
        cx.render(rsx! {
            #[dxfmt::skip]
            div {
                width: "100%",
                height: "100%",
                onclick: move |_| {
                    tui_ctx.quit();
                }
            }
        })
    }
}

#[test]
fn context_menu() {
    dioxus_tui::launch_cfg(app, dioxus_tui::Config::new().with_headless());

    fn app(cx: Scope) -> Element {
        let render_count = use_state(cx, || 0);
        let tui_ctx: TuiContext = cx.consume_context().unwrap();
        let render_count_handle = render_count.clone();
        cx.spawn(async move {
            PollN::new(3).await;
            render_count_handle.modify(|x| *x + 1);
        });
        if *render_count.get() > 2 {
            panic!("Event was not received");
        }
        tui_ctx.inject_event(Event::Mouse(MouseEvent {
            column: 50,
            row: 50,
            kind: crossterm::event::MouseEventKind::Down(MouseButton::Right),
            modifiers: KeyModifiers::NONE,
        }));
        tui_ctx.inject_event(Event::Mouse(MouseEvent {
            column: 50,
            row: 50,
            kind: crossterm::event::MouseEventKind::Up(MouseButton::Right),
            modifiers: KeyModifiers::NONE,
        }));
        cx.render(rsx! {
            #[dxfmt::skip]
            div {
                width: "100%",
                height: "100%",
                oncontextmenu: move |_| {
                    tui_ctx.quit();
                }
            }
        })
    }
}