custom-snap v2.0.0

Custom Snap - Minimal fullpage.js clone

A minimal TypeScript clone of fullpage.js that allows both scroll snapping and native scrolling in different sections of your website.

Demo link: https://hasanmothaffar.github.io/custom-snap/

Features

• Lightweight and simple (0 dependencies)
• Works with both fullpage sections (100vh) and variable height sections.
• You can customize the snap scrolling's duration and easing presets

Installation

npm install custom-snap

Example usage

HTML structure

<div id="container">
	<div style="height: 100vh"></div>
	<div style="height: 100vh"></div>
	<div style="height: 200vh"></div>
	<div style="height: 100vh"></div>
	<div style="height: 200vh"></div>
	<div style="height: 100vh"></div>
</div>

JS

import { CustomSnap } from "custom-snap";

const scrollInstance = new CustomSnap({
	container: document.querySelector("#container"),
});

scrollInstance.register();

Options

Instance methods

/**
 * Sets a new easing preset for snap scrolling
 */
setEasing(easing: EasingPreset): void

/**
 * Sets a new duration for snap scrolling
 */
setSnapDuration(duration = 1000): void

/**
 * Returns the scroll's direction
 */
getScrollDirection(): ScrollDirection

/**
 * Hides the browser's scrollbar using CSS
 */
hideScrollbar(): void

/**
 * Shows the browser's scrollbar
 */
showScrollbar(): void

/**
 * Scroll to the container's nth child over a period `duration` of time using index:
 *
 * first child => index = 0.
 * second child => index = 1.
 * Nth child => index = n - 1
 */
scrollToSectionByIndex(index: number, duration: number): void

/**
 * Enable scroll instance.
 */
register(): void

/**
 * Disable scroll instance.
 */
unregister(): void

Types

type EasingPreset = "easeInOutQuad" | "easeInCubic" | "inOutQuintic";
type ScrollDirection = "top-to-bottom" | "bottom-to-top" | "";

type EventCallback = (id?: number, section?: HTMLElement | null) => void;

Inspiration

• https://gist.github.com/james2doyle/5694700
• https://github.com/tarun-dugar/easy-scroll
• https://github.com/alvarotrigo/fullPage.js
• https://github.com/geomolenaar/LeScroll

Credits

• Linkedin Account
• GitHub Account