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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
//! Safe, owned browser DOM handles for Atlas applications.
mod canvas;
mod clipboard;
mod content_box;
mod file_drop;
mod gpu_canvas;
mod keyboard;
mod text;
pub use self::canvas::{CanvasSize, RgbaFrame, WebCanvas};
pub use self::clipboard::WebClipboard;
pub use self::file_drop::{BrowserFiles, DropFiles, DropMetadata, DroppedFile, DroppedFileAccess};
pub use self::gpu_canvas::WebGpuCanvas;
pub use self::keyboard::KeyboardMetadata;
pub use self::text::{
CompositionMetadata, TextInputMetadata, TextSelection, TextSelectionDirection,
};
use std::io;
pub use crate::content_box::ContentBoxPoint;
use wasm_bindgen::JsCast;
use wasm_bindgen::JsValue;
use wasm_bindgen::closure::Closure;
use web_sys::{
Document, Element, Event, HtmlButtonElement, HtmlDialogElement, HtmlElement, HtmlInputElement,
HtmlSelectElement, HtmlTextAreaElement, MouseEvent, PointerEvent, WheelEvent, Window,
};
/// A browser document obtained from the current window.
#[derive(Clone)]
pub struct WebDocument {
document: Document,
}
impl WebDocument {
/// Obtains the document for the current browser window.
///
/// # Errors
/// Returns [`io::ErrorKind::Unsupported`] when no browser window or
/// document is available.
pub fn current() -> io::Result<Self> {
let window = web_sys::window().ok_or_else(|| {
io::Error::new(
io::ErrorKind::Unsupported,
"DOM access requires a browser Window",
)
})?;
Self::from_window(window)
}
/// Wraps a browser window's document.
///
/// # Errors
/// Returns [`io::ErrorKind::Unsupported`] when the window has no document.
pub fn from_window(window: Window) -> io::Result<Self> {
window
.document()
.map(|document| Self { document })
.ok_or_else(|| {
io::Error::new(io::ErrorKind::Unsupported, "Browser Window has no Document")
})
}
/// Returns the document body.
///
/// # Errors
/// Returns [`io::ErrorKind::NotFound`] before the document body exists.
pub fn body(&self) -> io::Result<WebElement> {
self.document
.body()
.map(|body| WebElement {
element: body.unchecked_into(),
})
.ok_or_else(|| io::Error::new(io::ErrorKind::NotFound, "Document body is absent"))
}
/// Finds an element by its stable identifier.
#[must_use]
pub fn get_element_by_id(&self, id: &str) -> Option<WebElement> {
self.document
.get_element_by_id(id)
.map(|element| WebElement { element })
}
/// Creates an element with the supplied HTML tag name.
///
/// # Errors
/// Returns the browser's DOM validation error as [`io::ErrorKind::InvalidInput`].
pub fn create_element(&self, tag: &str) -> io::Result<WebElement> {
self.document
.create_element(tag)
.map(|element| WebElement { element })
.map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "Invalid DOM element name"))
}
/// Returns the browser's text clipboard provider.
///
/// Clipboard access is available only in a secure browser context and
/// remains subject to the browser's permission and user-activation
/// policy. The provider never exposes a filesystem or native clipboard
/// handle to the application.
///
/// # Errors
/// Returns [`io::ErrorKind::Unsupported`] when the current document has no
/// navigator clipboard API, including an insecure browser context.
pub fn clipboard(&self) -> io::Result<WebClipboard> {
clipboard::from_document(self)
}
}
/// An owned browser element handle.
#[derive(Clone)]
pub struct WebElement {
element: Element,
}
/// An element extent measured in CSS pixels.
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct ElementSize {
width: f64,
height: f64,
}
impl ElementSize {
/// Returns the rendered width in CSS pixels.
#[must_use]
pub const fn width(self) -> f64 {
self.width
}
/// Returns the rendered height in CSS pixels.
#[must_use]
pub const fn height(self) -> f64 {
self.height
}
}
impl WebElement {
/// Returns the element's identifier, or an empty string when it has none.
#[must_use]
pub fn id(&self) -> String {
self.element.id()
}
/// Replaces the element's HTML contents.
///
/// The caller owns the markup string and must only pass trusted
/// application-authored content. Untrusted values belong in
/// [`Self::set_text`].
pub fn set_inner_html(&self, markup: &str) {
self.element.set_inner_html(markup);
}
/// Replaces the element's text content without interpreting markup.
pub fn set_text(&self, text: &str) {
self.element.set_text_content(Some(text));
}
/// Sets one DOM attribute.
///
/// # Errors
/// Returns the browser's DOM validation error as [`io::ErrorKind::InvalidInput`].
pub fn set_attribute(&self, name: &str, value: &str) -> io::Result<()> {
self.element
.set_attribute(name, value)
.map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "Invalid DOM attribute"))
}
/// Sets one inline CSS property through the browser's CSS object model.
///
/// Property-by-property mutation avoids replacing the element's complete
/// `style` attribute and remains usable when a content security policy
/// rejects application-authored inline style declarations.
///
/// # Errors
/// Returns [`io::ErrorKind::InvalidInput`] when this is not an HTML
/// element or setting the property throws a browser exception.
pub fn set_style_property(&self, name: &str, value: &str) -> io::Result<()> {
let element = self.element.dyn_ref::<HtmlElement>().ok_or_else(|| {
io::Error::new(io::ErrorKind::InvalidInput, "DOM element has no CSS style")
})?;
element.style().set_property(name, value).map_err(|_| {
io::Error::new(
io::ErrorKind::InvalidInput,
"Browser rejected CSS style property",
)
})
}
/// Returns the element's rendered border-box extent in fractional CSS pixels.
///
/// The dimensions include padding and borders and reflect CSS transforms,
/// matching the browser's `getBoundingClientRect` semantics.
#[must_use]
pub fn bounding_size(&self) -> ElementSize {
let bounds = self.element.get_bounding_client_rect();
ElementSize {
width: bounds.width(),
height: bounds.height(),
}
}
/// Maps a viewport client point into the untransformed local content box.
///
/// The returned point carries the content extent measured in the same
/// layout read as the coordinate. Borders and padding are excluded. The
/// mapping composes this element's and its ancestors' two-dimensional
/// affine CSS transforms. The bounding rectangle supplies only the
/// transformed box translation; its transformed extent is never treated as
/// a local content size.
///
/// # Errors
/// Returns a typed error for unavailable or invalid CSS geometry,
/// three-dimensional or singular transforms, motion paths, or CSS zoom.
/// Closed shadow roots cannot expose their composed transform ancestry;
/// callers embedding a canvas there must keep transforming wrappers inside
/// the inspectable root.
pub fn content_box_point(&self, client_x: f64, client_y: f64) -> io::Result<ContentBoxPoint> {
content_box::measure_point(&self.element, client_x, client_y)
}
/// Returns the disabled state of a button, input, or select control.
#[must_use]
pub fn disabled(&self) -> Option<bool> {
self.element
.dyn_ref::<HtmlButtonElement>()
.map(HtmlButtonElement::disabled)
.or_else(|| {
self.element
.dyn_ref::<HtmlInputElement>()
.map(HtmlInputElement::disabled)
})
.or_else(|| {
self.element
.dyn_ref::<HtmlSelectElement>()
.map(HtmlSelectElement::disabled)
})
}
/// Sets the disabled state of a button, input, or select control.
///
/// # Errors
/// Returns [`io::ErrorKind::InvalidInput`] when this element is not a
/// disableable form control.
pub fn set_disabled(&self, disabled: bool) -> io::Result<()> {
if let Some(button) = self.element.dyn_ref::<HtmlButtonElement>() {
button.set_disabled(disabled);
return Ok(());
}
if let Some(input) = self.element.dyn_ref::<HtmlInputElement>() {
input.set_disabled(disabled);
return Ok(());
}
if let Some(select) = self.element.dyn_ref::<HtmlSelectElement>() {
select.set_disabled(disabled);
return Ok(());
}
Err(io::Error::new(
io::ErrorKind::InvalidInput,
"DOM element is not a disableable form control",
))
}
/// Returns whether this HTML dialog is open.
#[must_use]
pub fn dialog_open(&self) -> Option<bool> {
self.element
.dyn_ref::<HtmlDialogElement>()
.map(HtmlDialogElement::open)
}
/// Opens this HTML dialog as a modal dialog.
///
/// # Errors
/// Returns [`io::ErrorKind::InvalidInput`] when this element is not a
/// dialog or when the browser rejects the modal transition.
pub fn show_modal(&self) -> io::Result<()> {
let dialog = self.element.dyn_ref::<HtmlDialogElement>().ok_or_else(|| {
io::Error::new(io::ErrorKind::InvalidInput, "DOM element is not a dialog")
})?;
dialog.show_modal().map(|_| ()).map_err(|_| {
io::Error::new(io::ErrorKind::InvalidInput, "Browser rejected modal dialog")
})
}
/// Closes this HTML dialog.
///
/// # Errors
/// Returns [`io::ErrorKind::InvalidInput`] when this element is not a
/// dialog.
pub fn close_dialog(&self) -> io::Result<()> {
let dialog = self.element.dyn_ref::<HtmlDialogElement>().ok_or_else(|| {
io::Error::new(io::ErrorKind::InvalidInput, "DOM element is not a dialog")
})?;
dialog.close();
Ok(())
}
/// Moves browser focus to this HTML element.
///
/// # Errors
/// Returns [`io::ErrorKind::InvalidInput`] when this element is not an
/// HTML element or when the browser rejects the focus request.
pub fn focus(&self) -> io::Result<()> {
let element = self.element.dyn_ref::<HtmlElement>().ok_or_else(|| {
io::Error::new(
io::ErrorKind::InvalidInput,
"DOM element cannot receive focus",
)
})?;
element.focus().map(|_| ()).map_err(|_| {
io::Error::new(
io::ErrorKind::InvalidInput,
"Browser rejected focus request",
)
})
}
/// Captures subsequent pointer events for this element.
///
/// # Errors
/// Returns [`io::ErrorKind::InvalidInput`] when the browser rejects the
/// pointer identifier or capture request.
pub fn set_pointer_capture(&self, pointer_id: i32) -> io::Result<()> {
self.element.set_pointer_capture(pointer_id).map_err(|_| {
io::Error::new(
io::ErrorKind::InvalidInput,
"Browser rejected pointer capture",
)
})
}
/// Releases a pointer previously captured by this element.
///
/// # Errors
/// Returns [`io::ErrorKind::InvalidInput`] when the browser rejects the
/// pointer identifier or release request.
pub fn release_pointer_capture(&self, pointer_id: i32) -> io::Result<()> {
self.element
.release_pointer_capture(pointer_id)
.map_err(|_| {
io::Error::new(
io::ErrorKind::InvalidInput,
"Browser rejected pointer release",
)
})
}
/// Returns whether this element currently captures a pointer identifier.
#[must_use]
pub fn has_pointer_capture(&self, pointer_id: i32) -> bool {
self.element.has_pointer_capture(pointer_id)
}
/// Appends a child and returns no detached handle.
///
/// # Errors
/// Returns [`io::ErrorKind::InvalidInput`] when the browser rejects the
/// parent/child relationship.
pub fn append_child(&self, child: &Self) -> io::Result<()> {
self.element
.append_child(&child.element)
.map(|_| ())
.map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "Invalid DOM child"))
}
/// Reads the value of a browser input or select element.
#[must_use]
pub fn value(&self) -> Option<String> {
self.element
.dyn_ref::<HtmlInputElement>()
.map(HtmlInputElement::value)
.or_else(|| {
self.element
.dyn_ref::<HtmlSelectElement>()
.map(HtmlSelectElement::value)
})
}
/// Reads the checked state of a browser input element.
///
/// Returns [`None`] when this element is not an input. Checkbox and radio
/// controls expose their current state through the same browser property;
/// other input kinds return their browser-defined unchecked state.
#[must_use]
pub fn checked(&self) -> Option<bool> {
self.element
.dyn_ref::<HtmlInputElement>()
.map(HtmlInputElement::checked)
}
/// Replaces the value of a browser input, textarea or select element.
///
/// A select element selects the option whose value matches. Browsers
/// clear the selection for a value no option carries; that value is
/// rejected instead and the previous selection is kept.
///
/// # Errors
/// Returns [`io::ErrorKind::InvalidInput`] when the element is not a
/// value-bearing control or a select has no option with `value`.
pub fn set_value(&self, value: &str) -> io::Result<()> {
if let Some(input) = self.element.dyn_ref::<HtmlInputElement>() {
input.set_value(value);
return Ok(());
}
if let Some(textarea) = self.element.dyn_ref::<HtmlTextAreaElement>() {
textarea.set_value(value);
return Ok(());
}
if let Some(select) = self.element.dyn_ref::<HtmlSelectElement>() {
let previous = select.value();
select.set_value(value);
if select.value() == value {
return Ok(());
}
select.set_value(&previous);
return Err(io::Error::new(
io::ErrorKind::InvalidInput,
"Select element has no option with the requested value",
));
}
Err(io::Error::new(
io::ErrorKind::InvalidInput,
"DOM element is not an input, textarea or select",
))
}
/// Registers a callback whose lifetime is tied to the returned listener.
///
/// Dropping the listener removes the callback from the element before the
/// closure is released, so cancellation cannot leave a JavaScript root.
///
/// # Errors
/// Returns [`io::ErrorKind::InvalidInput`] when the event name is invalid
/// or the browser refuses the listener.
pub fn add_event_listener<F>(
&self,
event_name: &str,
callback: F,
) -> io::Result<WebEventListener>
where
F: FnMut(WebEvent) + 'static,
{
let mut callback = callback;
let closure = Closure::wrap(Box::new(move |event: Event| {
callback(WebEvent { event });
}) as Box<dyn FnMut(Event)>);
self.element
.add_event_listener_with_callback(event_name, closure.as_ref().unchecked_ref())
.map_err(|_| {
io::Error::new(
io::ErrorKind::InvalidInput,
"Browser rejected event listener",
)
})?;
Ok(WebEventListener {
element: self.element.clone(),
event_name: event_name.to_owned(),
closure,
})
}
}
/// A browser event delivered to an owned listener.
pub struct WebEvent {
event: Event,
}
impl WebEvent {
/// Returns the browser's trust snapshot for this event.
///
/// `true` means the browser marked the event as trusted. This is a
/// browser provenance signal, not proof of a physical user or of an
/// authenticated automation session; consumers apply their own input
/// policy.
#[must_use]
pub fn is_trusted(&self) -> bool {
self.event.is_trusted()
}
}
/// The browser pointer device that produced an event.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum PointerType {
/// A mouse or mouse-like pointing device.
Mouse,
/// A pen or stylus device.
Pen,
/// A direct-touch device.
Touch,
/// A browser-defined pointer type not covered by the known variants.
Other,
}
impl PointerType {
/// Returns the stable label used by the browser-facing documentation.
#[must_use]
pub const fn as_str(self) -> &'static str {
match self {
Self::Mouse => "mouse",
Self::Pen => "pen",
Self::Touch => "touch",
Self::Other => "other",
}
}
}
/// The unit used for browser wheel deltas.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum WheelDeltaMode {
/// Deltas are expressed in CSS pixels.
Pixel,
/// Deltas are expressed in lines of content.
Line,
/// Deltas are expressed in pages of content.
Page,
/// A browser-defined delta unit.
Other,
}
impl WheelDeltaMode {
/// Returns the stable label used by the browser-facing documentation.
#[must_use]
pub const fn as_str(self) -> &'static str {
match self {
Self::Pixel => "pixel",
Self::Line => "line",
Self::Page => "page",
Self::Other => "other",
}
}
}
/// Modifier-key state captured with one browser input event.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct PointerModifiers {
ctrl: bool,
shift: bool,
alt: bool,
meta: bool,
}
impl PointerModifiers {
/// Returns whether Control was held for the event.
#[must_use]
pub const fn ctrl(self) -> bool {
self.ctrl
}
/// Returns whether Shift was held for the event.
#[must_use]
pub const fn shift(self) -> bool {
self.shift
}
/// Returns whether Alt was held for the event.
#[must_use]
pub const fn alt(self) -> bool {
self.alt
}
/// Returns whether Meta was held for the event.
#[must_use]
pub const fn meta(self) -> bool {
self.meta
}
}
/// Input metadata captured from one browser pointer event.
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct PointerMetadata {
pointer_id: i32,
pointer_type: PointerType,
client_x: f64,
client_y: f64,
offset_x: i32,
offset_y: i32,
button: i16,
buttons: u16,
modifiers: PointerModifiers,
primary: bool,
trusted: bool,
}
impl PointerMetadata {
/// Returns the browser-assigned pointer identifier.
#[must_use]
pub const fn pointer_id(self) -> i32 {
self.pointer_id
}
/// Returns the normalized pointer device type.
#[must_use]
pub const fn pointer_type(self) -> PointerType {
self.pointer_type
}
/// Returns the viewport-relative horizontal coordinate in CSS pixels.
#[must_use]
pub const fn client_x(self) -> f64 {
self.client_x
}
/// Returns the viewport-relative vertical coordinate in CSS pixels.
#[must_use]
pub const fn client_y(self) -> f64 {
self.client_y
}
/// Returns the target-relative horizontal coordinate in CSS pixels.
#[must_use]
pub const fn offset_x(self) -> i32 {
self.offset_x
}
/// Returns the target-relative vertical coordinate in CSS pixels.
#[must_use]
pub const fn offset_y(self) -> i32 {
self.offset_y
}
/// Returns the button changed by the event (`-1` when the browser has no button).
#[must_use]
pub const fn button(self) -> i16 {
self.button
}
/// Returns the bitmask of buttons currently held down.
#[must_use]
pub const fn buttons(self) -> u16 {
self.buttons
}
/// Returns the modifier-key snapshot.
#[must_use]
pub const fn modifiers(self) -> PointerModifiers {
self.modifiers
}
/// Returns whether this is the primary pointer for its device.
#[must_use]
pub const fn is_primary(self) -> bool {
self.primary
}
/// Returns the browser trust snapshot captured with this event.
#[must_use]
pub const fn is_trusted(self) -> bool {
self.trusted
}
}
/// Input metadata captured from one browser wheel event.
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct WheelMetadata {
delta_x: f64,
delta_y: f64,
delta_z: f64,
delta_mode: WheelDeltaMode,
client_x: f64,
client_y: f64,
offset_x: i32,
offset_y: i32,
modifiers: PointerModifiers,
trusted: bool,
}
impl WheelMetadata {
/// Returns the horizontal wheel delta in [`Self::delta_mode`] units.
#[must_use]
pub const fn delta_x(self) -> f64 {
self.delta_x
}
/// Returns the vertical wheel delta in [`Self::delta_mode`] units.
#[must_use]
pub const fn delta_y(self) -> f64 {
self.delta_y
}
/// Returns the depth wheel delta in [`Self::delta_mode`] units.
#[must_use]
pub const fn delta_z(self) -> f64 {
self.delta_z
}
/// Returns the browser unit used by the deltas.
#[must_use]
pub const fn delta_mode(self) -> WheelDeltaMode {
self.delta_mode
}
/// Returns the viewport-relative horizontal coordinate in CSS pixels.
#[must_use]
pub const fn client_x(self) -> f64 {
self.client_x
}
/// Returns the viewport-relative vertical coordinate in CSS pixels.
#[must_use]
pub const fn client_y(self) -> f64 {
self.client_y
}
/// Returns the target-relative horizontal coordinate in CSS pixels.
#[must_use]
pub const fn offset_x(self) -> i32 {
self.offset_x
}
/// Returns the target-relative vertical coordinate in CSS pixels.
#[must_use]
pub const fn offset_y(self) -> i32 {
self.offset_y
}
/// Returns the modifier-key snapshot.
#[must_use]
pub const fn modifiers(self) -> PointerModifiers {
self.modifiers
}
/// Returns the browser trust snapshot captured with this event.
#[must_use]
pub const fn is_trusted(self) -> bool {
self.trusted
}
}
fn modifier_state(event: &MouseEvent) -> PointerModifiers {
PointerModifiers {
ctrl: MouseEvent::ctrl_key(event),
shift: MouseEvent::shift_key(event),
alt: MouseEvent::alt_key(event),
meta: MouseEvent::meta_key(event),
}
}
impl WebEvent {
/// Returns the event target when it is a DOM element.
#[must_use]
pub fn target(&self) -> Option<WebElement> {
self.event
.target()
.and_then(|target| target.dyn_into::<Element>().ok())
.map(|element| WebElement { element })
}
/// Reads an input or select value from the event target.
#[must_use]
pub fn value(&self) -> Option<String> {
self.target().and_then(|target| target.value())
}
/// Returns the identifier carried by a pointer event.
#[must_use]
pub fn pointer_id(&self) -> Option<i32> {
self.event
.dyn_ref::<PointerEvent>()
.map(PointerEvent::pointer_id)
}
/// Reads pointer metadata from this event.
///
/// The snapshot includes the pointer device, viewport and target-relative
/// coordinates, button state, modifier keys, primary-pointer marker and
/// browser trust provenance.
/// Events that are not [`PointerEvent`] values return [`None`].
#[must_use]
pub fn pointer_metadata(&self) -> Option<PointerMetadata> {
let pointer = self.event.dyn_ref::<PointerEvent>()?;
let mouse = self.event.dyn_ref::<MouseEvent>()?;
let pointer_type = match PointerEvent::pointer_type(pointer).as_str() {
"mouse" => PointerType::Mouse,
"pen" => PointerType::Pen,
"touch" => PointerType::Touch,
_ => PointerType::Other,
};
Some(PointerMetadata {
pointer_id: PointerEvent::pointer_id(pointer),
pointer_type,
client_x: event_coordinate(mouse, "clientX")?,
client_y: event_coordinate(mouse, "clientY")?,
offset_x: MouseEvent::offset_x(mouse),
offset_y: MouseEvent::offset_y(mouse),
button: MouseEvent::button(mouse),
buttons: MouseEvent::buttons(mouse),
modifiers: modifier_state(mouse),
primary: PointerEvent::is_primary(pointer),
trusted: self.is_trusted(),
})
}
/// Reads wheel metadata from this event.
///
/// The snapshot includes three browser deltas, their unit, viewport and
/// target-relative coordinates, modifier keys and browser trust
/// provenance. Events that are not [`WheelEvent`] values return [`None`].
#[must_use]
pub fn wheel_metadata(&self) -> Option<WheelMetadata> {
let wheel = self.event.dyn_ref::<WheelEvent>()?;
let mouse = self.event.dyn_ref::<MouseEvent>()?;
let delta_mode = match WheelEvent::delta_mode(wheel) {
0 => WheelDeltaMode::Pixel,
1 => WheelDeltaMode::Line,
2 => WheelDeltaMode::Page,
_ => WheelDeltaMode::Other,
};
Some(WheelMetadata {
delta_x: WheelEvent::delta_x(wheel),
delta_y: WheelEvent::delta_y(wheel),
delta_z: WheelEvent::delta_z(wheel),
delta_mode,
client_x: event_coordinate(mouse, "clientX")?,
client_y: event_coordinate(mouse, "clientY")?,
offset_x: MouseEvent::offset_x(mouse),
offset_y: MouseEvent::offset_y(mouse),
modifiers: modifier_state(mouse),
trusted: self.is_trusted(),
})
}
/// Stops the browser's default action for this event.
pub fn prevent_default(&self) {
self.event.prevent_default();
}
}
fn event_coordinate(event: &MouseEvent, property: &str) -> Option<f64> {
let value = js_sys::Reflect::get(event.as_ref(), &JsValue::from_str(property)).ok()?;
let coordinate = value.as_f64()?;
coordinate.is_finite().then_some(coordinate)
}
/// An event listener with explicit browser callback teardown.
pub struct WebEventListener {
element: Element,
event_name: String,
closure: Closure<dyn FnMut(Event)>,
}
impl Drop for WebEventListener {
fn drop(&mut self) {
let _ = self.element.remove_event_listener_with_callback(
&self.event_name,
self.closure.as_ref().unchecked_ref(),
);
}
}