@bitovi/scrolling-nav
Advanced tools
Readme
A web component for navigating to sections of your page that can stick as you scroll.
If you are using a module loader, you can install the web component with NPM like:
npm install @bitovi/scrolling-nav
Import the web component:
import "../../node_modules/@bitovi/scrolling-nav";
To use, just insert the HTML element tag created by the package.
<scrolling-nav></scrolling-nav>
That's it.
You can optionally provide attributes to the component to customize your experience. Here are the default attribute values.
<scrolling-nav
scrollable-container-selector="window"
heading-selector="h2"
></scrolling-nav>
falsestring"window"The scrollable-container-selector attribute is the tag (HTML element, class, or ID) contains the section headings that you want to scroll to. By default, it will be the window.
<scrolling-nav scrollable-container-selector=".header"></scrolling-nav>
falsestring"h2"The heading-selector attribute is the tag (HTML element, class, or ID) that will be used to create the navbar items. By default, it will scour the <body> for H2 tags.
<scrolling-nav heading-selector="h3"><scrolling-nav>
You can override or modify the default styles by using the provided IDs and classes. The component is structured like the following:
<scrolling-nav>
<ul class="scrolling-nav-inner">
...
<ul class="scrolling-nav-item">
<a>Heading Example 1</a>
</ul>
...
<ul class="scrolling-nav-item">
<a>Heading Example 2</a>
</ul>
...
</div>
</scrolling-nav>
To customize the styles of the navbar container, use the following tag in your styles:
scrolling-nav {}
To customize the styles of the navbar inner container (which is scrolled by the outer container), use the following ID in your styles:
scrolling-nav > ul {}
To customize the styles of the navbar's items, use the following class in your styles:
scrolling-nav > ul > li {}
If you want to customize the active state of a nav item, use the following class in your styles:
scrolling-nav > ul > li.scrolling-nav-active {}
The scrolling-nav-active class is added whenever the section represented by the nav item is in or below the top 1/3 of the page and above of the next section in the page. The scrolling-nav-active class will only be applied to one item at a time.
You may get the following linting error on the web component: Property 'scrolling-nav' does not exist on type 'JSX.IntrinsicElements'. To fix this, add the following snippet to your declarations.d.ts file.
// In ~/declarations.d.ts
declare namespace JSX {
// ...
interface IntrinsicElements {
// ...
"scrolling-nav": any;
}
}
FAQs
Just drop it in to enable quick navigation to sections of your page.
The npm package @bitovi/scrolling-nav receives a total of 0 weekly downloads. As such, @bitovi/scrolling-nav popularity was classified as not popular.
We found that @bitovi/scrolling-nav demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers 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
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.