Travis CI Github Build Codacy Badge Codebeat Badge CodeFactor Badge DeepScan grade Analytics
Create a fullscreen intro section and dismiss it in a single gesture.
See the demo here
GitHub stars GitHub forks GitHub watchers GitHub followers
GitHub code size in bytes GitHub repo size GitHub language count GitHub top language GitHub last commit
This library creates a fullscreen intro section and disables the default page scroll.
The page scroll is being enabled again after a single mouse scroll, touch swipe up or any gesture that forces the page to move upwards.
npm i introscroll
or
yarn add introscroll
or
just download this repository and link the files located in dist folder
or include it from unpkg.com
<script src="https://unpkg.com/introscroll"></script>
Then
import IntroScroll from 'introscroll';
and initialize an instance using default settings
const intro = new IntroScroll();
or add your own settings
const intro = new IntroScroll({ element: '#your-fullscreen-section', wrapper: '#your-fullscreen-sections-wrapper', container: '#your-fullscreen-sections-container', trigger: '#your-fullscreen-sections-link', scrollClass: 'intro--scrolled', duration: 1000, afterScroll(instance) { console.log(instance.element); } });
For more details please see the demo.
MIT