Skip to content

๐Ÿ–ฑ๏ธ A highly customizable scroll-to-anywhere component for WASM frameworks.

License

Notifications You must be signed in to change notification settings

opensass/scroll-rs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

14 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ–ฑ๏ธ 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.