adam/leptos-use
1
0
Fork 0
mirror of https://github.com/adoyle0/leptos-use.git synced 2025-01-22 16:49:22 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

updated book and template with features

Browse source
This commit is contained in:
Maccesch 2024-08-24 22:50:02 +01:00
parent 55f5ff9557
commit 1ba0b03965
76 changed files with 79 additions and 79 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/book/src/animation/use_interval.md
View file

@ -1,3 +1,3 @@
# use_interval
<!-- cmdrun python3 ../extract_doc_comment.py use_interval -->
<!-- cmdrun python3 ../extract_doc_comment.py use_interval use_interval -->

2
docs/book/src/animation/use_interval_fn.md
View file

@ -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 -->

2
docs/book/src/animation/use_raf_fn.md
View file

@ -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 -->

2
docs/book/src/animation/use_timeout_fn.md
View file

@ -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 -->

2
docs/book/src/animation/use_timestamp.md
View file

@ -1,3 +1,3 @@
# use_timestamp
<!-- cmdrun python3 ../extract_doc_comment.py use_timestamp -->
<!-- cmdrun python3 ../extract_doc_comment.py use_timestamp use_timestamp -->

2
docs/book/src/browser/use_breakpoints.md
View file

@ -1,3 +1,3 @@
# use_breakpoints
<!-- cmdrun python3 ../extract_doc_comment.py use_breakpoints -->
<!-- cmdrun python3 ../extract_doc_comment.py use_breakpoints use_breakpoints -->

2
docs/book/src/browser/use_broadcast_channel.md
View file

@ -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 -->

2
docs/book/src/browser/use_clipboard.md
View file

@ -1,3 +1,3 @@
# use_clipboard
<!-- cmdrun python3 ../extract_doc_comment.py use_clipboard -->
<!-- cmdrun python3 ../extract_doc_comment.py use_clipboard use_clipboard -->

2
docs/book/src/browser/use_color_mode.md
View file

@ -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 -->

2
docs/book/src/browser/use_cookie.md
View file

@ -1,3 +1,3 @@
# use_cookie
<!-- cmdrun python3 ../extract_doc_comment.py use_cookie -->
<!-- cmdrun python3 ../extract_doc_comment.py use_cookie use_cookie -->

2
docs/book/src/browser/use_css_var.md
View file

@ -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 -->

2
docs/book/src/browser/use_display_media.md
View file

@ -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 -->

2
docs/book/src/browser/use_event_listener.md
View file

@ -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 -->

2
docs/book/src/browser/use_favicon.md
View file

@ -1,3 +1,3 @@
# use_favicon
<!-- cmdrun python3 ../extract_doc_comment.py use_favicon -->
<!-- cmdrun python3 ../extract_doc_comment.py use_favicon use_favicon -->

2
docs/book/src/browser/use_media_query.md
View file

@ -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 -->

2
docs/book/src/browser/use_permission.md
View file

@ -1,3 +1,3 @@
# use_permission
<!-- cmdrun python3 ../extract_doc_comment.py use_permission -->
<!-- cmdrun python3 ../extract_doc_comment.py use_permission use_permission -->

2
docs/book/src/browser/use_preferred_contrast.md
View file

@ -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 -->

2
docs/book/src/browser/use_preferred_dark.md
View file

@ -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 -->

2
docs/book/src/browser/use_prefers_reduced_motion.md
View file

@ -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 -->

2
docs/book/src/browser/use_service_worker.md
View file

@ -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 -->

2
docs/book/src/browser/use_user_media.md
View file

@ -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 -->

2
docs/book/src/browser/use_web_notification.md
View file

@ -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 -->

2
docs/book/src/elements/use_active_element.md
View file

@ -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 -->

2
docs/book/src/elements/use_document.md
View file

@ -1,3 +1,3 @@
# use_document
<!-- cmdrun python3 ../extract_doc_comment.py use_document -->
<!-- cmdrun python3 ../extract_doc_comment.py use_document use_document -->

2
docs/book/src/elements/use_document_visibility.md
View file

@ -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 -->

2
docs/book/src/elements/use_draggable.md
View file

@ -1,3 +1,3 @@
# use_draggable
<!-- cmdrun python3 ../extract_doc_comment.py use_draggable -->
<!-- cmdrun python3 ../extract_doc_comment.py use_draggable use_draggable -->

2
docs/book/src/elements/use_drop_zone.md
View file

@ -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 -->

2
docs/book/src/elements/use_element_bounding.md
View file

@ -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 -->

2
docs/book/src/elements/use_element_size.md
View file

@ -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 -->

2
docs/book/src/elements/use_element_visibility.md
View file

@ -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 -->

2
docs/book/src/elements/use_intersection_observer.md
View file

@ -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 -->

2
docs/book/src/elements/use_mouse_in_element.md
View file

@ -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 -->

