lenis 1.1.8 → 1.1.10-dev.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,30 +1,114 @@
1
+ /// <reference types="react" />
1
2
  import * as react from 'react';
2
- import { ForwardRefExoticComponent, PropsWithoutRef, RefAttributes, ReactNode } from 'react';
3
- import Lenis, { LenisOptions } from 'lenis';
3
+ import { ReactNode, ComponentPropsWithoutRef } from 'react';
4
+ import Lenis, { ScrollCallback, LenisOptions } from 'lenis';
4
5
 
5
- type LenisEventHandler = (lenis: Lenis) => void;
6
- interface LenisContextValue {
6
+ type LenisContextValue = {
7
7
  lenis: Lenis;
8
- addCallback: (handler: LenisEventHandler, priority: number) => void;
9
- removeCallback: (handler: LenisEventHandler) => void;
10
- }
11
- declare const LenisContext: react.Context<LenisContextValue | null>;
12
- declare function useLenis(callback?: (lenis: Lenis) => void, deps?: Array<any>, priority?: number): Lenis | undefined;
13
- type ForwardRefComponent<P, T> = ForwardRefExoticComponent<PropsWithoutRef<P> & RefAttributes<T>>;
14
- type Props = {
8
+ addCallback: (callback: ScrollCallback, priority: number) => void;
9
+ removeCallback: (callback: ScrollCallback) => void;
10
+ };
11
+ type LenisProps = {
12
+ /**
13
+ * Setup a global instance of Lenis
14
+ * @default false
15
+ */
15
16
  root?: boolean;
17
+ /**
18
+ * Lenis options
19
+ */
16
20
  options?: LenisOptions;
21
+ /**
22
+ * Auto-setup requestAnimationFrame
23
+ * @default true
24
+ */
17
25
  autoRaf?: boolean;
26
+ /**
27
+ * RequestAnimationFrame priority
28
+ * @default 0
29
+ */
18
30
  rafPriority?: number;
19
- className?: string;
31
+ /**
32
+ * Children
33
+ */
20
34
  children?: ReactNode;
21
- props?: any;
35
+ /**
36
+ * Class name for the wrapper div
37
+ *
38
+ * When `root` is `false`, this will be applied to the wrapper div
39
+ */
40
+ className?: string;
41
+ /**
42
+ * Additional props for the wrapper div
43
+ *
44
+ * When `root` is `false`, this will be applied to the wrapper div
45
+ */
46
+ props?: Omit<ComponentPropsWithoutRef<'div'>, 'children' | 'className'>;
22
47
  };
23
48
  type LenisRef = {
24
- wrapper?: HTMLElement;
25
- content?: HTMLElement;
49
+ /**
50
+ * The wrapper div element
51
+ *
52
+ * Will only be defined if `root` is `false`
53
+ */
54
+ wrapper: HTMLDivElement | null;
55
+ /**
56
+ * The content div element
57
+ *
58
+ * Will only be defined if `root` is `false`
59
+ */
60
+ content: HTMLDivElement | null;
61
+ /**
62
+ * The lenis instance
63
+ */
26
64
  lenis?: Lenis;
27
65
  };
28
- declare const ReactLenis: ForwardRefComponent<Props, LenisRef>;
29
66
 
30
- export { ReactLenis as Lenis, LenisContext, ReactLenis, ReactLenis as default, useLenis };
67
+ declare const LenisContext: react.Context<LenisContextValue | null>;
68
+ /**
69
+ * Hook to access the Lenis instance and its methods
70
+ *
71
+ * @example <caption>Scroll callback</caption>
72
+ * useLenis((lenis) => {
73
+ * if (lenis.isScrolling) {
74
+ * console.log('Scrolling...')
75
+ * }
76
+ *
77
+ * if (lenis.progress === 1) {
78
+ * console.log('At the end!')
79
+ * }
80
+ * })
81
+ *
82
+ * @example <caption>Scroll callback with dependencies</caption>
83
+ * useLenis((lenis) => {
84
+ * if (lenis.isScrolling) {
85
+ * console.log('Scrolling...', someDependency)
86
+ * }
87
+ * }, [someDependency])
88
+ * @example <caption>Scroll callback with priority</caption>
89
+ * useLenis((lenis) => {
90
+ * if (lenis.isScrolling) {
91
+ * console.log('Scrolling...')
92
+ * }
93
+ * }, [], 1)
94
+ * @example <caption>Instance access</caption>
95
+ * const lenis = useLenis()
96
+ *
97
+ * handleClick() {
98
+ * lenis.scrollTo(100, {
99
+ * lerp: 0.1,
100
+ * duration: 1,
101
+ * easing: (t) => t,
102
+ * onComplete: () => {
103
+ * console.log('Complete!')
104
+ * }
105
+ * })
106
+ * }
107
+ */
108
+ declare function useLenis(callback?: ScrollCallback, deps?: any[], priority?: number): Lenis | undefined;
109
+ /**
110
+ * React component to setup a Lenis instance
111
+ */
112
+ declare const ReactLenis: react.ForwardRefExoticComponent<LenisProps & react.RefAttributes<LenisRef>>;
113
+
114
+ export { ReactLenis as Lenis, LenisContext, type LenisContextValue, type LenisProps, type LenisRef, ReactLenis, ReactLenis as default, useLenis };
@@ -1,2 +1,2 @@
1
- import{jsx as r}from"react/jsx-runtime";import e from"@darkroom.engineering/tempus";import t from"lenis";import{useState as n,useEffect as s,createContext as i,forwardRef as o,useRef as l,useCallback as c,useImperativeHandle as a,useContext as u}from"react";"function"==typeof SuppressedError&&SuppressedError;const f=i(null),p=new class Store{constructor(r){this.listeners=[],this.state=r}set(r){this.state=r;for(let r of this.listeners)r(this.state)}subscribe(r){return this.listeners=[...this.listeners,r],()=>{this.listeners=this.listeners.filter((e=>e!==r))}}get(){return this.state}}({});function useCurrentLenis(){const r=u(f),e=function useStore(r){const[e,t]=n(r.get());return s((()=>r.subscribe((r=>t(r)))),[r]),e}(p);return null!=r?r:e}function useLenis(r,e=[],t=0){const{lenis:n,addCallback:i,removeCallback:o}=useCurrentLenis();return s((()=>{if(r&&i&&o&&n)return i(r,t),r(n),()=>{o(r)}}),[n,i,o,t,...e]),n}const d=o(((i,o)=>{var{children:u,root:d=!1,options:b={},autoRaf:m=!0,rafPriority:h=0,className:y}=i,v=function __rest(r,e){var t={};for(var n in r)Object.prototype.hasOwnProperty.call(r,n)&&e.indexOf(n)<0&&(t[n]=r[n]);if(null!=r&&"function"==typeof Object.getOwnPropertySymbols){var s=0;for(n=Object.getOwnPropertySymbols(r);s<n.length;s++)e.indexOf(n[s])<0&&Object.prototype.propertyIsEnumerable.call(r,n[s])&&(t[n[s]]=r[n[s]])}return t}(i,["children","root","options","autoRaf","rafPriority","className"]);const O=l(null),g=l(null),[k,j]=n(void 0),C=l([]),w=c(((r,e)=>{C.current.push({callback:r,priority:e}),C.current.sort(((r,e)=>r.priority-e.priority))}),[]),S=c((r=>{C.current=C.current.filter((e=>e.callback!==r))}),[]);a(o,(()=>({wrapper:O.current,content:g.current,lenis:k})),[k]),s((()=>{const r=new t(Object.assign(Object.assign({},b),!d&&{wrapper:O.current,content:g.current}));return j(r),()=>{r.destroy(),j(void 0)}}),[d,JSON.stringify(b)]),s((()=>{if(k&&m)return e.add((r=>{null==k||k.raf(r)}),h)}),[k,m,h]),s((()=>{if(d&&k)return p.set({lenis:k,addCallback:w,removeCallback:S}),()=>p.set({})}),[d,k,w,S]);const P=c(((...r)=>{for(let e=0;e<C.current.length;e++)C.current[e].callback(...r)}),[]);return s((()=>(null==k||k.on("scroll",P),()=>{null==k||k.off("scroll",P)})),[k,P]),r(f.Provider,{value:{lenis:k,addCallback:w,removeCallback:S},children:d?u:r("div",Object.assign({ref:O,className:y},v,{children:r("div",{ref:g,children:u})}))})}));export{d as Lenis,f as LenisContext,d as ReactLenis,d as default,useLenis};
1
+ import{jsx as r}from"react/jsx-runtime";import e from"@darkroom.engineering/tempus";import t from"lenis";import{useState as s,useEffect as n,createContext as i,forwardRef as l,useRef as o,useImperativeHandle as c,useCallback as a,useContext as u}from"react";const f=i(null),d=new class Store{constructor(r){this.state=r,this.listeners=[]}set(r){this.state=r;for(let r of this.listeners)r(this.state)}subscribe(r){return this.listeners=[...this.listeners,r],()=>{this.listeners=this.listeners.filter((e=>e!==r))}}get(){return this.state}}(null),p={};function useLenis(r,e=[],t=0){var i;const l=u(f),o=function useStore(r){const[e,t]=s(r.get());return n((()=>r.subscribe((r=>t(r)))),[r]),e}(d),c=null!==(i=null!=l?l:o)&&void 0!==i?i:p,{lenis:a,addCallback:b,removeCallback:h}=c;return n((()=>{if(r&&b&&h&&a)return b(r,t),r(a),()=>{h(r)}}),[a,b,h,t,...e]),a}const b=l((({children:i,root:l=!1,options:u={},autoRaf:p=!0,rafPriority:b=0,className:h,props:m},v)=>{const k=o(null),g=o(null),[y,C]=s(void 0);c(v,(()=>({wrapper:k.current,content:g.current,lenis:y})),[y]),n((()=>{const r=new t(Object.assign(Object.assign({},u),!l&&{wrapper:k.current,content:g.current}));return C(r),()=>{r.destroy(),C(void 0)}}),[l,JSON.stringify(u)]),n((()=>{if(y&&p)return e.add((r=>y.raf(r)),b)}),[y,p,b]);const j=o([]),w=a(((r,e)=>{j.current.push({callback:r,priority:e}),j.current.sort(((r,e)=>r.priority-e.priority))}),[]),O=a((r=>{j.current=j.current.filter((e=>e.callback!==r))}),[]);return n((()=>{if(l&&y)return d.set({lenis:y,addCallback:w,removeCallback:O}),()=>d.set(null)}),[l,y,w,O]),n((()=>{if(!y)return;const onScroll=r=>{for(let e=0;e<j.current.length;e++)j.current[e].callback(r)};return y.on("scroll",onScroll),()=>{y.off("scroll",onScroll)}}),[y]),r(f.Provider,{value:{lenis:y,addCallback:w,removeCallback:O},children:l?i:r("div",Object.assign({ref:k,className:h},m,{children:r("div",{ref:g,children:i})}))})}));export{b as Lenis,f as LenisContext,b as ReactLenis,b as default,useLenis};
2
2
  //# sourceMappingURL=lenis-react.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"lenis-react.mjs","sources":["../../../node_modules/.pnpm/@rollup+plugin-typescript@11.1.6_rollup@4.14.3_tslib@2.6.2_typescript@5.4.5/node_modules/tslib/tslib.es6.js","../../src/index.tsx","../../src/store.ts"],"sourcesContent":["/******************************************************************************\r\nCopyright (c) Microsoft Corporation.\r\n\r\nPermission to use, copy, modify, and/or distribute this software for any\r\npurpose with or without fee is hereby granted.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\r\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\r\nAND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\r\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\r\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\r\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\r\nPERFORMANCE OF THIS SOFTWARE.\r\n***************************************************************************** */\r\n/* global Reflect, Promise, SuppressedError, Symbol */\r\n\r\nvar extendStatics = function(d, b) {\r\n extendStatics = Object.setPrototypeOf ||\r\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\r\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\r\n return extendStatics(d, b);\r\n};\r\n\r\nexport function __extends(d, b) {\r\n if (typeof b !== \"function\" && b !== null)\r\n throw new TypeError(\"Class extends value \" + String(b) + \" is not a constructor or null\");\r\n extendStatics(d, b);\r\n function __() { this.constructor = d; }\r\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\r\n}\r\n\r\nexport var __assign = function() {\r\n __assign = Object.assign || function __assign(t) {\r\n for (var s, i = 1, n = arguments.length; i < n; i++) {\r\n s = arguments[i];\r\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];\r\n }\r\n return t;\r\n }\r\n return __assign.apply(this, arguments);\r\n}\r\n\r\nexport function __rest(s, e) {\r\n var t = {};\r\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)\r\n t[p] = s[p];\r\n if (s != null && typeof Object.getOwnPropertySymbols === \"function\")\r\n for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {\r\n if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))\r\n t[p[i]] = s[p[i]];\r\n }\r\n return t;\r\n}\r\n\r\nexport function __decorate(decorators, target, key, desc) {\r\n var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;\r\n if (typeof Reflect === \"object\" && typeof Reflect.decorate === \"function\") r = Reflect.decorate(decorators, target, key, desc);\r\n else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;\r\n return c > 3 && r && Object.defineProperty(target, key, r), r;\r\n}\r\n\r\nexport function __param(paramIndex, decorator) {\r\n return function (target, key) { decorator(target, key, paramIndex); }\r\n}\r\n\r\nexport function __esDecorate(ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {\r\n function accept(f) { if (f !== void 0 && typeof f !== \"function\") throw new TypeError(\"Function expected\"); return f; }\r\n var kind = contextIn.kind, key = kind === \"getter\" ? \"get\" : kind === \"setter\" ? \"set\" : \"value\";\r\n var target = !descriptorIn && ctor ? contextIn[\"static\"] ? ctor : ctor.prototype : null;\r\n var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});\r\n var _, done = false;\r\n for (var i = decorators.length - 1; i >= 0; i--) {\r\n var context = {};\r\n for (var p in contextIn) context[p] = p === \"access\" ? {} : contextIn[p];\r\n for (var p in contextIn.access) context.access[p] = contextIn.access[p];\r\n context.addInitializer = function (f) { if (done) throw new TypeError(\"Cannot add initializers after decoration has completed\"); extraInitializers.push(accept(f || null)); };\r\n var result = (0, decorators[i])(kind === \"accessor\" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);\r\n if (kind === \"accessor\") {\r\n if (result === void 0) continue;\r\n if (result === null || typeof result !== \"object\") throw new TypeError(\"Object expected\");\r\n if (_ = accept(result.get)) descriptor.get = _;\r\n if (_ = accept(result.set)) descriptor.set = _;\r\n if (_ = accept(result.init)) initializers.unshift(_);\r\n }\r\n else if (_ = accept(result)) {\r\n if (kind === \"field\") initializers.unshift(_);\r\n else descriptor[key] = _;\r\n }\r\n }\r\n if (target) Object.defineProperty(target, contextIn.name, descriptor);\r\n done = true;\r\n};\r\n\r\nexport function __runInitializers(thisArg, initializers, value) {\r\n var useValue = arguments.length > 2;\r\n for (var i = 0; i < initializers.length; i++) {\r\n value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);\r\n }\r\n return useValue ? value : void 0;\r\n};\r\n\r\nexport function __propKey(x) {\r\n return typeof x === \"symbol\" ? x : \"\".concat(x);\r\n};\r\n\r\nexport function __setFunctionName(f, name, prefix) {\r\n if (typeof name === \"symbol\") name = name.description ? \"[\".concat(name.description, \"]\") : \"\";\r\n return Object.defineProperty(f, \"name\", { configurable: true, value: prefix ? \"\".concat(prefix, \" \", name) : name });\r\n};\r\n\r\nexport function __metadata(metadataKey, metadataValue) {\r\n if (typeof Reflect === \"object\" && typeof Reflect.metadata === \"function\") return Reflect.metadata(metadataKey, metadataValue);\r\n}\r\n\r\nexport function __awaiter(thisArg, _arguments, P, generator) {\r\n function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }\r\n return new (P || (P = Promise))(function (resolve, reject) {\r\n function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }\r\n function rejected(value) { try { step(generator[\"throw\"](value)); } catch (e) { reject(e); } }\r\n function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }\r\n step((generator = generator.apply(thisArg, _arguments || [])).next());\r\n });\r\n}\r\n\r\nexport function __generator(thisArg, body) {\r\n var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;\r\n return g = { next: verb(0), \"throw\": verb(1), \"return\": verb(2) }, typeof Symbol === \"function\" && (g[Symbol.iterator] = function() { return this; }), g;\r\n function verb(n) { return function (v) { return step([n, v]); }; }\r\n function step(op) {\r\n if (f) throw new TypeError(\"Generator is already executing.\");\r\n while (g && (g = 0, op[0] && (_ = 0)), _) try {\r\n if (f = 1, y && (t = op[0] & 2 ? y[\"return\"] : op[0] ? y[\"throw\"] || ((t = y[\"return\"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;\r\n if (y = 0, t) op = [op[0] & 2, t.value];\r\n switch (op[0]) {\r\n case 0: case 1: t = op; break;\r\n case 4: _.label++; return { value: op[1], done: false };\r\n case 5: _.label++; y = op[1]; op = [0]; continue;\r\n case 7: op = _.ops.pop(); _.trys.pop(); continue;\r\n default:\r\n if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }\r\n if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }\r\n if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }\r\n if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }\r\n if (t[2]) _.ops.pop();\r\n _.trys.pop(); continue;\r\n }\r\n op = body.call(thisArg, _);\r\n } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }\r\n if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };\r\n }\r\n}\r\n\r\nexport var __createBinding = Object.create ? (function(o, m, k, k2) {\r\n if (k2 === undefined) k2 = k;\r\n var desc = Object.getOwnPropertyDescriptor(m, k);\r\n if (!desc || (\"get\" in desc ? !m.__esModule : desc.writable || desc.configurable)) {\r\n desc = { enumerable: true, get: function() { return m[k]; } };\r\n }\r\n Object.defineProperty(o, k2, desc);\r\n}) : (function(o, m, k, k2) {\r\n if (k2 === undefined) k2 = k;\r\n o[k2] = m[k];\r\n});\r\n\r\nexport function __exportStar(m, o) {\r\n for (var p in m) if (p !== \"default\" && !Object.prototype.hasOwnProperty.call(o, p)) __createBinding(o, m, p);\r\n}\r\n\r\nexport function __values(o) {\r\n var s = typeof Symbol === \"function\" && Symbol.iterator, m = s && o[s], i = 0;\r\n if (m) return m.call(o);\r\n if (o && typeof o.length === \"number\") return {\r\n next: function () {\r\n if (o && i >= o.length) o = void 0;\r\n return { value: o && o[i++], done: !o };\r\n }\r\n };\r\n throw new TypeError(s ? \"Object is not iterable.\" : \"Symbol.iterator is not defined.\");\r\n}\r\n\r\nexport function __read(o, n) {\r\n var m = typeof Symbol === \"function\" && o[Symbol.iterator];\r\n if (!m) return o;\r\n var i = m.call(o), r, ar = [], e;\r\n try {\r\n while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);\r\n }\r\n catch (error) { e = { error: error }; }\r\n finally {\r\n try {\r\n if (r && !r.done && (m = i[\"return\"])) m.call(i);\r\n }\r\n finally { if (e) throw e.error; }\r\n }\r\n return ar;\r\n}\r\n\r\n/** @deprecated */\r\nexport function __spread() {\r\n for (var ar = [], i = 0; i < arguments.length; i++)\r\n ar = ar.concat(__read(arguments[i]));\r\n return ar;\r\n}\r\n\r\n/** @deprecated */\r\nexport function __spreadArrays() {\r\n for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;\r\n for (var r = Array(s), k = 0, i = 0; i < il; i++)\r\n for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)\r\n r[k] = a[j];\r\n return r;\r\n}\r\n\r\nexport function __spreadArray(to, from, pack) {\r\n if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {\r\n if (ar || !(i in from)) {\r\n if (!ar) ar = Array.prototype.slice.call(from, 0, i);\r\n ar[i] = from[i];\r\n }\r\n }\r\n return to.concat(ar || Array.prototype.slice.call(from));\r\n}\r\n\r\nexport function __await(v) {\r\n return this instanceof __await ? (this.v = v, this) : new __await(v);\r\n}\r\n\r\nexport function __asyncGenerator(thisArg, _arguments, generator) {\r\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\r\n var g = generator.apply(thisArg, _arguments || []), i, q = [];\r\n return i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i;\r\n function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }\r\n function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }\r\n function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }\r\n function fulfill(value) { resume(\"next\", value); }\r\n function reject(value) { resume(\"throw\", value); }\r\n function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }\r\n}\r\n\r\nexport function __asyncDelegator(o) {\r\n var i, p;\r\n return i = {}, verb(\"next\"), verb(\"throw\", function (e) { throw e; }), verb(\"return\"), i[Symbol.iterator] = function () { return this; }, i;\r\n function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: false } : f ? f(v) : v; } : f; }\r\n}\r\n\r\nexport function __asyncValues(o) {\r\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\r\n var m = o[Symbol.asyncIterator], i;\r\n return m ? m.call(o) : (o = typeof __values === \"function\" ? __values(o) : o[Symbol.iterator](), i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i);\r\n function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }\r\n function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }\r\n}\r\n\r\nexport function __makeTemplateObject(cooked, raw) {\r\n if (Object.defineProperty) { Object.defineProperty(cooked, \"raw\", { value: raw }); } else { cooked.raw = raw; }\r\n return cooked;\r\n};\r\n\r\nvar __setModuleDefault = Object.create ? (function(o, v) {\r\n Object.defineProperty(o, \"default\", { enumerable: true, value: v });\r\n}) : function(o, v) {\r\n o[\"default\"] = v;\r\n};\r\n\r\nexport function __importStar(mod) {\r\n if (mod && mod.__esModule) return mod;\r\n var result = {};\r\n if (mod != null) for (var k in mod) if (k !== \"default\" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);\r\n __setModuleDefault(result, mod);\r\n return result;\r\n}\r\n\r\nexport function __importDefault(mod) {\r\n return (mod && mod.__esModule) ? mod : { default: mod };\r\n}\r\n\r\nexport function __classPrivateFieldGet(receiver, state, kind, f) {\r\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a getter\");\r\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot read private member from an object whose class did not declare it\");\r\n return kind === \"m\" ? f : kind === \"a\" ? f.call(receiver) : f ? f.value : state.get(receiver);\r\n}\r\n\r\nexport function __classPrivateFieldSet(receiver, state, value, kind, f) {\r\n if (kind === \"m\") throw new TypeError(\"Private method is not writable\");\r\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a setter\");\r\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot write private member to an object whose class did not declare it\");\r\n return (kind === \"a\" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;\r\n}\r\n\r\nexport function __classPrivateFieldIn(state, receiver) {\r\n if (receiver === null || (typeof receiver !== \"object\" && typeof receiver !== \"function\")) throw new TypeError(\"Cannot use 'in' operator on non-object\");\r\n return typeof state === \"function\" ? receiver === state : state.has(receiver);\r\n}\r\n\r\nexport function __addDisposableResource(env, value, async) {\r\n if (value !== null && value !== void 0) {\r\n if (typeof value !== \"object\" && typeof value !== \"function\") throw new TypeError(\"Object expected.\");\r\n var dispose;\r\n if (async) {\r\n if (!Symbol.asyncDispose) throw new TypeError(\"Symbol.asyncDispose is not defined.\");\r\n dispose = value[Symbol.asyncDispose];\r\n }\r\n if (dispose === void 0) {\r\n if (!Symbol.dispose) throw new TypeError(\"Symbol.dispose is not defined.\");\r\n dispose = value[Symbol.dispose];\r\n }\r\n if (typeof dispose !== \"function\") throw new TypeError(\"Object not disposable.\");\r\n env.stack.push({ value: value, dispose: dispose, async: async });\r\n }\r\n else if (async) {\r\n env.stack.push({ async: true });\r\n }\r\n return value;\r\n}\r\n\r\nvar _SuppressedError = typeof SuppressedError === \"function\" ? SuppressedError : function (error, suppressed, message) {\r\n var e = new Error(message);\r\n return e.name = \"SuppressedError\", e.error = error, e.suppressed = suppressed, e;\r\n};\r\n\r\nexport function __disposeResources(env) {\r\n function fail(e) {\r\n env.error = env.hasError ? new _SuppressedError(e, env.error, \"An error was suppressed during disposal.\") : e;\r\n env.hasError = true;\r\n }\r\n function next() {\r\n while (env.stack.length) {\r\n var rec = env.stack.pop();\r\n try {\r\n var result = rec.dispose && rec.dispose.call(rec.value);\r\n if (rec.async) return Promise.resolve(result).then(next, function(e) { fail(e); return next(); });\r\n }\r\n catch (e) {\r\n fail(e);\r\n }\r\n }\r\n if (env.hasError) throw env.error;\r\n }\r\n return next();\r\n}\r\n\r\nexport default {\r\n __extends: __extends,\r\n __assign: __assign,\r\n __rest: __rest,\r\n __decorate: __decorate,\r\n __param: __param,\r\n __metadata: __metadata,\r\n __awaiter: __awaiter,\r\n __generator: __generator,\r\n __createBinding: __createBinding,\r\n __exportStar: __exportStar,\r\n __values: __values,\r\n __read: __read,\r\n __spread: __spread,\r\n __spreadArrays: __spreadArrays,\r\n __spreadArray: __spreadArray,\r\n __await: __await,\r\n __asyncGenerator: __asyncGenerator,\r\n __asyncDelegator: __asyncDelegator,\r\n __asyncValues: __asyncValues,\r\n __makeTemplateObject: __makeTemplateObject,\r\n __importStar: __importStar,\r\n __importDefault: __importDefault,\r\n __classPrivateFieldGet: __classPrivateFieldGet,\r\n __classPrivateFieldSet: __classPrivateFieldSet,\r\n __classPrivateFieldIn: __classPrivateFieldIn,\r\n __addDisposableResource: __addDisposableResource,\r\n __disposeResources: __disposeResources,\r\n};\r\n","'use client'\r\n\r\nimport Tempus from '@darkroom.engineering/tempus'\r\nimport Lenis, { LenisOptions } from 'lenis'\r\nimport {\r\n ForwardRefExoticComponent,\r\n PropsWithoutRef,\r\n ReactNode,\r\n RefAttributes,\r\n createContext,\r\n forwardRef,\r\n useCallback,\r\n useContext,\r\n useEffect,\r\n useImperativeHandle,\r\n useRef,\r\n useState,\r\n} from 'react'\r\nimport { Store, useStore } from './store'\r\n\r\ntype LenisEventHandler = (lenis: Lenis) => void\r\ninterface LenisContextValue {\r\n lenis: Lenis\r\n addCallback: (handler: LenisEventHandler, priority: number) => void\r\n removeCallback: (handler: LenisEventHandler) => void\r\n}\r\n\r\nexport const LenisContext = createContext<LenisContextValue | null>(null)\r\n\r\nconst rootLenisContextStore = new Store({})\r\n\r\nfunction useCurrentLenis() {\r\n const localContext = useContext(LenisContext)\r\n const rootContext = useStore(rootLenisContextStore)\r\n\r\n return localContext ?? rootContext\r\n}\r\n\r\nexport function useLenis(\r\n callback?: (lenis: Lenis) => void,\r\n deps: Array<any> = [],\r\n priority = 0,\r\n): Lenis | undefined {\r\n const { lenis, addCallback, removeCallback } = useCurrentLenis()\r\n\r\n useEffect(() => {\r\n if (!callback || !addCallback || !removeCallback || !lenis) return\r\n\r\n addCallback(callback, priority)\r\n callback(lenis)\r\n\r\n return () => {\r\n removeCallback(callback)\r\n }\r\n }, [lenis, addCallback, removeCallback, priority, ...deps])\r\n\r\n return lenis\r\n}\r\n\r\ntype ForwardRefComponent<P, T> = ForwardRefExoticComponent<\r\n PropsWithoutRef<P> & RefAttributes<T>\r\n>\r\n\r\ntype Props = {\r\n root?: boolean\r\n options?: LenisOptions\r\n autoRaf?: boolean\r\n rafPriority?: number\r\n className?: string\r\n children?: ReactNode\r\n props?: any\r\n}\r\n\r\ntype LenisRef = {\r\n wrapper?: HTMLElement\r\n content?: HTMLElement\r\n lenis?: Lenis\r\n}\r\n\r\nconst ReactLenis: ForwardRefComponent<Props, LenisRef> = forwardRef<\r\n LenisRef,\r\n Props\r\n>(\r\n (\r\n {\r\n children,\r\n root = false,\r\n options = {},\r\n autoRaf = true,\r\n rafPriority = 0,\r\n className,\r\n ...props\r\n }: Props,\r\n ref,\r\n ) => {\r\n const wrapperRef = useRef<HTMLDivElement | null>(null)\r\n const contentRef = useRef<HTMLDivElement | null>(null)\r\n\r\n const [lenis, setLenis] = useState<Lenis | undefined>(undefined)\r\n\r\n const callbacksRefs = useRef<\r\n {\r\n callback: LenisEventHandler\r\n priority: number\r\n }[]\r\n >([])\r\n\r\n const addCallback: LenisContextValue['addCallback'] = useCallback(\r\n (callback, priority) => {\r\n callbacksRefs.current.push({ callback, priority })\r\n callbacksRefs.current.sort((a, b) => a.priority - b.priority)\r\n },\r\n [],\r\n )\r\n\r\n const removeCallback: LenisContextValue['removeCallback'] = useCallback(\r\n (callback) => {\r\n callbacksRefs.current = callbacksRefs.current.filter(\r\n (cb) => cb.callback !== callback,\r\n )\r\n },\r\n [],\r\n )\r\n\r\n useImperativeHandle(\r\n ref,\r\n () => ({\r\n wrapper: wrapperRef.current!,\r\n content: contentRef.current!,\r\n lenis,\r\n }),\r\n [lenis],\r\n )\r\n\r\n useEffect(() => {\r\n const lenis = new Lenis({\r\n ...options,\r\n ...(!root && {\r\n wrapper: wrapperRef.current!,\r\n content: contentRef.current!,\r\n }),\r\n })\r\n\r\n setLenis(lenis)\r\n\r\n return () => {\r\n lenis.destroy()\r\n setLenis(undefined)\r\n }\r\n }, [root, JSON.stringify(options)])\r\n\r\n useEffect(() => {\r\n if (!lenis || !autoRaf) return\r\n\r\n return Tempus.add((time: number) => {\r\n lenis?.raf(time)\r\n }, rafPriority)\r\n }, [lenis, autoRaf, rafPriority])\r\n\r\n useEffect(() => {\r\n if (root && lenis) {\r\n rootLenisContextStore.set({ lenis, addCallback, removeCallback })\r\n\r\n return () => rootLenisContextStore.set({})\r\n }\r\n }, [root, lenis, addCallback, removeCallback])\r\n\r\n const onScroll = useCallback((...args) => {\r\n for (let i = 0; i < callbacksRefs.current.length; i++) {\r\n callbacksRefs.current[i].callback(...args)\r\n }\r\n }, [])\r\n\r\n useEffect(() => {\r\n lenis?.on('scroll', onScroll)\r\n\r\n return () => {\r\n lenis?.off('scroll', onScroll)\r\n }\r\n }, [lenis, onScroll])\r\n\r\n // const onClassNameChange = useCallback(() => {\r\n // if (wrapperRef.current) {\r\n // wrapperRef.current.className = cn(lenis?.className, className)\r\n // }\r\n // }, [lenis, className])\r\n\r\n // useEffect(() => {\r\n // onClassNameChange()\r\n\r\n // lenis?.on('className change', onClassNameChange)\r\n\r\n // return () => {\r\n // lenis?.off('className change', onClassNameChange)\r\n // }\r\n // }, [lenis, onClassNameChange])\r\n\r\n return (\r\n <LenisContext.Provider\r\n value={{ lenis: lenis!, addCallback, removeCallback }}\r\n >\r\n {root ? (\r\n children\r\n ) : (\r\n <div ref={wrapperRef} className={className} {...props}>\r\n <div ref={contentRef}>{children}</div>\r\n </div>\r\n )}\r\n </LenisContext.Provider>\r\n )\r\n },\r\n)\r\n\r\nexport { ReactLenis as Lenis, ReactLenis }\r\nexport default ReactLenis\r\n","import { useEffect, useState } from 'react'\r\n\r\nexport class Store {\r\n private state: any\r\n private listeners: Array<(state: any) => any> = []\r\n\r\n constructor(state: any) {\r\n this.state = state\r\n }\r\n\r\n set(state: any) {\r\n this.state = state\r\n\r\n for (let listener of this.listeners) {\r\n listener(this.state)\r\n }\r\n }\r\n\r\n subscribe(listener: (state: any) => any) {\r\n this.listeners = [...this.listeners, listener]\r\n return () => {\r\n this.listeners = this.listeners.filter((l) => l !== listener)\r\n }\r\n }\r\n\r\n get() {\r\n return this.state\r\n }\r\n}\r\n\r\nexport function useStore(store: Store) {\r\n const [state, setState] = useState(store.get())\r\n\r\n useEffect(() => {\r\n return store.subscribe((state: any) => setState(state))\r\n }, [store])\r\n\r\n return state\r\n}\r\n"],"names":["SuppressedError","LenisContext","createContext","rootLenisContextStore","Store","constructor","state","this","listeners","set","listener","subscribe","filter","l","get","useCurrentLenis","localContext","useContext","rootContext","useStore","store","setState","useState","useEffect","useLenis","callback","deps","priority","lenis","addCallback","removeCallback","ReactLenis","forwardRef","_a","ref","children","root","options","autoRaf","rafPriority","className","props","__rest","s","e","t","p","Object","prototype","hasOwnProperty","call","indexOf","getOwnPropertySymbols","i","length","propertyIsEnumerable","wrapperRef","useRef","contentRef","setLenis","undefined","callbacksRefs","useCallback","current","push","sort","a","b","cb","useImperativeHandle","wrapper","content","Lenis","assign","destroy","JSON","stringify","Tempus","add","time","raf","onScroll","args","on","off","_jsx","Provider","value"],"mappings":"kQA2TkD,mBAApBA,iBAAiCA,sBChSlDC,EAAeC,EAAwC,MAE9DC,EAAwB,UC3BjBC,MAIX,WAAAC,CAAYC,GAFJC,KAASC,UAA+B,GAG9CD,KAAKD,MAAQA,CACd,CAED,GAAAG,CAAIH,GACFC,KAAKD,MAAQA,EAEb,IAAK,IAAII,KAAYH,KAAKC,UACxBE,EAASH,KAAKD,MAEjB,CAED,SAAAK,CAAUD,GAER,OADAH,KAAKC,UAAY,IAAID,KAAKC,UAAWE,GAC9B,KACLH,KAAKC,UAAYD,KAAKC,UAAUI,QAAQC,GAAMA,IAAMH,GAAS,CAEhE,CAED,GAAAI,GACE,OAAOP,KAAKD,KACb,GDEqC,CAAA,GAExC,SAASS,kBACP,MAAMC,EAAeC,EAAWhB,GAC1BiB,ECHF,SAAUC,SAASC,GACvB,MAAOd,EAAOe,GAAYC,EAASF,EAAMN,OAMzC,OAJAS,GAAU,IACDH,EAAMT,WAAWL,GAAee,EAASf,MAC/C,CAACc,IAEGd,CACT,CDLsBa,CAAShB,GAE7B,OAAOa,QAAAA,EAAgBE,CACzB,CAEM,SAAUM,SACdC,EACAC,EAAmB,GACnBC,EAAW,GAEX,MAAMC,MAAEA,EAAKC,YAAEA,EAAWC,eAAEA,GAAmBf,kBAa/C,OAXAQ,GAAU,KACR,GAAKE,GAAaI,GAAgBC,GAAmBF,EAKrD,OAHAC,EAAYJ,EAAUE,GACtBF,EAASG,GAEF,KACLE,EAAeL,EAAS,CACzB,GACA,CAACG,EAAOC,EAAaC,EAAgBH,KAAaD,IAE9CE,CACT,CAsBM,MAAAG,EAAmDC,GAIvD,CACEC,EASAC,SATAC,SACEA,EAAQC,KACRA,GAAO,EAAKC,QACZA,EAAU,GAAEC,QACZA,GAAU,EAAIC,YACdA,EAAc,EAACC,UACfA,KACGC,EDjDF,SAASC,OAAOC,EAAGC,GACtB,IAAIC,EAAI,CAAA,EACR,IAAK,IAAIC,KAAKH,EAAOI,OAAOC,UAAUC,eAAeC,KAAKP,EAAGG,IAAMF,EAAEO,QAAQL,GAAK,IAC9ED,EAAEC,GAAKH,EAAEG,IACb,GAAS,MAALH,GAAqD,mBAAjCI,OAAOK,sBACtB,KAAIC,EAAI,EAAb,IAAgBP,EAAIC,OAAOK,sBAAsBT,GAAIU,EAAIP,EAAEQ,OAAQD,IAC3DT,EAAEO,QAAQL,EAAEO,IAAM,GAAKN,OAAOC,UAAUO,qBAAqBL,KAAKP,EAAGG,EAAEO,MACvER,EAAEC,EAAEO,IAAMV,EAAEG,EAAEO,IAF4B,CAItD,OAAOR,CACX,CCgCIH,CAAAT,EAAA,CAAA,WAAA,OAAA,UAAA,UAAA,cAAA,cAWA,MAAMuB,EAAaC,EAA8B,MAC3CC,EAAaD,EAA8B,OAE1C7B,EAAO+B,GAAYrC,OAA4BsC,GAEhDC,EAAgBJ,EAKpB,IAEI5B,EAAgDiC,GACpD,CAACrC,EAAUE,KACTkC,EAAcE,QAAQC,KAAK,CAAEvC,WAAUE,aACvCkC,EAAcE,QAAQE,MAAK,CAACC,EAAGC,IAAMD,EAAEvC,SAAWwC,EAAExC,UAAS,GAE/D,IAGIG,EAAsDgC,GACzDrC,IACCoC,EAAcE,QAAUF,EAAcE,QAAQnD,QAC3CwD,GAAOA,EAAG3C,WAAaA,GACzB,GAEH,IAGF4C,EACEnC,GACA,KAAO,CACLoC,QAASd,EAAWO,QACpBQ,QAASb,EAAWK,QACpBnC,WAEF,CAACA,IAGHL,GAAU,KACR,MAAMK,EAAQ,IAAI4C,EAAKzB,OAAA0B,OAAA1B,OAAA0B,OAAA,CAAA,EAClBpC,IACED,GAAQ,CACXkC,QAASd,EAAWO,QACpBQ,QAASb,EAAWK,WAMxB,OAFAJ,EAAS/B,GAEF,KACLA,EAAM8C,UACNf,OAASC,EAAU,CACpB,GACA,CAACxB,EAAMuC,KAAKC,UAAUvC,KAEzBd,GAAU,KACR,GAAKK,GAAUU,EAEf,OAAOuC,EAAOC,KAAKC,IACjBnD,SAAAA,EAAOoD,IAAID,EAAK,GACfxC,EAAY,GACd,CAACX,EAAOU,EAASC,IAEpBhB,GAAU,KACR,GAAIa,GAAQR,EAGV,OAFAzB,EAAsBM,IAAI,CAAEmB,QAAOC,cAAaC,mBAEzC,IAAM3B,EAAsBM,IAAI,CAAA,EACxC,GACA,CAAC2B,EAAMR,EAAOC,EAAaC,IAE9B,MAAMmD,EAAWnB,GAAY,IAAIoB,KAC/B,IAAK,IAAI7B,EAAI,EAAGA,EAAIQ,EAAcE,QAAQT,OAAQD,IAChDQ,EAAcE,QAAQV,GAAG5B,YAAYyD,EACtC,GACA,IA0BH,OAxBA3D,GAAU,KACRK,SAAAA,EAAOuD,GAAG,SAAUF,GAEb,KACLrD,SAAAA,EAAOwD,IAAI,SAAUH,EAAS,IAE/B,CAACrD,EAAOqD,IAmBTI,EAACpF,EAAaqF,SACZ,CAAAC,MAAO,CAAE3D,MAAOA,EAAQC,cAAaC,kBAAgBK,SAEpDC,EACC,EAEAiD,EAAA,MAAAtC,OAAA0B,OAAA,CAAKvC,IAAKsB,EAAYhB,UAAWA,GAAeC,YAC9C4C,EAAK,MAAA,CAAAnD,IAAKwB,EAAavB,SAAAA,QAI9B","x_google_ignoreList":[0]}
1
+ {"version":3,"file":"lenis-react.mjs","sources":["../../src/index.tsx","../../src/store.ts"],"sourcesContent":["'use client'\r\n\r\nimport Tempus from '@darkroom.engineering/tempus'\r\nimport Lenis, { type ScrollCallback } from 'lenis'\r\nimport {\r\n createContext,\r\n forwardRef,\r\n useCallback,\r\n useContext,\r\n useEffect,\r\n useImperativeHandle,\r\n useRef,\r\n useState,\r\n} from 'react'\r\nimport { Store, useStore } from './store'\r\nimport type { LenisContextValue, LenisProps, LenisRef } from './types'\r\n\r\nexport const LenisContext = createContext<LenisContextValue | null>(null)\r\n\r\nconst rootLenisContextStore = new Store<LenisContextValue | null>(null)\r\n\r\n// Fall back to an empty object if both context and store are not available\r\nconst fallbackContext: Partial<LenisContextValue> = {}\r\n\r\n/**\r\n * Hook to access the Lenis instance and its methods\r\n *\r\n * @example <caption>Scroll callback</caption>\r\n * useLenis((lenis) => {\r\n * if (lenis.isScrolling) {\r\n * console.log('Scrolling...')\r\n * }\r\n *\r\n * if (lenis.progress === 1) {\r\n * console.log('At the end!')\r\n * }\r\n * })\r\n *\r\n * @example <caption>Scroll callback with dependencies</caption>\r\n * useLenis((lenis) => {\r\n * if (lenis.isScrolling) {\r\n * console.log('Scrolling...', someDependency)\r\n * }\r\n * }, [someDependency])\r\n * @example <caption>Scroll callback with priority</caption>\r\n * useLenis((lenis) => {\r\n * if (lenis.isScrolling) {\r\n * console.log('Scrolling...')\r\n * }\r\n * }, [], 1)\r\n * @example <caption>Instance access</caption>\r\n * const lenis = useLenis()\r\n *\r\n * handleClick() {\r\n * lenis.scrollTo(100, {\r\n * lerp: 0.1,\r\n * duration: 1,\r\n * easing: (t) => t,\r\n * onComplete: () => {\r\n * console.log('Complete!')\r\n * }\r\n * })\r\n * }\r\n */\r\nexport function useLenis(\r\n callback?: ScrollCallback,\r\n deps: any[] = [],\r\n priority = 0\r\n) {\r\n // Try to get the lenis instance from the context first\r\n const localContext = useContext(LenisContext)\r\n // Fall back to the root store if the context is not available\r\n const rootContext = useStore(rootLenisContextStore)\r\n // Fall back to the fallback context if all else fails\r\n const currentContext = localContext ?? rootContext ?? fallbackContext\r\n\r\n const { lenis, addCallback, removeCallback } = currentContext\r\n\r\n useEffect(() => {\r\n if (!callback || !addCallback || !removeCallback || !lenis) return\r\n\r\n addCallback(callback, priority)\r\n callback(lenis)\r\n\r\n return () => {\r\n removeCallback(callback)\r\n }\r\n }, [lenis, addCallback, removeCallback, priority, ...deps])\r\n\r\n return lenis\r\n}\r\n\r\n/**\r\n * React component to setup a Lenis instance\r\n */\r\nconst ReactLenis = forwardRef<LenisRef, LenisProps>(\r\n (\r\n {\r\n children,\r\n root = false,\r\n options = {},\r\n autoRaf = true,\r\n rafPriority = 0,\r\n className,\r\n props,\r\n }: LenisProps,\r\n ref\r\n ) => {\r\n const wrapperRef = useRef<HTMLDivElement | null>(null)\r\n const contentRef = useRef<HTMLDivElement | null>(null)\r\n\r\n const [lenis, setLenis] = useState<Lenis | undefined>(undefined)\r\n\r\n // Setup ref\r\n useImperativeHandle(\r\n ref,\r\n () => ({\r\n wrapper: wrapperRef.current,\r\n content: contentRef.current,\r\n lenis,\r\n }),\r\n [lenis]\r\n )\r\n\r\n // Setup lenis instance\r\n useEffect(() => {\r\n const lenis = new Lenis({\r\n ...options,\r\n ...(!root && {\r\n wrapper: wrapperRef.current!,\r\n content: contentRef.current!,\r\n }),\r\n })\r\n\r\n setLenis(lenis)\r\n\r\n return () => {\r\n lenis.destroy()\r\n setLenis(undefined)\r\n }\r\n }, [root, JSON.stringify(options)])\r\n\r\n // Setup raf\r\n useEffect(() => {\r\n if (!lenis || !autoRaf) return\r\n\r\n return Tempus.add((time: number) => lenis.raf(time), rafPriority)\r\n }, [lenis, autoRaf, rafPriority])\r\n\r\n // Handle callbacks\r\n const callbacksRefs = useRef<\r\n {\r\n callback: ScrollCallback\r\n priority: number\r\n }[]\r\n >([])\r\n\r\n const addCallback: LenisContextValue['addCallback'] = useCallback(\r\n (callback, priority) => {\r\n callbacksRefs.current.push({ callback, priority })\r\n callbacksRefs.current.sort((a, b) => a.priority - b.priority)\r\n },\r\n []\r\n )\r\n\r\n const removeCallback: LenisContextValue['removeCallback'] = useCallback(\r\n (callback) => {\r\n callbacksRefs.current = callbacksRefs.current.filter(\r\n (cb) => cb.callback !== callback\r\n )\r\n },\r\n []\r\n )\r\n\r\n // This makes sure to set the global context if the root is true\r\n useEffect(() => {\r\n if (root && lenis) {\r\n rootLenisContextStore.set({ lenis, addCallback, removeCallback })\r\n\r\n return () => rootLenisContextStore.set(null)\r\n }\r\n }, [root, lenis, addCallback, removeCallback])\r\n\r\n // Setup callback listeners\r\n useEffect(() => {\r\n if (!lenis) return\r\n\r\n const onScroll: ScrollCallback = (data) => {\r\n for (let i = 0; i < callbacksRefs.current.length; i++) {\r\n callbacksRefs.current[i].callback(data)\r\n }\r\n }\r\n\r\n lenis.on('scroll', onScroll)\r\n\r\n return () => {\r\n lenis.off('scroll', onScroll)\r\n }\r\n }, [lenis])\r\n\r\n return (\r\n <LenisContext.Provider\r\n value={{ lenis: lenis!, addCallback, removeCallback }}\r\n >\r\n {root ? (\r\n children\r\n ) : (\r\n <div ref={wrapperRef} className={className} {...props}>\r\n <div ref={contentRef}>{children}</div>\r\n </div>\r\n )}\r\n </LenisContext.Provider>\r\n )\r\n }\r\n)\r\n\r\nexport * from './types'\r\nexport { ReactLenis as Lenis, ReactLenis }\r\nexport default ReactLenis\r\n","import { useEffect, useState } from 'react'\r\n\r\ntype Listener<S> = (state: S) => void\r\n\r\nexport class Store<S> {\r\n private listeners: Listener<S>[] = []\r\n\r\n constructor(private state: S) {}\r\n\r\n set(state: S) {\r\n this.state = state\r\n\r\n for (let listener of this.listeners) {\r\n listener(this.state)\r\n }\r\n }\r\n\r\n subscribe(listener: Listener<S>) {\r\n this.listeners = [...this.listeners, listener]\r\n return () => {\r\n this.listeners = this.listeners.filter((l) => l !== listener)\r\n }\r\n }\r\n\r\n get() {\r\n return this.state\r\n }\r\n}\r\n\r\nexport function useStore<S>(store: Store<S>) {\r\n const [state, setState] = useState(store.get())\r\n\r\n useEffect(() => {\r\n return store.subscribe((state) => setState(state))\r\n }, [store])\r\n\r\n return state\r\n}\r\n"],"names":["LenisContext","createContext","rootLenisContextStore","Store","constructor","state","this","listeners","set","listener","subscribe","filter","l","get","fallbackContext","useLenis","callback","deps","priority","localContext","useContext","rootContext","useStore","store","setState","useState","useEffect","currentContext","_a","lenis","addCallback","removeCallback","ReactLenis","forwardRef","children","root","options","autoRaf","rafPriority","className","props","ref","wrapperRef","useRef","contentRef","setLenis","undefined","useImperativeHandle","wrapper","current","content","Lenis","Object","assign","destroy","JSON","stringify","Tempus","add","time","raf","callbacksRefs","useCallback","push","sort","a","b","cb","onScroll","data","i","length","on","off","_jsx","Provider","value"],"mappings":"wQAiBaA,EAAeC,EAAwC,MAE9DC,EAAwB,UCfjBC,MAGX,WAAAC,CAAoBC,GAAAC,KAAKD,MAALA,EAFZC,KAASC,UAAkB,EAEH,CAEhC,GAAAC,CAAIH,GACFC,KAAKD,MAAQA,EAEb,IAAK,IAAII,KAAYH,KAAKC,UACxBE,EAASH,KAAKD,MAEjB,CAED,SAAAK,CAAUD,GAER,OADAH,KAAKC,UAAY,IAAID,KAAKC,UAAWE,GAC9B,KACLH,KAAKC,UAAYD,KAAKC,UAAUI,QAAQC,GAAMA,IAAMH,GAAS,CAEhE,CAED,GAAAI,GACE,OAAOP,KAAKD,KACb,GDP+D,MAG5DS,EAA8C,CAAA,EA0C9C,SAAUC,SACdC,EACAC,EAAc,GACdC,EAAW,SAGX,MAAMC,EAAeC,EAAWpB,GAE1BqB,EC3CF,SAAUC,SAAYC,GAC1B,MAAOlB,EAAOmB,GAAYC,EAASF,EAAMV,OAMzC,OAJAa,GAAU,IACDH,EAAMb,WAAWL,GAAUmB,EAASnB,MAC1C,CAACkB,IAEGlB,CACT,CDmCsBiB,CAASpB,GAEvByB,EAAgD,QAA/BC,EAAAT,QAAAA,EAAgBE,SAAe,IAAAO,EAAAA,EAAAd,GAEhDe,MAAEA,EAAKC,YAAEA,EAAWC,eAAEA,GAAmBJ,EAa/C,OAXAD,GAAU,KACR,GAAKV,GAAac,GAAgBC,GAAmBF,EAKrD,OAHAC,EAAYd,EAAUE,GACtBF,EAASa,GAEF,KACLE,EAAef,EAAS,CACzB,GACA,CAACa,EAAOC,EAAaC,EAAgBb,KAAaD,IAE9CY,CACT,CAKA,MAAMG,EAAaC,GACjB,EAEIC,WACAC,QAAO,EACPC,UAAU,CAAA,EACVC,WAAU,EACVC,cAAc,EACdC,YACAC,SAEFC,KAEA,MAAMC,EAAaC,EAA8B,MAC3CC,EAAaD,EAA8B,OAE1Cd,EAAOgB,GAAYpB,OAA4BqB,GAGtDC,EACEN,GACA,KAAO,CACLO,QAASN,EAAWO,QACpBC,QAASN,EAAWK,QACpBpB,WAEF,CAACA,IAIHH,GAAU,KACR,MAAMG,EAAQ,IAAIsB,EAAKC,OAAAC,OAAAD,OAAAC,OAAA,CAAA,EAClBjB,IACED,GAAQ,CACXa,QAASN,EAAWO,QACpBC,QAASN,EAAWK,WAMxB,OAFAJ,EAAShB,GAEF,KACLA,EAAMyB,UACNT,OAASC,EAAU,CACpB,GACA,CAACX,EAAMoB,KAAKC,UAAUpB,KAGzBV,GAAU,KACR,GAAKG,GAAUQ,EAEf,OAAOoB,EAAOC,KAAKC,GAAiB9B,EAAM+B,IAAID,IAAOrB,EAAY,GAChE,CAACT,EAAOQ,EAASC,IAGpB,MAAMuB,EAAgBlB,EAKpB,IAEIb,EAAgDgC,GACpD,CAAC9C,EAAUE,KACT2C,EAAcZ,QAAQc,KAAK,CAAE/C,WAAUE,aACvC2C,EAAcZ,QAAQe,MAAK,CAACC,EAAGC,IAAMD,EAAE/C,SAAWgD,EAAEhD,UAAS,GAE/D,IAGIa,EAAsD+B,GACzD9C,IACC6C,EAAcZ,QAAUY,EAAcZ,QAAQtC,QAC3CwD,GAAOA,EAAGnD,WAAaA,GACzB,GAEH,IA6BF,OAzBAU,GAAU,KACR,GAAIS,GAAQN,EAGV,OAFA3B,EAAsBM,IAAI,CAAEqB,QAAOC,cAAaC,mBAEzC,IAAM7B,EAAsBM,IAAI,KACxC,GACA,CAAC2B,EAAMN,EAAOC,EAAaC,IAG9BL,GAAU,KACR,IAAKG,EAAO,OAEZ,MAAMuC,SAA4BC,IAChC,IAAK,IAAIC,EAAI,EAAGA,EAAIT,EAAcZ,QAAQsB,OAAQD,IAChDT,EAAcZ,QAAQqB,GAAGtD,SAASqD,EACnC,EAKH,OAFAxC,EAAM2C,GAAG,SAAUJ,UAEZ,KACLvC,EAAM4C,IAAI,SAAUL,SAAS,CAC9B,GACA,CAACvC,IAGF6C,EAAC1E,EAAa2E,SACZ,CAAAC,MAAO,CAAE/C,MAAOA,EAAQC,cAAaC,kBAAgBG,SAEpDC,EACC,EAEAuC,EAAA,MAAAtB,OAAAC,OAAA,CAAKZ,IAAKC,EAAYH,UAAWA,GAAeC,YAC9CkC,EAAK,MAAA,CAAAjC,IAAKG,EAAaV,SAAAA,QAI9B"}
@@ -1,4 +1,4 @@
1
- import Lenis from 'lenis';
1
+ import Lenis, { UserData, EasingFunction } from 'lenis';
2
2
 
3
3
  type SnapElementOptions = {
4
4
  align?: string[];
@@ -36,45 +36,130 @@ declare class SnapElement {
36
36
  onResize: ([entry]: ResizeObserverEntry[]) => void;
37
37
  }
38
38
 
39
- type UID = number;
40
-
41
- type Viewport = {
42
- width: number;
43
- height: number;
44
- };
45
39
  type SnapItem = {
46
40
  value: number;
47
- userData: object;
41
+ userData: UserData;
48
42
  };
43
+ type OnSnapCallback = (item: SnapItem) => void;
49
44
  type SnapOptions = {
45
+ /**
46
+ * Snap type
47
+ * @default mandatory
48
+ */
50
49
  type?: 'mandatory' | 'proximity';
50
+ /**
51
+ * Linear interpolation (lerp) intensity (between 0 and 1)
52
+ */
51
53
  lerp?: number;
52
- easing?: (t: number) => number;
54
+ /**
55
+ * The easing function to use for the snap animation
56
+ */
57
+ easing?: EasingFunction;
58
+ /**
59
+ * The duration of the snap animation (in s)
60
+ */
53
61
  duration?: number;
62
+ /**
63
+ * The velocity threshold to trigger a snap
64
+ */
54
65
  velocityThreshold?: number;
66
+ /**
67
+ * The debounce delay (in ms) to prevent snapping too often
68
+ */
55
69
  debounce?: number;
56
- onSnapStart?: (t: SnapItem) => void;
57
- onSnapComplete?: (t: SnapItem) => void;
70
+ /**
71
+ * Called when the snap starts
72
+ */
73
+ onSnapStart?: OnSnapCallback;
74
+ /**
75
+ * Called when the snap completes
76
+ */
77
+ onSnapComplete?: OnSnapCallback;
58
78
  };
79
+
80
+ type UID = number;
81
+
82
+ type RequiredPick<T, F extends keyof T> = Omit<T, F> & Required<Pick<T, F>>;
83
+ /**
84
+ * Snap class to handle the snap functionality
85
+ *
86
+ * @example
87
+ * const snap = new Snap(lenis, {
88
+ * type: 'mandatory', // 'mandatory', 'proximity'
89
+ * lerp: 0.1,
90
+ * duration: 1,
91
+ * easing: (t) => t,
92
+ * onSnapStart: (snap) => {
93
+ * console.log('onSnapStart', snap)
94
+ * },
95
+ * onSnapComplete: (snap) => {
96
+ * console.log('onSnapComplete', snap)
97
+ * },
98
+ * })
99
+ *
100
+ * snap.add(500) // snap at 500px
101
+ *
102
+ * const removeSnap = snap.add(500)
103
+ *
104
+ * if (someCondition) {
105
+ * removeSnap()
106
+ * }
107
+ */
59
108
  declare class Snap {
60
- lenis: Lenis;
61
- options: SnapOptions;
62
- elements: Map<UID, SnapElement>;
63
- snaps: Map<UID, SnapItem>;
64
- viewport: Viewport;
65
- isStopped: Boolean;
66
- onSnapDebounced: Function;
109
+ private lenis;
110
+ options: RequiredPick<SnapOptions, 'type' | 'velocityThreshold' | 'debounce'>;
111
+ elements: Map<number, SnapElement>;
112
+ snaps: Map<number, SnapItem>;
113
+ viewport: {
114
+ width: number;
115
+ height: number;
116
+ };
117
+ isStopped: boolean;
118
+ onSnapDebounced: () => void;
67
119
  constructor(lenis: Lenis, { type, lerp, easing, duration, velocityThreshold, debounce: debounceDelay, onSnapStart, onSnapComplete, }?: SnapOptions);
120
+ /**
121
+ * Destroy the snap instance
122
+ */
68
123
  destroy(): void;
124
+ /**
125
+ * Start the snap after it has been stopped
126
+ */
69
127
  start(): void;
128
+ /**
129
+ * Stop the snap
130
+ */
70
131
  stop(): void;
71
- add(value: number, userData?: object): () => void;
132
+ /**
133
+ * Add a snap to the snap instance
134
+ *
135
+ * @param value The value to snap to
136
+ * @param userData User data that will be forwarded through the snap event
137
+ * @returns Unsubscribe function
138
+ */
139
+ add(value: number, userData?: UserData): () => void;
140
+ /**
141
+ * Remove a snap from the snap instance
142
+ *
143
+ * @param id The snap id of the snap to remove
144
+ */
72
145
  remove(id: UID): void;
146
+ /**
147
+ * Add an element to the snap instance
148
+ *
149
+ * @param element The element to add
150
+ * @param options The options for the element
151
+ * @returns Unsubscribe function
152
+ */
73
153
  addElement(element: HTMLElement, options?: SnapElementOptions): () => void;
154
+ /**
155
+ * Remove an element from the snap instance
156
+ *
157
+ * @param id The snap id of the snap element to remove
158
+ */
74
159
  removeElement(id: UID): void;
75
160
  private onWindowResize;
76
161
  private onScroll;
77
162
  private onSnap;
78
163
  }
79
164
 
80
- export { type SnapOptions, Snap as default };
165
+ export { type OnSnapCallback, type SnapItem, type SnapOptions, Snap as default };