beet_core 0.0.8

Core utilities and types for other beet crates
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

//! DOM helpers for working with `web_sys::Document` in a cohesive, extension-free style.
//!
//! This module provides small, focused functions that wrap common DOM patterns.
//! Functions are named to read clearly at call-sites and return typed elements
//! whenever possible.
//!
//! Design:
//! - Prefer simple, ergonomic free functions over ad-hoc extension traits.
//! - Panic on missing `window`/`document` (tests run in a DOM-enabled wasm environment).
//! - Return `Result<_, JsValue>` only when interacting with DOM APIs that already return errors (e.g., creating script/link elements).
//!
//! Examples
//!
//! Create and append a div to the body:
//! ```
//! use beet_core::web_utils::document_ext::*;
//! let div = create_div();
//! div.set_inner_html("hello");
//! append_child(&div);
//! ```
//!
//! Find a typed element via CSS selector:
//! ```
//! use beet_core::web_utils::document_ext::*;
//! let div = create_div();
//! div.set_id("my-div");
//! append_child(&div);
//! let found = query_selector::<web_sys::HtmlDivElement>("#my-div").unwrap();
//! assert_eq!(found.id(), "my-div");
//! ```
//!
//! Add a style to the page head:
//! ```
//! use beet_core::web_utils::document_ext::*;
//! let link = add_style_src_to_head("data:text/css,body{display:block}").unwrap();
//! assert_eq!(link.rel(), "stylesheet");
//! ```

use crate::prelude::*;
use futures_lite::future::race;
use wasm_bindgen::JsCast;
use wasm_bindgen::JsValue;
use web_sys::Document;
use web_sys::Event;
use web_sys::HtmlAnchorElement;
use web_sys::HtmlButtonElement;
use web_sys::HtmlCanvasElement;
use web_sys::HtmlDivElement;
use web_sys::HtmlElement;
use web_sys::HtmlHeadElement;
use web_sys::HtmlInputElement;
use web_sys::HtmlLinkElement;
use web_sys::HtmlParagraphElement;
use web_sys::HtmlScriptElement;
use web_sys::KeyboardEvent;
use web_sys::MouseEvent;
use web_sys::Node;
use web_sys::Window;

fn window() -> Window { web_sys::window().unwrap() }

/// Return the current document.
pub fn document() -> Document { window().document().unwrap() }

/// Return the `<head>` element of the current document.
pub fn head() -> HtmlHeadElement { document().head().unwrap() }

/// Return the `<body>` element of the current document.
pub fn body() -> HtmlElement { document().body().unwrap() }

/// Append a node to the end of `<body>`.
pub fn append_child(node: &Node) { body().append_child(node).unwrap(); }

/// Remove all children from `<body>`.
pub fn clear_body() {
	let body_el = body();
	while let Some(child) = body_el.first_child() {
		body_el.remove_child(&child).unwrap();
	}
}

/// Query the document and, if found, downcast the element to `T`.
///
/// Returns `None` if no element matches the selector.
pub fn query_selector<T>(selector: &str) -> Option<T>
where
	T: JsCast,
{
	document()
		.query_selector(selector)
		.unwrap()
		.map(|el| el.dyn_into::<T>().unwrap())
}

/// Create an `HtmlElement` with the provided tag name.
pub fn create_element(local_name: &str) -> HtmlElement {
	document()
		.create_element(local_name)
		.unwrap()
		.dyn_into()
		.unwrap()
}

/// Create a typed anchor element.
pub fn create_anchor() -> HtmlAnchorElement {
	document().create_element("a").unwrap().dyn_into().unwrap()
}

/// Create a typed canvas element.
pub fn create_canvas() -> HtmlCanvasElement {
	document()
		.create_element("canvas")
		.unwrap()
		.dyn_into()
		.unwrap()
}

/// Create a typed div element.
pub fn create_div() -> HtmlDivElement {
	document()
		.create_element("div")
		.unwrap()
		.dyn_into()
		.unwrap()
}

