Struct UseEventListenerOptions

pub struct UseEventListenerOptions { /* private fields */ }

Options for use_event_listener_with_options.

Implementations

impl UseEventListenerOptions

pub fn capture(self, value: bool) -> Self

A boolean value indicating that events of this type will be dispatched to the registered listener before being dispatched to any EventTarget beneath it in the DOM tree. If not specified, defaults to false.

pub fn once(self, value: bool) -> Self

A boolean value indicating that the listener should be invoked at most once after being added. If true, the listener would be automatically removed when invoked. If not specified, defaults to false.

pub fn passive<OptionInnerType>( self, value: impl Into<Option<OptionInnerType>>, ) -> Self

where OptionInnerType: Into<bool>,

A boolean value that, if true, indicates that the function specified by listener will never call preventDefault(). If a passive listener does call preventDefault(), the user agent will do nothing other than generate a console warning. If not specified, defaults to false – except that in browsers other than Safari, defaults to true for the wheel, mousewheel, touchstart and touchmove events. See Improving scrolling performance with passive listeners to learn more.

Trait Implementations

impl Clone for UseEventListenerOptions

fn clone(&self) -> UseEventListenerOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for UseEventListenerOptions

fn default() -> UseEventListenerOptions

Returns the “default value” for a type.

impl Copy for UseEventListenerOptions