mirror of
https://github.com/adoyle0/leptos-use.git
synced 2025-01-22 16:49:22 -05:00
Merge branch 'main' into leptos-0.7
# Conflicts: # .idea/leptos-use.iml # src/sync_signal.rs # template/examples/{{ function_name }}/Cargo.ffizer.hbs.toml
This commit is contained in:
commit
d63f4f4b99
125 changed files with 1970 additions and 203 deletions
4
.idea/leptos-use.iml
generated
4
.idea/leptos-use.iml
generated
|
@ -81,6 +81,10 @@
|
|||
<sourceFolder url="file://$MODULE_DIR$/examples/use_locale/src" isTestSource="false" />
|
||||
<sourceFolder url="file://$MODULE_DIR$/examples/use_locales/src" isTestSource="false" />
|
||||
<sourceFolder url="file://$MODULE_DIR$/examples/use_prefers_reduced_motion/src" isTestSource="false" />
|
||||
<sourceFolder url="file://$MODULE_DIR$/examples/use_toggle/src" isTestSource="false" />
|
||||
<sourceFolder url="file://$MODULE_DIR$/examples/use_web_lock/src" isTestSource="false" />
|
||||
<sourceFolder url="file://$MODULE_DIR$/examples/use_window_size/src" isTestSource="false" />
|
||||
<sourceFolder url="file://$MODULE_DIR$/examples/aaaaa/src" isTestSource="false" />
|
||||
<excludeFolder url="file://$MODULE_DIR$/examples/use_event_listener/target" />
|
||||
<excludeFolder url="file://$MODULE_DIR$/target" />
|
||||
<excludeFolder url="file://$MODULE_DIR$/docs/book/book" />
|
||||
|
|
40
CHANGELOG.md
40
CHANGELOG.md
|
@ -3,19 +3,45 @@
|
|||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [Unreleased] -
|
||||
## [0.13.2] - 2024-09-02
|
||||
|
||||
### Fix 🍕
|
||||
|
||||
- Fixed web-sys `unstable_apis` flag for `use_web_lock`
|
||||
|
||||
## [0.13.1] - 2024-09-01
|
||||
|
||||
### New Functions 🚀
|
||||
|
||||
- `use_prefers_reduced_motion`
|
||||
|
||||
### Breaking Change 🛠
|
||||
|
||||
- `use_websocket` now supports different types for sending and receiving messages
|
||||
- `use_web_lock`
|
||||
- `use_window_size`
|
||||
|
||||
### Change 🔥
|
||||
|
||||
- There is now a feature for almost every function to get better compile and rust-analyzer times.
|
||||
- `UseWebsocket::protocols` now supports a signal. It is read right before `open` is called. (thanks to @zakstucke)
|
||||
|
||||
## [0.13.0] - 2024-08-28
|
||||
|
||||
### New Functions 🚀
|
||||
|
||||
- `use_toggle`
|
||||
- `use_prefers_reduced_motion` (thanks to @hcandelaria)
|
||||
|
||||
### Breaking Changes 🛠
|
||||
|
||||
- `use_websocket` now supports different types for sending and receiving messages
|
||||
- `SyncSignalOptions` now can take now either transformations or assignment functions but not both.
|
||||
- updated to `codee` version 0.2.0
|
||||
|
||||
### Fixes 🍕
|
||||
|
||||
- `use_websocket` fixed error with cleanup and reconnect (thanks to @BakerNet).
|
||||
|
||||
### New Features 🚀
|
||||
|
||||
- There is now a feature for almost every function to get better compile and rust-analyzer times.
|
||||
- `use_web_notification` now supports the `vibrate` option (thanks to @hcandelaria).
|
||||
- `UseDocument` now supports a whole bunch of methods more from `document` (thanks to @luckynumberke7in).
|
||||
|
||||
## [0.12.0] - 2024-08-14
|
||||
|
||||
|
|
17
Cargo.toml
17
Cargo.toml
|
@ -1,6 +1,6 @@
|
|||
[package]
|
||||
name = "leptos-use"
|
||||
version = "0.12.0"
|
||||
version = "0.13.2"
|
||||
edition = "2021"
|
||||
authors = ["Marc-Stefan Cassola"]
|
||||
categories = ["gui", "web-programming"]
|
||||
|
@ -54,6 +54,8 @@ unic-langid = { version = "0.9", features = ["macros"] }
|
|||
|
||||
[features]
|
||||
default = [
|
||||
"use_web_lock",
|
||||
"use_window_size",
|
||||
"is_err",
|
||||
"is_none",
|
||||
"is_ok",
|
||||
|
@ -112,6 +114,7 @@ default = [
|
|||
"use_throttle_fn",
|
||||
"use_timeout_fn",
|
||||
"use_timestamp",
|
||||
"use_toggle",
|
||||
"use_to_string",
|
||||
"use_user_media",
|
||||
"use_web_notification",
|
||||
|
@ -125,6 +128,15 @@ default = [
|
|||
"watch_with_options",
|
||||
"whenever"
|
||||
]
|
||||
use_web_lock = [
|
||||
"web-sys/AbortSignal",
|
||||
"web-sys/Lock",
|
||||
"web-sys/LockManager",
|
||||
"web-sys/LockMode",
|
||||
"web-sys/LockOptions",
|
||||
"web-sys/Navigator",
|
||||
]
|
||||
use_window_size = ["use_media_query"]
|
||||
actix = ["dep:actix-web", "dep:leptos_actix", "dep:http0_2"]
|
||||
axum = ["dep:leptos_axum", "dep:http1"]
|
||||
docs = ["dep:web-sys"]
|
||||
|
@ -323,6 +335,7 @@ use_supported = []
|
|||
use_throttle_fn = []
|
||||
use_timeout_fn = []
|
||||
use_timestamp = ["use_interval_fn", "use_raf_fn"]
|
||||
use_toggle = []
|
||||
use_to_string = []
|
||||
use_user_media = [
|
||||
"use_window",
|
||||
|
@ -341,7 +354,7 @@ use_web_notification = [
|
|||
"web-sys/NotificationDirection",
|
||||
"web-sys/VisibilityState"
|
||||
]
|
||||
use_websocket = ["dep:codee"]
|
||||
use_websocket = ["dep:web-sys", "dep:codee"]
|
||||
use_window = ["use_document", "dep:web-sys", "web-sys/Navigator", "web-sys/MediaQueryList"]
|
||||
use_window_focus = ["use_event_listener"]
|
||||
use_window_scroll = ["use_event_listener", "use_window"]
|
||||
|
|
14
README.md
14
README.md
|
@ -13,7 +13,7 @@
|
|||
<a href="https://crates.io/crates/leptos-use"><img src="https://img.shields.io/crates/v/leptos-use.svg?label=&color=%232C1275" alt="Crates.io"/></a>
|
||||
<a href="https://leptos-use.rs/server_side_rendering.html"><img src="https://img.shields.io/badge/-SSR-%236a214b" alt="SSR"></a>
|
||||
<a href="https://leptos-use.rs"><img src="https://img.shields.io/badge/-docs%20%26%20demos-%239A233F" alt="Docs & Demos"></a>
|
||||
<a href="https://leptos-use.rs"><img src="https://img.shields.io/badge/-82%20functions-%23EF3939" alt="82 Functions" /></a>
|
||||
<a href="https://leptos-use.rs"><img src="https://img.shields.io/badge/-86%20functions-%23EF3939" alt="86 Functions" /></a>
|
||||
</p>
|
||||
|
||||
<br/>
|
||||
|
@ -87,9 +87,9 @@ This will create the function file in the src directory, scaffold an example dir
|
|||
|
||||
## Leptos compatibility
|
||||
|
||||
| Crate version | Compatible Leptos version |
|
||||
|------------------|---------------------------|
|
||||
| <= 0.3 | 0.3 |
|
||||
| 0.4, 0.5, 0.6 | 0.4 |
|
||||
| 0.7, 0.8, 0.9 | 0.5 |
|
||||
| 0.10, 0.11, 0.12 | 0.6 |
|
||||
| Crate version | Compatible Leptos version |
|
||||
|---------------|---------------------------|
|
||||
| <= 0.3 | 0.3 |
|
||||
| 0.4, 0.5, 0.6 | 0.4 |
|
||||
| 0.7, 0.8, 0.9 | 0.5 |
|
||||
| 0.10 – 0.13 | 0.6 |
|
||||
|
|
|
@ -32,6 +32,7 @@
|
|||
- [use_window](elements/use_window.md)
|
||||
- [use_window_focus](elements/use_window_focus.md)
|
||||
- [use_window_scroll](elements/use_window_scroll.md)
|
||||
- [use_window_size](elements/use_window_size.md)
|
||||
|
||||
# Browser
|
||||
|
||||
|
@ -51,6 +52,7 @@
|
|||
- [use_prefers_reduced_motion](browser/use_prefers_reduced_motion.md)
|
||||
- [use_service_worker](browser/use_service_worker.md)
|
||||
- [use_user_media](browser/use_user_media.md)
|
||||
- [use_web_lock](browser/use_web_lock.md)
|
||||
- [use_web_notification](browser/use_web_notification.md)
|
||||
|
||||
# Sensors
|
||||
|
@ -111,6 +113,7 @@
|
|||
- [use_supported](utilities/use_supported.md)
|
||||
- [use_throttle_fn](utilities/use_throttle_fn.md)
|
||||
- [use_to_string](utilities/use_to_string.md)
|
||||
- [use_toggle](utilities/use_toggle.md)
|
||||
|
||||
# Intl
|
||||
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_interval
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_interval -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_interval use_interval -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_interval_fn
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_interval_fn -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_interval_fn use_interval_fn -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_raf_fn
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_raf_fn -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_raf_fn use_raf_fn -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_timeout_fn
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_timeout_fn -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_timeout_fn use_timeout_fn -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_timestamp
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_timestamp -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_timestamp use_timestamp -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_breakpoints
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_breakpoints -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_breakpoints use_breakpoints -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_broadcast_channel
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_broadcast_channel -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_broadcast_channel use_broadcast_channel -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_clipboard
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_clipboard -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_clipboard use_clipboard -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_color_mode
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_color_mode -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_color_mode use_color_mode -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_cookie
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_cookie -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_cookie use_cookie -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_css_var
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_css_var -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_css_var use_css_var -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_display_media
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_display_media -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_display_media use_display_media -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_event_listener
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_event_listener -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_event_listener use_event_listener -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_favicon
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_favicon -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_favicon use_favicon -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_media_query
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_media_query -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_media_query use_media_query -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_permission
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_permission -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_permission use_permission -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_preferred_contrast
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_preferred_contrast -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_preferred_contrast use_preferred_contrast -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_preferred_dark
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_preferred_dark -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_preferred_dark use_preferred_dark -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_prefers_reduced_motion
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_prefers_reduced_motion -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_prefers_reduced_motion use_prefers_reduced_motion -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_service_worker
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_service_worker -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_service_worker use_service_worker -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_user_media
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_user_media -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_user_media use_user_media -->
|
||||
|
|
3
docs/book/src/browser/use_web_lock.md
Normal file
3
docs/book/src/browser/use_web_lock.md
Normal file
|
@ -0,0 +1,3 @@
|
|||
# use_web_lock
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_web_lock use_web_lock -->
|
|
@ -1,3 +1,3 @@
|
|||
# use_web_notification
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_web_notification -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_web_notification use_web_notification -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_active_element
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_active_element -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_active_element use_active_element -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_document
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_document -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_document use_document -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_document_visibility
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_document_visibility -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_document_visibility use_document_visibility -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_draggable
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_draggable -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_draggable use_draggable -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_drop_zone
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_drop_zone -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_drop_zone use_drop_zone -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_element_bounding
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_element_bounding -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_element_bounding use_element_bounding -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_element_size
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_element_size -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_element_size use_element_size -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_element_visibility
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_element_visibility -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_element_visibility use_element_visibility -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_intersection_observer
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_intersection_observer -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_intersection_observer use_intersection_observer -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_mouse_in_element
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_mouse_in_element -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_mouse_in_element use_mouse_in_element -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_mutation_observer
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_mutation_observer -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_mutation_observer use_mutation_observer -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_resize_observer
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_resize_observer -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_resize_observer use_resize_observer -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_window
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_window -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_window use_window -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_window_focus
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_window_focus -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_window_focus use_window_focus -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_window_scroll
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_window_scroll -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_window_scroll use_window_scroll -->
|
||||
|
|
3
docs/book/src/elements/use_window_size.md
Normal file
3
docs/book/src/elements/use_window_size.md
Normal file
|
@ -0,0 +1,3 @@
|
|||
# use_window_size
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_window_size use_window_size -->
|
|
@ -1,3 +1,3 @@
|
|||
# use_intl_number_format
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_intl_number_format -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_intl_number_format use_intl_number_format -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_locale
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_locale -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_locale use_locale -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_locales
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_locales -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_locales use_locales -->
|
||||
|
|
|
@ -12,6 +12,6 @@
|
|||
<a href="https://crates.io/crates/leptos-use"><img src="https://img.shields.io/crates/v/leptos-use.svg?label=&color=%232C1275" alt="Crates.io"/></a>
|
||||
<a href="https://leptos-use.rs/server_side_rendering.html"><img src="https://img.shields.io/badge/-SSR-%236a214b" alt="SSR"></a>
|
||||
<a href="./get_started.html"><img src="https://img.shields.io/badge/-docs%20%26%20demos-%239A233F" alt="Docs & Demos"></a>
|
||||
<a href="./functions.html"><img src="https://img.shields.io/badge/-82%20functions-%23EF3939" alt="82 Functions" /></a>
|
||||
<a href="./functions.html"><img src="https://img.shields.io/badge/-86%20functions-%23EF3939" alt="86 Functions" /></a>
|
||||
</p>
|
||||
</div>
|
|
@ -1,3 +1,3 @@
|
|||
# use_sorted
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_sorted -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_sorted use_sorted -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_event_source
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_event_source -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_event_source use_event_source -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_websocket
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_websocket -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_websocket use_websocket -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# signal_debounced
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py signal_debounced -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py signal_debounced signal_debounced -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# signal_throttled
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py signal_throttled -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py signal_throttled signal_throttled -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# sync_signal
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py sync_signal -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py sync_signal sync_signal -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# on_click_outside
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py on_click_outside -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py on_click_outside on_click_outside -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_device_orientation
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_device_orientation -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_device_orientation use_device_orientation -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_device_pixel_ratio
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_device_pixel_ratio -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_device_pixel_ratio use_device_pixel_ratio -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_element_hover
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_element_hover -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_element_hover use_element_hover -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_geolocation
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_geolocation -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_geolocation use_geolocation -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_idle
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_idle -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_idle use_idle -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_infinite_scroll
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_infinite_scroll -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_infinite_scroll use_infinite_scroll -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_mouse
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_mouse -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_mouse use_mouse -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_scroll
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_scroll -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_scroll use_scroll -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_local_storage
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py storage/use_local_storage -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py storage/use_local_storage storage -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_session_storage
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py storage/use_session_storage -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py storage/use_session_storage storage -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_storage
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py storage/use_storage -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py storage/use_storage storage -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# header
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py utils/header -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py utils/header utils/header -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# is_err
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py is_err -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py is_err is_err -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# is_none
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py is_none -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py is_none is_none -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# is_ok
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py is_ok -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py is_ok is_ok -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# is_some
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py is_some -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py is_some is_some -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_cycle_list
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_cycle_list -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_cycle_list use_cycle_list -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_debounce_fn
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_debounce_fn -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_debounce_fn use_debounce_fn -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_supported
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_supported -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_supported use_supported -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_throttle_fn
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_throttle_fn -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_throttle_fn use_throttle_fn -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# use_to_string
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_to_string -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_to_string use_to_string -->
|
||||
|
|
3
docs/book/src/utilities/use_toggle.md
Normal file
3
docs/book/src/utilities/use_toggle.md
Normal file
|
@ -0,0 +1,3 @@
|
|||
# use_toggle
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py use_toggle use_toggle -->
|
|
@ -1,3 +1,3 @@
|
|||
# watch_debounced
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py watch_debounced -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py watch_debounced watch_debounced -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# watch_pausable
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py watch_pausable -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py watch_pausable watch_pausable -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# watch_throttled
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py watch_throttled -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py watch_throttled watch_throttled -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# watch_with_options
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py watch -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py watch watch -->
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
# whenever
|
||||
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py whenever -->
|
||||
<!-- cmdrun python3 ../extract_doc_comment.py whenever whenever -->
|
||||
|
|
|
@ -55,11 +55,14 @@ members = [
|
|||
"use_throttle_fn",
|
||||
"use_timeout_fn",
|
||||
"use_timestamp",
|
||||
"use_toggle",
|
||||
"use_user_media",
|
||||
"use_web_lock",
|
||||
"use_web_notification",
|
||||
"use_websocket",
|
||||
"use_window_focus",
|
||||
"use_window_scroll",
|
||||
"use_window_size",
|
||||
"watch_debounced",
|
||||
"watch_pausable",
|
||||
"watch_throttled",
|
||||
|
|
16
examples/use_toggle/Cargo.toml
Normal file
16
examples/use_toggle/Cargo.toml
Normal file
|
@ -0,0 +1,16 @@
|
|||
[package]
|
||||
name = "use_toggle"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[dependencies]
|
||||
leptos = { version = "0.6", features = ["nightly", "csr"] }
|
||||
console_error_panic_hook = "0.1"
|
||||
console_log = "1"
|
||||
log = "0.4"
|
||||
leptos-use = { path = "../..", features = ["use_toggle", "docs"] }
|
||||
web-sys = "0.3"
|
||||
|
||||
[dev-dependencies]
|
||||
wasm-bindgen = "0.2"
|
||||
wasm-bindgen-test = "0.3.0"
|
23
examples/use_toggle/README.md
Normal file
23
examples/use_toggle/README.md
Normal file
|
@ -0,0 +1,23 @@
|
|||
A simple example for `use_toggle`.
|
||||
|
||||
If you don't have it installed already, install [Trunk](https://trunkrs.dev/) and [Tailwind](https://tailwindcss.com/docs/installation)
|
||||
as well as the nightly toolchain for Rust and the wasm32-unknown-unknown target:
|
||||
|
||||
```bash
|
||||
cargo install trunk
|
||||
npm install -D tailwindcss @tailwindcss/forms
|
||||
rustup toolchain install nightly
|
||||
rustup target add wasm32-unknown-unknown
|
||||
```
|
||||
|
||||
Then, open two terminals. In the first one, run:
|
||||
|
||||
```
|
||||
npx tailwindcss -i ./input.css -o ./style/output.css --watch
|
||||
```
|
||||
|
||||
In the second one, run:
|
||||
|
||||
```bash
|
||||
trunk serve --open
|
||||
```
|
2
examples/use_toggle/Trunk.toml
Normal file
2
examples/use_toggle/Trunk.toml
Normal file
|
@ -0,0 +1,2 @@
|
|||
[build]
|
||||
public_url = "/demo/"
|
7
examples/use_toggle/index.html
Normal file
7
examples/use_toggle/index.html
Normal file
|
@ -0,0 +1,7 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<link data-trunk rel="css" href="style/output.css">
|
||||
</head>
|
||||
<body></body>
|
||||
</html>
|
3
examples/use_toggle/input.css
Normal file
3
examples/use_toggle/input.css
Normal file
|
@ -0,0 +1,3 @@
|
|||
@tailwind base;
|
||||
@tailwind components;
|
||||
@tailwind utilities;
|
2
examples/use_toggle/rust-toolchain.toml
Normal file
2
examples/use_toggle/rust-toolchain.toml
Normal file
|
@ -0,0 +1,2 @@
|
|||
[toolchain]
|
||||
channel = "nightly"
|
24
examples/use_toggle/src/main.rs
Normal file
24
examples/use_toggle/src/main.rs
Normal file
|
@ -0,0 +1,24 @@
|
|||
use leptos::*;
|
||||
use leptos_use::docs::{demo_or_body, BooleanDisplay};
|
||||
use leptos_use::{use_toggle, UseToggleReturn};
|
||||
|
||||
#[component]
|
||||
fn Demo() -> impl IntoView {
|
||||
let UseToggleReturn { toggle, value, set_value } = use_toggle(true);
|
||||
|
||||
view! {
|
||||
<p>Value: <BooleanDisplay value=value /></p>
|
||||
<button on:click=move |_| toggle()>Toggle</button>
|
||||
<button on:click=move |_| set_value(true)>Set <code>true</code></button>
|
||||
<button on:click=move |_| set_value(false)>Set <code>false</code></button>
|
||||
}
|
||||
}
|
||||
|
||||
fn main() {
|
||||
_ = console_log::init_with_level(log::Level::Debug);
|
||||
console_error_panic_hook::set_once();
|
||||
|
||||
mount_to(demo_or_body(), || {
|
||||
view! { <Demo /> }
|
||||
})
|
||||
}
|
289
examples/use_toggle/style/output.css
Normal file
289
examples/use_toggle/style/output.css
Normal file
|
@ -0,0 +1,289 @@
|
|||
[type='text'],[type='email'],[type='url'],[type='password'],[type='number'],[type='date'],[type='datetime-local'],[type='month'],[type='search'],[type='tel'],[type='time'],[type='week'],[multiple],textarea,select {
|
||||
-webkit-appearance: none;
|
||||
-moz-appearance: none;
|
||||
appearance: none;
|
||||
background-color: #fff;
|
||||
border-color: #6b7280;
|
||||
border-width: 1px;
|
||||
border-radius: 0px;
|
||||
padding-top: 0.5rem;
|
||||
padding-right: 0.75rem;
|
||||
padding-bottom: 0.5rem;
|
||||
padding-left: 0.75rem;
|
||||
font-size: 1rem;
|
||||
line-height: 1.5rem;
|
||||
--tw-shadow: 0 0 #0000;
|
||||
}
|
||||
|
||||
[type='text']:focus, [type='email']:focus, [type='url']:focus, [type='password']:focus, [type='number']:focus, [type='date']:focus, [type='datetime-local']:focus, [type='month']:focus, [type='search']:focus, [type='tel']:focus, [type='time']:focus, [type='week']:focus, [multiple]:focus, textarea:focus, select:focus {
|
||||
outline: 2px solid transparent;
|
||||
outline-offset: 2px;
|
||||
--tw-ring-inset: var(--tw-empty,/*!*/ /*!*/);
|
||||
--tw-ring-offset-width: 0px;
|
||||
--tw-ring-offset-color: #fff;
|
||||
--tw-ring-color: #2563eb;
|
||||
--tw-ring-offset-shadow: var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color);
|
||||
--tw-ring-shadow: var(--tw-ring-inset) 0 0 0 calc(1px + var(--tw-ring-offset-width)) var(--tw-ring-color);
|
||||
box-shadow: var(--tw-ring-offset-shadow), var(--tw-ring-shadow), var(--tw-shadow);
|
||||
border-color: #2563eb;
|
||||
}
|
||||
|
||||
input::-moz-placeholder, textarea::-moz-placeholder {
|
||||
color: #6b7280;
|
||||
opacity: 1;
|
||||
}
|
||||
|
||||
input::placeholder,textarea::placeholder {
|
||||
color: #6b7280;
|
||||
opacity: 1;
|
||||
}
|
||||
|
||||
::-webkit-datetime-edit-fields-wrapper {
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
::-webkit-date-and-time-value {
|
||||
min-height: 1.5em;
|
||||
}
|
||||
|
||||
::-webkit-datetime-edit,::-webkit-datetime-edit-year-field,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute-field,::-webkit-datetime-edit-second-field,::-webkit-datetime-edit-millisecond-field,::-webkit-datetime-edit-meridiem-field {
|
||||
padding-top: 0;
|
||||
padding-bottom: 0;
|
||||
}
|
||||
|
||||
select {
|
||||
background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 20 20'%3e%3cpath stroke='%236b7280' stroke-linecap='round' stroke-linejoin='round' stroke-width='1.5' d='M6 8l4 4 4-4'/%3e%3c/svg%3e");
|
||||
background-position: right 0.5rem center;
|
||||
background-repeat: no-repeat;
|
||||
background-size: 1.5em 1.5em;
|
||||
padding-right: 2.5rem;
|
||||
-webkit-print-color-adjust: exact;
|
||||
print-color-adjust: exact;
|
||||
}
|
||||
|
||||
[multiple] {
|
||||
background-image: initial;
|
||||
background-position: initial;
|
||||
background-repeat: unset;
|
||||
background-size: initial;
|
||||
padding-right: 0.75rem;
|
||||
-webkit-print-color-adjust: unset;
|
||||
print-color-adjust: unset;
|
||||
}
|
||||
|
||||
[type='checkbox'],[type='radio'] {
|
||||
-webkit-appearance: none;
|
||||
-moz-appearance: none;
|
||||
appearance: none;
|
||||
padding: 0;
|
||||
-webkit-print-color-adjust: exact;
|
||||
print-color-adjust: exact;
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
background-origin: border-box;
|
||||
-webkit-user-select: none;
|
||||
-moz-user-select: none;
|
||||
user-select: none;
|
||||
flex-shrink: 0;
|
||||
height: 1rem;
|
||||
width: 1rem;
|
||||
color: #2563eb;
|
||||
background-color: #fff;
|
||||
border-color: #6b7280;
|
||||
border-width: 1px;
|
||||
--tw-shadow: 0 0 #0000;
|
||||
}
|
||||
|
||||
[type='checkbox'] {
|
||||
border-radius: 0px;
|
||||
}
|
||||
|
||||
[type='radio'] {
|
||||
border-radius: 100%;
|
||||
}
|
||||
|
||||
[type='checkbox']:focus,[type='radio']:focus {
|
||||
outline: 2px solid transparent;
|
||||
outline-offset: 2px;
|
||||
--tw-ring-inset: var(--tw-empty,/*!*/ /*!*/);
|
||||
--tw-ring-offset-width: 2px;
|
||||
--tw-ring-offset-color: #fff;
|
||||
--tw-ring-color: #2563eb;
|
||||
--tw-ring-offset-shadow: var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color);
|
||||
--tw-ring-shadow: var(--tw-ring-inset) 0 0 0 calc(2px + var(--tw-ring-offset-width)) var(--tw-ring-color);
|
||||
box-shadow: var(--tw-ring-offset-shadow), var(--tw-ring-shadow), var(--tw-shadow);
|
||||
}
|
||||
|
||||
[type='checkbox']:checked,[type='radio']:checked {
|
||||
border-color: transparent;
|
||||
background-color: currentColor;
|
||||
background-size: 100% 100%;
|
||||
background-position: center;
|
||||
background-repeat: no-repeat;
|
||||
}
|
||||
|
||||
[type='checkbox']:checked {
|
||||
background-image: url("data:image/svg+xml,%3csvg viewBox='0 0 16 16' fill='white' xmlns='http://www.w3.org/2000/svg'%3e%3cpath d='M12.207 4.793a1 1 0 010 1.414l-5 5a1 1 0 01-1.414 0l-2-2a1 1 0 011.414-1.414L6.5 9.086l4.293-4.293a1 1 0 011.414 0z'/%3e%3c/svg%3e");
|
||||
}
|
||||
|
||||
[type='radio']:checked {
|
||||
background-image: url("data:image/svg+xml,%3csvg viewBox='0 0 16 16' fill='white' xmlns='http://www.w3.org/2000/svg'%3e%3ccircle cx='8' cy='8' r='3'/%3e%3c/svg%3e");
|
||||
}
|
||||
|
||||
[type='checkbox']:checked:hover,[type='checkbox']:checked:focus,[type='radio']:checked:hover,[type='radio']:checked:focus {
|
||||
border-color: transparent;
|
||||
background-color: currentColor;
|
||||
}
|
||||
|
||||
[type='checkbox']:indeterminate {
|
||||
background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 16 16'%3e%3cpath stroke='white' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='M4 8h8'/%3e%3c/svg%3e");
|
||||
border-color: transparent;
|
||||
background-color: currentColor;
|
||||
background-size: 100% 100%;
|
||||
background-position: center;
|
||||
background-repeat: no-repeat;
|
||||
}
|
||||
|
||||
[type='checkbox']:indeterminate:hover,[type='checkbox']:indeterminate:focus {
|
||||
border-color: transparent;
|
||||
background-color: currentColor;
|
||||
}
|
||||
|
||||
[type='file'] {
|
||||
background: unset;
|
||||
border-color: inherit;
|
||||
border-width: 0;
|
||||
border-radius: 0;
|
||||
padding: 0;
|
||||
font-size: unset;
|
||||
line-height: inherit;
|
||||
}
|
||||
|
||||
[type='file']:focus {
|
||||
outline: 1px solid ButtonText;
|
||||
outline: 1px auto -webkit-focus-ring-color;
|
||||
}
|
||||
|
||||
*, ::before, ::after {
|
||||
--tw-border-spacing-x: 0;
|
||||
--tw-border-spacing-y: 0;
|
||||
--tw-translate-x: 0;
|
||||
--tw-translate-y: 0;
|
||||
--tw-rotate: 0;
|
||||
--tw-skew-x: 0;
|
||||
--tw-skew-y: 0;
|
||||
--tw-scale-x: 1;
|
||||
--tw-scale-y: 1;
|
||||
--tw-pan-x: ;
|
||||
--tw-pan-y: ;
|
||||
--tw-pinch-zoom: ;
|
||||
--tw-scroll-snap-strictness: proximity;
|
||||
--tw-gradient-from-position: ;
|
||||
--tw-gradient-via-position: ;
|
||||
--tw-gradient-to-position: ;
|
||||
--tw-ordinal: ;
|
||||
--tw-slashed-zero: ;
|
||||
--tw-numeric-figure: ;
|
||||
--tw-numeric-spacing: ;
|
||||
--tw-numeric-fraction: ;
|
||||
--tw-ring-inset: ;
|
||||
--tw-ring-offset-width: 0px;
|
||||
--tw-ring-offset-color: #fff;
|
||||
--tw-ring-color: rgb(59 130 246 / 0.5);
|
||||
--tw-ring-offset-shadow: 0 0 #0000;
|
||||
--tw-ring-shadow: 0 0 #0000;
|
||||
--tw-shadow: 0 0 #0000;
|
||||
--tw-shadow-colored: 0 0 #0000;
|
||||
--tw-blur: ;
|
||||
--tw-brightness: ;
|
||||
--tw-contrast: ;
|
||||
--tw-grayscale: ;
|
||||
--tw-hue-rotate: ;
|
||||
--tw-invert: ;
|
||||
--tw-saturate: ;
|
||||
--tw-sepia: ;
|
||||
--tw-drop-shadow: ;
|
||||
--tw-backdrop-blur: ;
|
||||
--tw-backdrop-brightness: ;
|
||||
--tw-backdrop-contrast: ;
|
||||
--tw-backdrop-grayscale: ;
|
||||
--tw-backdrop-hue-rotate: ;
|
||||
--tw-backdrop-invert: ;
|
||||
--tw-backdrop-opacity: ;
|
||||
--tw-backdrop-saturate: ;
|
||||
--tw-backdrop-sepia: ;
|
||||
}
|
||||
|
||||
::backdrop {
|
||||
--tw-border-spacing-x: 0;
|
||||
--tw-border-spacing-y: 0;
|
||||
--tw-translate-x: 0;
|
||||
--tw-translate-y: 0;
|
||||
--tw-rotate: 0;
|
||||
--tw-skew-x: 0;
|
||||
--tw-skew-y: 0;
|
||||
--tw-scale-x: 1;
|
||||
--tw-scale-y: 1;
|
||||
--tw-pan-x: ;
|
||||
--tw-pan-y: ;
|
||||
--tw-pinch-zoom: ;
|
||||
--tw-scroll-snap-strictness: proximity;
|
||||
--tw-gradient-from-position: ;
|
||||
--tw-gradient-via-position: ;
|
||||
--tw-gradient-to-position: ;
|
||||
--tw-ordinal: ;
|
||||
--tw-slashed-zero: ;
|
||||
--tw-numeric-figure: ;
|
||||
--tw-numeric-spacing: ;
|
||||
--tw-numeric-fraction: ;
|
||||
--tw-ring-inset: ;
|
||||
--tw-ring-offset-width: 0px;
|
||||
--tw-ring-offset-color: #fff;
|
||||
--tw-ring-color: rgb(59 130 246 / 0.5);
|
||||
--tw-ring-offset-shadow: 0 0 #0000;
|
||||
--tw-ring-shadow: 0 0 #0000;
|
||||
--tw-shadow: 0 0 #0000;
|
||||
--tw-shadow-colored: 0 0 #0000;
|
||||
--tw-blur: ;
|
||||
--tw-brightness: ;
|
||||
--tw-contrast: ;
|
||||
--tw-grayscale: ;
|
||||
--tw-hue-rotate: ;
|
||||
--tw-invert: ;
|
||||
--tw-saturate: ;
|
||||
--tw-sepia: ;
|
||||
--tw-drop-shadow: ;
|
||||
--tw-backdrop-blur: ;
|
||||
--tw-backdrop-brightness: ;
|
||||
--tw-backdrop-contrast: ;
|
||||
--tw-backdrop-grayscale: ;
|
||||
--tw-backdrop-hue-rotate: ;
|
||||
--tw-backdrop-invert: ;
|
||||
--tw-backdrop-opacity: ;
|
||||
--tw-backdrop-saturate: ;
|
||||
--tw-backdrop-sepia: ;
|
||||
}
|
||||
|
||||
.block {
|
||||
display: block;
|
||||
}
|
||||
|
||||
.text-\[--brand-color\] {
|
||||
color: var(--brand-color);
|
||||
}
|
||||
|
||||
.text-green-600 {
|
||||
--tw-text-opacity: 1;
|
||||
color: rgb(22 163 74 / var(--tw-text-opacity));
|
||||
}
|
||||
|
||||
.opacity-75 {
|
||||
opacity: 0.75;
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: dark) {
|
||||
.dark\:text-green-500 {
|
||||
--tw-text-opacity: 1;
|
||||
color: rgb(34 197 94 / var(--tw-text-opacity));
|
||||
}
|
||||
}
|
15
examples/use_toggle/tailwind.config.js
Normal file
15
examples/use_toggle/tailwind.config.js
Normal file
|
@ -0,0 +1,15 @@
|
|||
/** @type {import('tailwindcss').Config} */
|
||||
module.exports = {
|
||||
content: {
|
||||
files: ["*.html", "./src/**/*.rs", "../../src/docs/**/*.rs"],
|
||||
},
|
||||
theme: {
|
||||
extend: {},
|
||||
},
|
||||
corePlugins: {
|
||||
preflight: false,
|
||||
},
|
||||
plugins: [
|
||||
require('@tailwindcss/forms'),
|
||||
],
|
||||
}
|
17
examples/use_web_lock/Cargo.toml
Normal file
17
examples/use_web_lock/Cargo.toml
Normal file
|
@ -0,0 +1,17 @@
|
|||
[package]
|
||||
name = "use_web_lock"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
[dependencies]
|
||||
gloo-timers = { version = "0.3", features = ["futures"] }
|
||||
leptos = { version = "0.6", features = ["nightly", "csr"] }
|
||||
console_error_panic_hook = "0.1"
|
||||
console_log = "1"
|
||||
log = "0.4"
|
||||
leptos-use = { path = "../..", features = ["use_web_lock", "docs"] }
|
||||
web-sys = { version = "0.3", features = ["Lock"] }
|
||||
|
||||
[dev-dependencies]
|
||||
wasm-bindgen = "0.2"
|
||||
wasm-bindgen-test = "0.3.0"
|
23
examples/use_web_lock/README.md
Normal file
23
examples/use_web_lock/README.md
Normal file
|
@ -0,0 +1,23 @@
|
|||
A simple example for `use_web_lock`.
|
||||
|
||||
If you don't have it installed already, install [Trunk](https://trunkrs.dev/) and [Tailwind](https://tailwindcss.com/docs/installation)
|
||||
as well as the nightly toolchain for Rust and the wasm32-unknown-unknown target:
|
||||
|
||||
```bash
|
||||
cargo install trunk
|
||||
npm install -D tailwindcss @tailwindcss/forms
|
||||
rustup toolchain install nightly
|
||||
rustup target add wasm32-unknown-unknown
|
||||
```
|
||||
|
||||
Then, open two terminals. In the first one, run:
|
||||
|
||||
```
|
||||
npx tailwindcss -i ./input.css -o ./style/output.css --watch
|
||||
```
|
||||
|
||||
In the second one, run:
|
||||
|
||||
```bash
|
||||
trunk serve --open
|
||||
```
|
2
examples/use_web_lock/Trunk.toml
Normal file
2
examples/use_web_lock/Trunk.toml
Normal file
|
@ -0,0 +1,2 @@
|
|||
[build]
|
||||
public_url = "/demo/"
|
7
examples/use_web_lock/index.html
Normal file
7
examples/use_web_lock/index.html
Normal file
|
@ -0,0 +1,7 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<link data-trunk rel="css" href="style/output.css">
|
||||
</head>
|
||||
<body></body>
|
||||
</html>
|
3
examples/use_web_lock/input.css
Normal file
3
examples/use_web_lock/input.css
Normal file
|
@ -0,0 +1,3 @@
|
|||
@tailwind base;
|
||||
@tailwind components;
|
||||
@tailwind utilities;
|
2
examples/use_web_lock/rust-toolchain.toml
Normal file
2
examples/use_web_lock/rust-toolchain.toml
Normal file
|
@ -0,0 +1,2 @@
|
|||
[toolchain]
|
||||
channel = "nightly"
|
47
examples/use_web_lock/src/main.rs
Normal file
47
examples/use_web_lock/src/main.rs
Normal file
|
@ -0,0 +1,47 @@
|
|||
use gloo_timers::future::sleep;
|
||||
use leptos::*;
|
||||
use leptos_use::docs::demo_or_body;
|
||||
use leptos_use::use_web_lock;
|
||||
use std::time::Duration;
|
||||
|
||||
async fn my_process(_lock: web_sys::Lock) -> i32 {
|
||||
sleep(Duration::from_millis(2000)).await;
|
||||
|
||||
42
|
||||
}
|
||||
|
||||
#[component]
|
||||
fn Demo() -> impl IntoView {
|
||||
let (res, set_res) = create_signal("Not started yet".to_string());
|
||||
|
||||
let on_click = move |_| {
|
||||
set_res.set("Running...".to_string());
|
||||
|
||||
spawn_local(async move {
|
||||
let res = use_web_lock("my_lock", my_process).await;
|
||||
|
||||
match res {
|
||||
Ok(res) => {
|
||||
set_res.set(format!("Result: {}", res));
|
||||
}
|
||||
Err(e) => {
|
||||
set_res.set(format!("Error: {:?}", e));
|
||||
}
|
||||
}
|
||||
});
|
||||
};
|
||||
|
||||
view! {
|
||||
<button on:click=on_click>Run locked task</button>
|
||||
<p>{res}</p>
|
||||
}
|
||||
}
|
||||
|
||||
fn main() {
|
||||
_ = console_log::init_with_level(log::Level::Debug);
|
||||
console_error_panic_hook::set_once();
|
||||
|
||||
mount_to(demo_or_body(), || {
|
||||
view! { <Demo/> }
|
||||
})
|
||||
}
|
289
examples/use_web_lock/style/output.css
Normal file
289
examples/use_web_lock/style/output.css
Normal file
|
@ -0,0 +1,289 @@
|
|||
[type='text'],[type='email'],[type='url'],[type='password'],[type='number'],[type='date'],[type='datetime-local'],[type='month'],[type='search'],[type='tel'],[type='time'],[type='week'],[multiple],textarea,select {
|
||||
-webkit-appearance: none;
|
||||
-moz-appearance: none;
|
||||
appearance: none;
|
||||
background-color: #fff;
|
||||
border-color: #6b7280;
|
||||
border-width: 1px;
|
||||
border-radius: 0px;
|
||||
padding-top: 0.5rem;
|
||||
padding-right: 0.75rem;
|
||||
padding-bottom: 0.5rem;
|
||||
padding-left: 0.75rem;
|
||||
font-size: 1rem;
|
||||
line-height: 1.5rem;
|
||||
--tw-shadow: 0 0 #0000;
|
||||
}
|
||||
|
||||
[type='text']:focus, [type='email']:focus, [type='url']:focus, [type='password']:focus, [type='number']:focus, [type='date']:focus, [type='datetime-local']:focus, [type='month']:focus, [type='search']:focus, [type='tel']:focus, [type='time']:focus, [type='week']:focus, [multiple]:focus, textarea:focus, select:focus {
|
||||
outline: 2px solid transparent;
|
||||
outline-offset: 2px;
|
||||
--tw-ring-inset: var(--tw-empty,/*!*/ /*!*/);
|
||||
--tw-ring-offset-width: 0px;
|
||||
--tw-ring-offset-color: #fff;
|
||||
--tw-ring-color: #2563eb;
|
||||
--tw-ring-offset-shadow: var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color);
|
||||
--tw-ring-shadow: var(--tw-ring-inset) 0 0 0 calc(1px + var(--tw-ring-offset-width)) var(--tw-ring-color);
|
||||
box-shadow: var(--tw-ring-offset-shadow), var(--tw-ring-shadow), var(--tw-shadow);
|
||||
border-color: #2563eb;
|
||||
}
|
||||
|
||||
input::-moz-placeholder, textarea::-moz-placeholder {
|
||||
color: #6b7280;
|
||||
opacity: 1;
|
||||
}
|
||||
|
||||
input::placeholder,textarea::placeholder {
|
||||
color: #6b7280;
|
||||
opacity: 1;
|
||||
}
|
||||
|
||||
::-webkit-datetime-edit-fields-wrapper {
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
::-webkit-date-and-time-value {
|
||||
min-height: 1.5em;
|
||||
}
|
||||
|
||||
::-webkit-datetime-edit,::-webkit-datetime-edit-year-field,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute-field,::-webkit-datetime-edit-second-field,::-webkit-datetime-edit-millisecond-field,::-webkit-datetime-edit-meridiem-field {
|
||||
padding-top: 0;
|
||||
padding-bottom: 0;
|
||||
}
|
||||
|
||||
select {
|
||||
background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 20 20'%3e%3cpath stroke='%236b7280' stroke-linecap='round' stroke-linejoin='round' stroke-width='1.5' d='M6 8l4 4 4-4'/%3e%3c/svg%3e");
|
||||
background-position: right 0.5rem center;
|
||||
background-repeat: no-repeat;
|
||||
background-size: 1.5em 1.5em;
|
||||
padding-right: 2.5rem;
|
||||
-webkit-print-color-adjust: exact;
|
||||
print-color-adjust: exact;
|
||||
}
|
||||
|
||||
[multiple] {
|
||||
background-image: initial;
|
||||
background-position: initial;
|
||||
background-repeat: unset;
|
||||
background-size: initial;
|
||||
padding-right: 0.75rem;
|
||||
-webkit-print-color-adjust: unset;
|
||||
print-color-adjust: unset;
|
||||
}
|
||||
|
||||
[type='checkbox'],[type='radio'] {
|
||||
-webkit-appearance: none;
|
||||
-moz-appearance: none;
|
||||
appearance: none;
|
||||
padding: 0;
|
||||
-webkit-print-color-adjust: exact;
|
||||
print-color-adjust: exact;
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
background-origin: border-box;
|
||||
-webkit-user-select: none;
|
||||
-moz-user-select: none;
|
||||
user-select: none;
|
||||
flex-shrink: 0;
|
||||
height: 1rem;
|
||||
width: 1rem;
|
||||
color: #2563eb;
|
||||
background-color: #fff;
|
||||
border-color: #6b7280;
|
||||
border-width: 1px;
|
||||
--tw-shadow: 0 0 #0000;
|
||||
}
|
||||
|
||||
[type='checkbox'] {
|
||||
border-radius: 0px;
|
||||
}
|
||||
|
||||
[type='radio'] {
|
||||
border-radius: 100%;
|
||||
}
|
||||
|
||||
[type='checkbox']:focus,[type='radio']:focus {
|
||||
outline: 2px solid transparent;
|
||||
outline-offset: 2px;
|
||||
--tw-ring-inset: var(--tw-empty,/*!*/ /*!*/);
|
||||
--tw-ring-offset-width: 2px;
|
||||
--tw-ring-offset-color: #fff;
|
||||
--tw-ring-color: #2563eb;
|
||||
--tw-ring-offset-shadow: var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color);
|
||||
--tw-ring-shadow: var(--tw-ring-inset) 0 0 0 calc(2px + var(--tw-ring-offset-width)) var(--tw-ring-color);
|
||||
box-shadow: var(--tw-ring-offset-shadow), var(--tw-ring-shadow), var(--tw-shadow);
|
||||
}
|
||||
|
||||
[type='checkbox']:checked,[type='radio']:checked {
|
||||
border-color: transparent;
|
||||
background-color: currentColor;
|
||||
background-size: 100% 100%;
|
||||
background-position: center;
|
||||
background-repeat: no-repeat;
|
||||
}
|
||||
|
||||
[type='checkbox']:checked {
|
||||
background-image: url("data:image/svg+xml,%3csvg viewBox='0 0 16 16' fill='white' xmlns='http://www.w3.org/2000/svg'%3e%3cpath d='M12.207 4.793a1 1 0 010 1.414l-5 5a1 1 0 01-1.414 0l-2-2a1 1 0 011.414-1.414L6.5 9.086l4.293-4.293a1 1 0 011.414 0z'/%3e%3c/svg%3e");
|
||||
}
|
||||
|
||||
[type='radio']:checked {
|
||||
background-image: url("data:image/svg+xml,%3csvg viewBox='0 0 16 16' fill='white' xmlns='http://www.w3.org/2000/svg'%3e%3ccircle cx='8' cy='8' r='3'/%3e%3c/svg%3e");
|
||||
}
|
||||
|
||||
[type='checkbox']:checked:hover,[type='checkbox']:checked:focus,[type='radio']:checked:hover,[type='radio']:checked:focus {
|
||||
border-color: transparent;
|
||||
background-color: currentColor;
|
||||
}
|
||||
|
||||
[type='checkbox']:indeterminate {
|
||||
background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 16 16'%3e%3cpath stroke='white' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='M4 8h8'/%3e%3c/svg%3e");
|
||||
border-color: transparent;
|
||||
background-color: currentColor;
|
||||
background-size: 100% 100%;
|
||||
background-position: center;
|
||||
background-repeat: no-repeat;
|
||||
}
|
||||
|
||||
[type='checkbox']:indeterminate:hover,[type='checkbox']:indeterminate:focus {
|
||||
border-color: transparent;
|
||||
background-color: currentColor;
|
||||
}
|
||||
|
||||
[type='file'] {
|
||||
background: unset;
|
||||
border-color: inherit;
|
||||
border-width: 0;
|
||||
border-radius: 0;
|
||||
padding: 0;
|
||||
font-size: unset;
|
||||
line-height: inherit;
|
||||
}
|
||||
|
||||
[type='file']:focus {
|
||||
outline: 1px solid ButtonText;
|
||||
outline: 1px auto -webkit-focus-ring-color;
|
||||
}
|
||||
|
||||
*, ::before, ::after {
|
||||
--tw-border-spacing-x: 0;
|
||||
--tw-border-spacing-y: 0;
|
||||
--tw-translate-x: 0;
|
||||
--tw-translate-y: 0;
|
||||
--tw-rotate: 0;
|
||||
--tw-skew-x: 0;
|
||||
--tw-skew-y: 0;
|
||||
--tw-scale-x: 1;
|
||||
--tw-scale-y: 1;
|
||||
--tw-pan-x: ;
|
||||
--tw-pan-y: ;
|
||||
--tw-pinch-zoom: ;
|
||||
--tw-scroll-snap-strictness: proximity;
|
||||
--tw-gradient-from-position: ;
|
||||
--tw-gradient-via-position: ;
|
||||
--tw-gradient-to-position: ;
|
||||
--tw-ordinal: ;
|
||||
--tw-slashed-zero: ;
|
||||
--tw-numeric-figure: ;
|
||||
--tw-numeric-spacing: ;
|
||||
--tw-numeric-fraction: ;
|
||||
--tw-ring-inset: ;
|
||||
--tw-ring-offset-width: 0px;
|
||||
--tw-ring-offset-color: #fff;
|
||||
--tw-ring-color: rgb(59 130 246 / 0.5);
|
||||
--tw-ring-offset-shadow: 0 0 #0000;
|
||||
--tw-ring-shadow: 0 0 #0000;
|
||||
--tw-shadow: 0 0 #0000;
|
||||
--tw-shadow-colored: 0 0 #0000;
|
||||
--tw-blur: ;
|
||||
--tw-brightness: ;
|
||||
--tw-contrast: ;
|
||||
--tw-grayscale: ;
|
||||
--tw-hue-rotate: ;
|
||||
--tw-invert: ;
|
||||
--tw-saturate: ;
|
||||
--tw-sepia: ;
|
||||
--tw-drop-shadow: ;
|
||||
--tw-backdrop-blur: ;
|
||||
--tw-backdrop-brightness: ;
|
||||
--tw-backdrop-contrast: ;
|
||||
--tw-backdrop-grayscale: ;
|
||||
--tw-backdrop-hue-rotate: ;
|
||||
--tw-backdrop-invert: ;
|
||||
--tw-backdrop-opacity: ;
|
||||
--tw-backdrop-saturate: ;
|
||||
--tw-backdrop-sepia: ;
|
||||
}
|
||||
|
||||
::backdrop {
|
||||
--tw-border-spacing-x: 0;
|
||||
--tw-border-spacing-y: 0;
|
||||
--tw-translate-x: 0;
|
||||
--tw-translate-y: 0;
|
||||
--tw-rotate: 0;
|
||||
--tw-skew-x: 0;
|
||||
--tw-skew-y: 0;
|
||||
--tw-scale-x: 1;
|
||||
--tw-scale-y: 1;
|
||||
--tw-pan-x: ;
|
||||
--tw-pan-y: ;
|
||||
--tw-pinch-zoom: ;
|
||||
--tw-scroll-snap-strictness: proximity;
|
||||
--tw-gradient-from-position: ;
|
||||
--tw-gradient-via-position: ;
|
||||
--tw-gradient-to-position: ;
|
||||
--tw-ordinal: ;
|
||||
--tw-slashed-zero: ;
|
||||
--tw-numeric-figure: ;
|
||||
--tw-numeric-spacing: ;
|
||||
--tw-numeric-fraction: ;
|
||||
--tw-ring-inset: ;
|
||||
--tw-ring-offset-width: 0px;
|
||||
--tw-ring-offset-color: #fff;
|
||||
--tw-ring-color: rgb(59 130 246 / 0.5);
|
||||
--tw-ring-offset-shadow: 0 0 #0000;
|
||||
--tw-ring-shadow: 0 0 #0000;
|
||||
--tw-shadow: 0 0 #0000;
|
||||
--tw-shadow-colored: 0 0 #0000;
|
||||
--tw-blur: ;
|
||||
--tw-brightness: ;
|
||||
--tw-contrast: ;
|
||||
--tw-grayscale: ;
|
||||
--tw-hue-rotate: ;
|
||||
--tw-invert: ;
|
||||
--tw-saturate: ;
|
||||
--tw-sepia: ;
|
||||
--tw-drop-shadow: ;
|
||||
--tw-backdrop-blur: ;
|
||||
--tw-backdrop-brightness: ;
|
||||
--tw-backdrop-contrast: ;
|
||||
--tw-backdrop-grayscale: ;
|
||||
--tw-backdrop-hue-rotate: ;
|
||||
--tw-backdrop-invert: ;
|
||||
--tw-backdrop-opacity: ;
|
||||
--tw-backdrop-saturate: ;
|
||||
--tw-backdrop-sepia: ;
|
||||
}
|
||||
|
||||
.block {
|
||||
display: block;
|
||||
}
|
||||
|
||||
.text-\[--brand-color\] {
|
||||
color: var(--brand-color);
|
||||
}
|
||||
|
||||
.text-green-600 {
|
||||
--tw-text-opacity: 1;
|
||||
color: rgb(22 163 74 / var(--tw-text-opacity));
|
||||
}
|
||||
|
||||
.opacity-75 {
|
||||
opacity: 0.75;
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: dark) {
|
||||
.dark\:text-green-500 {
|
||||
--tw-text-opacity: 1;
|
||||
color: rgb(34 197 94 / var(--tw-text-opacity));
|
||||
}
|
||||
}
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Reference in a new issue