web-html5-scripts/techniques/vanilla-js-smooth-scroll/index.html
2020-01-20 21:00:54 +01:00

117 lines
2.8 KiB
HTML

<!DOCTYPE html>
<html lang="en" >
<head>
<meta charset="UTF-8">
<title>Vanilla JS Smooth Scroll</title>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/normalize/5.0.0/normalize.min.css">
<link rel='stylesheet' href='https://highlightjs.org/static/demo/styles/night-owl.css'><link rel="stylesheet" href="./style.css">
</head>
<body>
<nav>
<a href="#section-1">Vanilla JS Smooth Scroll</a>
<a href="#section-2">Easy to use!</a>
<a href="#section-3">Usage</a>
<a href="#section-4">Options</a>
<a href="#section-5">That's it</a>
</nav>
<section id="section-1">
<div>
<strong>Vanilla JS Smooth Scroll</strong>
</div>
</section>
<section id="section-2">
<div>
<strong>Easy to use!</strong>
</div>
</section>
<section id="section-3">
<div>
<span>Usage:</span>
<pre>
<code class="javascript">
let links = document.getElementsByTagName('a');
[].forEach.call(links, (el) => {
el.scrollToSmooth({
speed: 500,
easing: 'easeInOutQuint',
callback: function () { console.log('we reached it!'); },
fixedHeader: null
});
});
</code>
</pre>
</div>
</section>
<section id="section-4">
<div>
<h3>Options:</h3>
<dl class="options">
<dt>speed</dt>
<dd>
Type: <code>Number</code><br>
Default: <code>400</code>
<p>
Scroll time in milliseconds
</p>
</dd>
<dt>easing</dt>
<dd>
Type: <code>string</code><br>
Default: <code>linear</code>
<p>
Easing function used for scrolling.<br>
Available Easings:
<ul>
<li>linear</li>
<li>easeInQuad</li>
<li>easeOutQuad</li>
<li>easeInOutQuad</li>
<li>easeInCubic</li>
<li>easeOutCubic</li>
<li>easeInOutCubic</li>
<li>easeInQuart</li>
<li>easeOutQuart</li>
<li>easeInOutQuart</li>
<li>easeInQuint</li>
<li>easeOutQuint</li>
<li>easeInOutQuint</li>
<li>easeInElastic</li>
<li>easeOutElastic</li>
<li>easeInOutElastic</li>
</ul>
</p>
</dd>
<dt>callback</dt>
<dd>
Type: <code>function</code><br>
Default: <code>null</code>
<p>
Callback to be executed when scrolling is finished
</p>
</dd>
<dt>fixedHeader</dt>
<dd>
Type: <code>string</code><br>
Default: <code>null</code>
<p>
The header element<br>
Example: '#fixed-header'
</p>
</dd>
</dl>
</div>
</section>
<section id="section-5">
<div>
<strong>Here we go!</strong>
</div>
</section>
<script src='https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.10/highlight.min.js'></script><script src="./script.js"></script>
</body>
</html>