Synphonyte/leptos-use

Collection of essential Leptos utilities inspired by React-Use / VueUse

Collection of essential Leptos utilities

Inspired by React-Use / VueUse / SolidJS-USE

Usage

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.13	0.6