@ramstack/pagelock 1.0.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2024 Rameel (https://github.com/rameel)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,101 @@
+# Pagelock
+
+The `@ramstack/pagelock` represents a simple utility for managing page scroll locking.
+The library weighs around 750 bytes, and has no external dependencies.
+
+## Installation
+
+### Via NPM
+```sh
+npm install --save @ramstack/pagelock
+```
+
+### Via CDN
+```html
+<script src="https://cdn.jsdelivr.net/npm/@ramstack/pagelock@1.0.0/dist/pagelock.min.js"></script>
+```
+
+## Usage examples
+
+#### Vanilla JS
+
+```vue
+<button onclick="show()">Show Modal</button>
+
+<script>
+    let release;
+
+    async function show() {
+        // Lock the page scroll before show modal dialog
+        release = pagelock();
+
+        await showModal();
+
+        // Unlock the page scroll
+        release();
+    }
+</script>
+```
+
+#### Vue
+
+```vue
+<script setup>
+
+import { ref, watch } from "vue";
+import { pagelock } from "@ramstack/pagelock";
+
+let show = ref(false);
+let release;
+
+watch(show, value => {
+  if (value) {
+    // Lock page scroll
+    release = pagelock();
+  }
+  else {
+    // Unlock page scroll
+    release?.();
+  }
+});
+
+</script>
+
+<template>
+  <label>
+    <input v-model="show" type="checkbox" />
+    Lock page
+  </label>
+  <div style="height: 1000px; width: 100%">
+  </div>
+</template>
+```
+
+## Functions
+
+```js
+/**
+ * Locks the page scroll. Subsequent calls to the function add to the queue of lock holders.
+ * Page scroll remains locked until the queue is empty. To forcibly release the page scroll,
+ * bypassing the queue, call the {@link pageunlock} function with `force = true`.
+ *
+ * @returns {() => void} - A function to unlock the page scroll.
+ * Subsequent calls to the release function are safe and only release its own captured lock,
+ * without affecting the other locks in the queue.
+ */
+function pagelock(): () => void;
+```
+
+```js
+/**
+ * Unlocks the page scroll. In contrast to the release function returned by {@link pagelock},
+ * the {@link pageunlock} function sequentially clears the queue of lock holders.
+ *
+ * @param {boolean} [force] - If `true`, forcibly unlocks the page scroll, bypassing the queue;
+ * otherwise, only the last lock in the queue will be released. The default is `false`.
+ */
+function pageunlock(force?: boolean): void;
+```
+
+## License
+This package is released under the **MIT License**.

package/dist/pagelock.esm.js

@@ -0,0 +1,47 @@
+let locks = [];
+let sequence = 0;
+let width;
+let props;
+function pagelock() {
+    if (!props) {
+        const { offsetHeight, clientHeight } = document.documentElement;
+        const style = document.body.style;
+        props = {
+            overflow: style.overflow,
+            paddingRight: style.paddingRight
+        };
+        if (offsetHeight > clientHeight) {
+            style.paddingRight = scrollbarWidth();
+        }
+        style.overflow = "hidden";
+    }
+    const seq = ++sequence;
+    locks.push(seq);
+    return () => {
+        locks = locks.filter(v => v !== seq);
+        restore();
+    };
+}
+function pageunlock(force) {
+    force ? locks = [] : locks.pop();
+    restore();
+}
+function restore() {
+    if (props && !locks.length) {
+        Object.assign(document.body.style, props);
+        props = null;
+    }
+}
+function scrollbarWidth() {
+    if (!width) {
+        const outer = document.createElement("div");
+        outer.innerHTML = "<div style='width:80px;height:80px;position:absolute;left:-90px;top:-90px;overflow:auto'><div style='height:99px'></div></div>";
+        const inner = outer.firstChild;
+        document.body.appendChild(outer);
+        width = (inner.offsetWidth - inner.clientWidth) + "px";
+        document.body.removeChild(outer);
+    }
+    return width;
+}
+
+export { pagelock, pageunlock };

package/dist/pagelock.esm.min.js

@@ -0,0 +1 @@
+let t,e,o=[],i=0;function n(){if(!e){const{offsetHeight:o,clientHeight:i}=document.documentElement,n=document.body.style;e={overflow:n.overflow,paddingRight:n.paddingRight},o>i&&(n.paddingRight=function(){if(!t){const e=document.createElement("div");e.innerHTML="<div style='width:80px;height:80px;position:absolute;left:-90px;top:-90px;overflow:auto'><div style='height:99px'></div></div>";const o=e.firstChild;document.body.appendChild(e),t=o.offsetWidth-o.clientWidth+"px",document.body.removeChild(e)}return t}()),n.overflow="hidden"}const n=++i;return o.push(n),()=>{o=o.filter((t=>t!==n)),l()}}function d(t){t?o=[]:o.pop(),l()}function l(){e&&!o.length&&(Object.assign(document.body.style,e),e=null)}export{n as pagelock,d as pageunlock};

package/dist/pagelock.js

@@ -0,0 +1,53 @@
+(function (exports) {
+    'use strict';
+
+    let locks = [];
+    let sequence = 0;
+    let width;
+    let props;
+    function pagelock() {
+        if (!props) {
+            const { offsetHeight, clientHeight } = document.documentElement;
+            const style = document.body.style;
+            props = {
+                overflow: style.overflow,
+                paddingRight: style.paddingRight
+            };
+            if (offsetHeight > clientHeight) {
+                style.paddingRight = scrollbarWidth();
+            }
+            style.overflow = "hidden";
+        }
+        const seq = ++sequence;
+        locks.push(seq);
+        return () => {
+            locks = locks.filter(v => v !== seq);
+            restore();
+        };
+    }
+    function pageunlock(force) {
+        force ? locks = [] : locks.pop();
+        restore();
+    }
+    function restore() {
+        if (props && !locks.length) {
+            Object.assign(document.body.style, props);
+            props = null;
+        }
+    }
+    function scrollbarWidth() {
+        if (!width) {
+            const outer = document.createElement("div");
+            outer.innerHTML = "<div style='width:80px;height:80px;position:absolute;left:-90px;top:-90px;overflow:auto'><div style='height:99px'></div></div>";
+            const inner = outer.firstChild;
+            document.body.appendChild(outer);
+            width = (inner.offsetWidth - inner.clientWidth) + "px";
+            document.body.removeChild(outer);
+        }
+        return width;
+    }
+
+    exports.pagelock = pagelock;
+    exports.pageunlock = pageunlock;
+
+})(this.window = this.window || {});

package/dist/pagelock.min.js

@@ -0,0 +1 @@
+!function(t){"use strict";let e,i,n=[],o=0;function d(){i&&!n.length&&(Object.assign(document.body.style,i),i=null)}t.pagelock=function(){if(!i){const{offsetHeight:t,clientHeight:n}=document.documentElement,o=document.body.style;i={overflow:o.overflow,paddingRight:o.paddingRight},t>n&&(o.paddingRight=function(){if(!e){const t=document.createElement("div");t.innerHTML="<div style='width:80px;height:80px;position:absolute;left:-90px;top:-90px;overflow:auto'><div style='height:99px'></div></div>";const i=t.firstChild;document.body.appendChild(t),e=i.offsetWidth-i.clientWidth+"px",document.body.removeChild(t)}return e}()),o.overflow="hidden"}const t=++o;return n.push(t),()=>{n=n.filter((e=>e!==t)),d()}},t.pageunlock=function(t){t?n=[]:n.pop(),d()}}(this.window=this.window||{});

package/dist/types/pagelock.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Locks the page scroll. Subsequent calls to the function add to the queue of lock holders.
+ * Page scroll remains locked until the queue is empty. To forcibly release the page scroll,
+ * bypassing the queue, call the {@link pageunlock} function with `force = true`.
+ *
+ * @returns {() => void} - A function to unlock the page scroll.
+ * Subsequent calls to the release function are safe and only release its own captured lock,
+ * without affecting the other locks in the queue.
+ */
+export declare function pagelock(): () => void;
+/**
+ * Unlocks the page scroll. In contrast to the release function returned by {@link pagelock},
+ * the {@link pageunlock} function sequentially clears the queue of lock holders.
+ *
+ * @param {boolean} [force] - If `true`, forcibly unlocks the page scroll, bypassing the queue;
+ * otherwise, only the last lock in the queue will be released. The default is `false`.
+ */
+export declare function pageunlock(force?: boolean): void;

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@ramstack/pagelock",
+  "version": "1.0.0",
+  "description": "A simple utility for managing page scroll locking. No external dependencies.",
+  "type": "module",
+  "main": "dist/pagelock.esm.js",
+  "module": "dist/pagelock.esm.js",
+  "types": "dist/types/pagelock.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "author": "rameel <rameel-b@hotmail.com>",
+  "license": "MIT",
+  "scripts": {
+    "build": "cross-env NODE_ENV=production rollup -c",
+    "prebuild": "npm run clean",
+    "clean": "rimraf dist"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rameel/pagelock.git"
+  },
+  "keywords": [
+    "pagelock",
+    "page-locking",
+    "scroll-locking",
+    "scroll-lock"
+  ],
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-replace": "^5.0.5",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "cross-env": "^7.0.3",
+    "rimraf": "^5.0.5",
+    "rollup": "^4.9.6",
+    "rollup-plugin-bundle-size": "^1.0.3",
+    "strip-comments": "^2.0.1",
+    "terser": "^5.27.0",
+    "tslib": "^2.6.2",
+    "typescript": "^5.3.3"
+  }
+}