Skip to content

Latest commit

Β 

History

History
58 lines (35 loc) Β· 2.4 KB

README.md

File metadata and controls

58 lines (35 loc) Β· 2.4 KB

πŸ–±οΈ Scroll-RS

Crates.io Crates.io Downloads Crates.io License made-with-rust Rust Maintenance

Open SASS Discord

logo

🎬 Demo

scroll-rs-demo

πŸ“œ Intro

Scroll-RS is a headless, customizable scroll-to-target component for Wasm-based frameworks like Yew, Dioxus, and Leptos. Enhance user experience by enabling smooth, controlled scrolling to specific positions on a page with optional auto-hide and custom styling.

πŸ€” Why Use Scroll-RS?

The following are some of the reasons why Scroll-RS is a great addition to your Wasm projects:

  1. ← ↑ β†’ ↓ Scroll Anywhere: Easily navigate to specific sections or positions on the page.
  2. 🎨 Fully Customizable: Use your own CSS styles, animations, and SVG icons.
  3. ⚑ Smooth Behavior: Choose between smooth, instant, or delayed scrolling effects.
  4. πŸ‘€ Auto-Hide: Automatically hide or show based on user-defined thresholds.
  5. πŸ”§ Flexible Offsets: Adjust scrolling positions and delays with ease.

Y Yew Usage

Refer to our guide to integrate this component into your Yew app.

🧬 Dioxus Usage

Refer to our guide to integrate this component into your Dioxus app.

🌱 Leptos Usage

Refer to our guide to integrate this component into your Leptos app.

🀝 Contributions

Contributions are welcome! Whether it's bug fixes, feature requests, or examples, we would love your help to make Scroll-RS better.

  1. Fork the repository.
  2. Create a new branch for your feature/bugfix.
  3. Submit a pull request for review.

πŸ“œ License

Scroll-RS is licensed under the MIT License. You are free to use, modify, and distribute this library in your projects.