#leptos #utilities

leptos-use

Collection of essential Leptos utilities inspired by SolidJS USE / VueUse

33 releases (9 breaking)

0.10.2 Feb 9, 2024
0.9.0 Dec 6, 2023
0.8.2 Nov 9, 2023
0.6.0 Jul 17, 2023

#1 in #hooks

Download history 466/week @ 2023-11-01 771/week @ 2023-11-08 615/week @ 2023-11-15 530/week @ 2023-11-22 686/week @ 2023-11-29 637/week @ 2023-12-06 822/week @ 2023-12-13 868/week @ 2023-12-20 646/week @ 2023-12-27 916/week @ 2024-01-03 987/week @ 2024-01-10 959/week @ 2024-01-17 969/week @ 2024-01-24 1238/week @ 2024-01-31 1778/week @ 2024-02-07 1741/week @ 2024-02-14

5,831 downloads per month
Used in 9 crates

MIT/Apache

530KB
10K SLoC


Leptos-Use – Collection of essential Leptos utilities

Collection of essential Leptos utilities

Inspired by React-Use / VueUse / SolidJS-USE

Crates.io SSR Docs & Demos 72 Functions




Usage

Docs MIT/Apache 2.0 Build Status Discord

use leptos::*;
use leptos_use::{use_mouse, UseMouseReturn};

#[component]
fn Demo() -> impl IntoView {
    let UseMouseReturn { x, y, .. } = use_mouse();
    
    view! { cx,
        {x} " x " {y}
    }
}

Missing a function? Open a ticket or PR!

Development

To run all tests run

cargo test --all-features

Book

First you need to install

cargo install mdbook mdbook-cmdrun trunk

To build the book go in your terminal into the docs/book folder and run

mdbook serve

This builds the html version of the book and runs a local dev server. To also add in the examples open another shell and run

python3 post_build.py

If you only want to add the example for one function you can run for example

python3 post_build.py use_storage

New Function Template

To scaffold a new function quickly you can run template/createfn.sh. It requires that ffizer and Python 3 is installed. This will create the function file in the src directory, scaffold an example directory and an entry in the book.

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.6

Dependencies

~21–37MB
~608K SLoC