Crates.io | leptos-use |
lib.rs | leptos-use |
version | 0.10.10 |
source | src |
created_at | 2023-05-12 19:26:39.041546 |
updated_at | 2024-05-10 19:57:53.658467 |
description | Collection of essential Leptos utilities inspired by SolidJS USE / VueUse |
homepage | https://leptos-use.rs |
repository | https://github.com/Synphonyte/leptos-use |
max_upload_size | |
id | 863237 |
size | 667,500 |
Inspired by React-Use / VueUse / SolidJS-USE
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!
To run all tests run
cargo test --all-features
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
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.
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 |