leptos-use/README.md

Collection of essential Leptos utilities

Inspired by React-Use / VueUse / SolidJS-USE

Usage

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

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

We have only just begun implementing the first dozen functions but they are already very usable and ergonomic.

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

New Function Template

To scaffold a new function quickly you can run template/createfn.sh. It requires that ffizer is installed.