Lib.rs

Cargo Features

[dependencies]
leptos-use = { version = "0.14.0-rc3", default-features = false, features = ["use_textarea_autosize", "use_web_lock", "use_window_size", "actix", "axum", "element", "is", "is_some", "math", "on_click_outside", "signal_debounced", "signal_throttled", "spin", "ssr", "storage", "sync_signal", "use_active_element", "use_breakpoints", "use_broadcast_channel", "use_clipboard", "use_color_mode", "use_cookie", "use_css_var", "use_cycle_list", "use_debounce_fn", "use_device_orientation", "use_device_pixel_ratio", "use_display_media", "use_document", "use_document_visibility", "use_draggable", "use_drop_zone", "use_element_bounding", "use_element_hover", "use_element_size", "use_element_visibility", "use_event_listener", "use_event_source", "use_favicon", "use_geolocation", "use_idle", "use_infinite_scroll", "use_intersection_observer", "use_interval", "use_interval_fn", "use_intl_number_format", "use_locale", "use_locales", "use_media_query", "use_mouse", "use_mouse_in_element", "use_mutation_observer", "use_permission", "use_preferred_contrast", "use_preferred_dark", "use_prefers_reduced_motion", "use_raf_fn", "use_resize_observer", "use_scroll", "use_service_worker", "use_sorted", "use_supported", "use_throttle_fn", "use_timeout_fn", "use_timestamp", "use_to_string", "use_user_media", "use_web_notification", "use_websocket", "use_window", "use_window_focus", "use_window_scroll", "wasm_ssr", "watch_debounced", "watch_pausable", "watch_throttled", "watch_with_options", "whenever", "docs", "async-trait", "gloo-utils"] }

default = is_err, is_none, is_ok, is_some, on_click_outside, signal_debounced, signal_throttled, storage, sync_signal, use_active_element, use_breakpoints, use_broadcast_channel, use_clipboard, use_color_mode, use_cookie, use_css_var, use_cycle_list, use_debounce_fn, use_device_orientation, use_device_pixel_ratio, use_display_media, use_document, use_document_visibility, use_draggable, use_drop_zone, use_element_bounding, use_element_hover, use_element_size, use_element_visibility, use_event_listener, use_event_source, use_favicon, use_geolocation, use_idle, use_infinite_scroll, use_intersection_observer, use_interval, use_interval_fn, use_intl_number_format, use_locale, use_locales, use_media_query, use_mouse, use_mouse_in_element, use_mutation_observer, use_permission, use_preferred_contrast, use_preferred_dark, use_prefers_reduced_motion, use_raf_fn, use_resize_observer, use_scroll, use_service_worker, use_sorted, use_supported, use_textarea_autosize, use_throttle_fn, use_timeout_fn, use_timestamp, use_to_string, use_toggle, use_user_media, use_web_lock, use_web_notification, use_websocket, use_window, use_window_focus, use_window_scroll, use_window_size, watch_debounced, watch_pausable, watch_throttled, watch_with_options, whenever

These default features are set whenever leptos-use is added without default-features = false somewhere in the dependency tree.

use_textarea_autosize default = use_resize_observer

Enables CssStyleDeclaration, HtmlElement and HtmlTextAreaElement of web-sys

use_web_lock default

Enables AbortSignal, Lock, LockManager, LockMode, LockOptions and Navigator of web-sys

use_window_size default = use_media_query

actix

Enables actix-web, http ^0.2, and leptos_actix

axum

Enables http and leptos_axum

element use_event_listener use_intersection_observer use_mouse use_mutation_observer use_resize_observer use_scroll = use_document, use_window

Enables EventTarget of web-sys

is on_click_outside = use_window

is_err is_none is_ok is_some default

math = num

Affects leptos-use::math…

on_click_outside default = is, use_event_listener

signal_debounced default = use_debounce_fn

signal_throttled default = use_throttle_fn

spin

Enables http and leptos-spin

ssr

storage default use_color_mode = use_event_listener, use_window, watch_with_options

Enables codee, CustomEventInit and Storage of web-sys

Affects leptos-use::storage…

sync_signal default use_color_mode

use_active_element default = use_event_listener

use_breakpoints default = use_media_query

use_broadcast_channel default use_cookie = use_event_listener, use_supported

Enables codee, BroadcastChannel of web-sys

use_clipboard default = use_event_listener, use_permission, use_supported, use_timeout_fn

Enables Clipboard of web-sys

use_color_mode default = storage, sync_signal, use_cookie, use_cycle_list, use_preferred_dark

use_cookie default use_color_mode = use_broadcast_channel, watch_pausable

Enables cookie, HtmlDocument of web-sys

use_css_var default = use_mutation_observer, watch_with_options

use_cycle_list default use_color_mode

use_debounce_fn default signal_debounced use_scroll

use_device_orientation default = use_event_listener, use_supported

use_device_pixel_ratio default = use_event_listener

Enables MediaQueryList of web-sys

use_display_media default = use_window

