Struct UseIdleOptions

pub struct UseIdleOptions { /* private fields */ }

Options for use_idle_with_options.

Implementations

impl UseIdleOptions

pub fn events(self, value: Vec<String>) -> Self

Event names to listen to for detected user activity. Default: vec!["mousemove", "mousedown", "resize", "keydown", "touchstart", "wheel"].

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

Whether to listen for document visibility change. Defaults to true.

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

Initial state of the returned idle. Defaults to false.

pub fn filter(self, value: FilterOptions) -> Self

Allows to debounce or throttle the event listener that is called for every event (from events). Defaults to a throttle by 50ms.

impl UseIdleOptions

pub fn debounce(self, ms: impl Into<MaybeSignal<f64>>) -> Self

Debounce the event listener by ms milliseconds.

pub fn debounce_with_options( self, ms: impl Into<MaybeSignal<f64>>, options: DebounceOptions, ) -> Self

Debounce the event listener by ms milliseconds with additional options.

pub fn throttle(self, ms: impl Into<MaybeSignal<f64>>) -> Self

Throttle the event listener by ms milliseconds.

pub fn throttle_with_options( self, ms: impl Into<MaybeSignal<f64>>, options: ThrottleOptions, ) -> Self

Throttle the event listener by ms milliseconds with additional options.

Trait Implementations

impl Default for UseIdleOptions

fn default() -> Self

Returns the “default value” for a type.