devela/lang/js/
definitions.rs

Help
1// devela::lang:js::namespace
2//
3//! Defines the [`Js`] namespace and related items.
4//
5// TOC
6// - struct Js
7// - enum JsEvent
8// - enum JsPermission
9// - enum JsPermissionState
10
11use crate::{TAG_EXPERIMENTAL, TAG_NON_STANDARD};
12
13/// A Javascript namespace.
14///
15/// # Methods
16/// - core APis
17///   - [console](#web-api-console)
18///   - [events](#web-api-events)
19///   - [history](#web-api-history--navigation)
20///   - [permissions](#web-api-permissions)
21/// - extended APis
22///   - media & graphics
23///     - [canvas](#web-api-canvas)
24//   - system & hardware
25///   - performance & optimization
26//     - time
27//   - advanced & experimental
28pub struct Js;
29
30/// # Web API Events
31///
32/// - <https://developer.mozilla.org/en-US/docs/Web/API/Event>
33/// - <https://developer.mozilla.org/en-US/docs/Web/API/EventTarget>
34#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
35#[repr(u8)]
36pub enum JsEvent {
37    /// Fires when an element is clicked.
38    Click,
39
40    /// Fires when a key is pressed down.
41    KeyDown,
42
43    /// Fires when a key is released.
44    KeyUp,
45
46    /// Fires when the mouse moves over an element.
47    MouseMove,
48
49    /// Fires when the mouse button is pressed down.
50    MouseDown,
51
52    /// Fires when the mouse button is released.
53    MouseUp,
54
55    /// Fires when the window is resized.
56    Resize,
57}
58impl JsEvent {
59    /// Returns the event name as a string.
60    pub fn as_str(self) -> &'static str {
61        use JsEvent as E;
62        match self {
63            E::Click => "click",
64            E::KeyDown => "keydown",
65            E::KeyUp => "keyup",
66            E::MouseMove => "mousemove",
67            E::MouseDown => "mousedown",
68            E::MouseUp => "mouseup",
69            E::Resize => "resize",
70        }
71    }
72}
73
74/// # Web API permissions
75///
76/// - <https://developer.mozilla.org/en-US/docs/Web/API/Permissions_API>
77/// - <https://developer.mozilla.org/en-US/docs/Web/API/Permissions#browser_compatibility>
78#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
79#[repr(u8)]
80pub enum JsPermission {
81    #[doc = TAG_EXPERIMENTAL!()]
82    /// Access to accelerometer sensor data.
83    Accelerometer,
84
85    #[doc = TAG_EXPERIMENTAL!()]
86    /// Background sync capability for web applications.
87    BackgroundSync,
88
89    /// Access to the device camera.
90    Camera,
91
92    #[doc = TAG_EXPERIMENTAL!()]
93    #[doc = TAG_NON_STANDARD!()]
94    /// Read access to the system clipboard.
95    ClipboardRead,
96
97    #[doc = TAG_EXPERIMENTAL!()]
98    /// Write access to the system clipboard.
99    ClipboardWrite,
100
101    /// Access to device geolocation data.
102    Geolocation,
103
104    #[doc = TAG_EXPERIMENTAL!()]
105    /// Access to gyroscope sensor data.
106    Gyroscope,
107
108    /// Access to the device microphone.
109    Microphone,
110
111    /// MIDI device access (without system exclusive messages).
112    Midi,
113
114    /// Permission to display system notifications.
115    Notifications,
116
117    #[doc = TAG_EXPERIMENTAL!()]
118    /// Permission to use a payment handler.
119    PaymentHandler,
120
121    /// Persistent storage access to prevent data loss.
122    PersistentStorage,
123
124    /// Permission to receive push notifications.
125    Push,
126
127    /// Allows preventing the screen from sleeping.
128    ScreenWakeLock,
129
130    /// Access to storage that requires explicit user permission.
131    StorageAccess,
132
133    #[doc = TAG_EXPERIMENTAL!()]
134    /// Allows a site to access storage without top-level navigation.
135    TopLevelStorageAccess,
136}
137impl JsPermission {
138    /// Returns the permission name as a string.
139    pub fn as_str(self) -> &'static str {
140        use JsPermission as P;
141        match self {
142            P::Accelerometer => "accelerometer",
143            P::BackgroundSync => "background-sync",
144            P::Camera => "camera",
145            P::ClipboardRead => "clipboard-read",
146            P::ClipboardWrite => "clipboard-write",
147            P::Geolocation => "geolocation",
148            P::Gyroscope => "gyroscope",
149            P::Microphone => "microphone",
150            P::Midi => "midi",
151            P::Notifications => "notifications",
152            P::PaymentHandler => "payment-handler",
153            P::PersistentStorage => "persistent-storage",
154            P::Push => "push",
155            P::ScreenWakeLock => "screen-wake-lock",
156            P::StorageAccess => "storage-access",
157            P::TopLevelStorageAccess => "top-level-storage-access",
158        }
159    }
160}
161
162/// # Permission query result state.
163#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
164#[repr(i8)]
165pub enum JsPermissionState {
166    /// The permission has been granted by the user.
167    Granted = 1,
168    /// The user has not yet granted or denied the permission.
169    Prompt = 0,
170    /// The user has not yet granted or denied the permission.
171    Denied = -1,
172    /// The queried permission is unsupported or unrecognized.
173    Unknown = -2,
174    /// An error occurred while querying the permission state.
175    Error = -3,
176}
177impl From<i32> for JsPermissionState {
178    fn from(from: i32) -> Self {
179        use JsPermissionState as S;
180        match from {
181            1 => S::Granted,
182            0 => S::Prompt,
183            -1 => S::Denied,
184            -2 => S::Unknown,
185            _ => S::Error,
186        }
187    }
188}
devela/lang/js/definitions.rs

devela/lang/js/
definitions.rs
