## Usage
[](https://docs.rs/leptos-use/)
[](https://github.com/synphonyte/leptos-use#license)
[](https://github.com/synphonyte/leptos-use/actions/workflows/ci.yml)
```rust
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
```shell
cargo test --all-features
```
### 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/) is installed.
## Leptos compatibility
| Crate version | Compatible Leptos version |
|---------------|---------------------------|
| <= 0.3 | 0.3 |
| 0.4, 0.5, 0.6 | 0.4 |
| main | 0.5.0-alpha |
