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

Merge pull request #136 from mondeja/fix-docs-bare-urls

Browse source 
Make rustdoc links work with the book
This commit is contained in:
Marc-Stefan Cassola 2024-07-27 17:50:00 +01:00 • committed by GitHub
commit 017d86842d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
32 changed files with 129 additions and 101 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
docs/book/post_build.py
View file

@ -14,6 +14,7 @@ def main():
for file in os.listdir(category_dir):
if file.endswith(".md") and (len(sys.argv) == 1 or (sys.argv[1] in file)):
build_and_copy_demo(category, file)
rewrite_links(category, file)
def build_and_copy_demo(category, md_name):
@ -24,7 +25,8 @@ def build_and_copy_demo(category, md_name):
code = p.wait()
if code != 0:
sys.exit(code, f"failed to build example '{name}'")
sys.stderr.write(f"failed to build example '{name}'\n")
sys.exit(code)
example_output_path = os.path.join(example_dir, "dist")
target_path = os.path.join("book", category, name, "demo")
@ -61,5 +63,27 @@ def build_and_copy_demo(category, md_name):
{body_split[1]}""")
def rewrite_links(category, md_name):
"""Rewrite links in generated documentation to make them
compatible between rustdoc and the book.
"""
html_name = f"{md_name[:-3]}.html"
target_path = os.path.join("book", category, html_name)
with open(target_path, "r") as f:
html = f.read()
html = html.replace(
"fn@crate::", "",
).replace(
"crate::", "",
).replace(
"fn@", "",
)
with open(target_path, "w") as f:
f.write(html)
if __name__ == '__main__':
main()

4
src/core/element_maybe_signal.rs
View file

@ -6,12 +6,14 @@ use std::marker::PhantomData;
use std::ops::Deref;
/// Used as an argument type to make it easily possible to pass either
///
/// * a `web_sys` element that implements `E` (for example `EventTarget`, `Element` or `HtmlElement`),
/// * an `Option<T>` where `T` is the web_sys element,
/// * a `Signal<T>` where `T` is the web_sys element,
/// * a `Signal<Option<T>>` where `T` is the web_sys element,
/// * a `NodeRef`
/// into a function. Used for example in [`use_event_listener`].
///
/// into a function. Used for example in [`fn@crate::use_event_listener`].
pub enum ElementMaybeSignal<T, E>
where
T: Into<E> + Clone + 'static,

4
src/core/elements_maybe_signal.rs
View file

@ -7,12 +7,14 @@ use std::marker::PhantomData;
use std::ops::Deref;
/// Used as an argument type to make it easily possible to pass either
///
/// * a `web_sys` element that implements `E` (for example `EventTarget` or `Element`),
/// * an `Option<T>` where `T` is the web_sys element,
/// * a `Signal<T>` where `T` is the web_sys element,
/// * a `Signal<Option<T>>` where `T` is the web_sys element,
/// * a `NodeRef`
/// into a function. Used for example in [`use_event_listener`].
///
/// into a function. Used for example in [`fn@crate::use_event_listener`].
pub enum ElementsMaybeSignal<T, E>
where
T: Into<E> + Clone + 'static,

4
src/lib.rs
View file

@ -25,7 +25,6 @@ mod is_none;
mod is_ok;
mod is_some;
mod on_click_outside;
mod use_user_media;
mod signal_debounced;
mod signal_throttled;
mod sync_signal;
@ -75,6 +74,7 @@ mod use_throttle_fn;
mod use_timeout_fn;
mod use_timestamp;
mod use_to_string;
mod use_user_media;
mod use_web_notification;
mod use_websocket;
mod use_window;
@ -91,7 +91,6 @@ pub use is_none::*;
pub use is_ok::*;
pub use is_some::*;
pub use on_click_outside::*;
pub use use_user_media::*;
pub use signal_debounced::*;
pub use signal_throttled::*;
pub use sync_signal::*;
@ -141,6 +140,7 @@ pub use use_throttle_fn::*;
pub use use_timeout_fn::*;
pub use use_timestamp::*;
pub use use_to_string::*;
pub use use_user_media::*;
pub use use_web_notification::*;
pub use use_websocket::*;
pub use use_window::*;

6
src/on_click_outside.rs
View file

@ -45,9 +45,9 @@ cfg_if! { if #[cfg(not(feature = "ssr"))] {
/// ```
///
/// > This function uses [Event.composedPath()](https://developer.mozilla.org/en-US/docs/Web/API/Event/composedPath)
/// which is **not** supported by IE 11, Edge 18 and below.
/// If you are targeting these browsers, we recommend you to include
/// [this code snippet](https://gist.github.com/sibbng/13e83b1dd1b733317ce0130ef07d4efd) on your project.
/// > which is **not** supported by IE 11, Edge 18 and below.
/// > If you are targeting these browsers, we recommend you to include
/// > [this code snippet](https://gist.github.com/sibbng/13e83b1dd1b733317ce0130ef07d4efd) on your project.
///
/// ## Excluding Elements
///

11
src/storage/use_local_storage.rs
View file

@ -2,14 +2,19 @@ use super::{use_storage_with_options, StorageType, UseStorageOptions};
use codee::{Decoder, Encoder};
use leptos::signal_prelude::*;
#[allow(rustdoc::bare_urls)]
/// Reactive [LocalStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage).
///
/// LocalStorage stores data in the browser with no expiration time. Access is given to all pages from the same origin (e.g., all pages from "https://example.com" share the same origin). While data doesn't expire the user can view, modify and delete all data stored. Browsers allow 5MB of data to be stored.
/// LocalStorage stores data in the browser with no expiration time. Access is given to all pages
/// from the same origin (e.g., all pages from "https://example.com" share the same origin).
/// While data doesn't expire the user can view, modify and delete all data stored.
/// Browsers allow 5MB of data to be stored.
///
/// This is contrast to [`use_session_storage`] which clears data when the page session ends and is not shared.
/// This is contrast to [`fn@crate::storage::use_session_storage`] which clears data when the page session ends and is not shared.
///
/// ## Usage
/// See [`use_storage`] for more details on how to use.
///
/// See [`fn@crate::storage::use_storage`] for more details on how to use.
pub fn use_local_storage<T, C>(
key: impl AsRef<str>,
) -> (Signal<T>, WriteSignal<T>, impl Fn() + Clone)

4
src/storage/use_session_storage.rs
View file

@ -6,10 +6,10 @@ use leptos::signal_prelude::*;
///
/// SessionStorages stores data in the browser that is deleted when the page session ends. A page session ends when the browser closes the tab. Data is not shared between pages. While data doesn't expire the user can view, modify and delete all data stored. Browsers allow 5MB of data to be stored.
///
/// Use [`use_local_storage`] to store data that is shared amongst all pages with the same origin and persists between page sessions.
/// Use [`fn@crate::storage::use_local_storage`] to store data that is shared amongst all pages with the same origin and persists between page sessions.
///
/// ## Usage
/// See [`use_storage`] for more details on how to use.
/// See [`fn@crate::storage::use_storage`] for more details on how to use.
pub fn use_session_storage<T, C>(
key: impl AsRef<str>,
) -> (Signal<T>, WriteSignal<T>, impl Fn() + Clone)

10
src/storage/use_storage.rs
View file

@ -23,15 +23,15 @@ const INTERNAL_STORAGE_EVENT: &str = "leptos-use-storage";
///
/// Pass a [`StorageType`] to determine the kind of key-value browser storage to use.
/// The specified key is where data is stored. All values are stored as UTF-16 strings which
/// is then encoded and decoded via the given [`Codec`]. This value is synced with other calls using
/// the same key on the smae page and across tabs for local storage.
/// is then encoded and decoded via the given `*Codec`. This value is synced with other calls using
/// the same key on the same page and across tabs for local storage.
/// See [`UseStorageOptions`] to see how behavior can be further customised.
///
/// Values are (en)decoded via the given codec. You can use any of the string codecs or a
/// binary codec wrapped in [`Base64`].
/// binary codec wrapped in `Base64`.
///
/// > Please check [the codec chapter](https://leptos-use.rs/codecs.html) to see what codecs are
/// available and what feature flags they require.
/// > available and what feature flags they require.
///
/// ## Example
///
@ -395,7 +395,7 @@ pub enum UseStorageError<E, D> {
ItemCodecError(CodecError<E, D>),
}
/// Options for use with [`use_local_storage_with_options`], [`use_session_storage_with_options`] and [`use_storage_with_options`].
/// Options for use with [`fn@crate::storage::use_local_storage_with_options`], [`fn@crate::storage::use_session_storage_with_options`] and [`use_storage_with_options`].
#[derive(DefaultBuilder)]
pub struct UseStorageOptions<T, E, D>
where

47
src/use_breakpoints.rs
View file

@ -37,6 +37,7 @@ use std::hash::Hash;
/// ## Breakpoints
///
/// There are many predefined breakpoints for major UI frameworks. The following are provided.
///
/// * [`breakpoints_tailwind`]
/// * [`breakpoints_bootstrap_v5`]
/// * [`breakpoints_material`]
@ -107,7 +108,7 @@ use std::hash::Hash;
///
/// ## Server-Side Rendering
///
/// Since internally this uses [`use_media_query`], which returns always `false` on the server,
/// Since internally this uses [`fn@crate::use_media_query`], which returns always `false` on the server,
/// the returned methods also will return `false`.
pub fn use_breakpoints<K: Eq + Hash + Debug + Clone>(
breakpoints: HashMap<K, u32>,
@ -276,7 +277,7 @@ impl<K: Eq + Hash + Debug + Clone> UseBreakpointsReturn<K> {
/// Breakpoint keys for Tailwind V2
///
/// See [https://tailwindcss.com/docs/breakpoints]
/// See <https://tailwindcss.com/docs/breakpoints>
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum BreakpointsTailwind {
Sm,
@ -288,7 +289,7 @@ pub enum BreakpointsTailwind {
/// Breakpoint definitions for Tailwind V2
///
/// See [https://tailwindcss.com/docs/breakpoints]
/// See <https://tailwindcss.com/docs/breakpoints>
pub fn breakpoints_tailwind() -> HashMap<BreakpointsTailwind, u32> {
HashMap::from([
(BreakpointsTailwind::Sm, 640),
@ -301,7 +302,7 @@ pub fn breakpoints_tailwind() -> HashMap<BreakpointsTailwind, u32> {
/// Breakpoint keys for Bootstrap V5
///
/// See [https://getbootstrap.com/docs/5.0/layout/breakpoints]
/// See <https://getbootstrap.com/docs/5.0/layout/breakpoints>
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum BreakpointsBootstrapV5 {
Sm,
@ -313,7 +314,7 @@ pub enum BreakpointsBootstrapV5 {
/// Breakpoint definitions for Bootstrap V5
///
/// See [https://getbootstrap.com/docs/5.0/layout/breakpoints]
/// <https://getbootstrap.com/docs/5.0/layout/breakpoints>
pub fn breakpoints_bootstrap_v5() -> HashMap<BreakpointsBootstrapV5, u32> {
HashMap::from([
(BreakpointsBootstrapV5::Sm, 576),
@ -326,7 +327,7 @@ pub fn breakpoints_bootstrap_v5() -> HashMap<BreakpointsBootstrapV5, u32> {
/// Breakpoint keys for Material UI V5
///
/// See [https://mui.com/material-ui/customization/breakpoints/]
/// See <https://mui.com/material-ui/customization/breakpoints/>
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum BreakpointsMaterial {
Xs,
@ -338,7 +339,7 @@ pub enum BreakpointsMaterial {
/// Breakpoint definitions for Material UI V5
///
/// See [https://mui.com/material-ui/customization/breakpoints/]
/// See <https://mui.com/material-ui/customization/breakpoints/>
pub fn breakpoints_material() -> HashMap<BreakpointsMaterial, u32> {
HashMap::from([
(BreakpointsMaterial::Xs, 1),
@ -351,7 +352,7 @@ pub fn breakpoints_material() -> HashMap<BreakpointsMaterial, u32> {
/// Breakpoint keys for Ant Design
///
/// See [https://ant.design/components/layout/#breakpoint-width]
/// See <https://ant.design/components/layout/#breakpoint-width>
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum BreakpointsAntDesign {
Xs,
@ -364,7 +365,7 @@ pub enum BreakpointsAntDesign {
/// Breakpoint definitions for Ant Design
///
/// See [https://ant.design/components/layout/#breakpoint-width]
/// See <https://ant.design/components/layout/#breakpoint-width>
pub fn breakpoints_ant_design() -> HashMap<BreakpointsAntDesign, u32> {
HashMap::from([
(BreakpointsAntDesign::Xs, 480),
@ -378,7 +379,7 @@ pub fn breakpoints_ant_design() -> HashMap<BreakpointsAntDesign, u32> {
/// Breakpoint keys for Quasar V2
///
/// See [https://quasar.dev/style/breakpoints]
/// See <https://quasar.dev/style/breakpoints>
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum BreakpointsQuasar {
Xs,
@ -390,7 +391,7 @@ pub enum BreakpointsQuasar {
/// Breakpoint definitions for Quasar V2
///
/// See [https://quasar.dev/style/breakpoints]
/// See <https://quasar.dev/style/breakpoints>
pub fn breakpoints_quasar() -> HashMap<BreakpointsQuasar, u32> {
HashMap::from([
(BreakpointsQuasar::Xs, 1),
@ -401,32 +402,32 @@ pub fn breakpoints_quasar() -> HashMap<BreakpointsQuasar, u32> {
])
}
/// Breakpoint keys for Sematic UI
/// Breakpoint keys for Semantic UI
///
/// See [https://semantic-ui.com/elements/container.html]
/// See <https://semantic-ui.com/elements/container.html>
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum BreakpointsSematic {
pub enum BreakpointsSemantic {
Mobile,
Tablet,
SmallMonitor,
LargeMonitor,
}
/// Breakpoint definitions for Sematic UI
/// Breakpoint definitions for Semantic UI
///
/// See [https://semantic-ui.com/elements/container.html]
pub fn breakpoints_sematic() -> HashMap<BreakpointsSematic, u32> {
/// See <https://semantic-ui.com/elements/container.html>
pub fn breakpoints_semantic() -> HashMap<BreakpointsSemantic, u32> {
HashMap::from([
(BreakpointsSematic::Mobile, 1),
(BreakpointsSematic::Tablet, 768),
(BreakpointsSematic::SmallMonitor, 992),
(BreakpointsSematic::LargeMonitor, 1200),
(BreakpointsSemantic::Mobile, 1),
(BreakpointsSemantic::Tablet, 768),
(BreakpointsSemantic::SmallMonitor, 992),
(BreakpointsSemantic::LargeMonitor, 1200),
])
}
/// Breakpoint keys for Master CSS
///
/// See [https://docs.master.co/css/breakpoints]
/// See <https://docs.master.co/css/breakpoints>
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum BreakpointsMasterCss {
Xxxs,
@ -443,7 +444,7 @@ pub enum BreakpointsMasterCss {
/// Breakpoint definitions for Master CSS
///
/// See [https://docs.master.co/css/breakpoints]
/// See <https://docs.master.co/css/breakpoints>
pub fn breakpoints_master_css() -> HashMap<BreakpointsMasterCss, u32> {
HashMap::from([
(BreakpointsMasterCss::Xxxs, 360),

4
src/use_broadcast_channel.rs
View file

@ -45,10 +45,10 @@ use wasm_bindgen::JsValue;
/// ```
///
/// Values are (en)decoded via the given codec. You can use any of the string codecs or a
/// binary codec wrapped in [`Base64`].
/// binary codec wrapped in `Base64`.
///
/// > Please check [the codec chapter](https://leptos-use.rs/codecs.html) to see what codecs are
/// available and what feature flags they require.
/// > available and what feature flags they require.
///
/// ```
/// # use leptos::*;

2
src/use_clipboard.rs
View file

@ -127,7 +127,7 @@ pub fn use_clipboard_with_options(
pub struct UseClipboardOptions {
/// When `true` event handlers are added so that the returned signal `text` is updated whenever the clipboard changes.
/// Defaults to `false`.
///
///
/// > Please note that clipboard changes are only detected when copying or cutting text inside the same document.
read: bool,

18
src/use_color_mode.rs
View file

@ -36,7 +36,7 @@ use wasm_bindgen::JsCast;
/// # }
/// ```
///
/// By default, it will match with users' browser preference using [`use_preferred_dark`] (a.k.a. `ColorMode::Auto`).
/// By default, it will match with users' browser preference using [`fn@crate::use_preferred_dark`] (a.k.a. `ColorMode::Auto`).
/// When reading the signal, it will by default return the current color mode (`ColorMode::Dark`, `ColorMode::Light` or
/// your custom modes `ColorMode::Custom("some-custom")`). The `ColorMode::Auto` variant can
/// be included in the returned modes by enabling the `emit_auto` option and using [`use_color_mode_with_options`].
@ -87,7 +87,7 @@ use wasm_bindgen::JsCast;
///
/// To persist color mode in a cookie, use `use_cookie_with_options` and specify `.cookie_enabled(true)`.
///
/// > Note: To work with SSR you have to add the `axum` or `actix` feature as described in [`use_cookie`].
/// > Note: To work with SSR you have to add the `axum` or `actix` feature as described in [`fn@crate::use_cookie`].
///
/// ```rust
/// # use leptos::*;
@ -116,13 +116,13 @@ use wasm_bindgen::JsCast;
///
/// If `cookie_enabled` is set to `true`, cookies will be used and if present this value will be used
/// on the server as well as on the client. Please note that you have to add the `axum` or `actix`
/// feature as described in [`use_cookie`].
/// feature as described in [`fn@crate::use_cookie`].
///
/// ## See also
///
/// * [`use_preferred_dark`]
/// * [`use_storage`]
/// * [`use_cookie`]
/// * [`fn@crate::use_preferred_dark`]
/// * [`fn@crate::storage::use_storage`]
/// * [`fn@crate::use_cookie`]
pub fn use_color_mode() -> UseColorModeReturn {
use_color_mode_with_options(UseColorModeOptions::default())
}
@ -426,7 +426,7 @@ where
/// To get the default behaviour back you can call the provided `default_handler` function.
/// It takes two parameters:
/// - `mode: ColorMode`: The color mode to change to.
/// -`default_handler: Rc<dyn Fn(ColorMode)>`: The default handler that would have been called if the `on_changed` handler had not been specified.
/// - `default_handler: Rc<dyn Fn(ColorMode)>`: The default handler that would have been called if the `on_changed` handler had not been specified.
on_changed: OnChangedFn,
/// When provided, `useStorage` will be skipped.
@ -508,9 +508,9 @@ pub struct UseColorModeReturn {
/// Main value setter signal of the color mode
pub set_mode: WriteSignal<ColorMode>,
/// Direct access to the returned signal of [`use_storage`] if enabled or [`UseColorModeOptions::storage_signal`] if provided
/// Direct access to the returned signal of [`fn@crate::storage::use_storage`] if enabled or [`UseColorModeOptions::storage_signal`] if provided
pub store: Signal<ColorMode>,
/// Direct write access to the returned signal of [`use_storage`] if enabled or [`UseColorModeOptions::storage_signal`] if provided
/// Direct write access to the returned signal of [`fn@crate::storage::use_storage`] if enabled or [`UseColorModeOptions::storage_signal`] if provided
pub set_store: WriteSignal<ColorMode>,
/// Signal of the system's preferred color mode that you would get from a media query

10
src/use_cookie.rs
View file

@ -57,10 +57,10 @@ use std::rc::Rc;
/// ```
///
/// Values are (en)decoded via the given codec. You can use any of the string codecs or a
/// binary codec wrapped in [`Base64`].
/// binary codec wrapped in `Base64`.
///
/// > Please check [the codec chapter](https://leptos-use.rs/codecs.html) to see what codecs are
/// available and what feature flags they require.
/// > available and what feature flags they require.
///
/// ## Cookie attributes
///
@ -92,7 +92,7 @@ use std::rc::Rc;
/// the HTTP response header according to options (if provided).
/// The returned `WriteSignal` may not affect the cookie headers on the server! It will try and write
/// the headers buy if this happens after the headers have already been streamed to the client then
/// this will have no effect.
/// this will have no effect.
///
/// > If you're using `axum` you have to enable the `"axum"` feature in your Cargo.toml.
/// > In case it's `actix-web` enable the feature `"actix"`, for `spin` enable `"spin"`.
@ -136,10 +136,6 @@ use std::rc::Rc;
/// # view! {}
/// # }
/// ```
///
/// ## Create Your Own Custom Codec
///
/// All you need to do is to implement the [`StringCodec`] trait together with `Default` and `Clone`.
pub fn use_cookie<T, C>(cookie_name: &str) -> (Signal<Option<T>>, WriteSignal<Option<T>>)
where
C: Encoder<T, Encoded = String> + Decoder<T, Encoded = str>,

2
src/use_element_size.rs
View file

@ -45,7 +45,7 @@ cfg_if! { if #[cfg(not(feature = "ssr"))] {
///
/// ## See also
///
/// - [`use_resize_observer`]
/// - [`fn@crate::use_resize_observer`]
pub fn use_element_size<El, T>(target: El) -> UseElementSizeReturn
where
El: Into<ElementMaybeSignal<T, web_sys::Element>> + Clone,

2
src/use_element_visibility.rs
View file

@ -40,7 +40,7 @@ use crate::{use_intersection_observer_with_options, UseIntersectionObserverOptio
///
/// ## See also
///
/// * [`use_intersection_observer`]
/// * [`fn@crate::use_intersection_observer`]
pub fn use_element_visibility<El, T>(target: El) -> Signal<bool>
where
El: Into<ElementMaybeSignal<T, web_sys::Element>>,

8
src/use_event_source.rs
View file

@ -19,10 +19,10 @@ use thiserror::Error;
/// ## Usage
///
/// Values are decoded via the given decoder. You can use any of the string codecs or a
/// binary codec wrapped in [`Base64`].
/// binary codec wrapped in `Base64`.
///
/// > Please check [the codec chapter](https://leptos-use.rs/codecs.html) to see what codecs are
/// available and what feature flags they require.
/// > available and what feature flags they require.
///
///
/// ```
@ -47,10 +47,6 @@ use thiserror::Error;
/// # }
/// ```
///
/// ### Create Your Own Custom Codec
///
/// All you need to do is to implement the [`StringCodec`] trait together with `Default` and `Clone`.
///
/// ### Named Events
///
/// You can define named events when using `use_event_source_with_options`.

2
src/use_intersection_observer.rs
View file

@ -52,7 +52,7 @@ cfg_if! { if #[cfg(not(feature = "ssr"))] {
///
/// ## See also
///
/// * [`use_element_visibility`]
/// * [`fn@crate::use_element_visibility`]
pub fn use_intersection_observer<El, T, F>(
target: El,
callback: F,

2
src/use_intl_number_format.rs
View file

@ -484,7 +484,7 @@ pub struct UseIntlNumberFormatOptions {
/// The currency to use in currency formatting.
/// Possible values are the ISO 4217 currency codes, such as "USD" for the US dollar, "EUR" for the euro,
/// or "CNY" for the Chinese RMB — see the [Current currency & funds code list](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=currency-codes.
/// or "CNY" for the Chinese RMB — see the [Current currency & funds code list](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=currency-codes).
/// There is no default value; if the style is `Currency`, the currency property must be provided.
#[builder(into)]
currency: Option<String>,

4
src/use_media_query.rs
View file

@ -36,8 +36,8 @@ use std::rc::Rc;
///
/// ## See also
///
/// * [`use_preferred_dark`]
/// * [`use_preferred_contrast`]
/// * [`fn@crate::use_preferred_dark`]
/// * [`fn@crate::use_preferred_contrast`]
pub fn use_media_query(query: impl Into<MaybeSignal<String>>) -> Signal<bool> {
let query = query.into();

4
src/use_preferred_contrast.rs
View file

@ -25,8 +25,8 @@ use std::fmt::Display;
///
/// ## See also
///
/// * [`use_media_query`]
/// * [`use_preferred_dark`]
/// * [`fn@crate::use_media_query`]
/// * [`fn@crate::use_preferred_dark`]
pub fn use_preferred_contrast() -> Signal<PreferredContrast> {
let is_more = use_media_query("(prefers-contrast: more)");
let is_less = use_media_query("(prefers-contrast: less)");

4
src/use_preferred_dark.rs
View file

@ -24,8 +24,8 @@ use leptos::*;
///
/// ## See also
///
/// * [`use_media_query`]
/// * [`use_preferred_contrast`]
/// * [`fn@crate::use_media_query`]
/// * [`fn@crate::use_preferred_contrast`]
pub fn use_preferred_dark() -> Signal<bool> {
use_media_query("(prefers-color-scheme: dark)")
}

2
src/use_raf_fn.rs
View file

@ -165,6 +165,6 @@ pub struct UseRafFnCallbackArgs {
/// Time elapsed between this and the last frame.
pub delta: f64,
/// Time elapsed since the creation of the web page. See [MDN Docs](https://developer.mozilla.org/en-US/docs/Web/API/DOMHighResTimeStamp#the_time_origin Time origin).
/// Time elapsed since the creation of the web page. See [MDN Docs](https://developer.mozilla.org/en-US/docs/Web/API/DOMHighResTimeStamp#the_time_origin) Time origin.
pub timestamp: f64,
}

2
src/use_resize_observer.rs
View file

@ -50,7 +50,7 @@ cfg_if! { if #[cfg(not(feature = "ssr"))] {
///
/// ## See also
///
/// - [`use_element_size`]
/// * [`fn@crate::use_element_size`]
pub fn use_resize_observer<El, T, F>(
target: El, // TODO : multiple elements?
callback: F,

4
src/use_timestamp.rs
View file

@ -155,10 +155,10 @@ pub struct UseTimestampOptions {
/// Interval type for [`UseTimestampOptions`].
#[derive(Copy, Clone, Eq, PartialEq, Debug)]
pub enum TimestampInterval {
/// use [`use_raf_fn`] for updating the timestamp
/// use [`fn@crate::use_raf_fn`] for updating the timestamp
RequestAnimationFrame,
/// use [`use_interval_fn`] for updating the timestamp
/// use [`fn@crate::use_interval_fn`] for updating the timestamp
Interval(u64),
}

4
src/use_websocket.rs
View file

@ -16,6 +16,7 @@ use js_sys::Array;
use wasm_bindgen::prelude::*;
use web_sys::{BinaryType, CloseEvent, Event, MessageEvent, WebSocket};
#[allow(rustdoc::bare_urls)]
/// Creating and managing a [Websocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) connection.
///
/// ## Demo
@ -27,7 +28,7 @@ use web_sys::{BinaryType, CloseEvent, Event, MessageEvent, WebSocket};
/// Values are (en)decoded via the given codec. You can use any of the codecs, string or binary.
///
/// > Please check [the codec chapter](https://leptos-use.rs/codecs.html) to see what codecs are
/// available and what feature flags they require.
/// > available and what feature flags they require.
///
/// ```
/// # use leptos::*;
@ -247,6 +248,7 @@ where
}
/// Version of [`use_websocket`] that takes `UseWebSocketOptions`. See [`use_websocket`] for how to use.
#[allow(clippy::type_complexity)]
pub fn use_websocket_with_options<T, C>(
url: &str,
options: UseWebSocketOptions<

2
src/use_window.rs
View file

@ -54,7 +54,7 @@ impl UseWindow {
navigator(&self) -> Option<web_sys::Navigator>
);
/// Returns the same as [`use_document`].
/// Returns the same as [`fn@use_document`].
#[inline(always)]
pub fn document(&self) -> UseDocument {
use_document()

4
src/utils/use_derive_signal.rs
View file

@ -1,6 +1,6 @@
/// Macro to easily create helper functions that derive a signal using a piece of code.
///
/// See [`is_ok`] or [`use_to_string`] as examples.
///
/// See [`fn@crate::is_ok`] or [`fn@crate::use_to_string`] as examples.
#[macro_export]
macro_rules! use_derive_signal {
(

9
src/watch_debounced.rs
View file

@ -34,7 +34,7 @@ use leptos::*;
///
/// Please note that if the current component is cleaned up before the debounced callback is called, the debounced callback will not be called.
///
/// There's also `watch_debounced_with_options` where you can specify the other watch options (except `filter`).
/// There's also [`watch_debounced_with_options`] where you can specify the other watch options (except `filter`).
///
/// ```
/// # use leptos::*;
@ -70,8 +70,8 @@ use leptos::*;
///
/// ## See also
///
/// * [`watch`]
/// * [`watch_throttled`]
/// * `leptos::watch`
/// * [`fn@crate::watch_throttled`]
pub fn watch_debounced<W, T, DFn, CFn>(deps: DFn, callback: CFn, ms: f64) -> impl Fn() + Clone
where
DFn: Fn() -> W + 'static,
@ -82,7 +82,8 @@ where
watch_with_options(deps, callback, WatchOptions::default().debounce(ms))
}
/// Version of `watch_debounced` that accepts `WatchDebouncedOptions`. See [`watch_debounced`] for how to use.
/// Version of `watch_debounced` that accepts `WatchDebouncedOptions`.
/// See [`watch_debounced`] for how to use.
pub fn watch_debounced_with_options<W, T, DFn, CFn>(
deps: DFn,
callback: CFn,

2
src/watch_pausable.rs
View file

@ -52,7 +52,7 @@ use leptos::*;
///
/// ## See also
///
/// * [`watch`]
/// * `leptos::watch`
pub fn watch_pausable<W, T, DFn, CFn>(
deps: DFn,
callback: CFn,

8
src/watch_throttled.rs
View file

@ -1,7 +1,7 @@
use crate::{watch_with_options, ThrottleOptions, WatchOptions};
use default_struct_builder::DefaultBuilder;
/// A throttled version of [`watch`].
/// A throttled version of `leptos::watch`.
///
/// ## Demo
///
@ -69,8 +69,8 @@ use default_struct_builder::DefaultBuilder;
///
/// ## See also
///
/// * [`watch`]
/// * [`watch_debounced`]
/// * `leptos::watch`
/// * [`fn@crate::watch_debounced`]
pub fn watch_throttled<W, T, DFn, CFn>(deps: DFn, callback: CFn, ms: f64) -> impl Fn() + Clone
where
DFn: Fn() -> W + 'static,
@ -81,7 +81,7 @@ where
watch_with_options(deps, callback, WatchOptions::default().throttle(ms))
}
/// Version of `watch_throttled` that accepts `WatchThrottledOptions`. See [`watch_throttled`] for how to use.
/// Version of [`fn@watch_throttled`] that accepts `WatchThrottledOptions`. See [`watch_throttled`] for how to use.
pub fn watch_throttled_with_options<W, T, DFn, CFn>(
deps: DFn,
callback: CFn,

9
src/watch_with_options.rs
View file

@ -38,7 +38,8 @@ use std::rc::Rc;
///
/// ## Filters
///
/// The callback can be throttled or debounced. Please see [`watch_throttled`] and [`watch_debounced`] for details.
/// The callback can be throttled or debounced. Please see [`fn@crate::watch_throttled`]
/// and [`fn@crate::watch_debounced`] for details.
///
/// ```
/// # use leptos::*;
@ -86,10 +87,8 @@ use std::rc::Rc;
///
/// ## See also
///
/// * [`watch_throttled`]
/// * [`watch_debounced`]
/// Version of `watch` that accepts `WatchOptions`. See [`watch`] for how to use.
/// * [`fn@crate::watch_throttled`]
/// * [`fn@crate::watch_debounced`]
pub fn watch_with_options<W, T, DFn, CFn>(
deps: DFn,
callback: CFn,

6
src/whenever.rs
View file

@ -20,7 +20,7 @@ use crate::{watch_with_options, WatchOptions};
///
/// ### Callback Function
///
/// Same as [`watch`], the callback will be called with `callback(input, prev_input, prev_return)`.
/// Same as [`fn@crate::watch`], the callback will be called with `callback(input, prev_input, prev_return)`.
///
/// ```
/// # use leptos::*;
@ -39,7 +39,7 @@ use crate::{watch_with_options, WatchOptions};
///
/// ### Computed
///
/// Same as [`watch`], you can pass a getter function to calculate on each change.
/// Same as [`fn@crate::watch`], you can pass a getter function to calculate on each change.
///
/// ```
/// # use leptos::*;
@ -59,7 +59,7 @@ use crate::{watch_with_options, WatchOptions};
///
/// ### Options
///
/// Options and defaults are same as [`watch_with_options`].
/// Options and defaults are same as [`fn@watch_with_options`].
///
/// ```
/// # use leptos::*;