main repo

node_modules/lenis/dist/lenis-react.d.ts

@@ -0,0 +1,105 @@
+import * as Lenis from 'lenis';
+import Lenis__default, { ScrollCallback, LenisOptions } from 'lenis';
+import * as react from 'react';
+import { ComponentPropsWithoutRef, ReactNode } from 'react';
+
+type LenisContextValue = {
+    lenis: Lenis__default;
+    addCallback: (callback: ScrollCallback, priority: number) => void;
+    removeCallback: (callback: ScrollCallback) => void;
+};
+type LenisProps = ComponentPropsWithoutRef<'div'> & {
+    /**
+     * Setup a global instance of Lenis
+     * if `asChild`, the component will render wrapper and content divs
+     * @default false
+     */
+    root?: boolean | 'asChild';
+    /**
+     * Lenis options
+     */
+    options?: LenisOptions;
+    /**
+     * Auto-setup requestAnimationFrame
+     * @default true
+     * @deprecated use options.autoRaf instead
+     */
+    autoRaf?: boolean;
+    /**
+     * Children
+     */
+    children?: ReactNode;
+};
+type LenisRef = {
+    /**
+     * The wrapper div element
+     *
+     * Will only be defined if `root` is `false` or `root` is `asChild`
+     */
+    wrapper: HTMLDivElement | null;
+    /**
+     * The content div element
+     *
+     * Will only be defined if `root` is `false` or `root` is `asChild`
+     */
+    content: HTMLDivElement | null;
+    /**
+     * The lenis instance
+     */
+    lenis?: Lenis__default;
+};
+
+declare const LenisContext: react.Context<LenisContextValue | null>;
+/**
+ * React component to setup a Lenis instance
+ */
+declare const ReactLenis: react.ForwardRefExoticComponent<Omit<react.DetailedHTMLProps<react.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    root?: boolean | "asChild";
+    options?: Lenis.LenisOptions;
+    autoRaf?: boolean;
+    children?: react.ReactNode;
+} & react.RefAttributes<LenisRef>>;
+
+/**
+ * Hook to access the Lenis instance and its methods
+ *
+ * @example <caption>Scroll callback</caption>
+ *          useLenis((lenis) => {
+ *            if (lenis.isScrolling) {
+ *              console.log('Scrolling...')
+ *            }
+ *
+ *            if (lenis.progress === 1) {
+ *              console.log('At the end!')
+ *            }
+ *          })
+ *
+ * @example <caption>Scroll callback with dependencies</caption>
+ *          useLenis((lenis) => {
+ *            if (lenis.isScrolling) {
+ *              console.log('Scrolling...', someDependency)
+ *            }
+ *          }, [someDependency])
+ * @example <caption>Scroll callback with priority</caption>
+ *          useLenis((lenis) => {
+ *            if (lenis.isScrolling) {
+ *              console.log('Scrolling...')
+ *            }
+ *          }, [], 1)
+ * @example <caption>Instance access</caption>
+ *          const lenis = useLenis()
+ *
+ *          handleClick() {
+ *            lenis.scrollTo(100, {
+ *              lerp: 0.1,
+ *              duration: 1,
+ *              easing: (t) => t,
+ *              onComplete: () => {
+ *                console.log('Complete!')
+ *              }
+ *            })
+ *          }
+ */
+declare function useLenis(callback?: ScrollCallback, deps?: any[], priority?: number): Lenis.default | undefined;
+
+export { ReactLenis as Lenis, LenisContext, type LenisContextValue, type LenisProps, type LenisRef, ReactLenis, ReactLenis as default, useLenis };