/// Create a typed input element.
pub fn create_input() -> HtmlInputElement {
	document()
		.create_element("input")
		.unwrap()
		.dyn_into()
		.unwrap()
}

/// Create a typed button element.
pub fn create_button() -> HtmlButtonElement {
	document()
		.create_element("button")
		.unwrap()
		.dyn_into()
		.unwrap()
}

/// Await the user's first interaction with the document (mousedown, scroll, or keydown).
/// Implemented using a Stream-based HtmlEventListener and racing the first next() without polling.
pub async fn await_interaction() {
	// Create three event streams on the window
	let mut on_click = HtmlEventListener::<MouseEvent>::new("mousedown");
	let mut on_scroll = HtmlEventListener::<Event>::new("scroll");
	let mut on_key = HtmlEventListener::<KeyboardEvent>::new("keydown");

	// Race the first event from any of the streams
	let click = async {
		on_click.next().await;
	};
	let scroll = async {
		on_scroll.next().await;
	};
	let key = async {
		on_key.next().await;
	};
	let _ = race(click, race(scroll, key)).await;
}


/// Create a typed paragraph element.
pub fn create_paragraph() -> HtmlParagraphElement {
	document().create_element("p").unwrap().dyn_into().unwrap()
}

/// Create a `<script src="...">` in the `<head>`.
///
/// Returns the created `HtmlScriptElement`.
pub fn add_script_src_to_head(src: &str) -> Result<HtmlScriptElement, JsValue> {
	let el = document()
		.create_element("script")?
		.dyn_into::<HtmlScriptElement>()?;
	el.set_src(src);
	el.set_type("text/javascript");
	head().append_child(&el)?;
	Ok(el)
}

/// Create a `<script>` with inline JS in the `<body>`.
///
/// Returns the created `HtmlScriptElement`.
pub fn add_script_content_to_body(
	code: &str,
) -> Result<HtmlScriptElement, JsValue> {
	let el = document()
		.create_element("script")?
		.dyn_into::<HtmlScriptElement>()?;
	el.set_type("text/javascript");
	el.set_inner_html(code);
	body().append_child(&el)?;
	Ok(el)
}

/// Create a `<link rel="stylesheet" href="...">` in the `<head>`.
///
/// Returns the created `HtmlLinkElement`.
pub fn add_style_src_to_head(src: &str) -> Result<HtmlLinkElement, JsValue> {
	let el = document()
		.create_element("link")?
		.dyn_into::<HtmlLinkElement>()?;
	el.set_href(src);
	el.set_rel("stylesheet");
	el.set_type("text/css");
	head().append_child(&el)?;
	Ok(el)
}

#[cfg(test)]
mod tests {
	use crate::prelude::*;
	use web_sys::HtmlDivElement;
	use web_sys::HtmlLinkElement;
	use web_sys::HtmlScriptElement;

	#[ignore = "requires dom"]
	#[test]
	fn runs_in_wasm() {
		// This ensures the test harness can reach the DOM.
		let _ = document_ext::document();
		let _ = document_ext::head();
		let _ = document_ext::body();
	}

	#[ignore = "requires dom"]
	#[test]
	fn creates_and_appends_div() {
		document_ext::clear_body();

		let div = document_ext::create_div();
		div.set_id("greeting");
		div.set_inner_html("hello");
		document_ext::append_child(&div);

		let found = document_ext::query_selector::<HtmlDivElement>("#greeting")
			.unwrap();
		found.inner_html().xpect_eq("hello");
	}

	#[ignore = "requires dom"]
	#[crate::test]
	async fn adds_script_and_style() {
		document_ext::clear_body();
		let _script =
			document_ext::add_script_content_to_body("window.__beet_flag = 1;")
				.unwrap();
		let _style = document_ext::add_style_src_to_head(
			"data:text/css,body{outline:0}",
		)
		.unwrap();

		let script_el =
			document_ext::query_selector::<HtmlScriptElement>("body script");
		let style_el = document_ext::query_selector::<HtmlLinkElement>(
			"head link[rel='stylesheet']",
		);

		script_el.is_some().xpect_true();
		style_el.is_some().xpect_true();
	}
}