Enables DisplayMediaStreamConstraints, MediaDevices, MediaStream and MediaStreamTrack of web-sys

use_document default element? use_idle use_window

Enables NodeList and VisibilityState of web-sys

use_document_visibility default = use_event_listener

Enables VisibilityState of web-sys

use_draggable default = use_event_listener

Enables DomRect of web-sys

use_drop_zone default = use_event_listener

Enables DataTransfer, File and FileList of web-sys

use_element_bounding default = use_event_listener, use_resize_observer

Enables DomRect of web-sys

use_element_hover default = use_event_listener

use_element_size default = use_resize_observer, watch_with_options

Enables ResizeObserverSize of web-sys

use_element_visibility default use_infinite_scroll = use_intersection_observer

Enables DomRect of web-sys

use_event_listener default on_click_outside storage use_active_element use_broadcast_channel use_clipboard use_device_orientation use_device_pixel_ratio use_document_visibility use_draggable use_drop_zone use_element_bounding use_element_hover use_event_source use_idle use_locales use_media_query use_mouse use_permission use_scroll use_web_notification use_window_focus use_window_scroll = element, watch_with_options

Enables EventListenerOptions and EventTarget of web-sys

use_event_source default = use_event_listener

Enables codee, EventSource and EventSourceInit of web-sys

use_favicon default

use_geolocation default = use_window

Enables Coordinates, Geolocation, Position, PositionError and PositionOptions of web-sys

use_idle default = use_document, use_event_listener, use_timestamp

use_infinite_scroll default = use_element_visibility, use_scroll

Enables futures-util and gloo-timers

use_intersection_observer default use_element_visibility = element, watch_with_options

Enables IntersectionObserver, IntersectionObserverEntry and IntersectionObserverInit of web-sys

use_interval default = use_interval_fn

use_interval_fn default use_interval use_timestamp

use_intl_number_format default

use_locale default = use_locales

Enables unic-langid

use_locales default use_locale = use_event_listener, use_window

use_media_query default use_breakpoints use_preferred_contrast use_preferred_dark use_prefers_reduced_motion use_window_size = use_event_listener

use_mouse default use_mouse_in_element = element, use_event_listener, use_window

Enables Touch and TouchList of web-sys

use_mouse_in_element default = use_mouse

Enables DomRect of web-sys

use_mutation_observer default use_css_var = element, use_supported

Enables MutationObserver, MutationObserverInit and MutationRecord of web-sys

use_permission default use_clipboard = use_event_listener

Enables PermissionState, PermissionStatus and Permissions of web-sys

use_preferred_contrast default = use_media_query

use_preferred_dark default use_color_mode = use_media_query

use_prefers_reduced_motion default = use_media_query

use_raf_fn default use_timestamp

use_resize_observer default use_element_bounding use_element_size use_textarea_autosize = element, use_supported

Enables DomRectReadOnly, ResizeObserver, ResizeObserverBoxOptions, ResizeObserverEntry and ResizeObserverOptions of web-sys

use_scroll default use_infinite_scroll = element, use_debounce_fn, use_event_listener, use_throttle_fn

Enables ScrollBehavior and ScrollToOptions of web-sys

use_service_worker default = use_window

Enables ServiceWorker, ServiceWorkerContainer and ServiceWorkerRegistration of web-sys

use_sorted default

use_supported default use_broadcast_channel use_clipboard use_device_orientation use_mutation_observer use_resize_observer use_web_notification

use_throttle_fn default signal_throttled use_scroll

use_timeout_fn default use_clipboard

use_timestamp default use_idle = use_interval_fn, use_raf_fn

use_toggle use_to_string default

use_user_media default = use_window

Enables MediaDevices, MediaStream, MediaStreamConstraints, MediaStreamTrack, MediaTrackConstraints and VideoFacingModeEnum of web-sys

use_web_notification default = use_event_listener, use_supported, use_window

Enables Notification, NotificationDirection, NotificationOptions, NotificationPermission and VisibilityState of web-sys

use_websocket default

Enables codee and web-sys

use_window default element? is? storage use_display_media use_geolocation use_locales use_mouse use_service_worker use_user_media use_web_notification use_window_scroll = use_document

Enables MediaQueryList and Navigator of web-sys

use_window_focus default = use_event_listener

use_window_scroll default = use_event_listener, use_window

wasm_ssr

watch_debounced default = watch_with_options

watch_pausable default use_cookie = watch_with_options

watch_throttled default = watch_with_options

watch_with_options default storage use_css_var use_element_size use_event_listener use_intersection_observer watch_debounced watch_pausable watch_throttled

whenever default

docs

Enables web-sys

Affects leptos-use::docs…

Features from optional dependencies

In crates that don't use the dep: syntax, optional dependencies automatically become Cargo features. These features may have been created by mistake, and this functionality may be removed in the future.

async-trait implicit feature

Enables async-trait

async-trait:

Type erasure for async trait methods

gloo-utils implicit feature

Enables gloo-utils

gloo-utils:

Convenience crate for common web_sys features

num math?