Git Product home page Git Product logo

lock-scroll's Introduction

Lock scroll

none dependencies npm npm bundle size license

A set of methods to lock scrolling within an element or an entire page on mobile devices, tablets and desktops.

Live Demo: https://bukacekd.github.io/lock-scroll

Features

  • easy to use
  • compatible with Android, IOS, MacOS and Windows
  • compatible with mobile devices, tablets and desktops
  • preserves the space corresponding to the width of the scrollbar

Installation

Npm

npm install @js4y/lock-scroll

CDN

<script src="https://unpkg.com/@js4y/lock-scroll/dist/index.js"></script>

Usage

Npm

import {lockScroll, unlockScroll} from '@js4y/lock-scroll';

// lock scrolling
lockScroll();
// unlock scrolling
unlockScroll();

CDN

<script src="https://unpkg.com/@js4y/lock-scroll/dist/index.js"></script>

<script>
    // lock scrolling
    js4y.scrolling.lockScroll();
    // unlock scrolling
    js4y.scrolling.unlockScroll();
<script>

Methods

lockScroll(target?: HTMLElement): void

Lock scrolling within an element or an entire page.

// lock page scrolling
lockScroll();

// lock scrolling for specific element
lockScroll(document.getElementById('scrollable-element'));

unlockScroll(target?: HTMLElement): void

Unlock scrolling within an element or an entire page.

// unlock page scrolling
unlockScroll();

// unlock scrolling for specific element
unlockScroll(document.getElementById('scrollable-element'));

Browser support

alt chrome alt edge alt firefox alt opera alt safari
Chrome 69+ Edge 79+ Firefox 41+ Opera 56+ Safari 12.1+

License

The project is licensed under MIT license.

Related

  • CountUp - A tiny dependency-free JavaSript library for animating numeric values.
  • Dialog - A tiny dependency-free JavaSript ES6 library built on a dialog element with minimal configuration.
  • Loader - A tiny dependency-free javascript loading spinner component with minimal configuration.

lock-scroll's People

Contributors

bukacekd avatar sainf avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.