Struct percy_dom::event::VirtualEvents

pub struct VirtualEvents { /* private fields */ }

When we create a DOM node, we store all of it’s closures and all of it’s children’s closures in VirtualEvents.

When an element gets interacted with in the DOM it’s event handlers get looked up in VirtualEvents.

This helps power event delegation, where for many events kinds of events such as onclick we use a single event listener on the element that the application was mounted on and then as events occur we look up the event handlers in VirtualEvents.

This is faster since instead of needing to add and remove event listeners from the DOM after when applying patches we can simply overwrite the old closures in VirtualEvents with new ones.

Cloning

VirtualEvents can be cloned cheaply. Clones share the same inner data.

Implementations

impl VirtualEvents

pub fn new() -> VirtualEvents

Create a new EventsByNodeIdx.

pub fn events_id_props_prefix(&self) -> f64

Unique for every PercyDom so that if multiple instances of PercyDom are nested their event delegation handlers don’t collide.

pub fn root(&self) -> Rc<RefCell<VirtualEventNode>>

Get the root event node.

pub fn set_root(&self, root: VirtualEventNode)

Set the root event node.

pub fn insert_event( &self, events_id: ElementEventsId, event_name: EventName, event: EventHandler, wrapper: Option<Rc<dyn AsRef<JsValue> + 'static>> )

Insert a newly tracked event.

Panics

Panics if the event_name is delegated and the event is not, or vice versa.

pub fn overwrite_event_attrib_fn( &self, events_id: &ElementEventsId, event_name: &EventName, event: EventHandler )

Overwrite an event handler.

Panics

Panics if there isn’t an event attrib fn to overwrite.

pub fn remove_non_delegated_event_wrapper( &mut self, events_id: &ElementEventsId, event_name: &EventName ) -> Rc<dyn AsRef<JsValue> + 'static>

Remove a managed event.

pub fn get_event_handler( &self, events_id: &ElementEventsId, event_name: &EventName ) -> Option<EventHandler>

Get the event handler for a node.

pub fn remove_event_handler( &self, events_id: &ElementEventsId, event_name: &EventName ) -> Option<EventHandler>

Remove an event handler.

pub fn remove_node(&self, events_id: &ElementEventsId)

Remove all event handlers for a node.

pub fn create_element_node(&self) -> VirtualEventNode

Create a new element node.

pub fn create_text_node(&self) -> VirtualEventNode

Create a new element node.

Trait Implementations

impl Clone for VirtualEvents

fn clone(&self) -> VirtualEvents

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.