leptos-use/README.md
2023-06-10 04:49:34 +01:00

1.9 KiB

Leptos-Use – Collection of essential Leptos utilities

Collection of essential Leptos utilities

Inspired by React-Use / VueUse / SolidJS-USE

Crates.io Docs & Demos 23 Functions





Docs MIT/Apache 2.0 Build Status

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_media_query