freya_hooks/
use_accessibility.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
use std::{cell::RefCell, rc::Rc};

use dioxus_core::{
    prelude::{consume_context, spawn, try_consume_context},
    use_hook,
};
use dioxus_hooks::{use_context_provider, use_effect};
use dioxus_signals::{Readable, Signal, Writable};
use freya_common::EventMessage;
use freya_core::{
    navigation_mode::{NavigationMode, NavigatorState},
    types::FocusReceiver,
};

use freya_core::{accessibility::ACCESSIBILITY_ROOT_ID, types::AccessibilityId};

use crate::use_platform;

pub type AccessibilityIdCounter = Rc<RefCell<u64>>;

#[derive(Clone)]
pub struct NavigationMark(bool);

impl NavigationMark {
    pub fn allowed(&self) -> bool {
        self.0
    }

    pub fn set_allowed(&mut self, allowed: bool) {
        self.0 = allowed;
    }
}

/// Sync both the Focus shared state and the platform accessibility focus
pub fn use_init_accessibility() -> Signal<NavigationMark> {
    let mut focused_id =
        use_context_provider::<Signal<AccessibilityId>>(|| Signal::new(ACCESSIBILITY_ROOT_ID));
    let mut navigation_mode =
        use_context_provider::<Signal<NavigationMode>>(|| Signal::new(NavigationMode::NotKeyboard));
    use_context_provider(|| Rc::new(RefCell::new(0u64)));
    let platform = use_platform();
    let navigation_mark = use_context_provider(|| Signal::new(NavigationMark(true)));

    // Tell the renderer the new focused node
    use_effect(move || {
        platform
            .send(EventMessage::FocusAccessibilityNode(*focused_id.read()))
            .unwrap();
    });

    use_hook(|| {
        let focus_id_listener = try_consume_context::<FocusReceiver>();
        let navigation_state = consume_context::<NavigatorState>();

        // Listen for focus changes
        spawn(async move {
            let focus_id_listener = focus_id_listener.clone();
            if let Some(mut focus_id_listener) = focus_id_listener {
                while focus_id_listener.changed().await.is_ok() {
                    *focused_id.write() = *focus_id_listener.borrow();
                }
            }
        });

        // Listen for navigation mode changes
        spawn(async move {
            let mut getter = navigation_state.getter();
            while getter.changed().await.is_ok() {
                *navigation_mode.write() = *getter.borrow();
            }
        });
    });

    navigation_mark
}

#[cfg(test)]
mod test {
    use freya::prelude::*;
    use freya_core::{accessibility::ACCESSIBILITY_ROOT_ID, events::EventName};
    use freya_testing::prelude::*;

    #[tokio::test]
    pub async fn focus_accessibility() {
        #[allow(non_snake_case)]
        fn OtherChild() -> Element {
            let mut focus_manager = use_focus();

            rsx!(rect {
                width: "100%",
                height: "50%",
                onclick: move |_| focus_manager.focus(),
            })
        }

        fn use_focus_app() -> Element {
            rsx!(
                rect {
                    width: "100%",
                    height: "100%",
                    OtherChild {},
                    OtherChild {}
                }
            )
        }

        let mut utils = launch_test_with_config(
            use_focus_app,
            TestingConfig {
                size: (100.0, 100.0).into(),
                ..TestingConfig::default()
            },
        );

        // Initial state
        utils.wait_for_update().await;
        assert_eq!(utils.focus_id(), ACCESSIBILITY_ROOT_ID);

        // Click on the first rect
        utils.push_event(PlatformEvent::Mouse {
            name: EventName::Click,
            cursor: (5.0, 5.0).into(),
            button: Some(MouseButton::Left),
        });

        // First rect is now focused
        utils.wait_for_update().await;
        utils.wait_for_update().await;
        utils.wait_for_update().await;
        let first_focus_id = utils.focus_id();
        assert_ne!(first_focus_id, ACCESSIBILITY_ROOT_ID);

        // Click on the second rect
        utils.push_event(PlatformEvent::Mouse {
            name: EventName::Click,
            cursor: (5.0, 75.0).into(),
            button: Some(MouseButton::Left),
        });

        // Second rect is now focused
        utils.wait_for_update().await;
        utils.wait_for_update().await;
        utils.wait_for_update().await;
        let second_focus_id = utils.focus_id();
        assert_ne!(first_focus_id, second_focus_id);
        assert_ne!(second_focus_id, ACCESSIBILITY_ROOT_ID);
    }
}