2
docs/book/src/elements/use_mutation_observer.md
View file

@ -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 -->

2
docs/book/src/elements/use_resize_observer.md
View file

@ -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 -->

2
docs/book/src/elements/use_window.md
View file

@ -1,3 +1,3 @@
# use_window
<!-- cmdrun python3 ../extract_doc_comment.py use_window -->
<!-- cmdrun python3 ../extract_doc_comment.py use_window use_window -->

2
docs/book/src/elements/use_window_focus.md
View file

@ -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 -->

2
docs/book/src/elements/use_window_scroll.md
View file

@ -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 -->

2
docs/book/src/intl/use_intl_number_format.md
View file

@ -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 -->

2
docs/book/src/intl/use_locale.md
View file

@ -1,3 +1,3 @@
# use_locale
<!-- cmdrun python3 ../extract_doc_comment.py use_locale -->
<!-- cmdrun python3 ../extract_doc_comment.py use_locale use_locale -->

2
docs/book/src/intl/use_locales.md
View file

@ -1,3 +1,3 @@
# use_locales
<!-- cmdrun python3 ../extract_doc_comment.py use_locales -->
<!-- cmdrun python3 ../extract_doc_comment.py use_locales use_locales -->

2
docs/book/src/iterable/use_sorted.md
View file

@ -1,3 +1,3 @@
# use_sorted
<!-- cmdrun python3 ../extract_doc_comment.py use_sorted -->
<!-- cmdrun python3 ../extract_doc_comment.py use_sorted use_sorted -->

2
docs/book/src/network/use_event_source.md
View file

@ -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 -->

2
docs/book/src/network/use_websocket.md
View file

@ -1,3 +1,3 @@
# use_websocket
<!-- cmdrun python3 ../extract_doc_comment.py use_websocket -->
<!-- cmdrun python3 ../extract_doc_comment.py use_websocket use_websocket -->

2
docs/book/src/reactivity/signal_debounced.md
View file

@ -1,3 +1,3 @@
# signal_debounced
<!-- cmdrun python3 ../extract_doc_comment.py signal_debounced -->
<!-- cmdrun python3 ../extract_doc_comment.py signal_debounced signal_debounced -->

2
docs/book/src/reactivity/signal_throttled.md
View file

@ -1,3 +1,3 @@
# signal_throttled
<!-- cmdrun python3 ../extract_doc_comment.py signal_throttled -->
<!-- cmdrun python3 ../extract_doc_comment.py signal_throttled signal_throttled -->

2
docs/book/src/reactivity/sync_signal.md
View file

@ -1,3 +1,3 @@
# sync_signal
<!-- cmdrun python3 ../extract_doc_comment.py sync_signal -->
<!-- cmdrun python3 ../extract_doc_comment.py sync_signal sync_signal -->

2
docs/book/src/sensors/on_click_outside.md
View file

@ -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 -->

2
docs/book/src/sensors/use_device_orientation.md
View file

@ -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 -->

2
docs/book/src/sensors/use_device_pixel_ratio.md
View file

@ -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 -->

2
docs/book/src/sensors/use_element_hover.md
View file

@ -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 -->

2
docs/book/src/sensors/use_geolocation.md
View file

@ -1,3 +1,3 @@
# use_geolocation
<!-- cmdrun python3 ../extract_doc_comment.py use_geolocation -->
<!-- cmdrun python3 ../extract_doc_comment.py use_geolocation use_geolocation -->

2
docs/book/src/sensors/use_idle.md
View file

@ -1,3 +1,3 @@
# use_idle
<!-- cmdrun python3 ../extract_doc_comment.py use_idle -->
<!-- cmdrun python3 ../extract_doc_comment.py use_idle use_idle -->

2
docs/book/src/sensors/use_infinite_scroll.md
View file

@ -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 -->

2
docs/book/src/sensors/use_mouse.md
View file

@ -1,3 +1,3 @@
# use_mouse
<!-- cmdrun python3 ../extract_doc_comment.py use_mouse -->
<!-- cmdrun python3 ../extract_doc_comment.py use_mouse use_mouse -->

2
docs/book/src/sensors/use_scroll.md
View file

@ -1,3 +1,3 @@
# use_scroll
<!-- cmdrun python3 ../extract_doc_comment.py use_scroll -->
<!-- cmdrun python3 ../extract_doc_comment.py use_scroll use_scroll -->

2
docs/book/src/storage/use_local_storage.md
View file

@ -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 -->

2
docs/book/src/storage/use_session_storage.md
View file

@ -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 -->

2
docs/book/src/storage/use_storage.md
View file

@ -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 -->

2
docs/book/src/utilities/header.md
View file

@ -1,3 +1,3 @@
# header
<!-- cmdrun python3 ../extract_doc_comment.py utils/header -->
<!-- cmdrun python3 ../extract_doc_comment.py utils/header utils/header -->

