@allxsmith/bestax-bulma 5.67.10 → 5.67.11

package/dist/types/components/Modal.d.ts

@@ -49,11 +49,15 @@ export interface ModalProps extends Omit<React.HTMLAttributes<HTMLDivElement>, '
     closeOnEscape?: boolean;
     /**
      * Lock page scroll while the modal is active, padding the page by the room
-     * its scrollbar took so the content stays put. An element fixed to the
-     * window's right edge, such as a `fixed` Navbar, isn't padded, and moves by
-     * the scrollbar's width while the page is locked. Ref-counted and shared
-     * with `Dialog`, `Sidebar` and `Loading`, so whichever overlay closes first
-     * does not unlock the page underneath one that is still open.
+     * its scrollbar took so the content stays put. A `fixed` Navbar, the toast
+     * and notification stacks and an Affix stay put too. The padding doesn't
+     * reach an element of your own fixed to the window's edge, which moves by
+     * the scrollbar's width unless it adds
+     * `var(--bulma-scroll-lock-offset-right, 0px)` to its `right` (the `-left`
+     * one to its `left`), which the lock sets on `<html>` while it's on.
+     * Ref-counted and shared with `Dialog`, `Sidebar` and `Loading`, so
+     * whichever overlay closes first does not unlock the page underneath one
+     * that is still open.
      * @defaultValue true
      */
     lockScroll?: boolean;

package/dist/types/helpers/scrollLock.d.ts

@@ -1,3 +1,15 @@
+/** A side of the window the page's scrollbar can take room on. */
+type ScrollLockSide = 'left' | 'right';
+/**
+ * The room the page's scrollbar gave back on one side while a lock is on,
+ * and `0px` otherwise, as a CSS value. An element fixed to that edge of the
+ * window adds it to its offset there, so it stays where it was as the
+ * scrollbar goes.
+ *
+ * @param side - The edge of the window the element is fixed to.
+ * @returns A `var()` with a `0px` fallback.
+ */
+export declare const scrollLockOffset: (side: ScrollLockSide) => string;
 /**
  * Locks (and ref-counted-ly unlocks) the page's scrolling while `active` is
  * true. Safe to call from multiple components at once: the page is only
@@ -7,3 +19,4 @@
  * @param active - Whether this caller wants the page's scrolling locked.
  */
 export declare function useScrollLock(active: boolean): void;
+export {};

package/dist/types-cjs/components/Modal.d.ts

@@ -49,11 +49,15 @@ export interface ModalProps extends Omit<React.HTMLAttributes<HTMLDivElement>, '
     closeOnEscape?: boolean;
     /**
      * Lock page scroll while the modal is active, padding the page by the room
-     * its scrollbar took so the content stays put. An element fixed to the
-     * window's right edge, such as a `fixed` Navbar, isn't padded, and moves by
-     * the scrollbar's width while the page is locked. Ref-counted and shared
-     * with `Dialog`, `Sidebar` and `Loading`, so whichever overlay closes first
-     * does not unlock the page underneath one that is still open.
+     * its scrollbar took so the content stays put. A `fixed` Navbar, the toast
+     * and notification stacks and an Affix stay put too. The padding doesn't
+     * reach an element of your own fixed to the window's edge, which moves by
+     * the scrollbar's width unless it adds
+     * `var(--bulma-scroll-lock-offset-right, 0px)` to its `right` (the `-left`
+     * one to its `left`), which the lock sets on `<html>` while it's on.
+     * Ref-counted and shared with `Dialog`, `Sidebar` and `Loading`, so
+     * whichever overlay closes first does not unlock the page underneath one
+     * that is still open.
      * @defaultValue true
      */
     lockScroll?: boolean;

package/dist/types-cjs/helpers/scrollLock.d.ts

@@ -1,3 +1,15 @@
+/** A side of the window the page's scrollbar can take room on. */
+type ScrollLockSide = 'left' | 'right';
+/**
+ * The room the page's scrollbar gave back on one side while a lock is on,
+ * and `0px` otherwise, as a CSS value. An element fixed to that edge of the
+ * window adds it to its offset there, so it stays where it was as the
+ * scrollbar goes.
+ *
+ * @param side - The edge of the window the element is fixed to.
+ * @returns A `var()` with a `0px` fallback.
+ */
+export declare const scrollLockOffset: (side: ScrollLockSide) => string;
 /**
  * Locks (and ref-counted-ly unlocks) the page's scrolling while `active` is
  * true. Safe to call from multiple components at once: the page is only
@@ -7,3 +19,4 @@
  * @param active - Whether this caller wants the page's scrolling locked.
  */
 export declare function useScrollLock(active: boolean): void;
+export {};