npm.io
5.0.0 • Published 2 years ago

onedionys-scrolling-utilities

Licence
ISC
Version
5.0.0
Deps
132
Size
15 kB
Vulns
0
Weekly
0
Stars
11

Welcome to One Dionys - Scrolling Utilities!

Functions to detect scroll position and provide control over scroll behavior.

Requirements

  • Web Browser - Can be used as an emulator to build applications. Example [Chrome, Firefox, Safari & Opera].
  • Internet - Because many use CDN and to make it easier to find solutions to all problems.

How To Use

Example Syntax
const scrollingUtilities = require('./src/scrollingUtilities');

// Example usage of isScrolledToBottom function
console.log(scrollingUtilities.isScrolledToBottom()); // Output: true/false

// Example usage of isScrolledToTop function
console.log(scrollingUtilities.isScrolledToTop()); // Output: true/false

// Example usage of scrollToElement function
const targetElement = document.getElementById('target');
scrollingUtilities.scrollToElement(targetElement, 1000); // Scroll to the target element smoothly in 1 second
Explanation
  • isScrolledToBottom: Checks if the page is scrolled to the bottom.
  • isScrolledToTop: Checks if the page is scrolled to the top.
  • scrollToElement: Smoothly scrolls to a specific element on the page.
Return Value
  • isScrolledToBottom: Returns true if scrolled to the bottom, false otherwise.
  • isScrolledToTop: Returns true if scrolled to the top, false otherwise.
  • scrollToElement: No return value.

Release Date

  • v1.0.0 : 08 March 2024
  • v1.0.1 : 11 March 2024
  • v4.0.0 : 11 March 2024
  • v4.0.1 : 13 March 2024
  • v4.0.2 : 18 March 2024
  • v5.0.0 : 31 March 2024

Author

License

  • Copyright 2024 One Dionys
  • One Dionys - Scrolling Utilities is an open source project licensed under the MIT license

Suppport & Donation

Love One Dionys - Scrolling Utilities? Support this project by donating or sharing with others in need.

Made with One Dionys

Keywords