Security News
New Proposed CISA Mandate Would Require Critical Infrastructure to Report Ransom Payments Within 24 Hours
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
@sidsbrmnn/scrollspy
Advanced tools
A simple lightweight JavaScript library without jQuery or any other dependencies to handle scroll spying on static webpages.
Weekly downloads
Readme
A simple lightweight JavaScript library without jQuery or any other dependencies to handle scroll spying on static webpages.
via NPM
Install it using npm
npm install --save @sidsbrmnn/scrollspy
Use the minified script from unpkg.com
<script src="https://unpkg.com/@sidsbrmnn/scrollspy@1.x/dist/scrollspy.min.js"></script>
Easy for using, syntax just like this:
scrollSpy(menu, options)
This little plugin will add active
class into your existing menu item when you scroll your page to a matched section by ID.
If you are giving it a try, make sure that you:
Added CSS for active
class in your menu item. Because, this plugin do NOT include CSS.
Create your sections.
Example: <section id="first-section">...</section>
Added an attribute which is an section ID into your menu items. Default is href
.
Example: "href"="#first-section"
.
You also replace href
with the other name by hrefAttribute
in options
.
The menu
is query selector to your menu. It is string
or HTMLElement
instance.
The options
is optional. It is type of object
which contains properties below:
Name | Type | Default | Description |
---|---|---|---|
sectionSelector | string | section | Query selector to your sections |
targetSelector | string | a | Element will be added active class |
offset | number | 0 | Offset number |
hrefAttribute | string | href | The menu item's attribute name which contains section ID |
activeClass | string | active | Active class name will be added into targetSelector |
isActive | function | null | A callback method that's called with the current menuItem and section |
import scrollSpy from '@sidsbrmnn/scrollspy'
const options = {
sectionSelector: 'section', // Query selector to your sections
targetSelector: '.nav-link', // Query selector to your elements that will be added `active` class
offset: 100 // Menu item will active before scroll to a matched section 100px
}
// Initialize
scrollSpy(document.getElementById('navMain'), options)
// Shorter way
scrollSpy('#navMain', options)
<script src="/path/to/dist/scrollspy.min.js"></script>
<script>
window.onload = function () {
scrollSpy('#navMain', {
sectionSelector: 'section',
targetSelector: '.nav-link',
offset: 100
});
}
</script>
FAQs
A simple lightweight JavaScript library without jQuery or any other dependencies to handle scroll spying on static webpages.
The npm package @sidsbrmnn/scrollspy receives a total of 791 weekly downloads. As such, @sidsbrmnn/scrollspy popularity was classified as not popular.
We found that @sidsbrmnn/scrollspy demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Security News
Redis is no longer OSS, breaking its explicit commitment to remain under the BSD 3-Clause License forever. This has angered contributors who are now working to fork the software.
Product
Socket AI now enables 'AI detected potential malware' alerts by default, ensuring users benefit from AI-powered state-of-the-art malware detection without needing to opt-in.