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
use crate::core::Size;
use crate::{
use_event_listener_with_options, use_media_query, use_window, UseEventListenerOptions,
};
use default_struct_builder::DefaultBuilder;
use leptos::ev::resize;
use leptos::prelude::*;
/// Reactive window size.
///
/// ## Demo
///
/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_window_size)
///
/// ## Usage
///
/// ```
/// # use leptos::*;
/// # use leptos_use::{use_window_size, UseWindowSizeReturn};
/// #
/// # #[component]
/// # fn Demo() -> impl IntoView {
/// let UseWindowSizeReturn { width, height } = use_window_size();
/// #
/// # view! { }
/// # }
/// ```
///
/// ## Server-Side Rendering
///
/// On the server the width and height are always `initial_size` which defaults to
/// `Size { width: INFINITY, height: INFINITY }`.
// #[doc(cfg(feature = "use_window_size"))]
pub fn use_window_size() -> UseWindowSizeReturn {
use_window_size_with_options(UseWindowSizeOptions::default())
}
/// Version of [`fn@crate::use_window_size`] that takes a `UseWindowSizeOptions`. See [`fn@crate::use_window_size`] for how to use.
// #[doc(cfg(feature = "use_window_size"))]
pub fn use_window_size_with_options(options: UseWindowSizeOptions) -> UseWindowSizeReturn {
let UseWindowSizeOptions {
initial_size,
listen_orientation,
include_scrollbar,
measure_type,
} = options;
let (width, set_width) = signal(initial_size.width);
let (height, set_height) = signal(initial_size.height);
let update;
#[cfg(not(feature = "ssr"))]
{
update = move || match measure_type {
MeasureType::Outer => {
set_width.set(
window()
.outer_width()
.expect("failed to get window width")
.as_f64()
.expect("width is not a f64"),
);
set_height.set(
window()
.outer_height()
.expect("failed to get window height")
.as_f64()
.expect("height is not a f64"),
);
}
MeasureType::Inner => {
if include_scrollbar {
set_width.set(
window()
.inner_width()
.expect("failed to get window width")
.as_f64()
.expect("width is not a f64"),
);
set_height.set(
window()
.inner_height()
.expect("failed to get window height")
.as_f64()
.expect("height is not a f64"),
);
} else {
set_width.set(
document()
.document_element()
.expect("no document element")
.client_width() as f64,
);
set_height.set(
document()
.document_element()
.expect("no document element")
.client_height() as f64,
);
}
}
};
}
#[cfg(feature = "ssr")]
{
update = || {};
let _ = initial_size;
let _ = include_scrollbar;
let _ = measure_type;
let _ = set_width;
let _ = set_height;
}
update();
let _ = use_event_listener_with_options(
use_window(),
resize,
move |_| update(),
UseEventListenerOptions::default().passive(true),
);
if listen_orientation {
let matches = use_media_query("(orientation: portrait)");
Effect::new(move |_| {
let _ = matches.get();
update();
});
}
UseWindowSizeReturn {
width: width.into(),
height: height.into(),
}
}
/// Options for [`fn@crate::use_window_size_with_options`].
// #[doc(cfg(feature = "use_window_size"))]
#[derive(DefaultBuilder)]
pub struct UseWindowSizeOptions {
/// The initial size before anything is measured (like on the server side).
/// Defaults to `Size { width: INFINITY, height: INFINITY }`.
initial_size: Size,
/// Listen to the window ` orientationchange ` event. Defaults to `true`.
listen_orientation: bool,
/// Whether the scrollbar should be included in the width and height
/// Only effective when `measure_type` is `MeasureType::Inner`.
/// Defaults to `true`.
include_scrollbar: bool,
/// Use `window.innerWidth` or `window.outerWidth`.
/// Defaults to `MeasureType::Inner`.
measure_type: MeasureType,
}
/// Type of the `measure_type` option.
#[derive(Default, Clone, Copy, PartialEq, Eq, Debug)]
pub enum MeasureType {
/// Use `window.innerWidth`
#[default]
Inner,
/// Use `window.outerWidth`
Outer,
}
impl Default for UseWindowSizeOptions {
fn default() -> Self {
Self {
initial_size: Size {
width: f64::INFINITY,
height: f64::INFINITY,
},
listen_orientation: true,
include_scrollbar: true,
measure_type: MeasureType::default(),
}
}
}
/// Return type of [`fn@crate::use_window_size`].
// #[doc(cfg(feature = "use_window_size"))]
pub struct UseWindowSizeReturn {
/// The width of the window.
pub width: Signal<f64>,
/// The height of the window.
pub height: Signal<f64>,
}