2
docs/book/src/utilities/is_err.md
View file

@ -1,3 +1,3 @@
# is_err
<!-- cmdrun python3 ../extract_doc_comment.py is_err -->
<!-- cmdrun python3 ../extract_doc_comment.py is_err is_err -->

2
docs/book/src/utilities/is_none.md
View file

@ -1,3 +1,3 @@
# is_none
<!-- cmdrun python3 ../extract_doc_comment.py is_none -->
<!-- cmdrun python3 ../extract_doc_comment.py is_none is_none -->

2
docs/book/src/utilities/is_ok.md
View file

@ -1,3 +1,3 @@
# is_ok
<!-- cmdrun python3 ../extract_doc_comment.py is_ok -->
<!-- cmdrun python3 ../extract_doc_comment.py is_ok is_ok -->

2
docs/book/src/utilities/is_some.md
View file

@ -1,3 +1,3 @@
# is_some
<!-- cmdrun python3 ../extract_doc_comment.py is_some -->
<!-- cmdrun python3 ../extract_doc_comment.py is_some is_some -->

2
docs/book/src/utilities/use_cycle_list.md
View file

@ -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 -->

2
docs/book/src/utilities/use_debounce_fn.md
View file

@ -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 -->

2
docs/book/src/utilities/use_supported.md
View file

@ -1,3 +1,3 @@
# use_supported
<!-- cmdrun python3 ../extract_doc_comment.py use_supported -->
<!-- cmdrun python3 ../extract_doc_comment.py use_supported use_supported -->

2
docs/book/src/utilities/use_throttle_fn.md
View file

@ -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 -->

2
docs/book/src/utilities/use_to_string.md
View file

@ -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 -->

2
docs/book/src/watch/watch_debounced.md
View file

@ -1,3 +1,3 @@
# watch_debounced
<!-- cmdrun python3 ../extract_doc_comment.py watch_debounced -->
<!-- cmdrun python3 ../extract_doc_comment.py watch_debounced watch_debounced -->

2
docs/book/src/watch/watch_pausable.md
View file

@ -1,3 +1,3 @@
# watch_pausable
<!-- cmdrun python3 ../extract_doc_comment.py watch_pausable -->
<!-- cmdrun python3 ../extract_doc_comment.py watch_pausable watch_pausable -->

2
docs/book/src/watch/watch_throttled.md
View file

@ -1,3 +1,3 @@
# watch_throttled
<!-- cmdrun python3 ../extract_doc_comment.py watch_throttled -->
<!-- cmdrun python3 ../extract_doc_comment.py watch_throttled watch_throttled -->

2
docs/book/src/watch/watch_with_options.md
View file

@ -1,3 +1,3 @@
# watch_with_options
<!-- cmdrun python3 ../extract_doc_comment.py watch -->
<!-- cmdrun python3 ../extract_doc_comment.py watch watch -->

2
docs/book/src/watch/whenever.md
View file

@ -1,3 +1,3 @@
# whenever
<!-- cmdrun python3 ../extract_doc_comment.py whenever -->
<!-- cmdrun python3 ../extract_doc_comment.py whenever whenever -->

6
template/.ffizer.yaml
View file

@ -11,12 +11,12 @@ variables:
default_value: ""
ask: Module [optional]
- name: feature
default_value: ""
ask: cfg feature [optional]
default_value: "{{ function_name }}"
ask: cfg feature
ignores:
- modify_files.py
- createfn.sh
scripts:
- cmd: python3 template/modify_files.py {{ function_name }} {{ category }}{{#if module}} --module {{ module }}{{/if}}{{#if feature}} --feature {{ feature }}{{/if}}
- cmd: python3 template/modify_files.py {{ function_name }} {{ category }}{{#if module}} --module {{ module }}{{/if}} --feature {{ feature }}

2
template/examples/{{ function_name }}/Cargo.ffizer.hbs.toml
View file

@ -8,7 +8,7 @@ leptos = { version = "0.6", features = ["nightly", "csr"] }
console_error_panic_hook = "0.1"
console_log = "1"
log = "0.4"
leptos-use = { path = "../..", features = ["docs"{{#if feature}}, "{{ feature }}"{{/if}}] }
leptos-use = { path = "../..", features = ["{{ feature }}", "docs"] }
web-sys = "0.3"
[dev-dependencies]

4
template/src/{{ module }}/{{ function_name }}.ffizer.hbs.rs
View file

@ -25,8 +25,8 @@ use leptos::*;
/// ```
///
/// ## Server-Side Rendering
/// {{#if feature}}
// #[doc(cfg(feature = "{{feature}}"))]{{/if}}
///
// #[doc(cfg(feature = "{{feature}}"))]
pub fn {{ function_name }}() -> {{ to_pascal_case function_name }}Return {
{{ function_name }}_with_options({{ to_pascal_case function_name }}Options::default())