@numiko/jump-links
v2.1.2
Published
> **Note:** The functionality of this package relies on the tailwind class `translate-y-0`. If the sticky nav functionality is not working, make sure to add this class to the tailwind safelist js file.
Readme
Note: The functionality of this package relies on the tailwind class
translate-y-0. If the sticky nav functionality is not working, make sure to add this class to the tailwind safelist js file.
Jump Links
A lightweight JavaScript package that creates a fixed navigation bar showing scroll progress and allowing users to jump between sections. The navigation can be revealed/hidden based on scroll position and supports both class-based and custom animations.
Features
- Smooth scrolling to sections
- Progress bar indication
- Configurable sticky behavior
- Support for both CSS classes and custom animations
- Intersection Observer for accurate section tracking
- Responsive to window resizing
- Accessible navigation
Installation
npm install @numiko/jump-linksAPI
See documentation for more detail on how to use the package.
