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
use webcore::value::Reference;
use webcore::try_from::TryInto;
use webapi::event_target::{IEventTarget, EventTarget};
use webapi::window_or_worker::IWindowOrWorker;
use webapi::storage::Storage;
use webapi::location::Location;
use webapi::history::History;
use webcore::once::Once;
use webcore::value::Value;
/// A handle to a pending animation frame request.
#[derive(Debug)]
pub struct RequestAnimationFrameHandle(Value);
impl RequestAnimationFrameHandle {
/// Cancels an animation frame request.
///
/// [(Javascript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Window/cancelAnimationFrame)
pub fn cancel(self) {
js!{
var val = @{self.0};
val.window.cancelAnimationFrame(val.request);
val.callback.drop();
};
}
}
/// The `Window` object represents a window containing a DOM document.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Window)
// https://html.spec.whatwg.org/#window
#[derive(Clone, Debug, PartialEq, Eq, ReferenceType)]
#[reference(instance_of = "Window")]
#[reference(subclass_of(EventTarget))]
pub struct Window( Reference );
impl IEventTarget for Window {}
impl IWindowOrWorker for Window {}
/// A global instance of [Window](struct.Window.html).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Window)
pub fn window() -> Window {
unsafe { js!( return window; ).into_reference_unchecked() }.unwrap()
}
impl Window {
/// The Window.alert() method displays an alert dialog
/// with the optional specified content and an OK button.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Window/alert)
// https://html.spec.whatwg.org/#the-window-object:dom-alert
pub fn alert( &self, message: &str ) {
js!( @(no_return)
@{self}.alert( @{message} );
);
}
/// The `local_storage` property allows you to access a local [Storage](struct.Storage.html)
/// object.
///
/// It is similar to the [Window::session_storage](struct.Window.html#method.session_storage).
/// The only difference is that, while data stored in `local_storage` has
/// no expiration time, data stored in `session_storage` gets cleared when
/// the browsing session ends - that is, when the browser is closed.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage)
// https://html.spec.whatwg.org/#the-localstorage-attribute:dom-localstorage
pub fn local_storage( &self ) -> Storage {
unsafe {
js!(
return @{self.as_ref()}.localStorage;
).into_reference_unchecked().unwrap()
}
}
/// The `session_storage` property allows you to access a session [Storage](struct.Storage.html)
/// object for the current origin.
///
/// It is similar to the [Window::local_storage](struct.Window.html#method.local_storage),
/// The only difference is that, while data stored in `local_storage` has
/// no expiration time, data stored in `session_storage` gets cleared when
/// the browsing session ends.
///
/// A page session lasts for as long as the browser is open and survives over
/// page reloads and restores. Opening a page in a new tab or window will cause
/// a new session to be initiated, which differs from how session cookies work.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage)
// https://html.spec.whatwg.org/#the-sessionstorage-attribute:dom-sessionstorage
pub fn session_storage( &self ) -> Storage {
unsafe {
js!(
return @{self.as_ref()}.sessionStorage;
).into_reference_unchecked().unwrap()
}
}
/// Returns a [Location](struct.Location.html) object which contains
/// information about the URL of the document and provides methods
/// for changing that URL and loading another URL.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Window/location)
// https://html.spec.whatwg.org/#the-window-object:dom-location
pub fn location( &self ) -> Option< Location > {
unsafe {
js!(
return @{self}.location;
).into_reference_unchecked()
}
}
/// You should call this method whenever you're ready to update your animation onscreen.
/// This will request that your animation function be called before the browser performs the next repaint.
/// The number of callbacks is usually 60 times per second, but will generally match the display refresh
/// rate in most web browsers as per W3C recommendation. request_animation_frame() calls are paused in most browsers
/// when running in background tabs or hidden iframes in order to improve performance and battery life.
///
/// The callback method is passed a single argument, a f64, which indicates the current time when
/// callbacks queued by requestAnimationFrame() begin to fire. Multiple callbacks in a single frame, therefore,
/// each receive the same timestamp even though time has passed during the computation of every previous callback's workload.
/// This timestamp is a decimal number, in milliseconds, but with a minimal precision of 1ms (1000 µs).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame)
// https://html.spec.whatwg.org/#the-window-object:dom-window-requestanimationframe
pub fn request_animation_frame< F: FnOnce(f64) + 'static>( &self, callback: F) -> RequestAnimationFrameHandle {
let values: Value = js!{
var callback = @{Once(callback)};
var request = @{self}.requestAnimationFrame(callback);
return { request: request, callback: callback, window: @{self} };
};
RequestAnimationFrameHandle(values)
}
/// Returns the global [History](struct.History.html) object, which provides methods to
/// manipulate the browser history.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Window/history)
// https://html.spec.whatwg.org/#the-window-object:dom-history
pub fn history(&self) -> History {
unsafe {
js!(
return @{self}.history;
).into_reference_unchecked().unwrap()
}
}
/// Returns the width (in pixels) of the browser window viewport including, if rendered,
/// the vertical scrollbar.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/window/innerWidth)
// https://drafts.csswg.org/cssom-view/#ref-for-dom-window-innerwidth
pub fn inner_width(&self) -> i32 {
js!(
return @{self}.innerWidth;
).try_into().unwrap()
}
/// Returns the height (in pixels) of the browser window viewport including, if rendered,
/// the horizontal scrollbar.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/window/innerHeight)
// https://drafts.csswg.org/cssom-view/#ref-for-dom-window-innerheight
pub fn inner_height(&self) -> i32 {
js!(
return @{self}.innerHeight;
).try_into().unwrap()
}
/// Returns the width of the outside of the browser window. It represents the width
/// of the whole browser window including sidebar (if expanded), window chrome
/// and window resizing borders/handles.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Window/outerWidth)
// https://drafts.csswg.org/cssom-view/#ref-for-dom-window-outerheight
pub fn outer_width(&self) -> i32 {
js!(
return @{self}.outerWidth;
).try_into().unwrap()
}
/// Returns the height of the outside of the browser window. It represents the height
/// of the whole browser window including sidebar (if expanded), window chrome
/// and window resizing borders/handles.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Window/outerHeight)
// https://drafts.csswg.org/cssom-view/#ref-for-dom-window-outerheight
pub fn outer_height(&self) -> i32 {
js!(
return @{self}.outerHeight;
).try_into().unwrap()
}
}