https://github.com/opensass/scroll-rs

🖱️ A headless, customizable scroll-to-target component for WASM frameworks.
https://github.com/opensass/scroll-rs

dioxus dioxus-fullstack leptos rust scroll scroll-to-top yew

Last synced: 7 days ago
JSON representation

🖱️ A headless, customizable scroll-to-target component for WASM frameworks.

• Host: GitHub
• URL: https://github.com/opensass/scroll-rs
• Owner: opensass
• License: mit
• Created: 2024-01-23T09:35:52.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-18T19:36:01.000Z (about 1 month ago)
• Last Synced: 2024-12-18T19:41:01.309Z (about 1 month ago)
• Topics: dioxus, dioxus-fullstack, leptos, rust, scroll, scroll-to-top, yew
• Language: Rust
• Homepage: https://scroll-rs.netlify.app
• Size: 17.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# 🖱️ Scroll-RS

[![Crates.io](https://img.shields.io/crates/v/scroll-rs)](https://crates.io/crates/scroll-rs)

[![Crates.io Downloads](https://img.shields.io/crates/d/scroll-rs)](https://crates.io/crates/scroll-rs)

![Crates.io License](https://img.shields.io/crates/l/scroll-rs)

[![made-with-rust](https://img.shields.io/badge/Made%20with-Rust-1f425f.svg?logo=rust&logoColor=white)](https://www.rust-lang.org/)

[![Rust](https://img.shields.io/badge/Rust-1.79%2B-blue.svg)](https://www.rust-lang.org)

[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/wiseaidev)

[![Open SASS Discord](https://dcbadge.limes.pink/api/server/b5JbvHW5nv)](https://discord.gg/b5JbvHW5nv)

![logo](./assets/logo.png)



## 🎬 Demo

![scroll-rs-demo](https://github.com/user-attachments/assets/cee5edb6-bf4f-4abd-8e4c-bc7cba3cd66c)

## 📜 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.

1. **🎨 Fully Customizable**: Use your own CSS styles, animations, and SVG icons.

1. **⚡ Smooth Behavior**: Choose between smooth, instant, or delayed scrolling effects.

1. **👀 Auto-Hide**: Automatically hide or show based on user-defined thresholds.

1. **🔧 Flexible Offsets**: Adjust scrolling positions and delays with ease.

## Y Yew Usage

Refer to [our guide](YEW.md) to integrate this component into your Yew app.

## 🧬 Dioxus Usage

Refer to [our guide](DIOXUS.md) to integrate this component into your Dioxus app.

## 🌱 Leptos Usage

Refer to [our guide](LEPTOS.md) 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.

1. Create a new branch for your feature/bugfix.

1. Submit a pull request for review.

## 📜 License

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