Struct gloo_events::EventListenerOptions

pub struct EventListenerOptions {
    pub phase: EventListenerPhase,
    pub passive: bool,
}

Specifies options for EventListener::new_with_options and EventListener::once_with_options.

Default

EventListenerOptions {
    phase: EventListenerPhase::Bubble,
    passive: true,
}

Examples

Sets phase to EventListenerPhase::Capture, using the default for the rest:

let options = EventListenerOptions::run_in_capture_phase();

Sets passive to false, using the default for the rest:

let options = EventListenerOptions::enable_prevent_default();

Specifies all options:

let options = EventListenerOptions {
    phase: EventListenerPhase::Capture,
    passive: false,
};

Fields

phase: EventListenerPhase

The phase that the event listener should be run in.

passive: bool

If this is true then performance is improved, but it is not possible to use event.prevent_default().

If this is false then performance might be reduced, but now it is possible to use event.prevent_default().

You can read more about the performance costs here.

Methods

impl EventListenerOptions

pub fn run_in_capture_phase() -> Self

Returns an EventListenerOptions with phase set to EventListenerPhase::Capture.

This is the same as:

EventListenerOptions {
    phase: EventListenerPhase::Capture,
    ..Default::default()
}

pub fn enable_prevent_default() -> Self

Returns an EventListenerOptions with passive set to false.

This is the same as:

EventListenerOptions {
    passive: false,
    ..Default::default()
}

Trait Implementations

impl Default for EventListenerOptions

fn default() -> Self

Returns the "default value" for a type.

impl Clone for EventListenerOptions

fn clone(&self) -> EventListenerOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for EventListenerOptions

impl Debug for EventListenerOptions

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.