mirui 0.46.2

A lightweight, no_std ECS-driven UI framework for embedded, mobile, desktop, and WebAssembly
Documentation 
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

use crate::ecs::{Entity, World};
use crate::surface::InputEvent;
use crate::ui::Parent;

use super::gesture::GestureEvent;

/// Marker component: this entity can receive keyboard/char input.
pub struct Focusable;

/// Marker for a focusable entity that accepts native text input.
///
/// Mobile hosts use this to show or hide the software keyboard without
/// coupling custom text editors to a concrete widget implementation.
pub struct TextEditable;

/// World resource tracking which entity currently has keyboard focus.
#[derive(Default)]
pub struct FocusState {
    pub focused: Option<Entity>,
}

/// Handler component for receiving Key/CharInput events on focused entities.
pub struct KeyHandler {
    pub on_key: fn(&mut World, Entity, &InputEvent) -> bool,
}

#[cfg(any(target_os = "android", target_os = "ios", test))]
pub(crate) fn text_input_requested(world: &World) -> bool {
    world
        .resource::<FocusState>()
        .and_then(|state| state.focused)
        .is_some_and(|entity| world.get::<TextEditable>(entity).is_some())
}

/// On Tap gesture, walk from target upward looking for a `Focusable`
/// entity. If found, set focus to it; otherwise blur.
pub fn focus_on_tap(world: &mut World, event: &GestureEvent) {
    let target = match event {
        GestureEvent::Tap { target, .. } => *target,
        _ => return,
    };

    let focused_entity = find_focusable(world, target);

    if let Some(fs) = world.resource_mut::<FocusState>() {
        fs.focused = focused_entity;
    }
}

fn find_focusable(world: &World, entity: Entity) -> Option<Entity> {
    if super::entity_or_ancestor_disabled(world, entity) {
        return None;
    }
    let mut cur = entity;
    loop {
        if world.get::<Focusable>(cur).is_some() {
            return Some(cur);
        }
        let p = world.get::<Parent>(cur)?;
        cur = p.0;
    }
}

/// Route Key/CharInput events to the focused entity's KeyHandler.
pub fn key_dispatch(world: &mut World, event: &InputEvent) {
    let target = match world.resource::<FocusState>() {
        Some(fs) => match fs.focused {
            Some(e) => e,
            None => return,
        },
        None => return,
    };

    match event {
        InputEvent::Key { .. } | InputEvent::CharInput { .. } => {}
        _ => return,
    }

    if super::entity_or_ancestor_disabled(world, target) {
        return;
    }

    let handler_fn = world.get::<KeyHandler>(target).map(|h| h.on_key);
    if let Some(f) = handler_fn {
        f(world, target, event);
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::ui::UserState;

    #[test]
    fn focus_skips_disabled_subtree() {
        let mut world = World::new();
        let parent = world.spawn_empty();
        let child = world.spawn_empty();
        world.insert(child, Parent(parent));
        world.insert(child, Focusable);
        world.insert(parent, UserState::Disabled);
        assert_eq!(find_focusable(&world, child), None);
    }

    #[test]
    fn focus_ignores_disabled_self() {
        let mut world = World::new();
        let e = world.spawn_empty();
        world.insert(e, Focusable);
        world.insert(e, UserState::Disabled);
        assert_eq!(find_focusable(&world, e), None);
    }

    #[test]
    fn focus_walks_through_non_disabled() {
        let mut world = World::new();
        let parent = world.spawn_empty();
        let child = world.spawn_empty();
        world.insert(child, Parent(parent));
        world.insert(parent, Focusable);
        assert_eq!(find_focusable(&world, child), Some(parent));
    }

    #[test]
    fn native_text_input_requires_a_focused_editable() {
        let mut world = World::new();
        world.insert_resource(FocusState::default());
        let entity = world.spawn_empty();
        world.insert(entity, Focusable);
        world.resource_mut::<FocusState>().unwrap().focused = Some(entity);
        assert!(!text_input_requested(&world));

        world.insert(entity, TextEditable);
        assert!(text_input_requested(&world));

        world.resource_mut::<FocusState>().unwrap().focused = None;
        assert!(!text_input_requested(&world));
    }
}