https://github.com/synphonyte/leptos-use
Collection of essential Leptos utilities inspired by React-Use / VueUse
https://github.com/synphonyte/leptos-use
dom hooks leptos leptos-use react-hooks react-use reactive rust solidjs-use utility-library vueuse webassembly yew-hooks
Last synced: about 2 months ago
JSON representation
Collection of essential Leptos utilities inspired by React-Use / VueUse
- Host: GitHub
- URL: https://github.com/synphonyte/leptos-use
- Owner: Synphonyte
- License: apache-2.0
- Created: 2023-05-12T19:19:46.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-16T23:22:58.000Z (3 months ago)
- Last Synced: 2025-05-01T19:39:07.782Z (2 months ago)
- Topics: dom, hooks, leptos, leptos-use, react-hooks, react-use, reactive, rust, solidjs-use, utility-library, vueuse, webassembly, yew-hooks
- Language: Rust
- Homepage: https://leptos-use.rs/
- Size: 1.64 MB
- Stars: 394
- Watchers: 3
- Forks: 90
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
Awesome Lists containing this project
README
Collection of essential Leptos utilities
Inspired by React-Use / VueUse
## Usage
[](https://docs.rs/leptos-use/)
[](https://github.com/synphonyte/leptos-use#license)
[](https://github.com/synphonyte/leptos-use/actions/workflows/cd.yml)
[](https://discord.com/channels/1031524867910148188/1121154537709895783)
```rust
use leptos::prelude::*;
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
```shell
# Run tests (general)
cargo test --features math,docs,ssr
# Run tests (axum) use_cookie
cargo test --features math,docs,ssr,axum --doc use_cookie
# Run tests (axum) use_locale
cargo test --features math,docs,ssr,axum --doc use_locale
# Run tests (actix) use_cookie
cargo test --features math,docs,ssr,actix --doc use_cookie
# Run tests (actix) use_locale
cargo test --features math,docs,ssr,actix --doc use_locale
```
### Book
First you need to install
```shell
cargo install mdbook mdbook-cmdrun trunk
```
To build the book go in your terminal into the docs/book folder
and run
```shell
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
```shell
python3 post_build.py
```
If you only want to add the example for one function you can run for example
```shell
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`](https://ffizer.github.io/) 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 |
| 0.14, 0.15 | 0.7 |
| 0.16 | 0.8 |