[yew-devel] [PATCH yew-widget-toolkit 1/2] dom: add convenience functions to get often used elements

Fri May 2 14:49:50 CEST 2025

Namely window/document/body. We use them throughout our codebase with
inline unwraps, instead we can use these helpers instead.

Signed-off-by: Dominik Csapak <d.csapak at proxmox.com>
---
 src/dom/mod.rs | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/src/dom/mod.rs b/src/dom/mod.rs
index f61dd21..679fab7 100644
--- a/src/dom/mod.rs
+++ b/src/dom/mod.rs
@@ -13,7 +13,7 @@ pub use dom_size_observer::{DomSizeObserver, IntoSizeCallback, SizeCallback};
 mod dom_visibility_observer;
 pub use dom_visibility_observer::DomVisibilityObserver;
 
-use web_sys::Node;
+use web_sys::{window, Document, HtmlElement, Node, Window};
 use yew::prelude::*;
 
 /// A Trait to convert structs into HtmlElement when possible
@@ -77,3 +77,21 @@ pub fn get_system_prefer_dark_mode() -> bool {
         false
     }
 }
+
+/// Convenience function to get the [`Window`] object.
+/// Panics if not in a browser context
+pub fn get_window() -> Window {
+    window().unwrap()
+}
+
+/// Convenience function to get the [`Document`] object.
+/// Panics if not in a browser context
+pub fn get_document() -> Document {
+    get_window().document().unwrap()
+}
+
+/// Convenience function to get the a reference to the <body> tag as [`HtmlElement`].
+/// Panics if not in a browser context
+pub fn get_body() -> HtmlElement {
+    get_document().body().unwrap()
+}
-- 
2.39.5



