Gathering detailed insights and metrics for smoothscroll-anchor-polyfill
Gathering detailed insights and metrics for smoothscroll-anchor-polyfill
Installations
npm install smoothscroll-anchor-polyfillDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Score
77
Supply Chain
100
Quality
76.1
Maintenance
100
Vulnerability
100
License
Releases
14
Contributors
2
Unable to fetch Contributors
Languages
1
JavaScript
JavaScript (100%)
Developer
Download Statistics
Total Downloads
461,566
Last Day
170
Last Week
1,386
Last Month
5,926
Last Year
81,085
GitHub Statistics
42 Stars
133 Commits
3 Forks
2 Watching
2 Branches
2 Contributors
Bundle Size
2.79 kB
Minified
1.33 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
1.3.4
Package Id
smoothscroll-anchor-polyfill@1.3.4
Unpacked Size
57.96 kB
Size
13.90 kB
File Count
10
Total Downloads
Cumulative downloads
Total Downloads
461,566
Last day
-39.7%
170
Compared to previous day
Last week
-12%
1,386
Compared to previous week
Last month
-10.3%
5,926
Compared to previous month
Last year
-6.5%
81,085
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Versions
smoothscroll-anchor-polyfill
⚓ Apply smooth scroll to anchor links to polyfill the CSS property scroll-behavior
Features
- ✔ Smooth scroll to target when clicking an anchor
- ✔ Smooth scroll to target on hashchange (◀/▶ buttons)
- ✔ Updates URL with #fragment
- ✔ Handles focus for improved accessibility
- ✔ Doesn't break server-side rendering
- ✔ 1.3KB gzipped
⚠ Requires smooth scroll for window.scroll() and Element.scrollIntoView() (e.g. smoothscroll-polyfill) to work!
Browser support
 IE / Edge |  Firefox |  Chrome |  Safari |  iOS Safari |  Opera |
|---|---|---|---|---|---|
| IE9+, Edge | native | native* | last 2 versions | last 2 versions | native* |
* hashchange navigation triggered by forwards/backwards buttons isn't smooth despite native support. Learn more
Usage
1. Set scroll-behavior: smooth in CSS
⚠ Has to be set global (on
html), check the docs for limitations
Because CSS properties unknown to a browser can't efficiently be parsed from JavaScript, just specyfing the normal scroll-behavior property is not enough unfortunately.
You need to add an additional CSS variable so the polyfill can read it:
1html { 2 --scroll-behavior: smooth; 3 scroll-behavior: smooth; 4}
You can also use media queries, toggle classes etc. to control the smooth scroll. The following only enables smooth scroll on Desktop devices, for example:
1html { 2 --scroll-behavior: auto; 3 scroll-behavior: auto; 4} 5 6@media screen and (min-width: 1150px) { 7 html { 8 --scroll-behavior: smooth; 9 scroll-behavior: smooth; 10 } 11}
💡 This process can be automated using a PostCSS plugin, so you can write regular CSS and it'll be transformed to work with the polyfill automatically.
The plugin will also read your browserslist and choose the right transformation depending on if all your browsers support CSS variables or not. It just works™
Need to support Internet Explorer?
Legacy browsers like Internet Explorer do not support CSS variables, so you need another way to specify scroll-behavior. There are two options:
Using the inline style attribute
1<html style="scroll-behavior: smooth;"> 2 ... 3</html>
Using font-family
Alternatively, you can specify the property as the name of a custom font family. Your actual fonts will still work the way they should (plus, you can simply declare actual fonts on body). As with CSS variables (and unlike inline styles), this allows you to use normal CSS features like media queries.
1<style> 2 html { 3 scroll-behavior: auto; 4 font-family: 'scroll-behavior: auto;', 'Roboto', sans-serif; 5 } 6</style>
2. Install the polyfill
Because this polyfill only wires up anchor links to use the browser's native window.scroll() and element.scrollIntoView() methods, you'll need to load a polyfill providing smooth scroll to these methods in addition to the steps outlined below.
smoothscroll-polyfill works, but you can just as well use another one or write your own implementation. Learn More
2a. From a CDN
1<script src="https://unpkg.com/smoothscroll-anchor-polyfill"></script>
2b. From npm
1npm install smoothscroll-anchor-polyfill
then
1import 'smoothscroll-anchor-polyfill'
Full Documentation & Demo
The full documentation with advanced installation instructions, limitations, features like enabling and disabling the smooth scrolling and more can be found at
jonaskuske.github.io/smoothscroll-anchor-polyfill.
The documentation site itself is built as a smooth scrolling one-page design, utilizing this polyfill.
PRs welcome!
© 2021, Jonas Kuske
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 0/9 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 22 are checked with a SAST tool
Reason
35 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
- Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
- Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
1.7
/10
Last Scanned on 2024-12-16
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More