Crate leptos_use

Collection of essential Leptos utilities inspired by SolidJS USE / VueUse

Re-exports

• pub use crate::utils::DebounceOptions;
• pub use crate::utils::ThrottleOptions;

Modules

• core
• utils

Structs

• Directions
• ScrollOffset
  Threshold in pixels when we consider a side to have arrived (UseScrollReturn::arrived_state).
• UseMouseEventExtractorDefault
• UseMouseOptions
• UseMouseReturn
  Return type of use_mouse.
• UseScrollOptions
  Options for use_scroll.
• UseScrollReturn
  The return value of use_scroll.

Enums

• ScrollBehavior
  The scroll behavior. Can be Auto (= not smooth) or Smooth. Defaults to Auto.
• UseMouseCoordType
  Defines how to get the coordinates from the event.
• UseMouseSourceType
  Identifies the source of the reported coordinates

Traits

• UseMouseEventExtractor
  Trait to implement if you want to specify a custom extractor

Functions

• use_debounce_fn
  Debounce execution of a function.
• use_debounce_fn_with_arg
  Version of use_debounce_fn with an argument for the debounced function. See the docs for use_debounce_fn for how to use.
• use_debounce_fn_with_arg_and_options
  Version of use_debounce_fn_with_arg with debounce options.
• use_debounce_fn_with_options
  Version of use_debounce_fn with debounce options. See the docs for use_debounce_fn for how to use.
• use_event_listener
  Use EventListener with ease. Register using addEventListener on mounted, and removeEventListener automatically on cleanup.
• use_event_listener_with_options
  Version of use_event_listener that takes web_sys::AddEventListenerOptions. See the docs for use_event_listener for how to use.
• use_mouse
  Reactive mouse position
• use_mouse_with_options
  Variant of use_mouse that accepts options. Please see use_mouse for how to use.
• use_scroll
  Reactive scroll position and state.
• use_scroll_with_options
  Version of use_scroll with options. See use_scroll for how to use.
• use_supported
  SSR compatibe is_supported
• use_throttle_fn
  Throttle execution of a function. Especially useful for rate limiting execution of handlers on events like resize and scroll.
• use_throttle_fn_with_arg
  Version of use_throttle_fn with an argument for the throttled function. See the docs for use_throttle_fn for how to use.
• use_throttle_fn_with_arg_and_options
  Version of use_throttle_fn_with_arg with throttle options. See the docs for use_throttle_fn for how to use.
• use_throttle_fn_with_options
  Version of use_throttle_fn with throttle options. See the docs for use_throttle_fn for how to use.
• watch
  A version of create_effect that listens to any dependency that is accessed inside deps. Also a stop handler is returned. If immediate is false, the callback will not run immediately but only after the first change is detected of any signal that is accessed in deps. The return value of deps is passed into callback as an argument together with the previous value and the previous value that the callback itself returned last time.