leptos_dom 0.7.0-beta

DOM operations for the Leptos web framework.
Documentation
pub mod typed;

use leptos_reactive::Oco;
use std::{cell::RefCell, collections::HashSet};
#[cfg(all(target_arch = "wasm32", feature = "web"))]
use wasm_bindgen::{
    convert::FromWasmAbi, intern, prelude::Closure, JsCast, JsValue,
    UnwrapThrowExt,
};

thread_local! {
    pub(crate) static GLOBAL_EVENTS: RefCell<HashSet<Oco<'static, str>>> = RefCell::new(HashSet::new());
}

// Used in template macro
#[doc(hidden)]
#[cfg(all(target_arch = "wasm32", feature = "web"))]
#[inline(always)]
pub fn add_event_helper<E: crate::ev::EventDescriptor + 'static>(
    target: &web_sys::Element,
    event: E,
    #[allow(unused_mut)] // used for tracing in debug
    mut event_handler: impl FnMut(E::EventType) + 'static,
) {
    let event_name = event.name();
    let event_handler = Box::new(event_handler);

    if E::BUBBLES {
        add_event_listener(
            target,
            event.event_delegation_key(),
            event_name,
            event_handler,
            &None,
        );
    } else {
        add_event_listener_undelegated(
            target,
            &event_name,
            event_handler,
            &None,
        );
    }
}

/// Adds an event listener to the target DOM element using implicit event delegation.
#[doc(hidden)]
#[cfg(all(target_arch = "wasm32", feature = "web"))]
pub fn add_event_listener<E>(
    target: &web_sys::Element,
    key: Oco<'static, str>,
    event_name: Oco<'static, str>,
    #[cfg(debug_assertions)] mut cb: Box<dyn FnMut(E)>,
    #[cfg(not(debug_assertions))] cb: Box<dyn FnMut(E)>,
    options: &Option<web_sys::AddEventListenerOptions>,
) where
    E: FromWasmAbi + 'static,
{
    cfg_if::cfg_if! {
      if #[cfg(debug_assertions)] {
        let span = ::tracing::Span::current();
        let cb = Box::new(move |e| {
          let prev = leptos_reactive::SpecialNonReactiveZone::enter();
          let _guard = span.enter();
          cb(e);
          leptos_reactive::SpecialNonReactiveZone::exit(prev);
        });
      }
    }

    let cb = Closure::wrap(cb as Box<dyn FnMut(E)>).into_js_value();
    let key = intern(&key);
    debug_assert_eq!(
        Ok(false),
        js_sys::Reflect::has(target, &JsValue::from_str(&key)),
        "Error while adding {key} event listener, a listener of type {key} \
         already present."
    );
    _ = js_sys::Reflect::set(target, &JsValue::from_str(&key), &cb);
    add_delegated_event_listener(&key, event_name, options);
}

#[doc(hidden)]
#[cfg(all(target_arch = "wasm32", feature = "web"))]
pub(crate) fn add_event_listener_undelegated<E>(
    target: &web_sys::Element,
    event_name: &str,
    #[cfg(debug_assertions)] mut cb: Box<dyn FnMut(E)>,
    #[cfg(not(debug_assertions))] cb: Box<dyn FnMut(E)>,
    options: &Option<web_sys::AddEventListenerOptions>,
) where
    E: FromWasmAbi + 'static,
{
    cfg_if::cfg_if! {
      if #[cfg(debug_assertions)] {
        let span = ::tracing::Span::current();
        let cb = Box::new(move |e| {
          let prev = leptos_reactive::SpecialNonReactiveZone::enter();
          let _guard = span.enter();
          cb(e);
          leptos_reactive::SpecialNonReactiveZone::exit(prev);
        });
      }
    }

    let event_name = intern(event_name);
    let cb = Closure::wrap(cb as Box<dyn FnMut(E)>).into_js_value();
    if let Some(options) = options {
        _ = target
            .add_event_listener_with_callback_and_add_event_listener_options(
                event_name,
                cb.unchecked_ref(),
                options,
            );
    } else {
        _ = target
            .add_event_listener_with_callback(event_name, cb.unchecked_ref());
    }
}

// cf eventHandler in ryansolid/dom-expressions
#[cfg(all(target_arch = "wasm32", feature = "web"))]
pub(crate) fn add_delegated_event_listener(
    key: &str,
    event_name: Oco<'static, str>,
    options: &Option<web_sys::AddEventListenerOptions>,
) {
    GLOBAL_EVENTS.with(|global_events| {
        let mut events = global_events.borrow_mut();
        if !events.contains(&event_name) {
            // create global handler
            let key = JsValue::from_str(&key);
            let handler = move |ev: web_sys::Event| {
                let target = ev.target();
                let node = ev.composed_path().get(0);
                let mut node = if node.is_undefined() || node.is_null() {
                    JsValue::from(target)
                } else {
                    node
                };

                // TODO reverse Shadow DOM retargetting

                // TODO simulate currentTarget

                while !node.is_null() {
                    let node_is_disabled = js_sys::Reflect::get(
                        &node,
                        &JsValue::from_str("disabled"),
                    )
                    .unwrap_throw()
                    .is_truthy();
                    if !node_is_disabled {
                        let maybe_handler =
                            js_sys::Reflect::get(&node, &key).unwrap_throw();
                        if !maybe_handler.is_undefined() {
                            let f = maybe_handler
                                .unchecked_ref::<js_sys::Function>();

                            if let Err(e) = f.call1(&node, &ev) {
                                wasm_bindgen::throw_val(e);
                            }

                            if ev.cancel_bubble() {
                                return;
                            }
                        }
                    }

                    // navigate up tree
                    if let Some(parent) =
                        node.unchecked_ref::<web_sys::Node>().parent_node()
                    {
                        node = parent.into()
                    } else if let Some(root) = node.dyn_ref::<web_sys::ShadowRoot>() {
                        node = root.host().unchecked_into();
                    } else  {
                        node = JsValue::null()
                    }
                }
            };

            cfg_if::cfg_if! {
              if #[cfg(debug_assertions)] {
                let span = ::tracing::Span::current();
                let handler = move |e| {
                  let _guard = span.enter();
                  handler(e);
                };
              }
            }

            let handler = Box::new(handler) as Box<dyn FnMut(web_sys::Event)>;
            let handler = Closure::wrap(handler).into_js_value();
            if let Some(options) = options {
                _ = crate::window().add_event_listener_with_callback_and_add_event_listener_options(
                    &event_name,
                    handler.unchecked_ref(),
                    options,
                );
            } else {
                _ = crate::window().add_event_listener_with_callback(
                    &event_name,
                    handler.unchecked_ref(),
                );

            }

            // register that we've created handler
            events.insert(event_name);
        }
    })
}