@nulogy/components 13.1.3 → 13.1.5

package/dist/src/utils/useScrollLock.d.ts

@@ -0,0 +1,55 @@
+import { useLayoutEffect } from "react";
+export declare const useIsomorphicLayoutEffect: typeof useLayoutEffect;
+/** Hook options. */
+type UseScrollLockOptions = {
+    /**
+     * Whether to lock the scroll initially.
+     * @default true
+     */
+    autoLock?: boolean;
+    /**
+     * The target element to lock the scroll (default is the body element).
+     * @default document.body
+     */
+    lockTarget?: HTMLElement | string;
+    /**
+     * Whether to prevent width reflow when locking the scroll.
+     * @default true
+     */
+    widthReflow?: boolean;
+};
+/** Hook return type. */
+type UseScrollLockReturn = {
+    /** Whether the scroll is locked. */
+    isLocked: boolean;
+    /** Lock the scroll. */
+    lock: () => void;
+    /** Unlock the scroll. */
+    unlock: () => void;
+};
+/**
+ * A custom hook that locks and unlocks scroll.
+ * @param {UseScrollLockOptions} [options] - Options to configure the hook, by default it will lock the scroll automatically.
+ * @returns {UseScrollLockReturn} - An object containing the lock and unlock functions.
+ * @public
+ * @see [Documentation](https://usehooks-ts.com/react-hook/use-scroll-lock)
+ * @example
+ * ```tsx
+ * // Lock the scroll when the modal is mounted, and unlock it when it's unmounted
+ * useScrollLock()
+ * ```
+ * @example
+ * ```tsx
+ * // Manually lock and unlock the scroll
+ * const { lock, unlock } = useScrollLock({ autoLock: false })
+ *
+ * return (
+ *  <div>
+ *   <button onClick={lock}>Lock</button>
+ *   <button onClick={unlock}>Unlock</button>
+ *  </div>
+ * )
+ * ```
+ */
+export declare function useScrollLock(options?: UseScrollLockOptions): UseScrollLockReturn;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nulogy/components",
-  "version": "13.1.3",
+  "version": "13.1.5",
   "description": "Component library for the Nulogy Design System - http://nulogy.design",
   "private": false,
   "publishConfig": {

package/dist/src/utils/PreventBodyElementScrolling.d.ts

@@ -1,8 +0,0 @@
-export default class PreventBodyElementScrolling extends React.Component<any, any, any> {
-    constructor(props: any);
-    constructor(props: any, context: any);
-    componentDidMount(): void;
-    componentWillUnmount(): void;
-    render(): React.JSX.Element;
-}
-import React from "react";