freya-android 0.5.0-rc.2

Android integration for Freya
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

#![cfg(target_os = "android")]

use freya_components::theming::{
    hooks::use_init_theme,
    themes::light_theme,
};
use freya_core::{
    integration::*,
    prelude::*,
};
use freya_winit::{
    integration::is_ime_role,
    plugins::{
        FreyaPlugin,
        PluginEvent,
        PluginHandle,
    },
};
use winit::platform::android::activity::AndroidApp;

mod keyboard;
mod status_bar;

/// Extension trait for [`Platform`] providing Android-specific APIs.
pub trait AndroidExt {
    /// Set whether the Android status bar uses light appearance (dark icons for light backgrounds).
    fn set_status_bar_light(&self, light: bool) -> Result<(), jni::errors::Error>;

    /// Show the Android soft keyboard.
    fn show_keyboard(&self) -> Result<(), jni::errors::Error>;

    /// Hide the Android soft keyboard.
    fn hide_keyboard(&self) -> Result<(), jni::errors::Error>;
}

impl AndroidExt for Platform {
    fn set_status_bar_light(&self, light: bool) -> Result<(), jni::errors::Error> {
        if let Some(app) = try_consume_root_context::<AndroidApp>() {
            status_bar::set_status_bar_light(&app, light)
        } else {
            Ok(())
        }
    }

    fn show_keyboard(&self) -> Result<(), jni::errors::Error> {
        if let Some(app) = try_consume_root_context::<AndroidApp>() {
            keyboard::show_keyboard(&app)
        } else {
            Ok(())
        }
    }

    fn hide_keyboard(&self) -> Result<(), jni::errors::Error> {
        if let Some(app) = try_consume_root_context::<AndroidApp>() {
            keyboard::hide_keyboard(&app)
        } else {
            Ok(())
        }
    }
}

/// Freya plugin for Android integration.
///
/// Stores the [`AndroidApp`] handle, provides it as root context,
/// and registers a root component that syncs the status bar
/// appearance with the app theme and manages the soft keyboard.
pub struct AndroidPlugin {
    app: AndroidApp,
}

impl AndroidPlugin {
    pub fn new(app: AndroidApp) -> Self {
        Self { app }
    }
}

impl FreyaPlugin for AndroidPlugin {
    fn plugin_id(&self) -> &'static str {
        "android"
    }

    fn on_event(&mut self, event: &mut PluginEvent, _handle: PluginHandle) {
        if let PluginEvent::RunnerCreated { runner } = event {
            let app = self.app.clone();
            runner.provide_root_context(move || app);
        }
    }

    fn root_component(&self, root: Element) -> Element {
        AndroidRoot { inner: root }.into_element()
    }
}

/// Root component that manages Android platform integration.
#[derive(Clone)]
struct AndroidRoot {
    inner: Element,
}

impl PartialEq for AndroidRoot {
    fn eq(&self, _other: &Self) -> bool {
        true
    }
}

impl Component for AndroidRoot {
    fn render(&self) -> impl IntoElement {
        let theme = use_init_theme(light_theme);

        // Sync status bar appearance with theme
        use_side_effect(move || {
            let platform = Platform::get();
            let is_light = theme.read().name == "light";
            if let Err(err) = platform.set_status_bar_light(is_light) {
                tracing::error!("Failed to set status bar appearance: {err:?}");
            }
        });

        // Show/hide keyboard based on focused node type
        use_side_effect(move || {
            let platform = Platform::get();
            let focused_node = platform.focused_accessibility_node.read();
            let result = if is_ime_role(focused_node.role()) {
                platform.show_keyboard()
            } else {
                platform.hide_keyboard()
            };
            if let Err(err) = result {
                tracing::error!("Failed to toggle soft keyboard: {err:?}");
            }
        });

        self.inner.clone()
    }
}