lenis 1.1.14-dev.3 → 1.1.14

package/dist/lenis.d.ts

@@ -17,7 +17,7 @@ declare class Dimensions {
     private debouncedResize?;
     private wrapperResizeObserver?;
     private contentResizeObserver?;
-    constructor(wrapper: HTMLElement | Window, content: HTMLElement, { autoResize, debounce: debounceValue }?: {
+    constructor(wrapper: HTMLElement | Window | Element, content: HTMLElement | Element, { autoResize, debounce: debounceValue }?: {
         autoResize?: boolean | undefined;
         debounce?: number | undefined;
     });
@@ -129,17 +129,17 @@ type LenisOptions = {
      * The element that will be used as the scroll container
      * @default window
      */
-    wrapper?: Window | HTMLElement;
+    wrapper?: Window | HTMLElement | Element;
     /**
      * The element that contains the content that will be scrolled, usually `wrapper`'s direct child
      * @default document.documentElement
      */
-    content?: HTMLElement;
+    content?: HTMLElement | Element;
     /**
      * The element that will listen to `wheel` and `touch` events
      * @default window
      */
-    eventsTarget?: Window | HTMLElement;
+    eventsTarget?: Window | HTMLElement | Element;
     /**
      * Smooth the scroll initiated by `wheel` events
      * @default true
@@ -212,6 +212,11 @@ type LenisOptions = {
      * Manually modify the events before they get consumed
      */
     virtualScroll?: (data: VirtualScrollData) => boolean;
+    /**
+     * Wether or not to enable overscroll on a nested lenis instance, similar to CSS overscroll-behavior (https://developer.mozilla.org/en-US/docs/Web/CSS/overscroll-behavior)
+     * @default true
+     */
+    overscroll?: boolean;
     /**
      * If `true`, Lenis will not try to detect the size of the content and wrapper
      * @default false
@@ -281,7 +286,7 @@ declare class Lenis {
     constructor({ wrapper, content, eventsTarget, smoothWheel, syncTouch, syncTouchLerp, touchInertiaMultiplier, duration, // in seconds
     easing, lerp, infinite, orientation, // vertical, horizontal
     gestureOrientation, // vertical, horizontal, both
-    touchMultiplier, wheelMultiplier, autoResize, prevent, virtualScroll, __experimental__naiveDimensions, }?: LenisOptions);
+    touchMultiplier, wheelMultiplier, autoResize, prevent, virtualScroll, overscroll, __experimental__naiveDimensions, }?: LenisOptions);
     /**
      * Destroy the lenis instance, remove all event listeners and clean up the class name
      */