overlayscrollbars-react 0.5.4 → 0.5.6

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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.5.6
4
+
5
+ ### Improvements
6
+
7
+ - The `OverlayScrollbarsComponent` now properly supports `'body'` as its element tag.
8
+
9
+ ## 0.5.5
10
+
11
+ ### Improvements
12
+
13
+ - Improve the type definitions with the usage of the `ElementType` type instead of the `JSX` namespace of the `@types/react` package in order to improve compatibility to older react versions.
14
+
3
15
  ## 0.5.4
4
16
 
5
17
  ### Improvements
@@ -1,2 +1,2 @@
1
- "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("react"),p=require("overlayscrollbars"),S=()=>{if(typeof window>"u"){const n=()=>{};return[n,n]}let a,o;const t=window,s=typeof t.requestIdleCallback=="function",u=t.requestAnimationFrame,i=t.cancelAnimationFrame,c=s?t.requestIdleCallback:u,f=s?t.cancelIdleCallback:i,l=()=>{f(a),i(o)};return[(n,r)=>{l(),a=c(s?()=>{l(),o=u(n)}:n,typeof r=="object"?r:{timeout:2233})},l]},R=a=>{const{options:o,events:t,defer:s}=a||{},[u,i]=e.useMemo(S,[]),c=e.useRef(null),f=e.useRef(s),l=e.useRef(o),n=e.useRef(t);return e.useEffect(()=>{f.current=s},[s]),e.useEffect(()=>{const{current:r}=c;l.current=o,p.OverlayScrollbars.valid(r)&&r.options(o||{},!0)},[o]),e.useEffect(()=>{const{current:r}=c;n.current=t,p.OverlayScrollbars.valid(r)&&r.on(t||{},!0)},[t]),e.useEffect(()=>()=>{var r;i(),(r=c.current)==null||r.destroy()},[]),e.useMemo(()=>[r=>{const y=c.current;if(p.OverlayScrollbars.valid(y))return;const d=f.current,b=l.current||{},v=n.current||{},m=()=>c.current=p.OverlayScrollbars(r,b,v);d?u(m,d):m()},()=>c.current],[])},O=(a,o)=>{const{element:t="div",options:s,events:u,defer:i,children:c,...f}=a,l=t,n=e.useRef(null),r=e.useRef(null),[y,d]=R({options:s,events:u,defer:i});return e.useEffect(()=>{const{current:b}=n,{current:v}=r;return b&&v&&y({target:b,elements:{viewport:v,content:v}}),()=>{var m;return(m=d())==null?void 0:m.destroy()}},[y,t]),e.useImperativeHandle(o,()=>({osInstance:d,getElement:()=>n.current}),[]),e.createElement(l,{"data-overlayscrollbars-initialize":"",ref:n,...f},e.createElement("div",{"data-overlayscrollbars-contents":"",ref:r},c))},E=e.forwardRef(O);exports.OverlayScrollbarsComponent=E;exports.useOverlayScrollbars=R;
1
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("react"),p=require("overlayscrollbars"),O=()=>{if(typeof window>"u"){const n=()=>{};return[n,n]}let a,o;const t=window,s=typeof t.requestIdleCallback=="function",u=t.requestAnimationFrame,i=t.cancelAnimationFrame,c=s?t.requestIdleCallback:u,f=s?t.cancelIdleCallback:i,l=()=>{f(a),i(o)};return[(n,r)=>{l(),a=c(s?()=>{l(),o=u(n)}:n,typeof r=="object"?r:{timeout:2233})},l]},S=a=>{const{options:o,events:t,defer:s}=a||{},[u,i]=e.useMemo(O,[]),c=e.useRef(null),f=e.useRef(s),l=e.useRef(o),n=e.useRef(t);return e.useEffect(()=>{f.current=s},[s]),e.useEffect(()=>{const{current:r}=c;l.current=o,p.OverlayScrollbars.valid(r)&&r.options(o||{},!0)},[o]),e.useEffect(()=>{const{current:r}=c;n.current=t,p.OverlayScrollbars.valid(r)&&r.on(t||{},!0)},[t]),e.useEffect(()=>()=>{var r;i(),(r=c.current)==null||r.destroy()},[]),e.useMemo(()=>[r=>{const y=c.current;if(p.OverlayScrollbars.valid(y))return;const d=f.current,b=l.current||{},m=n.current||{},v=()=>c.current=p.OverlayScrollbars(r,b,m);d?u(v,d):v()},()=>c.current],[])},E=(a,o)=>{const{element:t="div",options:s,events:u,defer:i,children:c,...f}=a,l=t,n=e.useRef(null),r=e.useRef(null),[y,d]=S({options:s,events:u,defer:i});return e.useEffect(()=>{const{current:b}=n,{current:m}=r;if(!b)return;const v=b;return y(t==="body"?{target:v,cancel:{body:null}}:{target:v,elements:{viewport:m,content:m}}),()=>{var R;return(R=d())==null?void 0:R.destroy()}},[y,t]),e.useImperativeHandle(o,()=>({osInstance:d,getElement:()=>n.current}),[]),e.createElement(l,{"data-overlayscrollbars-initialize":"",ref:n,...f},t==="body"?c:e.createElement("div",{"data-overlayscrollbars-contents":"",ref:r},c))},I=e.forwardRef(E);exports.OverlayScrollbarsComponent=I;exports.useOverlayScrollbars=S;
2
2
  //# sourceMappingURL=overlayscrollbars-react.cjs.map
@@ -1,2 +1,2 @@
1
- "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("react"),p=require("overlayscrollbars"),S=()=>{if(typeof window>"u"){const n=()=>{};return[n,n]}let a,o;const t=window,s=typeof t.requestIdleCallback=="function",u=t.requestAnimationFrame,i=t.cancelAnimationFrame,c=s?t.requestIdleCallback:u,f=s?t.cancelIdleCallback:i,l=()=>{f(a),i(o)};return[(n,r)=>{l(),a=c(s?()=>{l(),o=u(n)}:n,typeof r=="object"?r:{timeout:2233})},l]},R=a=>{const{options:o,events:t,defer:s}=a||{},[u,i]=e.useMemo(S,[]),c=e.useRef(null),f=e.useRef(s),l=e.useRef(o),n=e.useRef(t);return e.useEffect(()=>{f.current=s},[s]),e.useEffect(()=>{const{current:r}=c;l.current=o,p.OverlayScrollbars.valid(r)&&r.options(o||{},!0)},[o]),e.useEffect(()=>{const{current:r}=c;n.current=t,p.OverlayScrollbars.valid(r)&&r.on(t||{},!0)},[t]),e.useEffect(()=>()=>{var r;i(),(r=c.current)==null||r.destroy()},[]),e.useMemo(()=>[r=>{const y=c.current;if(p.OverlayScrollbars.valid(y))return;const d=f.current,b=l.current||{},v=n.current||{},m=()=>c.current=p.OverlayScrollbars(r,b,v);d?u(m,d):m()},()=>c.current],[])},O=(a,o)=>{const{element:t="div",options:s,events:u,defer:i,children:c,...f}=a,l=t,n=e.useRef(null),r=e.useRef(null),[y,d]=R({options:s,events:u,defer:i});return e.useEffect(()=>{const{current:b}=n,{current:v}=r;return b&&v&&y({target:b,elements:{viewport:v,content:v}}),()=>{var m;return(m=d())==null?void 0:m.destroy()}},[y,t]),e.useImperativeHandle(o,()=>({osInstance:d,getElement:()=>n.current}),[]),e.createElement(l,{"data-overlayscrollbars-initialize":"",ref:n,...f},e.createElement("div",{"data-overlayscrollbars-contents":"",ref:r},c))},E=e.forwardRef(O);exports.OverlayScrollbarsComponent=E;exports.useOverlayScrollbars=R;
1
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("react"),p=require("overlayscrollbars"),O=()=>{if(typeof window>"u"){const n=()=>{};return[n,n]}let a,o;const t=window,s=typeof t.requestIdleCallback=="function",u=t.requestAnimationFrame,i=t.cancelAnimationFrame,c=s?t.requestIdleCallback:u,f=s?t.cancelIdleCallback:i,l=()=>{f(a),i(o)};return[(n,r)=>{l(),a=c(s?()=>{l(),o=u(n)}:n,typeof r=="object"?r:{timeout:2233})},l]},S=a=>{const{options:o,events:t,defer:s}=a||{},[u,i]=e.useMemo(O,[]),c=e.useRef(null),f=e.useRef(s),l=e.useRef(o),n=e.useRef(t);return e.useEffect(()=>{f.current=s},[s]),e.useEffect(()=>{const{current:r}=c;l.current=o,p.OverlayScrollbars.valid(r)&&r.options(o||{},!0)},[o]),e.useEffect(()=>{const{current:r}=c;n.current=t,p.OverlayScrollbars.valid(r)&&r.on(t||{},!0)},[t]),e.useEffect(()=>()=>{var r;i(),(r=c.current)==null||r.destroy()},[]),e.useMemo(()=>[r=>{const y=c.current;if(p.OverlayScrollbars.valid(y))return;const d=f.current,b=l.current||{},m=n.current||{},v=()=>c.current=p.OverlayScrollbars(r,b,m);d?u(v,d):v()},()=>c.current],[])},E=(a,o)=>{const{element:t="div",options:s,events:u,defer:i,children:c,...f}=a,l=t,n=e.useRef(null),r=e.useRef(null),[y,d]=S({options:s,events:u,defer:i});return e.useEffect(()=>{const{current:b}=n,{current:m}=r;if(!b)return;const v=b;return y(t==="body"?{target:v,cancel:{body:null}}:{target:v,elements:{viewport:m,content:m}}),()=>{var R;return(R=d())==null?void 0:R.destroy()}},[y,t]),e.useImperativeHandle(o,()=>({osInstance:d,getElement:()=>n.current}),[]),e.createElement(l,{"data-overlayscrollbars-initialize":"",ref:n,...f},t==="body"?c:e.createElement("div",{"data-overlayscrollbars-contents":"",ref:r},c))},I=e.forwardRef(E);exports.OverlayScrollbarsComponent=I;exports.useOverlayScrollbars=S;
2
2
  //# sourceMappingURL=overlayscrollbars-react.cjs.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"overlayscrollbars-react.cjs.js","sources":["../src/useOverlayScrollbars.ts","../src/OverlayScrollbarsComponent.tsx"],"sourcesContent":["// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nimport React, { useEffect, useMemo, useRef } from 'react';\r\nimport { OverlayScrollbars } from 'overlayscrollbars';\r\nimport type { InitializationTarget } from 'overlayscrollbars';\r\nimport type {\r\n OverlayScrollbarsComponentProps,\r\n OverlayScrollbarsComponentRef,\r\n} from './OverlayScrollbarsComponent';\r\n\r\ntype Defer = [\r\n requestDefer: (callback: () => any, options?: OverlayScrollbarsComponentProps['defer']) => void,\r\n cancelDefer: () => void\r\n];\r\n\r\nexport interface UseOverlayScrollbarsParams {\r\n /** OverlayScrollbars options. */\r\n options?: OverlayScrollbarsComponentProps['options'];\r\n /** OverlayScrollbars events. */\r\n events?: OverlayScrollbarsComponentProps['events'];\r\n /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */\r\n defer?: OverlayScrollbarsComponentProps['defer'];\r\n}\r\n\r\nexport type UseOverlayScrollbarsInitialization = (target: InitializationTarget) => void;\r\n\r\nexport type UseOverlayScrollbarsInstance = () => ReturnType<\r\n OverlayScrollbarsComponentRef['osInstance']\r\n>;\r\n\r\nconst createDefer = (): Defer => {\r\n /* c8 ignore start */\r\n if (typeof window === 'undefined') {\r\n // mock ssr calls with \"noop\"\r\n // eslint-disable-next-line @typescript-eslint/no-empty-function\r\n const noop = () => {};\r\n return [noop, noop];\r\n }\r\n /* c8 ignore end */\r\n\r\n let idleId: number;\r\n let rafId: number;\r\n const wnd = window;\r\n const idleSupported = typeof wnd.requestIdleCallback === 'function';\r\n const rAF = wnd.requestAnimationFrame;\r\n const cAF = wnd.cancelAnimationFrame;\r\n const rIdle = idleSupported ? wnd.requestIdleCallback : rAF;\r\n const cIdle = idleSupported ? wnd.cancelIdleCallback : cAF;\r\n const clear = () => {\r\n cIdle(idleId);\r\n cAF(rafId);\r\n };\r\n\r\n return [\r\n (callback, options) => {\r\n clear();\r\n idleId = rIdle(\r\n idleSupported\r\n ? () => {\r\n clear();\r\n // inside idle its best practice to use rAF to change DOM for best performance\r\n rafId = rAF(callback);\r\n }\r\n : callback,\r\n typeof options === 'object' ? options : { timeout: 2233 }\r\n );\r\n },\r\n clear,\r\n ];\r\n};\r\n\r\n/**\r\n * Hook for advanced usage of OverlayScrollbars. (When the OverlayScrollbarsComponent is not enough)\r\n * @param params Parameters for customization.\r\n * @returns A tuple with two values:\r\n * The first value is the initialization function, it takes one argument which is the `InitializationTarget`.\r\n * The second value is a function which returns the current OverlayScrollbars instance or `null` if not initialized.\r\n */\r\nexport const useOverlayScrollbars = (\r\n params?: UseOverlayScrollbarsParams\r\n): [UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance] => {\r\n const { options, events, defer } = params || {};\r\n const [requestDefer, cancelDefer] = useMemo<Defer>(createDefer, []);\r\n const instanceRef = useRef<ReturnType<UseOverlayScrollbarsInstance>>(null);\r\n const deferRef = useRef(defer);\r\n const optionsRef = useRef(options);\r\n const eventsRef = useRef(events);\r\n\r\n useEffect(() => {\r\n deferRef.current = defer;\r\n }, [defer]);\r\n\r\n useEffect(() => {\r\n const { current: instance } = instanceRef;\r\n\r\n optionsRef.current = options;\r\n\r\n if (OverlayScrollbars.valid(instance)) {\r\n instance.options(options || {}, true);\r\n }\r\n }, [options]);\r\n\r\n useEffect(() => {\r\n const { current: instance } = instanceRef;\r\n\r\n eventsRef.current = events;\r\n\r\n if (OverlayScrollbars.valid(instance)) {\r\n instance.on(events || {}, true);\r\n }\r\n }, [events]);\r\n\r\n useEffect(\r\n () => () => {\r\n cancelDefer();\r\n instanceRef.current?.destroy();\r\n },\r\n []\r\n );\r\n\r\n return useMemo<[UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance]>(\r\n () => [\r\n (target) => {\r\n // if already initialized do nothing\r\n const presentInstance = instanceRef.current;\r\n if (OverlayScrollbars.valid(presentInstance)) {\r\n return;\r\n }\r\n\r\n const currDefer = deferRef.current;\r\n const currOptions = optionsRef.current || {};\r\n const currEvents = eventsRef.current || {};\r\n const init = () =>\r\n (instanceRef.current = OverlayScrollbars(target, currOptions, currEvents));\r\n\r\n if (currDefer) {\r\n requestDefer(init, currDefer);\r\n } else {\r\n init();\r\n }\r\n },\r\n () => instanceRef.current,\r\n ],\r\n []\r\n );\r\n};\r\n","// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nimport React, { forwardRef, useEffect, useRef, useImperativeHandle } from 'react';\r\nimport type { OverlayScrollbars } from 'overlayscrollbars';\r\nimport type { PartialOptions, EventListeners } from 'overlayscrollbars';\r\nimport type { ComponentPropsWithoutRef, ElementRef, ForwardedRef } from 'react';\r\nimport { useOverlayScrollbars } from './useOverlayScrollbars';\r\n\r\ntype OverlayScrollbarsComponentBaseProps<T extends keyof JSX.IntrinsicElements> =\r\n ComponentPropsWithoutRef<T> & {\r\n /** Tag of the root element. */\r\n element?: T;\r\n /** OverlayScrollbars options. */\r\n options?: PartialOptions | false | null;\r\n /** OverlayScrollbars events. */\r\n events?: EventListeners | false | null;\r\n /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */\r\n defer?: boolean | IdleRequestOptions;\r\n };\r\n\r\nexport type OverlayScrollbarsComponentProps<T extends keyof JSX.IntrinsicElements = 'div'> =\r\n OverlayScrollbarsComponentBaseProps<T> & {\r\n ref?: ForwardedRef<OverlayScrollbarsComponentRef<T>>;\r\n };\r\n\r\nexport interface OverlayScrollbarsComponentRef<T extends keyof JSX.IntrinsicElements = 'div'> {\r\n /** Returns the OverlayScrollbars instance or null if not initialized. */\r\n osInstance(): OverlayScrollbars | null;\r\n /** Returns the root element. */\r\n getElement(): ElementRef<T> | null;\r\n}\r\n\r\nconst OverlayScrollbarsComponent = <T extends keyof JSX.IntrinsicElements>(\r\n props: OverlayScrollbarsComponentBaseProps<T>,\r\n ref: ForwardedRef<OverlayScrollbarsComponentRef<T>>\r\n) => {\r\n const { element = 'div', options, events, defer, children, ...other } = props;\r\n const Tag = element;\r\n const elementRef = useRef<ElementRef<T>>(null);\r\n const childrenRef = useRef<HTMLDivElement>(null);\r\n const [initialize, osInstance] = useOverlayScrollbars({ options, events, defer });\r\n\r\n useEffect(() => {\r\n const { current: elm } = elementRef;\r\n const { current: childrenElm } = childrenRef;\r\n if (elm && childrenElm) {\r\n initialize({\r\n target: elm as any,\r\n elements: {\r\n viewport: childrenElm,\r\n content: childrenElm,\r\n },\r\n });\r\n }\r\n return () => osInstance()?.destroy();\r\n }, [initialize, element]);\r\n\r\n useImperativeHandle(\r\n ref,\r\n () => {\r\n return {\r\n osInstance,\r\n getElement: () => elementRef.current,\r\n };\r\n },\r\n []\r\n );\r\n\r\n return (\r\n // @ts-ignore\r\n <Tag data-overlayscrollbars-initialize=\"\" ref={elementRef} {...other}>\r\n <div data-overlayscrollbars-contents=\"\" ref={childrenRef}>\r\n {children}\r\n </div>\r\n </Tag>\r\n );\r\n};\r\n\r\nconst OverlayScrollbarsComponentForwardedRef = forwardRef(OverlayScrollbarsComponent) as <\r\n T extends keyof JSX.IntrinsicElements\r\n>(\r\n props: OverlayScrollbarsComponentProps<T>\r\n) => ReturnType<typeof OverlayScrollbarsComponent>;\r\n\r\nexport { OverlayScrollbarsComponentForwardedRef as OverlayScrollbarsComponent };\r\n"],"names":["createDefer","noop","idleId","rafId","wnd","idleSupported","rAF","cAF","rIdle","cIdle","clear","callback","options","useOverlayScrollbars","params","events","defer","requestDefer","cancelDefer","useMemo","instanceRef","useRef","deferRef","optionsRef","eventsRef","useEffect","instance","OverlayScrollbars","_a","target","presentInstance","currDefer","currOptions","currEvents","init","OverlayScrollbarsComponent","props","ref","element","children","other","Tag","elementRef","childrenRef","initialize","osInstance","elm","childrenElm","useImperativeHandle","React","OverlayScrollbarsComponentForwardedRef","forwardRef"],"mappings":"wIA6BMA,EAAc,IAAa,CAE3B,GAAA,OAAO,OAAW,IAAa,CAGjC,MAAMC,EAAO,IAAM,CAAA,EACZ,MAAA,CAACA,EAAMA,CAAI,CACpB,CAGI,IAAAC,EACAC,EACJ,MAAMC,EAAM,OACNC,EAAgB,OAAOD,EAAI,qBAAwB,WACnDE,EAAMF,EAAI,sBACVG,EAAMH,EAAI,qBACVI,EAAQH,EAAgBD,EAAI,oBAAsBE,EAClDG,EAAQJ,EAAgBD,EAAI,mBAAqBG,EACjDG,EAAQ,IAAM,CAClBD,EAAMP,CAAM,EACZK,EAAIJ,CAAK,CAAA,EAGJ,MAAA,CACL,CAACQ,EAAUC,IAAY,CACfF,IACGR,EAAAM,EACPH,EACI,IAAM,CACEK,IAENP,EAAQG,EAAIK,CAAQ,CAAA,EAEtBA,EACJ,OAAOC,GAAY,SAAWA,EAAU,CAAE,QAAS,IAAK,CAAA,CAE5D,EACAF,CAAA,CAEJ,EASaG,EACXC,GACuE,CACvE,KAAM,CAAE,QAAAF,EAAS,OAAAG,EAAQ,MAAAC,CAAM,EAAIF,GAAU,CAAA,EACvC,CAACG,EAAcC,CAAW,EAAIC,EAAAA,QAAenB,EAAa,CAAA,CAAE,EAC5DoB,EAAcC,SAAiD,IAAI,EACnEC,EAAWD,SAAOL,CAAK,EACvBO,EAAaF,SAAOT,CAAO,EAC3BY,EAAYH,SAAON,CAAM,EAE/BU,OAAAA,EAAAA,UAAU,IAAM,CACdH,EAAS,QAAUN,CAAA,EAClB,CAACA,CAAK,CAAC,EAEVS,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASC,CAAa,EAAAN,EAE9BG,EAAW,QAAUX,EAEjBe,EAAA,kBAAkB,MAAMD,CAAQ,GAClCA,EAAS,QAAQd,GAAW,CAAC,EAAG,EAAI,CACtC,EACC,CAACA,CAAO,CAAC,EAEZa,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASC,CAAa,EAAAN,EAE9BI,EAAU,QAAUT,EAEhBY,EAAA,kBAAkB,MAAMD,CAAQ,GAClCA,EAAS,GAAGX,GAAU,CAAC,EAAG,EAAI,CAChC,EACC,CAACA,CAAM,CAAC,EAEXU,EAAA,UACE,IAAM,IAAM,OACEP,KACZU,EAAAR,EAAY,UAAZ,MAAAQ,EAAqB,SACvB,EACA,CAAC,CAAA,EAGIT,EAAA,QACL,IAAM,CACHU,GAAW,CAEV,MAAMC,EAAkBV,EAAY,QAChC,GAAAO,EAAA,kBAAkB,MAAMG,CAAe,EACzC,OAGF,MAAMC,EAAYT,EAAS,QACrBU,EAAcT,EAAW,SAAW,GACpCU,EAAaT,EAAU,SAAW,GAClCU,EAAO,IACVd,EAAY,QAAUO,EAAkB,kBAAAE,EAAQG,EAAaC,CAAU,EAEtEF,EACFd,EAAaiB,EAAMH,CAAS,EAEvBG,GAET,EACA,IAAMd,EAAY,OACpB,EACA,CAAC,CAAA,CAEL,ECjHMe,EAA6B,CACjCC,EACAC,IACG,CACG,KAAA,CAAE,QAAAC,EAAU,MAAO,QAAA1B,EAAS,OAAAG,EAAQ,MAAAC,EAAO,SAAAuB,EAAU,GAAGC,CAAU,EAAAJ,EAClEK,EAAMH,EACNI,EAAarB,SAAsB,IAAI,EACvCsB,EAActB,SAAuB,IAAI,EACzC,CAACuB,EAAYC,CAAU,EAAIhC,EAAqB,CAAE,QAAAD,EAAS,OAAAG,EAAQ,MAAAC,CAAA,CAAO,EAEhFS,OAAAA,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASqB,CAAQ,EAAAJ,EACnB,CAAE,QAASK,CAAgB,EAAAJ,EACjC,OAAIG,GAAOC,GACEH,EAAA,CACT,OAAQE,EACR,SAAU,CACR,SAAUC,EACV,QAASA,CACX,CAAA,CACD,EAEI,IAAM,OAAA,OAAAnB,EAAAiB,MAAA,YAAAjB,EAAc,UAAQ,EAClC,CAACgB,EAAYN,CAAO,CAAC,EAExBU,EAAA,oBACEX,EACA,KACS,CACL,WAAAQ,EACA,WAAY,IAAMH,EAAW,OAAA,GAGjC,CAAC,CAAA,EAKAO,EAAA,cAAAR,EAAA,CAAI,oCAAkC,GAAG,IAAKC,EAAa,GAAGF,CAC7D,EAAAS,EAAA,cAAC,OAAI,kCAAgC,GAAG,IAAKN,GAC1CJ,CACH,CACF,CAEJ,EAEMW,EAAyCC,aAAWhB,CAA0B"}
1
+ {"version":3,"file":"overlayscrollbars-react.cjs.js","sources":["../src/useOverlayScrollbars.ts","../src/OverlayScrollbarsComponent.tsx"],"sourcesContent":["// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nimport React, { useEffect, useMemo, useRef } from 'react';\r\nimport { OverlayScrollbars } from 'overlayscrollbars';\r\nimport type { InitializationTarget } from 'overlayscrollbars';\r\nimport type {\r\n OverlayScrollbarsComponentProps,\r\n OverlayScrollbarsComponentRef,\r\n} from './OverlayScrollbarsComponent';\r\n\r\ntype Defer = [\r\n requestDefer: (callback: () => any, options?: OverlayScrollbarsComponentProps['defer']) => void,\r\n cancelDefer: () => void\r\n];\r\n\r\nexport interface UseOverlayScrollbarsParams {\r\n /** OverlayScrollbars options. */\r\n options?: OverlayScrollbarsComponentProps['options'];\r\n /** OverlayScrollbars events. */\r\n events?: OverlayScrollbarsComponentProps['events'];\r\n /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */\r\n defer?: OverlayScrollbarsComponentProps['defer'];\r\n}\r\n\r\nexport type UseOverlayScrollbarsInitialization = (target: InitializationTarget) => void;\r\n\r\nexport type UseOverlayScrollbarsInstance = () => ReturnType<\r\n OverlayScrollbarsComponentRef['osInstance']\r\n>;\r\n\r\nconst createDefer = (): Defer => {\r\n /* c8 ignore start */\r\n if (typeof window === 'undefined') {\r\n // mock ssr calls with \"noop\"\r\n // eslint-disable-next-line @typescript-eslint/no-empty-function\r\n const noop = () => {};\r\n return [noop, noop];\r\n }\r\n /* c8 ignore end */\r\n\r\n let idleId: number;\r\n let rafId: number;\r\n const wnd = window;\r\n const idleSupported = typeof wnd.requestIdleCallback === 'function';\r\n const rAF = wnd.requestAnimationFrame;\r\n const cAF = wnd.cancelAnimationFrame;\r\n const rIdle = idleSupported ? wnd.requestIdleCallback : rAF;\r\n const cIdle = idleSupported ? wnd.cancelIdleCallback : cAF;\r\n const clear = () => {\r\n cIdle(idleId);\r\n cAF(rafId);\r\n };\r\n\r\n return [\r\n (callback, options) => {\r\n clear();\r\n idleId = rIdle(\r\n idleSupported\r\n ? () => {\r\n clear();\r\n // inside idle its best practice to use rAF to change DOM for best performance\r\n rafId = rAF(callback);\r\n }\r\n : callback,\r\n typeof options === 'object' ? options : { timeout: 2233 }\r\n );\r\n },\r\n clear,\r\n ];\r\n};\r\n\r\n/**\r\n * Hook for advanced usage of OverlayScrollbars. (When the OverlayScrollbarsComponent is not enough)\r\n * @param params Parameters for customization.\r\n * @returns A tuple with two values:\r\n * The first value is the initialization function, it takes one argument which is the `InitializationTarget`.\r\n * The second value is a function which returns the current OverlayScrollbars instance or `null` if not initialized.\r\n */\r\nexport const useOverlayScrollbars = (\r\n params?: UseOverlayScrollbarsParams\r\n): [UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance] => {\r\n const { options, events, defer } = params || {};\r\n const [requestDefer, cancelDefer] = useMemo<Defer>(createDefer, []);\r\n const instanceRef = useRef<ReturnType<UseOverlayScrollbarsInstance>>(null);\r\n const deferRef = useRef(defer);\r\n const optionsRef = useRef(options);\r\n const eventsRef = useRef(events);\r\n\r\n useEffect(() => {\r\n deferRef.current = defer;\r\n }, [defer]);\r\n\r\n useEffect(() => {\r\n const { current: instance } = instanceRef;\r\n\r\n optionsRef.current = options;\r\n\r\n if (OverlayScrollbars.valid(instance)) {\r\n instance.options(options || {}, true);\r\n }\r\n }, [options]);\r\n\r\n useEffect(() => {\r\n const { current: instance } = instanceRef;\r\n\r\n eventsRef.current = events;\r\n\r\n if (OverlayScrollbars.valid(instance)) {\r\n instance.on(events || {}, true);\r\n }\r\n }, [events]);\r\n\r\n useEffect(\r\n () => () => {\r\n cancelDefer();\r\n instanceRef.current?.destroy();\r\n },\r\n []\r\n );\r\n\r\n return useMemo<[UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance]>(\r\n () => [\r\n (target) => {\r\n // if already initialized do nothing\r\n const presentInstance = instanceRef.current;\r\n if (OverlayScrollbars.valid(presentInstance)) {\r\n return;\r\n }\r\n\r\n const currDefer = deferRef.current;\r\n const currOptions = optionsRef.current || {};\r\n const currEvents = eventsRef.current || {};\r\n const init = () =>\r\n (instanceRef.current = OverlayScrollbars(target, currOptions, currEvents));\r\n\r\n if (currDefer) {\r\n requestDefer(init, currDefer);\r\n } else {\r\n init();\r\n }\r\n },\r\n () => instanceRef.current,\r\n ],\r\n []\r\n );\r\n};\r\n","// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nimport React, { forwardRef, useEffect, useRef, useImperativeHandle } from 'react';\r\nimport type { OverlayScrollbars } from 'overlayscrollbars';\r\nimport type { PartialOptions, EventListeners } from 'overlayscrollbars';\r\nimport type {\r\n ComponentPropsWithoutRef,\r\n ElementRef,\r\n ElementType,\r\n ForwardedRef,\r\n ReactElement,\r\n} from 'react';\r\nimport { useOverlayScrollbars } from './useOverlayScrollbars';\r\n\r\ntype OverlayScrollbarsComponentBaseProps<T extends ElementType = 'div'> =\r\n ComponentPropsWithoutRef<T> & {\r\n /** Tag of the root element. */\r\n element?: T;\r\n /** OverlayScrollbars options. */\r\n options?: PartialOptions | false | null;\r\n /** OverlayScrollbars events. */\r\n events?: EventListeners | false | null;\r\n /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */\r\n defer?: boolean | IdleRequestOptions;\r\n };\r\n\r\nexport type OverlayScrollbarsComponentProps<T extends ElementType = 'div'> =\r\n OverlayScrollbarsComponentBaseProps<T> & {\r\n ref?: ForwardedRef<OverlayScrollbarsComponentRef<T>>;\r\n };\r\n\r\nexport interface OverlayScrollbarsComponentRef<T extends ElementType = 'div'> {\r\n /** Returns the OverlayScrollbars instance or null if not initialized. */\r\n osInstance(): OverlayScrollbars | null;\r\n /** Returns the root element. */\r\n getElement(): ElementRef<T> | null;\r\n}\r\n\r\nconst OverlayScrollbarsComponent = <T extends ElementType = 'div'>(\r\n props: OverlayScrollbarsComponentBaseProps<T>,\r\n ref: ForwardedRef<OverlayScrollbarsComponentRef<T>>\r\n): ReactElement | null => {\r\n const { element = 'div', options, events, defer, children, ...other } = props;\r\n const Tag = element;\r\n const elementRef = useRef<ElementRef<T>>(null);\r\n const childrenRef = useRef<HTMLDivElement>(null);\r\n const [initialize, osInstance] = useOverlayScrollbars({ options, events, defer });\r\n\r\n useEffect(() => {\r\n const { current: elm } = elementRef;\r\n const { current: contentsElm } = childrenRef;\r\n\r\n /* c8 ignore start */\r\n if (!elm) {\r\n return;\r\n }\r\n /* c8 ignore end */\r\n\r\n const target = elm as unknown as HTMLElement;\r\n\r\n initialize(\r\n element === 'body'\r\n ? {\r\n target,\r\n cancel: {\r\n body: null,\r\n },\r\n }\r\n : {\r\n target,\r\n elements: {\r\n viewport: contentsElm,\r\n content: contentsElm,\r\n },\r\n }\r\n );\r\n\r\n return () => osInstance()?.destroy();\r\n }, [initialize, element]);\r\n\r\n useImperativeHandle(\r\n ref,\r\n () => {\r\n return {\r\n osInstance,\r\n getElement: () => elementRef.current,\r\n };\r\n },\r\n []\r\n );\r\n\r\n return (\r\n // @ts-ignore\r\n <Tag data-overlayscrollbars-initialize=\"\" ref={elementRef} {...other}>\r\n {element === 'body' ? (\r\n children\r\n ) : (\r\n <div data-overlayscrollbars-contents=\"\" ref={childrenRef}>\r\n {children}\r\n </div>\r\n )}\r\n </Tag>\r\n );\r\n};\r\n\r\nconst OverlayScrollbarsComponentForwardedRef = forwardRef(OverlayScrollbarsComponent) as <\r\n T extends ElementType = 'div'\r\n>(\r\n props: OverlayScrollbarsComponentProps<T>\r\n) => ReturnType<typeof OverlayScrollbarsComponent>;\r\n\r\nexport { OverlayScrollbarsComponentForwardedRef as OverlayScrollbarsComponent };\r\n"],"names":["createDefer","noop","idleId","rafId","wnd","idleSupported","rAF","cAF","rIdle","cIdle","clear","callback","options","useOverlayScrollbars","params","events","defer","requestDefer","cancelDefer","useMemo","instanceRef","useRef","deferRef","optionsRef","eventsRef","useEffect","instance","OverlayScrollbars","_a","target","presentInstance","currDefer","currOptions","currEvents","init","OverlayScrollbarsComponent","props","ref","element","children","other","Tag","elementRef","childrenRef","initialize","osInstance","elm","contentsElm","useImperativeHandle","OverlayScrollbarsComponentForwardedRef","forwardRef"],"mappings":"wIA6BMA,EAAc,IAAa,CAE3B,GAAA,OAAO,OAAW,IAAa,CAGjC,MAAMC,EAAO,IAAM,CAAA,EACZ,MAAA,CAACA,EAAMA,CAAI,CACpB,CAGI,IAAAC,EACAC,EACJ,MAAMC,EAAM,OACNC,EAAgB,OAAOD,EAAI,qBAAwB,WACnDE,EAAMF,EAAI,sBACVG,EAAMH,EAAI,qBACVI,EAAQH,EAAgBD,EAAI,oBAAsBE,EAClDG,EAAQJ,EAAgBD,EAAI,mBAAqBG,EACjDG,EAAQ,IAAM,CAClBD,EAAMP,CAAM,EACZK,EAAIJ,CAAK,CAAA,EAGJ,MAAA,CACL,CAACQ,EAAUC,IAAY,CACfF,IACGR,EAAAM,EACPH,EACI,IAAM,CACEK,IAENP,EAAQG,EAAIK,CAAQ,CAAA,EAEtBA,EACJ,OAAOC,GAAY,SAAWA,EAAU,CAAE,QAAS,IAAK,CAAA,CAE5D,EACAF,CAAA,CAEJ,EASaG,EACXC,GACuE,CACvE,KAAM,CAAE,QAAAF,EAAS,OAAAG,EAAQ,MAAAC,CAAM,EAAIF,GAAU,CAAA,EACvC,CAACG,EAAcC,CAAW,EAAIC,EAAAA,QAAenB,EAAa,CAAA,CAAE,EAC5DoB,EAAcC,SAAiD,IAAI,EACnEC,EAAWD,SAAOL,CAAK,EACvBO,EAAaF,SAAOT,CAAO,EAC3BY,EAAYH,SAAON,CAAM,EAE/BU,OAAAA,EAAAA,UAAU,IAAM,CACdH,EAAS,QAAUN,CAAA,EAClB,CAACA,CAAK,CAAC,EAEVS,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASC,CAAa,EAAAN,EAE9BG,EAAW,QAAUX,EAEjBe,EAAA,kBAAkB,MAAMD,CAAQ,GAClCA,EAAS,QAAQd,GAAW,CAAC,EAAG,EAAI,CACtC,EACC,CAACA,CAAO,CAAC,EAEZa,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASC,CAAa,EAAAN,EAE9BI,EAAU,QAAUT,EAEhBY,EAAA,kBAAkB,MAAMD,CAAQ,GAClCA,EAAS,GAAGX,GAAU,CAAC,EAAG,EAAI,CAChC,EACC,CAACA,CAAM,CAAC,EAEXU,EAAA,UACE,IAAM,IAAM,OACEP,KACZU,EAAAR,EAAY,UAAZ,MAAAQ,EAAqB,SACvB,EACA,CAAC,CAAA,EAGIT,EAAA,QACL,IAAM,CACHU,GAAW,CAEV,MAAMC,EAAkBV,EAAY,QAChC,GAAAO,EAAA,kBAAkB,MAAMG,CAAe,EACzC,OAGF,MAAMC,EAAYT,EAAS,QACrBU,EAAcT,EAAW,SAAW,GACpCU,EAAaT,EAAU,SAAW,GAClCU,EAAO,IACVd,EAAY,QAAUO,EAAkB,kBAAAE,EAAQG,EAAaC,CAAU,EAEtEF,EACFd,EAAaiB,EAAMH,CAAS,EAEvBG,GAET,EACA,IAAMd,EAAY,OACpB,EACA,CAAC,CAAA,CAEL,EC3GMe,EAA6B,CACjCC,EACAC,IACwB,CAClB,KAAA,CAAE,QAAAC,EAAU,MAAO,QAAA1B,EAAS,OAAAG,EAAQ,MAAAC,EAAO,SAAAuB,EAAU,GAAGC,CAAU,EAAAJ,EAClEK,EAAMH,EACNI,EAAarB,SAAsB,IAAI,EACvCsB,EAActB,SAAuB,IAAI,EACzC,CAACuB,EAAYC,CAAU,EAAIhC,EAAqB,CAAE,QAAAD,EAAS,OAAAG,EAAQ,MAAAC,CAAA,CAAO,EAEhFS,OAAAA,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASqB,CAAQ,EAAAJ,EACnB,CAAE,QAASK,CAAgB,EAAAJ,EAGjC,GAAI,CAACG,EACH,OAIF,MAAMjB,EAASiB,EAEf,OAAAF,EACEN,IAAY,OACR,CACE,OAAAT,EACA,OAAQ,CACN,KAAM,IACR,CAAA,EAEF,CACE,OAAAA,EACA,SAAU,CACR,SAAUkB,EACV,QAASA,CACX,CACF,CAAA,EAGC,IAAM,OAAA,OAAAnB,EAAAiB,MAAA,YAAAjB,EAAc,UAAQ,EAClC,CAACgB,EAAYN,CAAO,CAAC,EAExBU,EAAA,oBACEX,EACA,KACS,CACL,WAAAQ,EACA,WAAY,IAAMH,EAAW,OAAA,GAGjC,CAAC,CAAA,kBAKAD,EAAI,CAAA,oCAAkC,GAAG,IAAKC,EAAa,GAAGF,CAC5D,EAAAF,IAAY,OACXC,kBAEC,MAAI,CAAA,kCAAgC,GAAG,IAAKI,GAC1CJ,CACH,CAEJ,CAEJ,EAEMU,EAAyCC,aAAWf,CAA0B"}
@@ -1 +1 @@
1
- {"version":3,"file":"overlayscrollbars-react.cjs","sources":["../src/useOverlayScrollbars.ts","../src/OverlayScrollbarsComponent.tsx"],"sourcesContent":["// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nimport React, { useEffect, useMemo, useRef } from 'react';\r\nimport { OverlayScrollbars } from 'overlayscrollbars';\r\nimport type { InitializationTarget } from 'overlayscrollbars';\r\nimport type {\r\n OverlayScrollbarsComponentProps,\r\n OverlayScrollbarsComponentRef,\r\n} from './OverlayScrollbarsComponent';\r\n\r\ntype Defer = [\r\n requestDefer: (callback: () => any, options?: OverlayScrollbarsComponentProps['defer']) => void,\r\n cancelDefer: () => void\r\n];\r\n\r\nexport interface UseOverlayScrollbarsParams {\r\n /** OverlayScrollbars options. */\r\n options?: OverlayScrollbarsComponentProps['options'];\r\n /** OverlayScrollbars events. */\r\n events?: OverlayScrollbarsComponentProps['events'];\r\n /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */\r\n defer?: OverlayScrollbarsComponentProps['defer'];\r\n}\r\n\r\nexport type UseOverlayScrollbarsInitialization = (target: InitializationTarget) => void;\r\n\r\nexport type UseOverlayScrollbarsInstance = () => ReturnType<\r\n OverlayScrollbarsComponentRef['osInstance']\r\n>;\r\n\r\nconst createDefer = (): Defer => {\r\n /* c8 ignore start */\r\n if (typeof window === 'undefined') {\r\n // mock ssr calls with \"noop\"\r\n // eslint-disable-next-line @typescript-eslint/no-empty-function\r\n const noop = () => {};\r\n return [noop, noop];\r\n }\r\n /* c8 ignore end */\r\n\r\n let idleId: number;\r\n let rafId: number;\r\n const wnd = window;\r\n const idleSupported = typeof wnd.requestIdleCallback === 'function';\r\n const rAF = wnd.requestAnimationFrame;\r\n const cAF = wnd.cancelAnimationFrame;\r\n const rIdle = idleSupported ? wnd.requestIdleCallback : rAF;\r\n const cIdle = idleSupported ? wnd.cancelIdleCallback : cAF;\r\n const clear = () => {\r\n cIdle(idleId);\r\n cAF(rafId);\r\n };\r\n\r\n return [\r\n (callback, options) => {\r\n clear();\r\n idleId = rIdle(\r\n idleSupported\r\n ? () => {\r\n clear();\r\n // inside idle its best practice to use rAF to change DOM for best performance\r\n rafId = rAF(callback);\r\n }\r\n : callback,\r\n typeof options === 'object' ? options : { timeout: 2233 }\r\n );\r\n },\r\n clear,\r\n ];\r\n};\r\n\r\n/**\r\n * Hook for advanced usage of OverlayScrollbars. (When the OverlayScrollbarsComponent is not enough)\r\n * @param params Parameters for customization.\r\n * @returns A tuple with two values:\r\n * The first value is the initialization function, it takes one argument which is the `InitializationTarget`.\r\n * The second value is a function which returns the current OverlayScrollbars instance or `null` if not initialized.\r\n */\r\nexport const useOverlayScrollbars = (\r\n params?: UseOverlayScrollbarsParams\r\n): [UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance] => {\r\n const { options, events, defer } = params || {};\r\n const [requestDefer, cancelDefer] = useMemo<Defer>(createDefer, []);\r\n const instanceRef = useRef<ReturnType<UseOverlayScrollbarsInstance>>(null);\r\n const deferRef = useRef(defer);\r\n const optionsRef = useRef(options);\r\n const eventsRef = useRef(events);\r\n\r\n useEffect(() => {\r\n deferRef.current = defer;\r\n }, [defer]);\r\n\r\n useEffect(() => {\r\n const { current: instance } = instanceRef;\r\n\r\n optionsRef.current = options;\r\n\r\n if (OverlayScrollbars.valid(instance)) {\r\n instance.options(options || {}, true);\r\n }\r\n }, [options]);\r\n\r\n useEffect(() => {\r\n const { current: instance } = instanceRef;\r\n\r\n eventsRef.current = events;\r\n\r\n if (OverlayScrollbars.valid(instance)) {\r\n instance.on(events || {}, true);\r\n }\r\n }, [events]);\r\n\r\n useEffect(\r\n () => () => {\r\n cancelDefer();\r\n instanceRef.current?.destroy();\r\n },\r\n []\r\n );\r\n\r\n return useMemo<[UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance]>(\r\n () => [\r\n (target) => {\r\n // if already initialized do nothing\r\n const presentInstance = instanceRef.current;\r\n if (OverlayScrollbars.valid(presentInstance)) {\r\n return;\r\n }\r\n\r\n const currDefer = deferRef.current;\r\n const currOptions = optionsRef.current || {};\r\n const currEvents = eventsRef.current || {};\r\n const init = () =>\r\n (instanceRef.current = OverlayScrollbars(target, currOptions, currEvents));\r\n\r\n if (currDefer) {\r\n requestDefer(init, currDefer);\r\n } else {\r\n init();\r\n }\r\n },\r\n () => instanceRef.current,\r\n ],\r\n []\r\n );\r\n};\r\n","// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nimport React, { forwardRef, useEffect, useRef, useImperativeHandle } from 'react';\r\nimport type { OverlayScrollbars } from 'overlayscrollbars';\r\nimport type { PartialOptions, EventListeners } from 'overlayscrollbars';\r\nimport type { ComponentPropsWithoutRef, ElementRef, ForwardedRef } from 'react';\r\nimport { useOverlayScrollbars } from './useOverlayScrollbars';\r\n\r\ntype OverlayScrollbarsComponentBaseProps<T extends keyof JSX.IntrinsicElements> =\r\n ComponentPropsWithoutRef<T> & {\r\n /** Tag of the root element. */\r\n element?: T;\r\n /** OverlayScrollbars options. */\r\n options?: PartialOptions | false | null;\r\n /** OverlayScrollbars events. */\r\n events?: EventListeners | false | null;\r\n /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */\r\n defer?: boolean | IdleRequestOptions;\r\n };\r\n\r\nexport type OverlayScrollbarsComponentProps<T extends keyof JSX.IntrinsicElements = 'div'> =\r\n OverlayScrollbarsComponentBaseProps<T> & {\r\n ref?: ForwardedRef<OverlayScrollbarsComponentRef<T>>;\r\n };\r\n\r\nexport interface OverlayScrollbarsComponentRef<T extends keyof JSX.IntrinsicElements = 'div'> {\r\n /** Returns the OverlayScrollbars instance or null if not initialized. */\r\n osInstance(): OverlayScrollbars | null;\r\n /** Returns the root element. */\r\n getElement(): ElementRef<T> | null;\r\n}\r\n\r\nconst OverlayScrollbarsComponent = <T extends keyof JSX.IntrinsicElements>(\r\n props: OverlayScrollbarsComponentBaseProps<T>,\r\n ref: ForwardedRef<OverlayScrollbarsComponentRef<T>>\r\n) => {\r\n const { element = 'div', options, events, defer, children, ...other } = props;\r\n const Tag = element;\r\n const elementRef = useRef<ElementRef<T>>(null);\r\n const childrenRef = useRef<HTMLDivElement>(null);\r\n const [initialize, osInstance] = useOverlayScrollbars({ options, events, defer });\r\n\r\n useEffect(() => {\r\n const { current: elm } = elementRef;\r\n const { current: childrenElm } = childrenRef;\r\n if (elm && childrenElm) {\r\n initialize({\r\n target: elm as any,\r\n elements: {\r\n viewport: childrenElm,\r\n content: childrenElm,\r\n },\r\n });\r\n }\r\n return () => osInstance()?.destroy();\r\n }, [initialize, element]);\r\n\r\n useImperativeHandle(\r\n ref,\r\n () => {\r\n return {\r\n osInstance,\r\n getElement: () => elementRef.current,\r\n };\r\n },\r\n []\r\n );\r\n\r\n return (\r\n // @ts-ignore\r\n <Tag data-overlayscrollbars-initialize=\"\" ref={elementRef} {...other}>\r\n <div data-overlayscrollbars-contents=\"\" ref={childrenRef}>\r\n {children}\r\n </div>\r\n </Tag>\r\n );\r\n};\r\n\r\nconst OverlayScrollbarsComponentForwardedRef = forwardRef(OverlayScrollbarsComponent) as <\r\n T extends keyof JSX.IntrinsicElements\r\n>(\r\n props: OverlayScrollbarsComponentProps<T>\r\n) => ReturnType<typeof OverlayScrollbarsComponent>;\r\n\r\nexport { OverlayScrollbarsComponentForwardedRef as OverlayScrollbarsComponent };\r\n"],"names":["createDefer","noop","idleId","rafId","wnd","idleSupported","rAF","cAF","rIdle","cIdle","clear","callback","options","useOverlayScrollbars","params","events","defer","requestDefer","cancelDefer","useMemo","instanceRef","useRef","deferRef","optionsRef","eventsRef","useEffect","instance","OverlayScrollbars","_a","target","presentInstance","currDefer","currOptions","currEvents","init","OverlayScrollbarsComponent","props","ref","element","children","other","Tag","elementRef","childrenRef","initialize","osInstance","elm","childrenElm","useImperativeHandle","React","OverlayScrollbarsComponentForwardedRef","forwardRef"],"mappings":"wIA6BMA,EAAc,IAAa,CAE3B,GAAA,OAAO,OAAW,IAAa,CAGjC,MAAMC,EAAO,IAAM,CAAA,EACZ,MAAA,CAACA,EAAMA,CAAI,CACpB,CAGI,IAAAC,EACAC,EACJ,MAAMC,EAAM,OACNC,EAAgB,OAAOD,EAAI,qBAAwB,WACnDE,EAAMF,EAAI,sBACVG,EAAMH,EAAI,qBACVI,EAAQH,EAAgBD,EAAI,oBAAsBE,EAClDG,EAAQJ,EAAgBD,EAAI,mBAAqBG,EACjDG,EAAQ,IAAM,CAClBD,EAAMP,CAAM,EACZK,EAAIJ,CAAK,CAAA,EAGJ,MAAA,CACL,CAACQ,EAAUC,IAAY,CACfF,IACGR,EAAAM,EACPH,EACI,IAAM,CACEK,IAENP,EAAQG,EAAIK,CAAQ,CAAA,EAEtBA,EACJ,OAAOC,GAAY,SAAWA,EAAU,CAAE,QAAS,IAAK,CAAA,CAE5D,EACAF,CAAA,CAEJ,EASaG,EACXC,GACuE,CACvE,KAAM,CAAE,QAAAF,EAAS,OAAAG,EAAQ,MAAAC,CAAM,EAAIF,GAAU,CAAA,EACvC,CAACG,EAAcC,CAAW,EAAIC,EAAAA,QAAenB,EAAa,CAAA,CAAE,EAC5DoB,EAAcC,SAAiD,IAAI,EACnEC,EAAWD,SAAOL,CAAK,EACvBO,EAAaF,SAAOT,CAAO,EAC3BY,EAAYH,SAAON,CAAM,EAE/BU,OAAAA,EAAAA,UAAU,IAAM,CACdH,EAAS,QAAUN,CAAA,EAClB,CAACA,CAAK,CAAC,EAEVS,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASC,CAAa,EAAAN,EAE9BG,EAAW,QAAUX,EAEjBe,EAAA,kBAAkB,MAAMD,CAAQ,GAClCA,EAAS,QAAQd,GAAW,CAAC,EAAG,EAAI,CACtC,EACC,CAACA,CAAO,CAAC,EAEZa,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASC,CAAa,EAAAN,EAE9BI,EAAU,QAAUT,EAEhBY,EAAA,kBAAkB,MAAMD,CAAQ,GAClCA,EAAS,GAAGX,GAAU,CAAC,EAAG,EAAI,CAChC,EACC,CAACA,CAAM,CAAC,EAEXU,EAAA,UACE,IAAM,IAAM,OACEP,KACZU,EAAAR,EAAY,UAAZ,MAAAQ,EAAqB,SACvB,EACA,CAAC,CAAA,EAGIT,EAAA,QACL,IAAM,CACHU,GAAW,CAEV,MAAMC,EAAkBV,EAAY,QAChC,GAAAO,EAAA,kBAAkB,MAAMG,CAAe,EACzC,OAGF,MAAMC,EAAYT,EAAS,QACrBU,EAAcT,EAAW,SAAW,GACpCU,EAAaT,EAAU,SAAW,GAClCU,EAAO,IACVd,EAAY,QAAUO,EAAkB,kBAAAE,EAAQG,EAAaC,CAAU,EAEtEF,EACFd,EAAaiB,EAAMH,CAAS,EAEvBG,GAET,EACA,IAAMd,EAAY,OACpB,EACA,CAAC,CAAA,CAEL,ECjHMe,EAA6B,CACjCC,EACAC,IACG,CACG,KAAA,CAAE,QAAAC,EAAU,MAAO,QAAA1B,EAAS,OAAAG,EAAQ,MAAAC,EAAO,SAAAuB,EAAU,GAAGC,CAAU,EAAAJ,EAClEK,EAAMH,EACNI,EAAarB,SAAsB,IAAI,EACvCsB,EAActB,SAAuB,IAAI,EACzC,CAACuB,EAAYC,CAAU,EAAIhC,EAAqB,CAAE,QAAAD,EAAS,OAAAG,EAAQ,MAAAC,CAAA,CAAO,EAEhFS,OAAAA,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASqB,CAAQ,EAAAJ,EACnB,CAAE,QAASK,CAAgB,EAAAJ,EACjC,OAAIG,GAAOC,GACEH,EAAA,CACT,OAAQE,EACR,SAAU,CACR,SAAUC,EACV,QAASA,CACX,CAAA,CACD,EAEI,IAAM,OAAA,OAAAnB,EAAAiB,MAAA,YAAAjB,EAAc,UAAQ,EAClC,CAACgB,EAAYN,CAAO,CAAC,EAExBU,EAAA,oBACEX,EACA,KACS,CACL,WAAAQ,EACA,WAAY,IAAMH,EAAW,OAAA,GAGjC,CAAC,CAAA,EAKAO,EAAA,cAAAR,EAAA,CAAI,oCAAkC,GAAG,IAAKC,EAAa,GAAGF,CAC7D,EAAAS,EAAA,cAAC,OAAI,kCAAgC,GAAG,IAAKN,GAC1CJ,CACH,CACF,CAEJ,EAEMW,EAAyCC,aAAWhB,CAA0B"}
1
+ {"version":3,"file":"overlayscrollbars-react.cjs","sources":["../src/useOverlayScrollbars.ts","../src/OverlayScrollbarsComponent.tsx"],"sourcesContent":["// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nimport React, { useEffect, useMemo, useRef } from 'react';\r\nimport { OverlayScrollbars } from 'overlayscrollbars';\r\nimport type { InitializationTarget } from 'overlayscrollbars';\r\nimport type {\r\n OverlayScrollbarsComponentProps,\r\n OverlayScrollbarsComponentRef,\r\n} from './OverlayScrollbarsComponent';\r\n\r\ntype Defer = [\r\n requestDefer: (callback: () => any, options?: OverlayScrollbarsComponentProps['defer']) => void,\r\n cancelDefer: () => void\r\n];\r\n\r\nexport interface UseOverlayScrollbarsParams {\r\n /** OverlayScrollbars options. */\r\n options?: OverlayScrollbarsComponentProps['options'];\r\n /** OverlayScrollbars events. */\r\n events?: OverlayScrollbarsComponentProps['events'];\r\n /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */\r\n defer?: OverlayScrollbarsComponentProps['defer'];\r\n}\r\n\r\nexport type UseOverlayScrollbarsInitialization = (target: InitializationTarget) => void;\r\n\r\nexport type UseOverlayScrollbarsInstance = () => ReturnType<\r\n OverlayScrollbarsComponentRef['osInstance']\r\n>;\r\n\r\nconst createDefer = (): Defer => {\r\n /* c8 ignore start */\r\n if (typeof window === 'undefined') {\r\n // mock ssr calls with \"noop\"\r\n // eslint-disable-next-line @typescript-eslint/no-empty-function\r\n const noop = () => {};\r\n return [noop, noop];\r\n }\r\n /* c8 ignore end */\r\n\r\n let idleId: number;\r\n let rafId: number;\r\n const wnd = window;\r\n const idleSupported = typeof wnd.requestIdleCallback === 'function';\r\n const rAF = wnd.requestAnimationFrame;\r\n const cAF = wnd.cancelAnimationFrame;\r\n const rIdle = idleSupported ? wnd.requestIdleCallback : rAF;\r\n const cIdle = idleSupported ? wnd.cancelIdleCallback : cAF;\r\n const clear = () => {\r\n cIdle(idleId);\r\n cAF(rafId);\r\n };\r\n\r\n return [\r\n (callback, options) => {\r\n clear();\r\n idleId = rIdle(\r\n idleSupported\r\n ? () => {\r\n clear();\r\n // inside idle its best practice to use rAF to change DOM for best performance\r\n rafId = rAF(callback);\r\n }\r\n : callback,\r\n typeof options === 'object' ? options : { timeout: 2233 }\r\n );\r\n },\r\n clear,\r\n ];\r\n};\r\n\r\n/**\r\n * Hook for advanced usage of OverlayScrollbars. (When the OverlayScrollbarsComponent is not enough)\r\n * @param params Parameters for customization.\r\n * @returns A tuple with two values:\r\n * The first value is the initialization function, it takes one argument which is the `InitializationTarget`.\r\n * The second value is a function which returns the current OverlayScrollbars instance or `null` if not initialized.\r\n */\r\nexport const useOverlayScrollbars = (\r\n params?: UseOverlayScrollbarsParams\r\n): [UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance] => {\r\n const { options, events, defer } = params || {};\r\n const [requestDefer, cancelDefer] = useMemo<Defer>(createDefer, []);\r\n const instanceRef = useRef<ReturnType<UseOverlayScrollbarsInstance>>(null);\r\n const deferRef = useRef(defer);\r\n const optionsRef = useRef(options);\r\n const eventsRef = useRef(events);\r\n\r\n useEffect(() => {\r\n deferRef.current = defer;\r\n }, [defer]);\r\n\r\n useEffect(() => {\r\n const { current: instance } = instanceRef;\r\n\r\n optionsRef.current = options;\r\n\r\n if (OverlayScrollbars.valid(instance)) {\r\n instance.options(options || {}, true);\r\n }\r\n }, [options]);\r\n\r\n useEffect(() => {\r\n const { current: instance } = instanceRef;\r\n\r\n eventsRef.current = events;\r\n\r\n if (OverlayScrollbars.valid(instance)) {\r\n instance.on(events || {}, true);\r\n }\r\n }, [events]);\r\n\r\n useEffect(\r\n () => () => {\r\n cancelDefer();\r\n instanceRef.current?.destroy();\r\n },\r\n []\r\n );\r\n\r\n return useMemo<[UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance]>(\r\n () => [\r\n (target) => {\r\n // if already initialized do nothing\r\n const presentInstance = instanceRef.current;\r\n if (OverlayScrollbars.valid(presentInstance)) {\r\n return;\r\n }\r\n\r\n const currDefer = deferRef.current;\r\n const currOptions = optionsRef.current || {};\r\n const currEvents = eventsRef.current || {};\r\n const init = () =>\r\n (instanceRef.current = OverlayScrollbars(target, currOptions, currEvents));\r\n\r\n if (currDefer) {\r\n requestDefer(init, currDefer);\r\n } else {\r\n init();\r\n }\r\n },\r\n () => instanceRef.current,\r\n ],\r\n []\r\n );\r\n};\r\n","// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nimport React, { forwardRef, useEffect, useRef, useImperativeHandle } from 'react';\r\nimport type { OverlayScrollbars } from 'overlayscrollbars';\r\nimport type { PartialOptions, EventListeners } from 'overlayscrollbars';\r\nimport type {\r\n ComponentPropsWithoutRef,\r\n ElementRef,\r\n ElementType,\r\n ForwardedRef,\r\n ReactElement,\r\n} from 'react';\r\nimport { useOverlayScrollbars } from './useOverlayScrollbars';\r\n\r\ntype OverlayScrollbarsComponentBaseProps<T extends ElementType = 'div'> =\r\n ComponentPropsWithoutRef<T> & {\r\n /** Tag of the root element. */\r\n element?: T;\r\n /** OverlayScrollbars options. */\r\n options?: PartialOptions | false | null;\r\n /** OverlayScrollbars events. */\r\n events?: EventListeners | false | null;\r\n /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */\r\n defer?: boolean | IdleRequestOptions;\r\n };\r\n\r\nexport type OverlayScrollbarsComponentProps<T extends ElementType = 'div'> =\r\n OverlayScrollbarsComponentBaseProps<T> & {\r\n ref?: ForwardedRef<OverlayScrollbarsComponentRef<T>>;\r\n };\r\n\r\nexport interface OverlayScrollbarsComponentRef<T extends ElementType = 'div'> {\r\n /** Returns the OverlayScrollbars instance or null if not initialized. */\r\n osInstance(): OverlayScrollbars | null;\r\n /** Returns the root element. */\r\n getElement(): ElementRef<T> | null;\r\n}\r\n\r\nconst OverlayScrollbarsComponent = <T extends ElementType = 'div'>(\r\n props: OverlayScrollbarsComponentBaseProps<T>,\r\n ref: ForwardedRef<OverlayScrollbarsComponentRef<T>>\r\n): ReactElement | null => {\r\n const { element = 'div', options, events, defer, children, ...other } = props;\r\n const Tag = element;\r\n const elementRef = useRef<ElementRef<T>>(null);\r\n const childrenRef = useRef<HTMLDivElement>(null);\r\n const [initialize, osInstance] = useOverlayScrollbars({ options, events, defer });\r\n\r\n useEffect(() => {\r\n const { current: elm } = elementRef;\r\n const { current: contentsElm } = childrenRef;\r\n\r\n /* c8 ignore start */\r\n if (!elm) {\r\n return;\r\n }\r\n /* c8 ignore end */\r\n\r\n const target = elm as unknown as HTMLElement;\r\n\r\n initialize(\r\n element === 'body'\r\n ? {\r\n target,\r\n cancel: {\r\n body: null,\r\n },\r\n }\r\n : {\r\n target,\r\n elements: {\r\n viewport: contentsElm,\r\n content: contentsElm,\r\n },\r\n }\r\n );\r\n\r\n return () => osInstance()?.destroy();\r\n }, [initialize, element]);\r\n\r\n useImperativeHandle(\r\n ref,\r\n () => {\r\n return {\r\n osInstance,\r\n getElement: () => elementRef.current,\r\n };\r\n },\r\n []\r\n );\r\n\r\n return (\r\n // @ts-ignore\r\n <Tag data-overlayscrollbars-initialize=\"\" ref={elementRef} {...other}>\r\n {element === 'body' ? (\r\n children\r\n ) : (\r\n <div data-overlayscrollbars-contents=\"\" ref={childrenRef}>\r\n {children}\r\n </div>\r\n )}\r\n </Tag>\r\n );\r\n};\r\n\r\nconst OverlayScrollbarsComponentForwardedRef = forwardRef(OverlayScrollbarsComponent) as <\r\n T extends ElementType = 'div'\r\n>(\r\n props: OverlayScrollbarsComponentProps<T>\r\n) => ReturnType<typeof OverlayScrollbarsComponent>;\r\n\r\nexport { OverlayScrollbarsComponentForwardedRef as OverlayScrollbarsComponent };\r\n"],"names":["createDefer","noop","idleId","rafId","wnd","idleSupported","rAF","cAF","rIdle","cIdle","clear","callback","options","useOverlayScrollbars","params","events","defer","requestDefer","cancelDefer","useMemo","instanceRef","useRef","deferRef","optionsRef","eventsRef","useEffect","instance","OverlayScrollbars","_a","target","presentInstance","currDefer","currOptions","currEvents","init","OverlayScrollbarsComponent","props","ref","element","children","other","Tag","elementRef","childrenRef","initialize","osInstance","elm","contentsElm","useImperativeHandle","OverlayScrollbarsComponentForwardedRef","forwardRef"],"mappings":"wIA6BMA,EAAc,IAAa,CAE3B,GAAA,OAAO,OAAW,IAAa,CAGjC,MAAMC,EAAO,IAAM,CAAA,EACZ,MAAA,CAACA,EAAMA,CAAI,CACpB,CAGI,IAAAC,EACAC,EACJ,MAAMC,EAAM,OACNC,EAAgB,OAAOD,EAAI,qBAAwB,WACnDE,EAAMF,EAAI,sBACVG,EAAMH,EAAI,qBACVI,EAAQH,EAAgBD,EAAI,oBAAsBE,EAClDG,EAAQJ,EAAgBD,EAAI,mBAAqBG,EACjDG,EAAQ,IAAM,CAClBD,EAAMP,CAAM,EACZK,EAAIJ,CAAK,CAAA,EAGJ,MAAA,CACL,CAACQ,EAAUC,IAAY,CACfF,IACGR,EAAAM,EACPH,EACI,IAAM,CACEK,IAENP,EAAQG,EAAIK,CAAQ,CAAA,EAEtBA,EACJ,OAAOC,GAAY,SAAWA,EAAU,CAAE,QAAS,IAAK,CAAA,CAE5D,EACAF,CAAA,CAEJ,EASaG,EACXC,GACuE,CACvE,KAAM,CAAE,QAAAF,EAAS,OAAAG,EAAQ,MAAAC,CAAM,EAAIF,GAAU,CAAA,EACvC,CAACG,EAAcC,CAAW,EAAIC,EAAAA,QAAenB,EAAa,CAAA,CAAE,EAC5DoB,EAAcC,SAAiD,IAAI,EACnEC,EAAWD,SAAOL,CAAK,EACvBO,EAAaF,SAAOT,CAAO,EAC3BY,EAAYH,SAAON,CAAM,EAE/BU,OAAAA,EAAAA,UAAU,IAAM,CACdH,EAAS,QAAUN,CAAA,EAClB,CAACA,CAAK,CAAC,EAEVS,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASC,CAAa,EAAAN,EAE9BG,EAAW,QAAUX,EAEjBe,EAAA,kBAAkB,MAAMD,CAAQ,GAClCA,EAAS,QAAQd,GAAW,CAAC,EAAG,EAAI,CACtC,EACC,CAACA,CAAO,CAAC,EAEZa,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASC,CAAa,EAAAN,EAE9BI,EAAU,QAAUT,EAEhBY,EAAA,kBAAkB,MAAMD,CAAQ,GAClCA,EAAS,GAAGX,GAAU,CAAC,EAAG,EAAI,CAChC,EACC,CAACA,CAAM,CAAC,EAEXU,EAAA,UACE,IAAM,IAAM,OACEP,KACZU,EAAAR,EAAY,UAAZ,MAAAQ,EAAqB,SACvB,EACA,CAAC,CAAA,EAGIT,EAAA,QACL,IAAM,CACHU,GAAW,CAEV,MAAMC,EAAkBV,EAAY,QAChC,GAAAO,EAAA,kBAAkB,MAAMG,CAAe,EACzC,OAGF,MAAMC,EAAYT,EAAS,QACrBU,EAAcT,EAAW,SAAW,GACpCU,EAAaT,EAAU,SAAW,GAClCU,EAAO,IACVd,EAAY,QAAUO,EAAkB,kBAAAE,EAAQG,EAAaC,CAAU,EAEtEF,EACFd,EAAaiB,EAAMH,CAAS,EAEvBG,GAET,EACA,IAAMd,EAAY,OACpB,EACA,CAAC,CAAA,CAEL,EC3GMe,EAA6B,CACjCC,EACAC,IACwB,CAClB,KAAA,CAAE,QAAAC,EAAU,MAAO,QAAA1B,EAAS,OAAAG,EAAQ,MAAAC,EAAO,SAAAuB,EAAU,GAAGC,CAAU,EAAAJ,EAClEK,EAAMH,EACNI,EAAarB,SAAsB,IAAI,EACvCsB,EAActB,SAAuB,IAAI,EACzC,CAACuB,EAAYC,CAAU,EAAIhC,EAAqB,CAAE,QAAAD,EAAS,OAAAG,EAAQ,MAAAC,CAAA,CAAO,EAEhFS,OAAAA,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASqB,CAAQ,EAAAJ,EACnB,CAAE,QAASK,CAAgB,EAAAJ,EAGjC,GAAI,CAACG,EACH,OAIF,MAAMjB,EAASiB,EAEf,OAAAF,EACEN,IAAY,OACR,CACE,OAAAT,EACA,OAAQ,CACN,KAAM,IACR,CAAA,EAEF,CACE,OAAAA,EACA,SAAU,CACR,SAAUkB,EACV,QAASA,CACX,CACF,CAAA,EAGC,IAAM,OAAA,OAAAnB,EAAAiB,MAAA,YAAAjB,EAAc,UAAQ,EAClC,CAACgB,EAAYN,CAAO,CAAC,EAExBU,EAAA,oBACEX,EACA,KACS,CACL,WAAAQ,EACA,WAAY,IAAMH,EAAW,OAAA,GAGjC,CAAC,CAAA,kBAKAD,EAAI,CAAA,oCAAkC,GAAG,IAAKC,EAAa,GAAGF,CAC5D,EAAAF,IAAY,OACXC,kBAEC,MAAI,CAAA,kCAAgC,GAAG,IAAKI,GAC1CJ,CACH,CAEJ,CAEJ,EAEMU,EAAyCC,aAAWf,CAA0B"}
@@ -1,81 +1,91 @@
1
- import R, { useMemo as w, useRef as f, useEffect as v, forwardRef as C, useImperativeHandle as E } from "react";
1
+ import w, { useMemo as C, useRef as d, useEffect as p, forwardRef as E, useImperativeHandle as O } from "react";
2
2
  import { OverlayScrollbars as I } from "overlayscrollbars";
3
- const O = () => {
3
+ const S = () => {
4
4
  if (typeof window > "u") {
5
5
  const n = () => {
6
6
  };
7
7
  return [n, n];
8
8
  }
9
- let l, c;
10
- const t = window, o = typeof t.requestIdleCallback == "function", a = t.requestAnimationFrame, i = t.cancelAnimationFrame, r = o ? t.requestIdleCallback : a, u = o ? t.cancelIdleCallback : i, s = () => {
11
- u(l), i(c);
9
+ let l, o;
10
+ const t = window, c = typeof t.requestIdleCallback == "function", a = t.requestAnimationFrame, i = t.cancelAnimationFrame, r = c ? t.requestIdleCallback : a, u = c ? t.cancelIdleCallback : i, s = () => {
11
+ u(l), i(o);
12
12
  };
13
13
  return [
14
14
  (n, e) => {
15
15
  s(), l = r(
16
- o ? () => {
17
- s(), c = a(n);
16
+ c ? () => {
17
+ s(), o = a(n);
18
18
  } : n,
19
19
  typeof e == "object" ? e : { timeout: 2233 }
20
20
  );
21
21
  },
22
22
  s
23
23
  ];
24
- }, S = (l) => {
25
- const { options: c, events: t, defer: o } = l || {}, [a, i] = w(O, []), r = f(null), u = f(o), s = f(c), n = f(t);
26
- return v(() => {
27
- u.current = o;
28
- }, [o]), v(() => {
24
+ }, F = (l) => {
25
+ const { options: o, events: t, defer: c } = l || {}, [a, i] = C(S, []), r = d(null), u = d(c), s = d(o), n = d(t);
26
+ return p(() => {
27
+ u.current = c;
28
+ }, [c]), p(() => {
29
29
  const { current: e } = r;
30
- s.current = c, I.valid(e) && e.options(c || {}, !0);
31
- }, [c]), v(() => {
30
+ s.current = o, I.valid(e) && e.options(o || {}, !0);
31
+ }, [o]), p(() => {
32
32
  const { current: e } = r;
33
33
  n.current = t, I.valid(e) && e.on(t || {}, !0);
34
- }, [t]), v(
34
+ }, [t]), p(
35
35
  () => () => {
36
36
  var e;
37
37
  i(), (e = r.current) == null || e.destroy();
38
38
  },
39
39
  []
40
- ), w(
40
+ ), C(
41
41
  () => [
42
42
  (e) => {
43
- const y = r.current;
44
- if (I.valid(y))
43
+ const v = r.current;
44
+ if (I.valid(v))
45
45
  return;
46
- const d = u.current, b = s.current || {}, m = n.current || {}, p = () => r.current = I(e, b, m);
47
- d ? a(p, d) : p();
46
+ const f = u.current, y = s.current || {}, b = n.current || {}, m = () => r.current = I(e, y, b);
47
+ f ? a(m, f) : m();
48
48
  },
49
49
  () => r.current
50
50
  ],
51
51
  []
52
52
  );
53
- }, F = (l, c) => {
54
- const { element: t = "div", options: o, events: a, defer: i, children: r, ...u } = l, s = t, n = f(null), e = f(null), [y, d] = S({ options: o, events: a, defer: i });
55
- return v(() => {
56
- const { current: b } = n, { current: m } = e;
57
- return b && m && y({
58
- target: b,
59
- elements: {
60
- viewport: m,
61
- content: m
53
+ }, q = (l, o) => {
54
+ const { element: t = "div", options: c, events: a, defer: i, children: r, ...u } = l, s = t, n = d(null), e = d(null), [v, f] = F({ options: c, events: a, defer: i });
55
+ return p(() => {
56
+ const { current: y } = n, { current: b } = e;
57
+ if (!y)
58
+ return;
59
+ const m = y;
60
+ return v(
61
+ t === "body" ? {
62
+ target: m,
63
+ cancel: {
64
+ body: null
65
+ }
66
+ } : {
67
+ target: m,
68
+ elements: {
69
+ viewport: b,
70
+ content: b
71
+ }
62
72
  }
63
- }), () => {
64
- var p;
65
- return (p = d()) == null ? void 0 : p.destroy();
73
+ ), () => {
74
+ var R;
75
+ return (R = f()) == null ? void 0 : R.destroy();
66
76
  };
67
- }, [y, t]), E(
68
- c,
77
+ }, [v, t]), O(
78
+ o,
69
79
  () => ({
70
- osInstance: d,
80
+ osInstance: f,
71
81
  getElement: () => n.current
72
82
  }),
73
83
  []
74
84
  ), // @ts-ignore
75
- /* @__PURE__ */ R.createElement(s, { "data-overlayscrollbars-initialize": "", ref: n, ...u }, /* @__PURE__ */ R.createElement("div", { "data-overlayscrollbars-contents": "", ref: e }, r));
76
- }, A = C(F);
85
+ /* @__PURE__ */ w.createElement(s, { "data-overlayscrollbars-initialize": "", ref: n, ...u }, t === "body" ? r : /* @__PURE__ */ w.createElement("div", { "data-overlayscrollbars-contents": "", ref: e }, r));
86
+ }, g = E(q);
77
87
  export {
78
- A as OverlayScrollbarsComponent,
79
- S as useOverlayScrollbars
88
+ g as OverlayScrollbarsComponent,
89
+ F as useOverlayScrollbars
80
90
  };
81
91
  //# sourceMappingURL=overlayscrollbars-react.esm.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"overlayscrollbars-react.esm.js","sources":["../src/useOverlayScrollbars.ts","../src/OverlayScrollbarsComponent.tsx"],"sourcesContent":["// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nimport React, { useEffect, useMemo, useRef } from 'react';\r\nimport { OverlayScrollbars } from 'overlayscrollbars';\r\nimport type { InitializationTarget } from 'overlayscrollbars';\r\nimport type {\r\n OverlayScrollbarsComponentProps,\r\n OverlayScrollbarsComponentRef,\r\n} from './OverlayScrollbarsComponent';\r\n\r\ntype Defer = [\r\n requestDefer: (callback: () => any, options?: OverlayScrollbarsComponentProps['defer']) => void,\r\n cancelDefer: () => void\r\n];\r\n\r\nexport interface UseOverlayScrollbarsParams {\r\n /** OverlayScrollbars options. */\r\n options?: OverlayScrollbarsComponentProps['options'];\r\n /** OverlayScrollbars events. */\r\n events?: OverlayScrollbarsComponentProps['events'];\r\n /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */\r\n defer?: OverlayScrollbarsComponentProps['defer'];\r\n}\r\n\r\nexport type UseOverlayScrollbarsInitialization = (target: InitializationTarget) => void;\r\n\r\nexport type UseOverlayScrollbarsInstance = () => ReturnType<\r\n OverlayScrollbarsComponentRef['osInstance']\r\n>;\r\n\r\nconst createDefer = (): Defer => {\r\n /* c8 ignore start */\r\n if (typeof window === 'undefined') {\r\n // mock ssr calls with \"noop\"\r\n // eslint-disable-next-line @typescript-eslint/no-empty-function\r\n const noop = () => {};\r\n return [noop, noop];\r\n }\r\n /* c8 ignore end */\r\n\r\n let idleId: number;\r\n let rafId: number;\r\n const wnd = window;\r\n const idleSupported = typeof wnd.requestIdleCallback === 'function';\r\n const rAF = wnd.requestAnimationFrame;\r\n const cAF = wnd.cancelAnimationFrame;\r\n const rIdle = idleSupported ? wnd.requestIdleCallback : rAF;\r\n const cIdle = idleSupported ? wnd.cancelIdleCallback : cAF;\r\n const clear = () => {\r\n cIdle(idleId);\r\n cAF(rafId);\r\n };\r\n\r\n return [\r\n (callback, options) => {\r\n clear();\r\n idleId = rIdle(\r\n idleSupported\r\n ? () => {\r\n clear();\r\n // inside idle its best practice to use rAF to change DOM for best performance\r\n rafId = rAF(callback);\r\n }\r\n : callback,\r\n typeof options === 'object' ? options : { timeout: 2233 }\r\n );\r\n },\r\n clear,\r\n ];\r\n};\r\n\r\n/**\r\n * Hook for advanced usage of OverlayScrollbars. (When the OverlayScrollbarsComponent is not enough)\r\n * @param params Parameters for customization.\r\n * @returns A tuple with two values:\r\n * The first value is the initialization function, it takes one argument which is the `InitializationTarget`.\r\n * The second value is a function which returns the current OverlayScrollbars instance or `null` if not initialized.\r\n */\r\nexport const useOverlayScrollbars = (\r\n params?: UseOverlayScrollbarsParams\r\n): [UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance] => {\r\n const { options, events, defer } = params || {};\r\n const [requestDefer, cancelDefer] = useMemo<Defer>(createDefer, []);\r\n const instanceRef = useRef<ReturnType<UseOverlayScrollbarsInstance>>(null);\r\n const deferRef = useRef(defer);\r\n const optionsRef = useRef(options);\r\n const eventsRef = useRef(events);\r\n\r\n useEffect(() => {\r\n deferRef.current = defer;\r\n }, [defer]);\r\n\r\n useEffect(() => {\r\n const { current: instance } = instanceRef;\r\n\r\n optionsRef.current = options;\r\n\r\n if (OverlayScrollbars.valid(instance)) {\r\n instance.options(options || {}, true);\r\n }\r\n }, [options]);\r\n\r\n useEffect(() => {\r\n const { current: instance } = instanceRef;\r\n\r\n eventsRef.current = events;\r\n\r\n if (OverlayScrollbars.valid(instance)) {\r\n instance.on(events || {}, true);\r\n }\r\n }, [events]);\r\n\r\n useEffect(\r\n () => () => {\r\n cancelDefer();\r\n instanceRef.current?.destroy();\r\n },\r\n []\r\n );\r\n\r\n return useMemo<[UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance]>(\r\n () => [\r\n (target) => {\r\n // if already initialized do nothing\r\n const presentInstance = instanceRef.current;\r\n if (OverlayScrollbars.valid(presentInstance)) {\r\n return;\r\n }\r\n\r\n const currDefer = deferRef.current;\r\n const currOptions = optionsRef.current || {};\r\n const currEvents = eventsRef.current || {};\r\n const init = () =>\r\n (instanceRef.current = OverlayScrollbars(target, currOptions, currEvents));\r\n\r\n if (currDefer) {\r\n requestDefer(init, currDefer);\r\n } else {\r\n init();\r\n }\r\n },\r\n () => instanceRef.current,\r\n ],\r\n []\r\n );\r\n};\r\n","// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nimport React, { forwardRef, useEffect, useRef, useImperativeHandle } from 'react';\r\nimport type { OverlayScrollbars } from 'overlayscrollbars';\r\nimport type { PartialOptions, EventListeners } from 'overlayscrollbars';\r\nimport type { ComponentPropsWithoutRef, ElementRef, ForwardedRef } from 'react';\r\nimport { useOverlayScrollbars } from './useOverlayScrollbars';\r\n\r\ntype OverlayScrollbarsComponentBaseProps<T extends keyof JSX.IntrinsicElements> =\r\n ComponentPropsWithoutRef<T> & {\r\n /** Tag of the root element. */\r\n element?: T;\r\n /** OverlayScrollbars options. */\r\n options?: PartialOptions | false | null;\r\n /** OverlayScrollbars events. */\r\n events?: EventListeners | false | null;\r\n /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */\r\n defer?: boolean | IdleRequestOptions;\r\n };\r\n\r\nexport type OverlayScrollbarsComponentProps<T extends keyof JSX.IntrinsicElements = 'div'> =\r\n OverlayScrollbarsComponentBaseProps<T> & {\r\n ref?: ForwardedRef<OverlayScrollbarsComponentRef<T>>;\r\n };\r\n\r\nexport interface OverlayScrollbarsComponentRef<T extends keyof JSX.IntrinsicElements = 'div'> {\r\n /** Returns the OverlayScrollbars instance or null if not initialized. */\r\n osInstance(): OverlayScrollbars | null;\r\n /** Returns the root element. */\r\n getElement(): ElementRef<T> | null;\r\n}\r\n\r\nconst OverlayScrollbarsComponent = <T extends keyof JSX.IntrinsicElements>(\r\n props: OverlayScrollbarsComponentBaseProps<T>,\r\n ref: ForwardedRef<OverlayScrollbarsComponentRef<T>>\r\n) => {\r\n const { element = 'div', options, events, defer, children, ...other } = props;\r\n const Tag = element;\r\n const elementRef = useRef<ElementRef<T>>(null);\r\n const childrenRef = useRef<HTMLDivElement>(null);\r\n const [initialize, osInstance] = useOverlayScrollbars({ options, events, defer });\r\n\r\n useEffect(() => {\r\n const { current: elm } = elementRef;\r\n const { current: childrenElm } = childrenRef;\r\n if (elm && childrenElm) {\r\n initialize({\r\n target: elm as any,\r\n elements: {\r\n viewport: childrenElm,\r\n content: childrenElm,\r\n },\r\n });\r\n }\r\n return () => osInstance()?.destroy();\r\n }, [initialize, element]);\r\n\r\n useImperativeHandle(\r\n ref,\r\n () => {\r\n return {\r\n osInstance,\r\n getElement: () => elementRef.current,\r\n };\r\n },\r\n []\r\n );\r\n\r\n return (\r\n // @ts-ignore\r\n <Tag data-overlayscrollbars-initialize=\"\" ref={elementRef} {...other}>\r\n <div data-overlayscrollbars-contents=\"\" ref={childrenRef}>\r\n {children}\r\n </div>\r\n </Tag>\r\n );\r\n};\r\n\r\nconst OverlayScrollbarsComponentForwardedRef = forwardRef(OverlayScrollbarsComponent) as <\r\n T extends keyof JSX.IntrinsicElements\r\n>(\r\n props: OverlayScrollbarsComponentProps<T>\r\n) => ReturnType<typeof OverlayScrollbarsComponent>;\r\n\r\nexport { OverlayScrollbarsComponentForwardedRef as OverlayScrollbarsComponent };\r\n"],"names":["createDefer","noop","idleId","rafId","wnd","idleSupported","rAF","cAF","rIdle","cIdle","clear","callback","options","useOverlayScrollbars","params","events","defer","requestDefer","cancelDefer","useMemo","instanceRef","useRef","deferRef","optionsRef","eventsRef","useEffect","instance","OverlayScrollbars","_a","target","presentInstance","currDefer","currOptions","currEvents","init","OverlayScrollbarsComponent","props","ref","element","children","other","Tag","elementRef","childrenRef","initialize","osInstance","elm","childrenElm","useImperativeHandle","React","OverlayScrollbarsComponentForwardedRef","forwardRef"],"mappings":";;AA6BA,MAAMA,IAAc,MAAa;AAE3B,MAAA,OAAO,SAAW,KAAa;AAGjC,UAAMC,IAAO,MAAM;AAAA,IAAA;AACZ,WAAA,CAACA,GAAMA,CAAI;AAAA,EACpB;AAGI,MAAAC,GACAC;AACJ,QAAMC,IAAM,QACNC,IAAgB,OAAOD,EAAI,uBAAwB,YACnDE,IAAMF,EAAI,uBACVG,IAAMH,EAAI,sBACVI,IAAQH,IAAgBD,EAAI,sBAAsBE,GAClDG,IAAQJ,IAAgBD,EAAI,qBAAqBG,GACjDG,IAAQ,MAAM;AAClB,IAAAD,EAAMP,CAAM,GACZK,EAAIJ,CAAK;AAAA,EAAA;AAGJ,SAAA;AAAA,IACL,CAACQ,GAAUC,MAAY;AACf,MAAAF,KACGR,IAAAM;AAAA,QACPH,IACI,MAAM;AACE,UAAAK,KAENP,IAAQG,EAAIK,CAAQ;AAAA,QAAA,IAEtBA;AAAA,QACJ,OAAOC,KAAY,WAAWA,IAAU,EAAE,SAAS,KAAK;AAAA,MAAA;AAAA,IAE5D;AAAA,IACAF;AAAA,EAAA;AAEJ,GASaG,IAAuB,CAClCC,MACuE;AACvE,QAAM,EAAE,SAAAF,GAAS,QAAAG,GAAQ,OAAAC,EAAM,IAAIF,KAAU,CAAA,GACvC,CAACG,GAAcC,CAAW,IAAIC,EAAenB,GAAa,CAAA,CAAE,GAC5DoB,IAAcC,EAAiD,IAAI,GACnEC,IAAWD,EAAOL,CAAK,GACvBO,IAAaF,EAAOT,CAAO,GAC3BY,IAAYH,EAAON,CAAM;AAE/B,SAAAU,EAAU,MAAM;AACd,IAAAH,EAAS,UAAUN;AAAA,EAAA,GAClB,CAACA,CAAK,CAAC,GAEVS,EAAU,MAAM;AACR,UAAA,EAAE,SAASC,EAAa,IAAAN;AAE9B,IAAAG,EAAW,UAAUX,GAEjBe,EAAkB,MAAMD,CAAQ,KAClCA,EAAS,QAAQd,KAAW,CAAC,GAAG,EAAI;AAAA,EACtC,GACC,CAACA,CAAO,CAAC,GAEZa,EAAU,MAAM;AACR,UAAA,EAAE,SAASC,EAAa,IAAAN;AAE9B,IAAAI,EAAU,UAAUT,GAEhBY,EAAkB,MAAMD,CAAQ,KAClCA,EAAS,GAAGX,KAAU,CAAC,GAAG,EAAI;AAAA,EAChC,GACC,CAACA,CAAM,CAAC,GAEXU;AAAA,IACE,MAAM,MAAM;;AACE,MAAAP,MACZU,IAAAR,EAAY,YAAZ,QAAAQ,EAAqB;AAAA,IACvB;AAAA,IACA,CAAC;AAAA,EAAA,GAGIT;AAAA,IACL,MAAM;AAAA,MACJ,CAACU,MAAW;AAEV,cAAMC,IAAkBV,EAAY;AAChC,YAAAO,EAAkB,MAAMG,CAAe;AACzC;AAGF,cAAMC,IAAYT,EAAS,SACrBU,IAAcT,EAAW,WAAW,IACpCU,IAAaT,EAAU,WAAW,IAClCU,IAAO,MACVd,EAAY,UAAUO,EAAkBE,GAAQG,GAAaC,CAAU;AAE1E,QAAIF,IACFd,EAAaiB,GAAMH,CAAS,IAEvBG;MAET;AAAA,MACA,MAAMd,EAAY;AAAA,IACpB;AAAA,IACA,CAAC;AAAA,EAAA;AAEL,GCjHMe,IAA6B,CACjCC,GACAC,MACG;AACG,QAAA,EAAE,SAAAC,IAAU,OAAO,SAAA1B,GAAS,QAAAG,GAAQ,OAAAC,GAAO,UAAAuB,GAAU,GAAGC,EAAU,IAAAJ,GAClEK,IAAMH,GACNI,IAAarB,EAAsB,IAAI,GACvCsB,IAActB,EAAuB,IAAI,GACzC,CAACuB,GAAYC,CAAU,IAAIhC,EAAqB,EAAE,SAAAD,GAAS,QAAAG,GAAQ,OAAAC,EAAA,CAAO;AAEhF,SAAAS,EAAU,MAAM;AACR,UAAA,EAAE,SAASqB,EAAQ,IAAAJ,GACnB,EAAE,SAASK,EAAgB,IAAAJ;AACjC,WAAIG,KAAOC,KACEH,EAAA;AAAA,MACT,QAAQE;AAAA,MACR,UAAU;AAAA,QACR,UAAUC;AAAA,QACV,SAASA;AAAA,MACX;AAAA,IAAA,CACD,GAEI,MAAM;;AAAA,cAAAnB,IAAAiB,QAAA,gBAAAjB,EAAc;AAAA;AAAA,EAAQ,GAClC,CAACgB,GAAYN,CAAO,CAAC,GAExBU;AAAA,IACEX;AAAA,IACA,OACS;AAAA,MACL,YAAAQ;AAAA,MACA,YAAY,MAAMH,EAAW;AAAA,IAAA;AAAA,IAGjC,CAAC;AAAA,EAAA;AAAA,EAKA,gBAAAO,EAAA,cAAAR,GAAA,EAAI,qCAAkC,IAAG,KAAKC,GAAa,GAAGF,EAC7D,GAAA,gBAAAS,EAAA,cAAC,SAAI,mCAAgC,IAAG,KAAKN,KAC1CJ,CACH,CACF;AAEJ,GAEMW,IAAyCC,EAAWhB,CAA0B;"}
1
+ {"version":3,"file":"overlayscrollbars-react.esm.js","sources":["../src/useOverlayScrollbars.ts","../src/OverlayScrollbarsComponent.tsx"],"sourcesContent":["// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nimport React, { useEffect, useMemo, useRef } from 'react';\r\nimport { OverlayScrollbars } from 'overlayscrollbars';\r\nimport type { InitializationTarget } from 'overlayscrollbars';\r\nimport type {\r\n OverlayScrollbarsComponentProps,\r\n OverlayScrollbarsComponentRef,\r\n} from './OverlayScrollbarsComponent';\r\n\r\ntype Defer = [\r\n requestDefer: (callback: () => any, options?: OverlayScrollbarsComponentProps['defer']) => void,\r\n cancelDefer: () => void\r\n];\r\n\r\nexport interface UseOverlayScrollbarsParams {\r\n /** OverlayScrollbars options. */\r\n options?: OverlayScrollbarsComponentProps['options'];\r\n /** OverlayScrollbars events. */\r\n events?: OverlayScrollbarsComponentProps['events'];\r\n /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */\r\n defer?: OverlayScrollbarsComponentProps['defer'];\r\n}\r\n\r\nexport type UseOverlayScrollbarsInitialization = (target: InitializationTarget) => void;\r\n\r\nexport type UseOverlayScrollbarsInstance = () => ReturnType<\r\n OverlayScrollbarsComponentRef['osInstance']\r\n>;\r\n\r\nconst createDefer = (): Defer => {\r\n /* c8 ignore start */\r\n if (typeof window === 'undefined') {\r\n // mock ssr calls with \"noop\"\r\n // eslint-disable-next-line @typescript-eslint/no-empty-function\r\n const noop = () => {};\r\n return [noop, noop];\r\n }\r\n /* c8 ignore end */\r\n\r\n let idleId: number;\r\n let rafId: number;\r\n const wnd = window;\r\n const idleSupported = typeof wnd.requestIdleCallback === 'function';\r\n const rAF = wnd.requestAnimationFrame;\r\n const cAF = wnd.cancelAnimationFrame;\r\n const rIdle = idleSupported ? wnd.requestIdleCallback : rAF;\r\n const cIdle = idleSupported ? wnd.cancelIdleCallback : cAF;\r\n const clear = () => {\r\n cIdle(idleId);\r\n cAF(rafId);\r\n };\r\n\r\n return [\r\n (callback, options) => {\r\n clear();\r\n idleId = rIdle(\r\n idleSupported\r\n ? () => {\r\n clear();\r\n // inside idle its best practice to use rAF to change DOM for best performance\r\n rafId = rAF(callback);\r\n }\r\n : callback,\r\n typeof options === 'object' ? options : { timeout: 2233 }\r\n );\r\n },\r\n clear,\r\n ];\r\n};\r\n\r\n/**\r\n * Hook for advanced usage of OverlayScrollbars. (When the OverlayScrollbarsComponent is not enough)\r\n * @param params Parameters for customization.\r\n * @returns A tuple with two values:\r\n * The first value is the initialization function, it takes one argument which is the `InitializationTarget`.\r\n * The second value is a function which returns the current OverlayScrollbars instance or `null` if not initialized.\r\n */\r\nexport const useOverlayScrollbars = (\r\n params?: UseOverlayScrollbarsParams\r\n): [UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance] => {\r\n const { options, events, defer } = params || {};\r\n const [requestDefer, cancelDefer] = useMemo<Defer>(createDefer, []);\r\n const instanceRef = useRef<ReturnType<UseOverlayScrollbarsInstance>>(null);\r\n const deferRef = useRef(defer);\r\n const optionsRef = useRef(options);\r\n const eventsRef = useRef(events);\r\n\r\n useEffect(() => {\r\n deferRef.current = defer;\r\n }, [defer]);\r\n\r\n useEffect(() => {\r\n const { current: instance } = instanceRef;\r\n\r\n optionsRef.current = options;\r\n\r\n if (OverlayScrollbars.valid(instance)) {\r\n instance.options(options || {}, true);\r\n }\r\n }, [options]);\r\n\r\n useEffect(() => {\r\n const { current: instance } = instanceRef;\r\n\r\n eventsRef.current = events;\r\n\r\n if (OverlayScrollbars.valid(instance)) {\r\n instance.on(events || {}, true);\r\n }\r\n }, [events]);\r\n\r\n useEffect(\r\n () => () => {\r\n cancelDefer();\r\n instanceRef.current?.destroy();\r\n },\r\n []\r\n );\r\n\r\n return useMemo<[UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance]>(\r\n () => [\r\n (target) => {\r\n // if already initialized do nothing\r\n const presentInstance = instanceRef.current;\r\n if (OverlayScrollbars.valid(presentInstance)) {\r\n return;\r\n }\r\n\r\n const currDefer = deferRef.current;\r\n const currOptions = optionsRef.current || {};\r\n const currEvents = eventsRef.current || {};\r\n const init = () =>\r\n (instanceRef.current = OverlayScrollbars(target, currOptions, currEvents));\r\n\r\n if (currDefer) {\r\n requestDefer(init, currDefer);\r\n } else {\r\n init();\r\n }\r\n },\r\n () => instanceRef.current,\r\n ],\r\n []\r\n );\r\n};\r\n","// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nimport React, { forwardRef, useEffect, useRef, useImperativeHandle } from 'react';\r\nimport type { OverlayScrollbars } from 'overlayscrollbars';\r\nimport type { PartialOptions, EventListeners } from 'overlayscrollbars';\r\nimport type {\r\n ComponentPropsWithoutRef,\r\n ElementRef,\r\n ElementType,\r\n ForwardedRef,\r\n ReactElement,\r\n} from 'react';\r\nimport { useOverlayScrollbars } from './useOverlayScrollbars';\r\n\r\ntype OverlayScrollbarsComponentBaseProps<T extends ElementType = 'div'> =\r\n ComponentPropsWithoutRef<T> & {\r\n /** Tag of the root element. */\r\n element?: T;\r\n /** OverlayScrollbars options. */\r\n options?: PartialOptions | false | null;\r\n /** OverlayScrollbars events. */\r\n events?: EventListeners | false | null;\r\n /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */\r\n defer?: boolean | IdleRequestOptions;\r\n };\r\n\r\nexport type OverlayScrollbarsComponentProps<T extends ElementType = 'div'> =\r\n OverlayScrollbarsComponentBaseProps<T> & {\r\n ref?: ForwardedRef<OverlayScrollbarsComponentRef<T>>;\r\n };\r\n\r\nexport interface OverlayScrollbarsComponentRef<T extends ElementType = 'div'> {\r\n /** Returns the OverlayScrollbars instance or null if not initialized. */\r\n osInstance(): OverlayScrollbars | null;\r\n /** Returns the root element. */\r\n getElement(): ElementRef<T> | null;\r\n}\r\n\r\nconst OverlayScrollbarsComponent = <T extends ElementType = 'div'>(\r\n props: OverlayScrollbarsComponentBaseProps<T>,\r\n ref: ForwardedRef<OverlayScrollbarsComponentRef<T>>\r\n): ReactElement | null => {\r\n const { element = 'div', options, events, defer, children, ...other } = props;\r\n const Tag = element;\r\n const elementRef = useRef<ElementRef<T>>(null);\r\n const childrenRef = useRef<HTMLDivElement>(null);\r\n const [initialize, osInstance] = useOverlayScrollbars({ options, events, defer });\r\n\r\n useEffect(() => {\r\n const { current: elm } = elementRef;\r\n const { current: contentsElm } = childrenRef;\r\n\r\n /* c8 ignore start */\r\n if (!elm) {\r\n return;\r\n }\r\n /* c8 ignore end */\r\n\r\n const target = elm as unknown as HTMLElement;\r\n\r\n initialize(\r\n element === 'body'\r\n ? {\r\n target,\r\n cancel: {\r\n body: null,\r\n },\r\n }\r\n : {\r\n target,\r\n elements: {\r\n viewport: contentsElm,\r\n content: contentsElm,\r\n },\r\n }\r\n );\r\n\r\n return () => osInstance()?.destroy();\r\n }, [initialize, element]);\r\n\r\n useImperativeHandle(\r\n ref,\r\n () => {\r\n return {\r\n osInstance,\r\n getElement: () => elementRef.current,\r\n };\r\n },\r\n []\r\n );\r\n\r\n return (\r\n // @ts-ignore\r\n <Tag data-overlayscrollbars-initialize=\"\" ref={elementRef} {...other}>\r\n {element === 'body' ? (\r\n children\r\n ) : (\r\n <div data-overlayscrollbars-contents=\"\" ref={childrenRef}>\r\n {children}\r\n </div>\r\n )}\r\n </Tag>\r\n );\r\n};\r\n\r\nconst OverlayScrollbarsComponentForwardedRef = forwardRef(OverlayScrollbarsComponent) as <\r\n T extends ElementType = 'div'\r\n>(\r\n props: OverlayScrollbarsComponentProps<T>\r\n) => ReturnType<typeof OverlayScrollbarsComponent>;\r\n\r\nexport { OverlayScrollbarsComponentForwardedRef as OverlayScrollbarsComponent };\r\n"],"names":["createDefer","noop","idleId","rafId","wnd","idleSupported","rAF","cAF","rIdle","cIdle","clear","callback","options","useOverlayScrollbars","params","events","defer","requestDefer","cancelDefer","useMemo","instanceRef","useRef","deferRef","optionsRef","eventsRef","useEffect","instance","OverlayScrollbars","_a","target","presentInstance","currDefer","currOptions","currEvents","init","OverlayScrollbarsComponent","props","ref","element","children","other","Tag","elementRef","childrenRef","initialize","osInstance","elm","contentsElm","useImperativeHandle","OverlayScrollbarsComponentForwardedRef","forwardRef"],"mappings":";;AA6BA,MAAMA,IAAc,MAAa;AAE3B,MAAA,OAAO,SAAW,KAAa;AAGjC,UAAMC,IAAO,MAAM;AAAA,IAAA;AACZ,WAAA,CAACA,GAAMA,CAAI;AAAA,EACpB;AAGI,MAAAC,GACAC;AACJ,QAAMC,IAAM,QACNC,IAAgB,OAAOD,EAAI,uBAAwB,YACnDE,IAAMF,EAAI,uBACVG,IAAMH,EAAI,sBACVI,IAAQH,IAAgBD,EAAI,sBAAsBE,GAClDG,IAAQJ,IAAgBD,EAAI,qBAAqBG,GACjDG,IAAQ,MAAM;AAClB,IAAAD,EAAMP,CAAM,GACZK,EAAIJ,CAAK;AAAA,EAAA;AAGJ,SAAA;AAAA,IACL,CAACQ,GAAUC,MAAY;AACf,MAAAF,KACGR,IAAAM;AAAA,QACPH,IACI,MAAM;AACE,UAAAK,KAENP,IAAQG,EAAIK,CAAQ;AAAA,QAAA,IAEtBA;AAAA,QACJ,OAAOC,KAAY,WAAWA,IAAU,EAAE,SAAS,KAAK;AAAA,MAAA;AAAA,IAE5D;AAAA,IACAF;AAAA,EAAA;AAEJ,GASaG,IAAuB,CAClCC,MACuE;AACvE,QAAM,EAAE,SAAAF,GAAS,QAAAG,GAAQ,OAAAC,EAAM,IAAIF,KAAU,CAAA,GACvC,CAACG,GAAcC,CAAW,IAAIC,EAAenB,GAAa,CAAA,CAAE,GAC5DoB,IAAcC,EAAiD,IAAI,GACnEC,IAAWD,EAAOL,CAAK,GACvBO,IAAaF,EAAOT,CAAO,GAC3BY,IAAYH,EAAON,CAAM;AAE/B,SAAAU,EAAU,MAAM;AACd,IAAAH,EAAS,UAAUN;AAAA,EAAA,GAClB,CAACA,CAAK,CAAC,GAEVS,EAAU,MAAM;AACR,UAAA,EAAE,SAASC,EAAa,IAAAN;AAE9B,IAAAG,EAAW,UAAUX,GAEjBe,EAAkB,MAAMD,CAAQ,KAClCA,EAAS,QAAQd,KAAW,CAAC,GAAG,EAAI;AAAA,EACtC,GACC,CAACA,CAAO,CAAC,GAEZa,EAAU,MAAM;AACR,UAAA,EAAE,SAASC,EAAa,IAAAN;AAE9B,IAAAI,EAAU,UAAUT,GAEhBY,EAAkB,MAAMD,CAAQ,KAClCA,EAAS,GAAGX,KAAU,CAAC,GAAG,EAAI;AAAA,EAChC,GACC,CAACA,CAAM,CAAC,GAEXU;AAAA,IACE,MAAM,MAAM;;AACE,MAAAP,MACZU,IAAAR,EAAY,YAAZ,QAAAQ,EAAqB;AAAA,IACvB;AAAA,IACA,CAAC;AAAA,EAAA,GAGIT;AAAA,IACL,MAAM;AAAA,MACJ,CAACU,MAAW;AAEV,cAAMC,IAAkBV,EAAY;AAChC,YAAAO,EAAkB,MAAMG,CAAe;AACzC;AAGF,cAAMC,IAAYT,EAAS,SACrBU,IAAcT,EAAW,WAAW,IACpCU,IAAaT,EAAU,WAAW,IAClCU,IAAO,MACVd,EAAY,UAAUO,EAAkBE,GAAQG,GAAaC,CAAU;AAE1E,QAAIF,IACFd,EAAaiB,GAAMH,CAAS,IAEvBG;MAET;AAAA,MACA,MAAMd,EAAY;AAAA,IACpB;AAAA,IACA,CAAC;AAAA,EAAA;AAEL,GC3GMe,IAA6B,CACjCC,GACAC,MACwB;AAClB,QAAA,EAAE,SAAAC,IAAU,OAAO,SAAA1B,GAAS,QAAAG,GAAQ,OAAAC,GAAO,UAAAuB,GAAU,GAAGC,EAAU,IAAAJ,GAClEK,IAAMH,GACNI,IAAarB,EAAsB,IAAI,GACvCsB,IAActB,EAAuB,IAAI,GACzC,CAACuB,GAAYC,CAAU,IAAIhC,EAAqB,EAAE,SAAAD,GAAS,QAAAG,GAAQ,OAAAC,EAAA,CAAO;AAEhF,SAAAS,EAAU,MAAM;AACR,UAAA,EAAE,SAASqB,EAAQ,IAAAJ,GACnB,EAAE,SAASK,EAAgB,IAAAJ;AAGjC,QAAI,CAACG;AACH;AAIF,UAAMjB,IAASiB;AAEf,WAAAF;AAAA,MACEN,MAAY,SACR;AAAA,QACE,QAAAT;AAAA,QACA,QAAQ;AAAA,UACN,MAAM;AAAA,QACR;AAAA,MAAA,IAEF;AAAA,QACE,QAAAA;AAAA,QACA,UAAU;AAAA,UACR,UAAUkB;AAAA,UACV,SAASA;AAAA,QACX;AAAA,MACF;AAAA,IAAA,GAGC,MAAM;;AAAA,cAAAnB,IAAAiB,QAAA,gBAAAjB,EAAc;AAAA;AAAA,EAAQ,GAClC,CAACgB,GAAYN,CAAO,CAAC,GAExBU;AAAA,IACEX;AAAA,IACA,OACS;AAAA,MACL,YAAAQ;AAAA,MACA,YAAY,MAAMH,EAAW;AAAA,IAAA;AAAA,IAGjC,CAAC;AAAA,EAAA;AAAA,kCAKAD,GAAI,EAAA,qCAAkC,IAAG,KAAKC,GAAa,GAAGF,EAC5D,GAAAF,MAAY,SACXC,oCAEC,OAAI,EAAA,mCAAgC,IAAG,KAAKI,KAC1CJ,CACH,CAEJ;AAEJ,GAEMU,IAAyCC,EAAWf,CAA0B;"}
@@ -1,81 +1,91 @@
1
- import R, { useMemo as w, useRef as f, useEffect as v, forwardRef as C, useImperativeHandle as E } from "react";
1
+ import w, { useMemo as C, useRef as d, useEffect as p, forwardRef as E, useImperativeHandle as O } from "react";
2
2
  import { OverlayScrollbars as I } from "overlayscrollbars";
3
- const O = () => {
3
+ const S = () => {
4
4
  if (typeof window > "u") {
5
5
  const n = () => {
6
6
  };
7
7
  return [n, n];
8
8
  }
9
- let l, c;
10
- const t = window, o = typeof t.requestIdleCallback == "function", a = t.requestAnimationFrame, i = t.cancelAnimationFrame, r = o ? t.requestIdleCallback : a, u = o ? t.cancelIdleCallback : i, s = () => {
11
- u(l), i(c);
9
+ let l, o;
10
+ const t = window, c = typeof t.requestIdleCallback == "function", a = t.requestAnimationFrame, i = t.cancelAnimationFrame, r = c ? t.requestIdleCallback : a, u = c ? t.cancelIdleCallback : i, s = () => {
11
+ u(l), i(o);
12
12
  };
13
13
  return [
14
14
  (n, e) => {
15
15
  s(), l = r(
16
- o ? () => {
17
- s(), c = a(n);
16
+ c ? () => {
17
+ s(), o = a(n);
18
18
  } : n,
19
19
  typeof e == "object" ? e : { timeout: 2233 }
20
20
  );
21
21
  },
22
22
  s
23
23
  ];
24
- }, S = (l) => {
25
- const { options: c, events: t, defer: o } = l || {}, [a, i] = w(O, []), r = f(null), u = f(o), s = f(c), n = f(t);
26
- return v(() => {
27
- u.current = o;
28
- }, [o]), v(() => {
24
+ }, F = (l) => {
25
+ const { options: o, events: t, defer: c } = l || {}, [a, i] = C(S, []), r = d(null), u = d(c), s = d(o), n = d(t);
26
+ return p(() => {
27
+ u.current = c;
28
+ }, [c]), p(() => {
29
29
  const { current: e } = r;
30
- s.current = c, I.valid(e) && e.options(c || {}, !0);
31
- }, [c]), v(() => {
30
+ s.current = o, I.valid(e) && e.options(o || {}, !0);
31
+ }, [o]), p(() => {
32
32
  const { current: e } = r;
33
33
  n.current = t, I.valid(e) && e.on(t || {}, !0);
34
- }, [t]), v(
34
+ }, [t]), p(
35
35
  () => () => {
36
36
  var e;
37
37
  i(), (e = r.current) == null || e.destroy();
38
38
  },
39
39
  []
40
- ), w(
40
+ ), C(
41
41
  () => [
42
42
  (e) => {
43
- const y = r.current;
44
- if (I.valid(y))
43
+ const v = r.current;
44
+ if (I.valid(v))
45
45
  return;
46
- const d = u.current, b = s.current || {}, m = n.current || {}, p = () => r.current = I(e, b, m);
47
- d ? a(p, d) : p();
46
+ const f = u.current, y = s.current || {}, b = n.current || {}, m = () => r.current = I(e, y, b);
47
+ f ? a(m, f) : m();
48
48
  },
49
49
  () => r.current
50
50
  ],
51
51
  []
52
52
  );
53
- }, F = (l, c) => {
54
- const { element: t = "div", options: o, events: a, defer: i, children: r, ...u } = l, s = t, n = f(null), e = f(null), [y, d] = S({ options: o, events: a, defer: i });
55
- return v(() => {
56
- const { current: b } = n, { current: m } = e;
57
- return b && m && y({
58
- target: b,
59
- elements: {
60
- viewport: m,
61
- content: m
53
+ }, q = (l, o) => {
54
+ const { element: t = "div", options: c, events: a, defer: i, children: r, ...u } = l, s = t, n = d(null), e = d(null), [v, f] = F({ options: c, events: a, defer: i });
55
+ return p(() => {
56
+ const { current: y } = n, { current: b } = e;
57
+ if (!y)
58
+ return;
59
+ const m = y;
60
+ return v(
61
+ t === "body" ? {
62
+ target: m,
63
+ cancel: {
64
+ body: null
65
+ }
66
+ } : {
67
+ target: m,
68
+ elements: {
69
+ viewport: b,
70
+ content: b
71
+ }
62
72
  }
63
- }), () => {
64
- var p;
65
- return (p = d()) == null ? void 0 : p.destroy();
73
+ ), () => {
74
+ var R;
75
+ return (R = f()) == null ? void 0 : R.destroy();
66
76
  };
67
- }, [y, t]), E(
68
- c,
77
+ }, [v, t]), O(
78
+ o,
69
79
  () => ({
70
- osInstance: d,
80
+ osInstance: f,
71
81
  getElement: () => n.current
72
82
  }),
73
83
  []
74
84
  ), // @ts-ignore
75
- /* @__PURE__ */ R.createElement(s, { "data-overlayscrollbars-initialize": "", ref: n, ...u }, /* @__PURE__ */ R.createElement("div", { "data-overlayscrollbars-contents": "", ref: e }, r));
76
- }, A = C(F);
85
+ /* @__PURE__ */ w.createElement(s, { "data-overlayscrollbars-initialize": "", ref: n, ...u }, t === "body" ? r : /* @__PURE__ */ w.createElement("div", { "data-overlayscrollbars-contents": "", ref: e }, r));
86
+ }, g = E(q);
77
87
  export {
78
- A as OverlayScrollbarsComponent,
79
- S as useOverlayScrollbars
88
+ g as OverlayScrollbarsComponent,
89
+ F as useOverlayScrollbars
80
90
  };
81
91
  //# sourceMappingURL=overlayscrollbars-react.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"overlayscrollbars-react.mjs","sources":["../src/useOverlayScrollbars.ts","../src/OverlayScrollbarsComponent.tsx"],"sourcesContent":["// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nimport React, { useEffect, useMemo, useRef } from 'react';\r\nimport { OverlayScrollbars } from 'overlayscrollbars';\r\nimport type { InitializationTarget } from 'overlayscrollbars';\r\nimport type {\r\n OverlayScrollbarsComponentProps,\r\n OverlayScrollbarsComponentRef,\r\n} from './OverlayScrollbarsComponent';\r\n\r\ntype Defer = [\r\n requestDefer: (callback: () => any, options?: OverlayScrollbarsComponentProps['defer']) => void,\r\n cancelDefer: () => void\r\n];\r\n\r\nexport interface UseOverlayScrollbarsParams {\r\n /** OverlayScrollbars options. */\r\n options?: OverlayScrollbarsComponentProps['options'];\r\n /** OverlayScrollbars events. */\r\n events?: OverlayScrollbarsComponentProps['events'];\r\n /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */\r\n defer?: OverlayScrollbarsComponentProps['defer'];\r\n}\r\n\r\nexport type UseOverlayScrollbarsInitialization = (target: InitializationTarget) => void;\r\n\r\nexport type UseOverlayScrollbarsInstance = () => ReturnType<\r\n OverlayScrollbarsComponentRef['osInstance']\r\n>;\r\n\r\nconst createDefer = (): Defer => {\r\n /* c8 ignore start */\r\n if (typeof window === 'undefined') {\r\n // mock ssr calls with \"noop\"\r\n // eslint-disable-next-line @typescript-eslint/no-empty-function\r\n const noop = () => {};\r\n return [noop, noop];\r\n }\r\n /* c8 ignore end */\r\n\r\n let idleId: number;\r\n let rafId: number;\r\n const wnd = window;\r\n const idleSupported = typeof wnd.requestIdleCallback === 'function';\r\n const rAF = wnd.requestAnimationFrame;\r\n const cAF = wnd.cancelAnimationFrame;\r\n const rIdle = idleSupported ? wnd.requestIdleCallback : rAF;\r\n const cIdle = idleSupported ? wnd.cancelIdleCallback : cAF;\r\n const clear = () => {\r\n cIdle(idleId);\r\n cAF(rafId);\r\n };\r\n\r\n return [\r\n (callback, options) => {\r\n clear();\r\n idleId = rIdle(\r\n idleSupported\r\n ? () => {\r\n clear();\r\n // inside idle its best practice to use rAF to change DOM for best performance\r\n rafId = rAF(callback);\r\n }\r\n : callback,\r\n typeof options === 'object' ? options : { timeout: 2233 }\r\n );\r\n },\r\n clear,\r\n ];\r\n};\r\n\r\n/**\r\n * Hook for advanced usage of OverlayScrollbars. (When the OverlayScrollbarsComponent is not enough)\r\n * @param params Parameters for customization.\r\n * @returns A tuple with two values:\r\n * The first value is the initialization function, it takes one argument which is the `InitializationTarget`.\r\n * The second value is a function which returns the current OverlayScrollbars instance or `null` if not initialized.\r\n */\r\nexport const useOverlayScrollbars = (\r\n params?: UseOverlayScrollbarsParams\r\n): [UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance] => {\r\n const { options, events, defer } = params || {};\r\n const [requestDefer, cancelDefer] = useMemo<Defer>(createDefer, []);\r\n const instanceRef = useRef<ReturnType<UseOverlayScrollbarsInstance>>(null);\r\n const deferRef = useRef(defer);\r\n const optionsRef = useRef(options);\r\n const eventsRef = useRef(events);\r\n\r\n useEffect(() => {\r\n deferRef.current = defer;\r\n }, [defer]);\r\n\r\n useEffect(() => {\r\n const { current: instance } = instanceRef;\r\n\r\n optionsRef.current = options;\r\n\r\n if (OverlayScrollbars.valid(instance)) {\r\n instance.options(options || {}, true);\r\n }\r\n }, [options]);\r\n\r\n useEffect(() => {\r\n const { current: instance } = instanceRef;\r\n\r\n eventsRef.current = events;\r\n\r\n if (OverlayScrollbars.valid(instance)) {\r\n instance.on(events || {}, true);\r\n }\r\n }, [events]);\r\n\r\n useEffect(\r\n () => () => {\r\n cancelDefer();\r\n instanceRef.current?.destroy();\r\n },\r\n []\r\n );\r\n\r\n return useMemo<[UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance]>(\r\n () => [\r\n (target) => {\r\n // if already initialized do nothing\r\n const presentInstance = instanceRef.current;\r\n if (OverlayScrollbars.valid(presentInstance)) {\r\n return;\r\n }\r\n\r\n const currDefer = deferRef.current;\r\n const currOptions = optionsRef.current || {};\r\n const currEvents = eventsRef.current || {};\r\n const init = () =>\r\n (instanceRef.current = OverlayScrollbars(target, currOptions, currEvents));\r\n\r\n if (currDefer) {\r\n requestDefer(init, currDefer);\r\n } else {\r\n init();\r\n }\r\n },\r\n () => instanceRef.current,\r\n ],\r\n []\r\n );\r\n};\r\n","// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nimport React, { forwardRef, useEffect, useRef, useImperativeHandle } from 'react';\r\nimport type { OverlayScrollbars } from 'overlayscrollbars';\r\nimport type { PartialOptions, EventListeners } from 'overlayscrollbars';\r\nimport type { ComponentPropsWithoutRef, ElementRef, ForwardedRef } from 'react';\r\nimport { useOverlayScrollbars } from './useOverlayScrollbars';\r\n\r\ntype OverlayScrollbarsComponentBaseProps<T extends keyof JSX.IntrinsicElements> =\r\n ComponentPropsWithoutRef<T> & {\r\n /** Tag of the root element. */\r\n element?: T;\r\n /** OverlayScrollbars options. */\r\n options?: PartialOptions | false | null;\r\n /** OverlayScrollbars events. */\r\n events?: EventListeners | false | null;\r\n /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */\r\n defer?: boolean | IdleRequestOptions;\r\n };\r\n\r\nexport type OverlayScrollbarsComponentProps<T extends keyof JSX.IntrinsicElements = 'div'> =\r\n OverlayScrollbarsComponentBaseProps<T> & {\r\n ref?: ForwardedRef<OverlayScrollbarsComponentRef<T>>;\r\n };\r\n\r\nexport interface OverlayScrollbarsComponentRef<T extends keyof JSX.IntrinsicElements = 'div'> {\r\n /** Returns the OverlayScrollbars instance or null if not initialized. */\r\n osInstance(): OverlayScrollbars | null;\r\n /** Returns the root element. */\r\n getElement(): ElementRef<T> | null;\r\n}\r\n\r\nconst OverlayScrollbarsComponent = <T extends keyof JSX.IntrinsicElements>(\r\n props: OverlayScrollbarsComponentBaseProps<T>,\r\n ref: ForwardedRef<OverlayScrollbarsComponentRef<T>>\r\n) => {\r\n const { element = 'div', options, events, defer, children, ...other } = props;\r\n const Tag = element;\r\n const elementRef = useRef<ElementRef<T>>(null);\r\n const childrenRef = useRef<HTMLDivElement>(null);\r\n const [initialize, osInstance] = useOverlayScrollbars({ options, events, defer });\r\n\r\n useEffect(() => {\r\n const { current: elm } = elementRef;\r\n const { current: childrenElm } = childrenRef;\r\n if (elm && childrenElm) {\r\n initialize({\r\n target: elm as any,\r\n elements: {\r\n viewport: childrenElm,\r\n content: childrenElm,\r\n },\r\n });\r\n }\r\n return () => osInstance()?.destroy();\r\n }, [initialize, element]);\r\n\r\n useImperativeHandle(\r\n ref,\r\n () => {\r\n return {\r\n osInstance,\r\n getElement: () => elementRef.current,\r\n };\r\n },\r\n []\r\n );\r\n\r\n return (\r\n // @ts-ignore\r\n <Tag data-overlayscrollbars-initialize=\"\" ref={elementRef} {...other}>\r\n <div data-overlayscrollbars-contents=\"\" ref={childrenRef}>\r\n {children}\r\n </div>\r\n </Tag>\r\n );\r\n};\r\n\r\nconst OverlayScrollbarsComponentForwardedRef = forwardRef(OverlayScrollbarsComponent) as <\r\n T extends keyof JSX.IntrinsicElements\r\n>(\r\n props: OverlayScrollbarsComponentProps<T>\r\n) => ReturnType<typeof OverlayScrollbarsComponent>;\r\n\r\nexport { OverlayScrollbarsComponentForwardedRef as OverlayScrollbarsComponent };\r\n"],"names":["createDefer","noop","idleId","rafId","wnd","idleSupported","rAF","cAF","rIdle","cIdle","clear","callback","options","useOverlayScrollbars","params","events","defer","requestDefer","cancelDefer","useMemo","instanceRef","useRef","deferRef","optionsRef","eventsRef","useEffect","instance","OverlayScrollbars","_a","target","presentInstance","currDefer","currOptions","currEvents","init","OverlayScrollbarsComponent","props","ref","element","children","other","Tag","elementRef","childrenRef","initialize","osInstance","elm","childrenElm","useImperativeHandle","React","OverlayScrollbarsComponentForwardedRef","forwardRef"],"mappings":";;AA6BA,MAAMA,IAAc,MAAa;AAE3B,MAAA,OAAO,SAAW,KAAa;AAGjC,UAAMC,IAAO,MAAM;AAAA,IAAA;AACZ,WAAA,CAACA,GAAMA,CAAI;AAAA,EACpB;AAGI,MAAAC,GACAC;AACJ,QAAMC,IAAM,QACNC,IAAgB,OAAOD,EAAI,uBAAwB,YACnDE,IAAMF,EAAI,uBACVG,IAAMH,EAAI,sBACVI,IAAQH,IAAgBD,EAAI,sBAAsBE,GAClDG,IAAQJ,IAAgBD,EAAI,qBAAqBG,GACjDG,IAAQ,MAAM;AAClB,IAAAD,EAAMP,CAAM,GACZK,EAAIJ,CAAK;AAAA,EAAA;AAGJ,SAAA;AAAA,IACL,CAACQ,GAAUC,MAAY;AACf,MAAAF,KACGR,IAAAM;AAAA,QACPH,IACI,MAAM;AACE,UAAAK,KAENP,IAAQG,EAAIK,CAAQ;AAAA,QAAA,IAEtBA;AAAA,QACJ,OAAOC,KAAY,WAAWA,IAAU,EAAE,SAAS,KAAK;AAAA,MAAA;AAAA,IAE5D;AAAA,IACAF;AAAA,EAAA;AAEJ,GASaG,IAAuB,CAClCC,MACuE;AACvE,QAAM,EAAE,SAAAF,GAAS,QAAAG,GAAQ,OAAAC,EAAM,IAAIF,KAAU,CAAA,GACvC,CAACG,GAAcC,CAAW,IAAIC,EAAenB,GAAa,CAAA,CAAE,GAC5DoB,IAAcC,EAAiD,IAAI,GACnEC,IAAWD,EAAOL,CAAK,GACvBO,IAAaF,EAAOT,CAAO,GAC3BY,IAAYH,EAAON,CAAM;AAE/B,SAAAU,EAAU,MAAM;AACd,IAAAH,EAAS,UAAUN;AAAA,EAAA,GAClB,CAACA,CAAK,CAAC,GAEVS,EAAU,MAAM;AACR,UAAA,EAAE,SAASC,EAAa,IAAAN;AAE9B,IAAAG,EAAW,UAAUX,GAEjBe,EAAkB,MAAMD,CAAQ,KAClCA,EAAS,QAAQd,KAAW,CAAC,GAAG,EAAI;AAAA,EACtC,GACC,CAACA,CAAO,CAAC,GAEZa,EAAU,MAAM;AACR,UAAA,EAAE,SAASC,EAAa,IAAAN;AAE9B,IAAAI,EAAU,UAAUT,GAEhBY,EAAkB,MAAMD,CAAQ,KAClCA,EAAS,GAAGX,KAAU,CAAC,GAAG,EAAI;AAAA,EAChC,GACC,CAACA,CAAM,CAAC,GAEXU;AAAA,IACE,MAAM,MAAM;;AACE,MAAAP,MACZU,IAAAR,EAAY,YAAZ,QAAAQ,EAAqB;AAAA,IACvB;AAAA,IACA,CAAC;AAAA,EAAA,GAGIT;AAAA,IACL,MAAM;AAAA,MACJ,CAACU,MAAW;AAEV,cAAMC,IAAkBV,EAAY;AAChC,YAAAO,EAAkB,MAAMG,CAAe;AACzC;AAGF,cAAMC,IAAYT,EAAS,SACrBU,IAAcT,EAAW,WAAW,IACpCU,IAAaT,EAAU,WAAW,IAClCU,IAAO,MACVd,EAAY,UAAUO,EAAkBE,GAAQG,GAAaC,CAAU;AAE1E,QAAIF,IACFd,EAAaiB,GAAMH,CAAS,IAEvBG;MAET;AAAA,MACA,MAAMd,EAAY;AAAA,IACpB;AAAA,IACA,CAAC;AAAA,EAAA;AAEL,GCjHMe,IAA6B,CACjCC,GACAC,MACG;AACG,QAAA,EAAE,SAAAC,IAAU,OAAO,SAAA1B,GAAS,QAAAG,GAAQ,OAAAC,GAAO,UAAAuB,GAAU,GAAGC,EAAU,IAAAJ,GAClEK,IAAMH,GACNI,IAAarB,EAAsB,IAAI,GACvCsB,IAActB,EAAuB,IAAI,GACzC,CAACuB,GAAYC,CAAU,IAAIhC,EAAqB,EAAE,SAAAD,GAAS,QAAAG,GAAQ,OAAAC,EAAA,CAAO;AAEhF,SAAAS,EAAU,MAAM;AACR,UAAA,EAAE,SAASqB,EAAQ,IAAAJ,GACnB,EAAE,SAASK,EAAgB,IAAAJ;AACjC,WAAIG,KAAOC,KACEH,EAAA;AAAA,MACT,QAAQE;AAAA,MACR,UAAU;AAAA,QACR,UAAUC;AAAA,QACV,SAASA;AAAA,MACX;AAAA,IAAA,CACD,GAEI,MAAM;;AAAA,cAAAnB,IAAAiB,QAAA,gBAAAjB,EAAc;AAAA;AAAA,EAAQ,GAClC,CAACgB,GAAYN,CAAO,CAAC,GAExBU;AAAA,IACEX;AAAA,IACA,OACS;AAAA,MACL,YAAAQ;AAAA,MACA,YAAY,MAAMH,EAAW;AAAA,IAAA;AAAA,IAGjC,CAAC;AAAA,EAAA;AAAA,EAKA,gBAAAO,EAAA,cAAAR,GAAA,EAAI,qCAAkC,IAAG,KAAKC,GAAa,GAAGF,EAC7D,GAAA,gBAAAS,EAAA,cAAC,SAAI,mCAAgC,IAAG,KAAKN,KAC1CJ,CACH,CACF;AAEJ,GAEMW,IAAyCC,EAAWhB,CAA0B;"}
1
+ {"version":3,"file":"overlayscrollbars-react.mjs","sources":["../src/useOverlayScrollbars.ts","../src/OverlayScrollbarsComponent.tsx"],"sourcesContent":["// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nimport React, { useEffect, useMemo, useRef } from 'react';\r\nimport { OverlayScrollbars } from 'overlayscrollbars';\r\nimport type { InitializationTarget } from 'overlayscrollbars';\r\nimport type {\r\n OverlayScrollbarsComponentProps,\r\n OverlayScrollbarsComponentRef,\r\n} from './OverlayScrollbarsComponent';\r\n\r\ntype Defer = [\r\n requestDefer: (callback: () => any, options?: OverlayScrollbarsComponentProps['defer']) => void,\r\n cancelDefer: () => void\r\n];\r\n\r\nexport interface UseOverlayScrollbarsParams {\r\n /** OverlayScrollbars options. */\r\n options?: OverlayScrollbarsComponentProps['options'];\r\n /** OverlayScrollbars events. */\r\n events?: OverlayScrollbarsComponentProps['events'];\r\n /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */\r\n defer?: OverlayScrollbarsComponentProps['defer'];\r\n}\r\n\r\nexport type UseOverlayScrollbarsInitialization = (target: InitializationTarget) => void;\r\n\r\nexport type UseOverlayScrollbarsInstance = () => ReturnType<\r\n OverlayScrollbarsComponentRef['osInstance']\r\n>;\r\n\r\nconst createDefer = (): Defer => {\r\n /* c8 ignore start */\r\n if (typeof window === 'undefined') {\r\n // mock ssr calls with \"noop\"\r\n // eslint-disable-next-line @typescript-eslint/no-empty-function\r\n const noop = () => {};\r\n return [noop, noop];\r\n }\r\n /* c8 ignore end */\r\n\r\n let idleId: number;\r\n let rafId: number;\r\n const wnd = window;\r\n const idleSupported = typeof wnd.requestIdleCallback === 'function';\r\n const rAF = wnd.requestAnimationFrame;\r\n const cAF = wnd.cancelAnimationFrame;\r\n const rIdle = idleSupported ? wnd.requestIdleCallback : rAF;\r\n const cIdle = idleSupported ? wnd.cancelIdleCallback : cAF;\r\n const clear = () => {\r\n cIdle(idleId);\r\n cAF(rafId);\r\n };\r\n\r\n return [\r\n (callback, options) => {\r\n clear();\r\n idleId = rIdle(\r\n idleSupported\r\n ? () => {\r\n clear();\r\n // inside idle its best practice to use rAF to change DOM for best performance\r\n rafId = rAF(callback);\r\n }\r\n : callback,\r\n typeof options === 'object' ? options : { timeout: 2233 }\r\n );\r\n },\r\n clear,\r\n ];\r\n};\r\n\r\n/**\r\n * Hook for advanced usage of OverlayScrollbars. (When the OverlayScrollbarsComponent is not enough)\r\n * @param params Parameters for customization.\r\n * @returns A tuple with two values:\r\n * The first value is the initialization function, it takes one argument which is the `InitializationTarget`.\r\n * The second value is a function which returns the current OverlayScrollbars instance or `null` if not initialized.\r\n */\r\nexport const useOverlayScrollbars = (\r\n params?: UseOverlayScrollbarsParams\r\n): [UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance] => {\r\n const { options, events, defer } = params || {};\r\n const [requestDefer, cancelDefer] = useMemo<Defer>(createDefer, []);\r\n const instanceRef = useRef<ReturnType<UseOverlayScrollbarsInstance>>(null);\r\n const deferRef = useRef(defer);\r\n const optionsRef = useRef(options);\r\n const eventsRef = useRef(events);\r\n\r\n useEffect(() => {\r\n deferRef.current = defer;\r\n }, [defer]);\r\n\r\n useEffect(() => {\r\n const { current: instance } = instanceRef;\r\n\r\n optionsRef.current = options;\r\n\r\n if (OverlayScrollbars.valid(instance)) {\r\n instance.options(options || {}, true);\r\n }\r\n }, [options]);\r\n\r\n useEffect(() => {\r\n const { current: instance } = instanceRef;\r\n\r\n eventsRef.current = events;\r\n\r\n if (OverlayScrollbars.valid(instance)) {\r\n instance.on(events || {}, true);\r\n }\r\n }, [events]);\r\n\r\n useEffect(\r\n () => () => {\r\n cancelDefer();\r\n instanceRef.current?.destroy();\r\n },\r\n []\r\n );\r\n\r\n return useMemo<[UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance]>(\r\n () => [\r\n (target) => {\r\n // if already initialized do nothing\r\n const presentInstance = instanceRef.current;\r\n if (OverlayScrollbars.valid(presentInstance)) {\r\n return;\r\n }\r\n\r\n const currDefer = deferRef.current;\r\n const currOptions = optionsRef.current || {};\r\n const currEvents = eventsRef.current || {};\r\n const init = () =>\r\n (instanceRef.current = OverlayScrollbars(target, currOptions, currEvents));\r\n\r\n if (currDefer) {\r\n requestDefer(init, currDefer);\r\n } else {\r\n init();\r\n }\r\n },\r\n () => instanceRef.current,\r\n ],\r\n []\r\n );\r\n};\r\n","// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nimport React, { forwardRef, useEffect, useRef, useImperativeHandle } from 'react';\r\nimport type { OverlayScrollbars } from 'overlayscrollbars';\r\nimport type { PartialOptions, EventListeners } from 'overlayscrollbars';\r\nimport type {\r\n ComponentPropsWithoutRef,\r\n ElementRef,\r\n ElementType,\r\n ForwardedRef,\r\n ReactElement,\r\n} from 'react';\r\nimport { useOverlayScrollbars } from './useOverlayScrollbars';\r\n\r\ntype OverlayScrollbarsComponentBaseProps<T extends ElementType = 'div'> =\r\n ComponentPropsWithoutRef<T> & {\r\n /** Tag of the root element. */\r\n element?: T;\r\n /** OverlayScrollbars options. */\r\n options?: PartialOptions | false | null;\r\n /** OverlayScrollbars events. */\r\n events?: EventListeners | false | null;\r\n /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */\r\n defer?: boolean | IdleRequestOptions;\r\n };\r\n\r\nexport type OverlayScrollbarsComponentProps<T extends ElementType = 'div'> =\r\n OverlayScrollbarsComponentBaseProps<T> & {\r\n ref?: ForwardedRef<OverlayScrollbarsComponentRef<T>>;\r\n };\r\n\r\nexport interface OverlayScrollbarsComponentRef<T extends ElementType = 'div'> {\r\n /** Returns the OverlayScrollbars instance or null if not initialized. */\r\n osInstance(): OverlayScrollbars | null;\r\n /** Returns the root element. */\r\n getElement(): ElementRef<T> | null;\r\n}\r\n\r\nconst OverlayScrollbarsComponent = <T extends ElementType = 'div'>(\r\n props: OverlayScrollbarsComponentBaseProps<T>,\r\n ref: ForwardedRef<OverlayScrollbarsComponentRef<T>>\r\n): ReactElement | null => {\r\n const { element = 'div', options, events, defer, children, ...other } = props;\r\n const Tag = element;\r\n const elementRef = useRef<ElementRef<T>>(null);\r\n const childrenRef = useRef<HTMLDivElement>(null);\r\n const [initialize, osInstance] = useOverlayScrollbars({ options, events, defer });\r\n\r\n useEffect(() => {\r\n const { current: elm } = elementRef;\r\n const { current: contentsElm } = childrenRef;\r\n\r\n /* c8 ignore start */\r\n if (!elm) {\r\n return;\r\n }\r\n /* c8 ignore end */\r\n\r\n const target = elm as unknown as HTMLElement;\r\n\r\n initialize(\r\n element === 'body'\r\n ? {\r\n target,\r\n cancel: {\r\n body: null,\r\n },\r\n }\r\n : {\r\n target,\r\n elements: {\r\n viewport: contentsElm,\r\n content: contentsElm,\r\n },\r\n }\r\n );\r\n\r\n return () => osInstance()?.destroy();\r\n }, [initialize, element]);\r\n\r\n useImperativeHandle(\r\n ref,\r\n () => {\r\n return {\r\n osInstance,\r\n getElement: () => elementRef.current,\r\n };\r\n },\r\n []\r\n );\r\n\r\n return (\r\n // @ts-ignore\r\n <Tag data-overlayscrollbars-initialize=\"\" ref={elementRef} {...other}>\r\n {element === 'body' ? (\r\n children\r\n ) : (\r\n <div data-overlayscrollbars-contents=\"\" ref={childrenRef}>\r\n {children}\r\n </div>\r\n )}\r\n </Tag>\r\n );\r\n};\r\n\r\nconst OverlayScrollbarsComponentForwardedRef = forwardRef(OverlayScrollbarsComponent) as <\r\n T extends ElementType = 'div'\r\n>(\r\n props: OverlayScrollbarsComponentProps<T>\r\n) => ReturnType<typeof OverlayScrollbarsComponent>;\r\n\r\nexport { OverlayScrollbarsComponentForwardedRef as OverlayScrollbarsComponent };\r\n"],"names":["createDefer","noop","idleId","rafId","wnd","idleSupported","rAF","cAF","rIdle","cIdle","clear","callback","options","useOverlayScrollbars","params","events","defer","requestDefer","cancelDefer","useMemo","instanceRef","useRef","deferRef","optionsRef","eventsRef","useEffect","instance","OverlayScrollbars","_a","target","presentInstance","currDefer","currOptions","currEvents","init","OverlayScrollbarsComponent","props","ref","element","children","other","Tag","elementRef","childrenRef","initialize","osInstance","elm","contentsElm","useImperativeHandle","OverlayScrollbarsComponentForwardedRef","forwardRef"],"mappings":";;AA6BA,MAAMA,IAAc,MAAa;AAE3B,MAAA,OAAO,SAAW,KAAa;AAGjC,UAAMC,IAAO,MAAM;AAAA,IAAA;AACZ,WAAA,CAACA,GAAMA,CAAI;AAAA,EACpB;AAGI,MAAAC,GACAC;AACJ,QAAMC,IAAM,QACNC,IAAgB,OAAOD,EAAI,uBAAwB,YACnDE,IAAMF,EAAI,uBACVG,IAAMH,EAAI,sBACVI,IAAQH,IAAgBD,EAAI,sBAAsBE,GAClDG,IAAQJ,IAAgBD,EAAI,qBAAqBG,GACjDG,IAAQ,MAAM;AAClB,IAAAD,EAAMP,CAAM,GACZK,EAAIJ,CAAK;AAAA,EAAA;AAGJ,SAAA;AAAA,IACL,CAACQ,GAAUC,MAAY;AACf,MAAAF,KACGR,IAAAM;AAAA,QACPH,IACI,MAAM;AACE,UAAAK,KAENP,IAAQG,EAAIK,CAAQ;AAAA,QAAA,IAEtBA;AAAA,QACJ,OAAOC,KAAY,WAAWA,IAAU,EAAE,SAAS,KAAK;AAAA,MAAA;AAAA,IAE5D;AAAA,IACAF;AAAA,EAAA;AAEJ,GASaG,IAAuB,CAClCC,MACuE;AACvE,QAAM,EAAE,SAAAF,GAAS,QAAAG,GAAQ,OAAAC,EAAM,IAAIF,KAAU,CAAA,GACvC,CAACG,GAAcC,CAAW,IAAIC,EAAenB,GAAa,CAAA,CAAE,GAC5DoB,IAAcC,EAAiD,IAAI,GACnEC,IAAWD,EAAOL,CAAK,GACvBO,IAAaF,EAAOT,CAAO,GAC3BY,IAAYH,EAAON,CAAM;AAE/B,SAAAU,EAAU,MAAM;AACd,IAAAH,EAAS,UAAUN;AAAA,EAAA,GAClB,CAACA,CAAK,CAAC,GAEVS,EAAU,MAAM;AACR,UAAA,EAAE,SAASC,EAAa,IAAAN;AAE9B,IAAAG,EAAW,UAAUX,GAEjBe,EAAkB,MAAMD,CAAQ,KAClCA,EAAS,QAAQd,KAAW,CAAC,GAAG,EAAI;AAAA,EACtC,GACC,CAACA,CAAO,CAAC,GAEZa,EAAU,MAAM;AACR,UAAA,EAAE,SAASC,EAAa,IAAAN;AAE9B,IAAAI,EAAU,UAAUT,GAEhBY,EAAkB,MAAMD,CAAQ,KAClCA,EAAS,GAAGX,KAAU,CAAC,GAAG,EAAI;AAAA,EAChC,GACC,CAACA,CAAM,CAAC,GAEXU;AAAA,IACE,MAAM,MAAM;;AACE,MAAAP,MACZU,IAAAR,EAAY,YAAZ,QAAAQ,EAAqB;AAAA,IACvB;AAAA,IACA,CAAC;AAAA,EAAA,GAGIT;AAAA,IACL,MAAM;AAAA,MACJ,CAACU,MAAW;AAEV,cAAMC,IAAkBV,EAAY;AAChC,YAAAO,EAAkB,MAAMG,CAAe;AACzC;AAGF,cAAMC,IAAYT,EAAS,SACrBU,IAAcT,EAAW,WAAW,IACpCU,IAAaT,EAAU,WAAW,IAClCU,IAAO,MACVd,EAAY,UAAUO,EAAkBE,GAAQG,GAAaC,CAAU;AAE1E,QAAIF,IACFd,EAAaiB,GAAMH,CAAS,IAEvBG;MAET;AAAA,MACA,MAAMd,EAAY;AAAA,IACpB;AAAA,IACA,CAAC;AAAA,EAAA;AAEL,GC3GMe,IAA6B,CACjCC,GACAC,MACwB;AAClB,QAAA,EAAE,SAAAC,IAAU,OAAO,SAAA1B,GAAS,QAAAG,GAAQ,OAAAC,GAAO,UAAAuB,GAAU,GAAGC,EAAU,IAAAJ,GAClEK,IAAMH,GACNI,IAAarB,EAAsB,IAAI,GACvCsB,IAActB,EAAuB,IAAI,GACzC,CAACuB,GAAYC,CAAU,IAAIhC,EAAqB,EAAE,SAAAD,GAAS,QAAAG,GAAQ,OAAAC,EAAA,CAAO;AAEhF,SAAAS,EAAU,MAAM;AACR,UAAA,EAAE,SAASqB,EAAQ,IAAAJ,GACnB,EAAE,SAASK,EAAgB,IAAAJ;AAGjC,QAAI,CAACG;AACH;AAIF,UAAMjB,IAASiB;AAEf,WAAAF;AAAA,MACEN,MAAY,SACR;AAAA,QACE,QAAAT;AAAA,QACA,QAAQ;AAAA,UACN,MAAM;AAAA,QACR;AAAA,MAAA,IAEF;AAAA,QACE,QAAAA;AAAA,QACA,UAAU;AAAA,UACR,UAAUkB;AAAA,UACV,SAASA;AAAA,QACX;AAAA,MACF;AAAA,IAAA,GAGC,MAAM;;AAAA,cAAAnB,IAAAiB,QAAA,gBAAAjB,EAAc;AAAA;AAAA,EAAQ,GAClC,CAACgB,GAAYN,CAAO,CAAC,GAExBU;AAAA,IACEX;AAAA,IACA,OACS;AAAA,MACL,YAAAQ;AAAA,MACA,YAAY,MAAMH,EAAW;AAAA,IAAA;AAAA,IAGjC,CAAC;AAAA,EAAA;AAAA,kCAKAD,GAAI,EAAA,qCAAkC,IAAG,KAAKC,GAAa,GAAGF,EAC5D,GAAAF,MAAY,SACXC,oCAEC,OAAI,EAAA,mCAAgC,IAAG,KAAKI,KAC1CJ,CACH,CAEJ;AAEJ,GAEMU,IAAyCC,EAAWf,CAA0B;"}
@@ -1,2 +1,2 @@
1
- (function(s,e){typeof exports=="object"&&typeof module<"u"?e(exports,require("react"),require("overlayscrollbars")):typeof define=="function"&&define.amd?define(["exports","react","overlayscrollbars"],e):(s=typeof globalThis<"u"?globalThis:s||self,e(s.OverlayScrollbarsReact={},s.React,s.OverlayScrollbarsGlobal))})(this,function(s,e,y){"use strict";const E=()=>{if(typeof window>"u"){const t=()=>{};return[t,t]}let i,c;const n=window,l=typeof n.requestIdleCallback=="function",f=n.requestAnimationFrame,a=n.cancelAnimationFrame,o=l?n.requestIdleCallback:f,d=l?n.cancelIdleCallback:a,u=()=>{d(i),a(c)};return[(t,r)=>{u(),i=o(l?()=>{u(),c=f(t)}:t,typeof r=="object"?r:{timeout:2233})},u]},O=i=>{const{options:c,events:n,defer:l}=i||{},[f,a]=e.useMemo(E,[]),o=e.useRef(null),d=e.useRef(l),u=e.useRef(c),t=e.useRef(n);return e.useEffect(()=>{d.current=l},[l]),e.useEffect(()=>{const{current:r}=o;u.current=c,y.OverlayScrollbars.valid(r)&&r.options(c||{},!0)},[c]),e.useEffect(()=>{const{current:r}=o;t.current=n,y.OverlayScrollbars.valid(r)&&r.on(n||{},!0)},[n]),e.useEffect(()=>()=>{var r;a(),(r=o.current)==null||r.destroy()},[]),e.useMemo(()=>[r=>{const b=o.current;if(y.OverlayScrollbars.valid(b))return;const v=d.current,S=u.current||{},m=t.current||{},p=()=>o.current=y.OverlayScrollbars(r,S,m);v?f(p,v):p()},()=>o.current],[])},I=(i,c)=>{const{element:n="div",options:l,events:f,defer:a,children:o,...d}=i,u=n,t=e.useRef(null),r=e.useRef(null),[b,v]=O({options:l,events:f,defer:a});return e.useEffect(()=>{const{current:S}=t,{current:m}=r;return S&&m&&b({target:S,elements:{viewport:m,content:m}}),()=>{var p;return(p=v())==null?void 0:p.destroy()}},[b,n]),e.useImperativeHandle(c,()=>({osInstance:v,getElement:()=>t.current}),[]),e.createElement(u,{"data-overlayscrollbars-initialize":"",ref:t,...d},e.createElement("div",{"data-overlayscrollbars-contents":"",ref:r},o))},w=e.forwardRef(I);s.OverlayScrollbarsComponent=w,s.useOverlayScrollbars=O,Object.defineProperty(s,Symbol.toStringTag,{value:"Module"})});
1
+ (function(s,e){typeof exports=="object"&&typeof module<"u"?e(exports,require("react"),require("overlayscrollbars")):typeof define=="function"&&define.amd?define(["exports","react","overlayscrollbars"],e):(s=typeof globalThis<"u"?globalThis:s||self,e(s.OverlayScrollbarsReact={},s.React,s.OverlayScrollbarsGlobal))})(this,function(s,e,m){"use strict";const I=()=>{if(typeof window>"u"){const t=()=>{};return[t,t]}let i,c;const r=window,l=typeof r.requestIdleCallback=="function",f=r.requestAnimationFrame,a=r.cancelAnimationFrame,o=l?r.requestIdleCallback:f,d=l?r.cancelIdleCallback:a,u=()=>{d(i),a(c)};return[(t,n)=>{u(),i=o(l?()=>{u(),c=f(t)}:t,typeof n=="object"?n:{timeout:2233})},u]},O=i=>{const{options:c,events:r,defer:l}=i||{},[f,a]=e.useMemo(I,[]),o=e.useRef(null),d=e.useRef(l),u=e.useRef(c),t=e.useRef(r);return e.useEffect(()=>{d.current=l},[l]),e.useEffect(()=>{const{current:n}=o;u.current=c,m.OverlayScrollbars.valid(n)&&n.options(c||{},!0)},[c]),e.useEffect(()=>{const{current:n}=o;t.current=r,m.OverlayScrollbars.valid(n)&&n.on(r||{},!0)},[r]),e.useEffect(()=>()=>{var n;a(),(n=o.current)==null||n.destroy()},[]),e.useMemo(()=>[n=>{const p=o.current;if(m.OverlayScrollbars.valid(p))return;const v=d.current,b=u.current||{},S=t.current||{},y=()=>o.current=m.OverlayScrollbars(n,b,S);v?f(y,v):y()},()=>o.current],[])},w=(i,c)=>{const{element:r="div",options:l,events:f,defer:a,children:o,...d}=i,u=r,t=e.useRef(null),n=e.useRef(null),[p,v]=O({options:l,events:f,defer:a});return e.useEffect(()=>{const{current:b}=t,{current:S}=n;if(!b)return;const y=b;return p(r==="body"?{target:y,cancel:{body:null}}:{target:y,elements:{viewport:S,content:S}}),()=>{var E;return(E=v())==null?void 0:E.destroy()}},[p,r]),e.useImperativeHandle(c,()=>({osInstance:v,getElement:()=>t.current}),[]),e.createElement(u,{"data-overlayscrollbars-initialize":"",ref:t,...d},r==="body"?o:e.createElement("div",{"data-overlayscrollbars-contents":"",ref:n},o))},h=e.forwardRef(w);s.OverlayScrollbarsComponent=h,s.useOverlayScrollbars=O,Object.defineProperty(s,Symbol.toStringTag,{value:"Module"})});
2
2
  //# sourceMappingURL=overlayscrollbars-react.umd.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"overlayscrollbars-react.umd.js","sources":["../src/useOverlayScrollbars.ts","../src/OverlayScrollbarsComponent.tsx"],"sourcesContent":["// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nimport React, { useEffect, useMemo, useRef } from 'react';\r\nimport { OverlayScrollbars } from 'overlayscrollbars';\r\nimport type { InitializationTarget } from 'overlayscrollbars';\r\nimport type {\r\n OverlayScrollbarsComponentProps,\r\n OverlayScrollbarsComponentRef,\r\n} from './OverlayScrollbarsComponent';\r\n\r\ntype Defer = [\r\n requestDefer: (callback: () => any, options?: OverlayScrollbarsComponentProps['defer']) => void,\r\n cancelDefer: () => void\r\n];\r\n\r\nexport interface UseOverlayScrollbarsParams {\r\n /** OverlayScrollbars options. */\r\n options?: OverlayScrollbarsComponentProps['options'];\r\n /** OverlayScrollbars events. */\r\n events?: OverlayScrollbarsComponentProps['events'];\r\n /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */\r\n defer?: OverlayScrollbarsComponentProps['defer'];\r\n}\r\n\r\nexport type UseOverlayScrollbarsInitialization = (target: InitializationTarget) => void;\r\n\r\nexport type UseOverlayScrollbarsInstance = () => ReturnType<\r\n OverlayScrollbarsComponentRef['osInstance']\r\n>;\r\n\r\nconst createDefer = (): Defer => {\r\n /* c8 ignore start */\r\n if (typeof window === 'undefined') {\r\n // mock ssr calls with \"noop\"\r\n // eslint-disable-next-line @typescript-eslint/no-empty-function\r\n const noop = () => {};\r\n return [noop, noop];\r\n }\r\n /* c8 ignore end */\r\n\r\n let idleId: number;\r\n let rafId: number;\r\n const wnd = window;\r\n const idleSupported = typeof wnd.requestIdleCallback === 'function';\r\n const rAF = wnd.requestAnimationFrame;\r\n const cAF = wnd.cancelAnimationFrame;\r\n const rIdle = idleSupported ? wnd.requestIdleCallback : rAF;\r\n const cIdle = idleSupported ? wnd.cancelIdleCallback : cAF;\r\n const clear = () => {\r\n cIdle(idleId);\r\n cAF(rafId);\r\n };\r\n\r\n return [\r\n (callback, options) => {\r\n clear();\r\n idleId = rIdle(\r\n idleSupported\r\n ? () => {\r\n clear();\r\n // inside idle its best practice to use rAF to change DOM for best performance\r\n rafId = rAF(callback);\r\n }\r\n : callback,\r\n typeof options === 'object' ? options : { timeout: 2233 }\r\n );\r\n },\r\n clear,\r\n ];\r\n};\r\n\r\n/**\r\n * Hook for advanced usage of OverlayScrollbars. (When the OverlayScrollbarsComponent is not enough)\r\n * @param params Parameters for customization.\r\n * @returns A tuple with two values:\r\n * The first value is the initialization function, it takes one argument which is the `InitializationTarget`.\r\n * The second value is a function which returns the current OverlayScrollbars instance or `null` if not initialized.\r\n */\r\nexport const useOverlayScrollbars = (\r\n params?: UseOverlayScrollbarsParams\r\n): [UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance] => {\r\n const { options, events, defer } = params || {};\r\n const [requestDefer, cancelDefer] = useMemo<Defer>(createDefer, []);\r\n const instanceRef = useRef<ReturnType<UseOverlayScrollbarsInstance>>(null);\r\n const deferRef = useRef(defer);\r\n const optionsRef = useRef(options);\r\n const eventsRef = useRef(events);\r\n\r\n useEffect(() => {\r\n deferRef.current = defer;\r\n }, [defer]);\r\n\r\n useEffect(() => {\r\n const { current: instance } = instanceRef;\r\n\r\n optionsRef.current = options;\r\n\r\n if (OverlayScrollbars.valid(instance)) {\r\n instance.options(options || {}, true);\r\n }\r\n }, [options]);\r\n\r\n useEffect(() => {\r\n const { current: instance } = instanceRef;\r\n\r\n eventsRef.current = events;\r\n\r\n if (OverlayScrollbars.valid(instance)) {\r\n instance.on(events || {}, true);\r\n }\r\n }, [events]);\r\n\r\n useEffect(\r\n () => () => {\r\n cancelDefer();\r\n instanceRef.current?.destroy();\r\n },\r\n []\r\n );\r\n\r\n return useMemo<[UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance]>(\r\n () => [\r\n (target) => {\r\n // if already initialized do nothing\r\n const presentInstance = instanceRef.current;\r\n if (OverlayScrollbars.valid(presentInstance)) {\r\n return;\r\n }\r\n\r\n const currDefer = deferRef.current;\r\n const currOptions = optionsRef.current || {};\r\n const currEvents = eventsRef.current || {};\r\n const init = () =>\r\n (instanceRef.current = OverlayScrollbars(target, currOptions, currEvents));\r\n\r\n if (currDefer) {\r\n requestDefer(init, currDefer);\r\n } else {\r\n init();\r\n }\r\n },\r\n () => instanceRef.current,\r\n ],\r\n []\r\n );\r\n};\r\n","// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nimport React, { forwardRef, useEffect, useRef, useImperativeHandle } from 'react';\r\nimport type { OverlayScrollbars } from 'overlayscrollbars';\r\nimport type { PartialOptions, EventListeners } from 'overlayscrollbars';\r\nimport type { ComponentPropsWithoutRef, ElementRef, ForwardedRef } from 'react';\r\nimport { useOverlayScrollbars } from './useOverlayScrollbars';\r\n\r\ntype OverlayScrollbarsComponentBaseProps<T extends keyof JSX.IntrinsicElements> =\r\n ComponentPropsWithoutRef<T> & {\r\n /** Tag of the root element. */\r\n element?: T;\r\n /** OverlayScrollbars options. */\r\n options?: PartialOptions | false | null;\r\n /** OverlayScrollbars events. */\r\n events?: EventListeners | false | null;\r\n /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */\r\n defer?: boolean | IdleRequestOptions;\r\n };\r\n\r\nexport type OverlayScrollbarsComponentProps<T extends keyof JSX.IntrinsicElements = 'div'> =\r\n OverlayScrollbarsComponentBaseProps<T> & {\r\n ref?: ForwardedRef<OverlayScrollbarsComponentRef<T>>;\r\n };\r\n\r\nexport interface OverlayScrollbarsComponentRef<T extends keyof JSX.IntrinsicElements = 'div'> {\r\n /** Returns the OverlayScrollbars instance or null if not initialized. */\r\n osInstance(): OverlayScrollbars | null;\r\n /** Returns the root element. */\r\n getElement(): ElementRef<T> | null;\r\n}\r\n\r\nconst OverlayScrollbarsComponent = <T extends keyof JSX.IntrinsicElements>(\r\n props: OverlayScrollbarsComponentBaseProps<T>,\r\n ref: ForwardedRef<OverlayScrollbarsComponentRef<T>>\r\n) => {\r\n const { element = 'div', options, events, defer, children, ...other } = props;\r\n const Tag = element;\r\n const elementRef = useRef<ElementRef<T>>(null);\r\n const childrenRef = useRef<HTMLDivElement>(null);\r\n const [initialize, osInstance] = useOverlayScrollbars({ options, events, defer });\r\n\r\n useEffect(() => {\r\n const { current: elm } = elementRef;\r\n const { current: childrenElm } = childrenRef;\r\n if (elm && childrenElm) {\r\n initialize({\r\n target: elm as any,\r\n elements: {\r\n viewport: childrenElm,\r\n content: childrenElm,\r\n },\r\n });\r\n }\r\n return () => osInstance()?.destroy();\r\n }, [initialize, element]);\r\n\r\n useImperativeHandle(\r\n ref,\r\n () => {\r\n return {\r\n osInstance,\r\n getElement: () => elementRef.current,\r\n };\r\n },\r\n []\r\n );\r\n\r\n return (\r\n // @ts-ignore\r\n <Tag data-overlayscrollbars-initialize=\"\" ref={elementRef} {...other}>\r\n <div data-overlayscrollbars-contents=\"\" ref={childrenRef}>\r\n {children}\r\n </div>\r\n </Tag>\r\n );\r\n};\r\n\r\nconst OverlayScrollbarsComponentForwardedRef = forwardRef(OverlayScrollbarsComponent) as <\r\n T extends keyof JSX.IntrinsicElements\r\n>(\r\n props: OverlayScrollbarsComponentProps<T>\r\n) => ReturnType<typeof OverlayScrollbarsComponent>;\r\n\r\nexport { OverlayScrollbarsComponentForwardedRef as OverlayScrollbarsComponent };\r\n"],"names":["createDefer","noop","idleId","rafId","wnd","idleSupported","rAF","cAF","rIdle","cIdle","clear","callback","options","useOverlayScrollbars","params","events","defer","requestDefer","cancelDefer","useMemo","instanceRef","useRef","deferRef","optionsRef","eventsRef","useEffect","instance","OverlayScrollbars","_a","target","presentInstance","currDefer","currOptions","currEvents","init","OverlayScrollbarsComponent","props","ref","element","children","other","Tag","elementRef","childrenRef","initialize","osInstance","elm","childrenElm","useImperativeHandle","React","OverlayScrollbarsComponentForwardedRef","forwardRef"],"mappings":"8VA6BA,MAAMA,EAAc,IAAa,CAE3B,GAAA,OAAO,OAAW,IAAa,CAGjC,MAAMC,EAAO,IAAM,CAAA,EACZ,MAAA,CAACA,EAAMA,CAAI,CACpB,CAGI,IAAAC,EACAC,EACJ,MAAMC,EAAM,OACNC,EAAgB,OAAOD,EAAI,qBAAwB,WACnDE,EAAMF,EAAI,sBACVG,EAAMH,EAAI,qBACVI,EAAQH,EAAgBD,EAAI,oBAAsBE,EAClDG,EAAQJ,EAAgBD,EAAI,mBAAqBG,EACjDG,EAAQ,IAAM,CAClBD,EAAMP,CAAM,EACZK,EAAIJ,CAAK,CAAA,EAGJ,MAAA,CACL,CAACQ,EAAUC,IAAY,CACfF,IACGR,EAAAM,EACPH,EACI,IAAM,CACEK,IAENP,EAAQG,EAAIK,CAAQ,CAAA,EAEtBA,EACJ,OAAOC,GAAY,SAAWA,EAAU,CAAE,QAAS,IAAK,CAAA,CAE5D,EACAF,CAAA,CAEJ,EASaG,EACXC,GACuE,CACvE,KAAM,CAAE,QAAAF,EAAS,OAAAG,EAAQ,MAAAC,CAAM,EAAIF,GAAU,CAAA,EACvC,CAACG,EAAcC,CAAW,EAAIC,EAAAA,QAAenB,EAAa,CAAA,CAAE,EAC5DoB,EAAcC,SAAiD,IAAI,EACnEC,EAAWD,SAAOL,CAAK,EACvBO,EAAaF,SAAOT,CAAO,EAC3BY,EAAYH,SAAON,CAAM,EAE/BU,OAAAA,EAAAA,UAAU,IAAM,CACdH,EAAS,QAAUN,CAAA,EAClB,CAACA,CAAK,CAAC,EAEVS,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASC,CAAa,EAAAN,EAE9BG,EAAW,QAAUX,EAEjBe,EAAA,kBAAkB,MAAMD,CAAQ,GAClCA,EAAS,QAAQd,GAAW,CAAC,EAAG,EAAI,CACtC,EACC,CAACA,CAAO,CAAC,EAEZa,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASC,CAAa,EAAAN,EAE9BI,EAAU,QAAUT,EAEhBY,EAAA,kBAAkB,MAAMD,CAAQ,GAClCA,EAAS,GAAGX,GAAU,CAAC,EAAG,EAAI,CAChC,EACC,CAACA,CAAM,CAAC,EAEXU,EAAA,UACE,IAAM,IAAM,OACEP,KACZU,EAAAR,EAAY,UAAZ,MAAAQ,EAAqB,SACvB,EACA,CAAC,CAAA,EAGIT,EAAA,QACL,IAAM,CACHU,GAAW,CAEV,MAAMC,EAAkBV,EAAY,QAChC,GAAAO,EAAA,kBAAkB,MAAMG,CAAe,EACzC,OAGF,MAAMC,EAAYT,EAAS,QACrBU,EAAcT,EAAW,SAAW,GACpCU,EAAaT,EAAU,SAAW,GAClCU,EAAO,IACVd,EAAY,QAAUO,EAAkB,kBAAAE,EAAQG,EAAaC,CAAU,EAEtEF,EACFd,EAAaiB,EAAMH,CAAS,EAEvBG,GAET,EACA,IAAMd,EAAY,OACpB,EACA,CAAC,CAAA,CAEL,ECjHMe,EAA6B,CACjCC,EACAC,IACG,CACG,KAAA,CAAE,QAAAC,EAAU,MAAO,QAAA1B,EAAS,OAAAG,EAAQ,MAAAC,EAAO,SAAAuB,EAAU,GAAGC,CAAU,EAAAJ,EAClEK,EAAMH,EACNI,EAAarB,SAAsB,IAAI,EACvCsB,EAActB,SAAuB,IAAI,EACzC,CAACuB,EAAYC,CAAU,EAAIhC,EAAqB,CAAE,QAAAD,EAAS,OAAAG,EAAQ,MAAAC,CAAA,CAAO,EAEhFS,OAAAA,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASqB,CAAQ,EAAAJ,EACnB,CAAE,QAASK,CAAgB,EAAAJ,EACjC,OAAIG,GAAOC,GACEH,EAAA,CACT,OAAQE,EACR,SAAU,CACR,SAAUC,EACV,QAASA,CACX,CAAA,CACD,EAEI,IAAM,OAAA,OAAAnB,EAAAiB,MAAA,YAAAjB,EAAc,UAAQ,EAClC,CAACgB,EAAYN,CAAO,CAAC,EAExBU,EAAA,oBACEX,EACA,KACS,CACL,WAAAQ,EACA,WAAY,IAAMH,EAAW,OAAA,GAGjC,CAAC,CAAA,EAKAO,EAAA,cAAAR,EAAA,CAAI,oCAAkC,GAAG,IAAKC,EAAa,GAAGF,CAC7D,EAAAS,EAAA,cAAC,OAAI,kCAAgC,GAAG,IAAKN,GAC1CJ,CACH,CACF,CAEJ,EAEMW,EAAyCC,aAAWhB,CAA0B"}
1
+ {"version":3,"file":"overlayscrollbars-react.umd.js","sources":["../src/useOverlayScrollbars.ts","../src/OverlayScrollbarsComponent.tsx"],"sourcesContent":["// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nimport React, { useEffect, useMemo, useRef } from 'react';\r\nimport { OverlayScrollbars } from 'overlayscrollbars';\r\nimport type { InitializationTarget } from 'overlayscrollbars';\r\nimport type {\r\n OverlayScrollbarsComponentProps,\r\n OverlayScrollbarsComponentRef,\r\n} from './OverlayScrollbarsComponent';\r\n\r\ntype Defer = [\r\n requestDefer: (callback: () => any, options?: OverlayScrollbarsComponentProps['defer']) => void,\r\n cancelDefer: () => void\r\n];\r\n\r\nexport interface UseOverlayScrollbarsParams {\r\n /** OverlayScrollbars options. */\r\n options?: OverlayScrollbarsComponentProps['options'];\r\n /** OverlayScrollbars events. */\r\n events?: OverlayScrollbarsComponentProps['events'];\r\n /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */\r\n defer?: OverlayScrollbarsComponentProps['defer'];\r\n}\r\n\r\nexport type UseOverlayScrollbarsInitialization = (target: InitializationTarget) => void;\r\n\r\nexport type UseOverlayScrollbarsInstance = () => ReturnType<\r\n OverlayScrollbarsComponentRef['osInstance']\r\n>;\r\n\r\nconst createDefer = (): Defer => {\r\n /* c8 ignore start */\r\n if (typeof window === 'undefined') {\r\n // mock ssr calls with \"noop\"\r\n // eslint-disable-next-line @typescript-eslint/no-empty-function\r\n const noop = () => {};\r\n return [noop, noop];\r\n }\r\n /* c8 ignore end */\r\n\r\n let idleId: number;\r\n let rafId: number;\r\n const wnd = window;\r\n const idleSupported = typeof wnd.requestIdleCallback === 'function';\r\n const rAF = wnd.requestAnimationFrame;\r\n const cAF = wnd.cancelAnimationFrame;\r\n const rIdle = idleSupported ? wnd.requestIdleCallback : rAF;\r\n const cIdle = idleSupported ? wnd.cancelIdleCallback : cAF;\r\n const clear = () => {\r\n cIdle(idleId);\r\n cAF(rafId);\r\n };\r\n\r\n return [\r\n (callback, options) => {\r\n clear();\r\n idleId = rIdle(\r\n idleSupported\r\n ? () => {\r\n clear();\r\n // inside idle its best practice to use rAF to change DOM for best performance\r\n rafId = rAF(callback);\r\n }\r\n : callback,\r\n typeof options === 'object' ? options : { timeout: 2233 }\r\n );\r\n },\r\n clear,\r\n ];\r\n};\r\n\r\n/**\r\n * Hook for advanced usage of OverlayScrollbars. (When the OverlayScrollbarsComponent is not enough)\r\n * @param params Parameters for customization.\r\n * @returns A tuple with two values:\r\n * The first value is the initialization function, it takes one argument which is the `InitializationTarget`.\r\n * The second value is a function which returns the current OverlayScrollbars instance or `null` if not initialized.\r\n */\r\nexport const useOverlayScrollbars = (\r\n params?: UseOverlayScrollbarsParams\r\n): [UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance] => {\r\n const { options, events, defer } = params || {};\r\n const [requestDefer, cancelDefer] = useMemo<Defer>(createDefer, []);\r\n const instanceRef = useRef<ReturnType<UseOverlayScrollbarsInstance>>(null);\r\n const deferRef = useRef(defer);\r\n const optionsRef = useRef(options);\r\n const eventsRef = useRef(events);\r\n\r\n useEffect(() => {\r\n deferRef.current = defer;\r\n }, [defer]);\r\n\r\n useEffect(() => {\r\n const { current: instance } = instanceRef;\r\n\r\n optionsRef.current = options;\r\n\r\n if (OverlayScrollbars.valid(instance)) {\r\n instance.options(options || {}, true);\r\n }\r\n }, [options]);\r\n\r\n useEffect(() => {\r\n const { current: instance } = instanceRef;\r\n\r\n eventsRef.current = events;\r\n\r\n if (OverlayScrollbars.valid(instance)) {\r\n instance.on(events || {}, true);\r\n }\r\n }, [events]);\r\n\r\n useEffect(\r\n () => () => {\r\n cancelDefer();\r\n instanceRef.current?.destroy();\r\n },\r\n []\r\n );\r\n\r\n return useMemo<[UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance]>(\r\n () => [\r\n (target) => {\r\n // if already initialized do nothing\r\n const presentInstance = instanceRef.current;\r\n if (OverlayScrollbars.valid(presentInstance)) {\r\n return;\r\n }\r\n\r\n const currDefer = deferRef.current;\r\n const currOptions = optionsRef.current || {};\r\n const currEvents = eventsRef.current || {};\r\n const init = () =>\r\n (instanceRef.current = OverlayScrollbars(target, currOptions, currEvents));\r\n\r\n if (currDefer) {\r\n requestDefer(init, currDefer);\r\n } else {\r\n init();\r\n }\r\n },\r\n () => instanceRef.current,\r\n ],\r\n []\r\n );\r\n};\r\n","// eslint-disable-next-line @typescript-eslint/no-unused-vars\r\nimport React, { forwardRef, useEffect, useRef, useImperativeHandle } from 'react';\r\nimport type { OverlayScrollbars } from 'overlayscrollbars';\r\nimport type { PartialOptions, EventListeners } from 'overlayscrollbars';\r\nimport type {\r\n ComponentPropsWithoutRef,\r\n ElementRef,\r\n ElementType,\r\n ForwardedRef,\r\n ReactElement,\r\n} from 'react';\r\nimport { useOverlayScrollbars } from './useOverlayScrollbars';\r\n\r\ntype OverlayScrollbarsComponentBaseProps<T extends ElementType = 'div'> =\r\n ComponentPropsWithoutRef<T> & {\r\n /** Tag of the root element. */\r\n element?: T;\r\n /** OverlayScrollbars options. */\r\n options?: PartialOptions | false | null;\r\n /** OverlayScrollbars events. */\r\n events?: EventListeners | false | null;\r\n /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */\r\n defer?: boolean | IdleRequestOptions;\r\n };\r\n\r\nexport type OverlayScrollbarsComponentProps<T extends ElementType = 'div'> =\r\n OverlayScrollbarsComponentBaseProps<T> & {\r\n ref?: ForwardedRef<OverlayScrollbarsComponentRef<T>>;\r\n };\r\n\r\nexport interface OverlayScrollbarsComponentRef<T extends ElementType = 'div'> {\r\n /** Returns the OverlayScrollbars instance or null if not initialized. */\r\n osInstance(): OverlayScrollbars | null;\r\n /** Returns the root element. */\r\n getElement(): ElementRef<T> | null;\r\n}\r\n\r\nconst OverlayScrollbarsComponent = <T extends ElementType = 'div'>(\r\n props: OverlayScrollbarsComponentBaseProps<T>,\r\n ref: ForwardedRef<OverlayScrollbarsComponentRef<T>>\r\n): ReactElement | null => {\r\n const { element = 'div', options, events, defer, children, ...other } = props;\r\n const Tag = element;\r\n const elementRef = useRef<ElementRef<T>>(null);\r\n const childrenRef = useRef<HTMLDivElement>(null);\r\n const [initialize, osInstance] = useOverlayScrollbars({ options, events, defer });\r\n\r\n useEffect(() => {\r\n const { current: elm } = elementRef;\r\n const { current: contentsElm } = childrenRef;\r\n\r\n /* c8 ignore start */\r\n if (!elm) {\r\n return;\r\n }\r\n /* c8 ignore end */\r\n\r\n const target = elm as unknown as HTMLElement;\r\n\r\n initialize(\r\n element === 'body'\r\n ? {\r\n target,\r\n cancel: {\r\n body: null,\r\n },\r\n }\r\n : {\r\n target,\r\n elements: {\r\n viewport: contentsElm,\r\n content: contentsElm,\r\n },\r\n }\r\n );\r\n\r\n return () => osInstance()?.destroy();\r\n }, [initialize, element]);\r\n\r\n useImperativeHandle(\r\n ref,\r\n () => {\r\n return {\r\n osInstance,\r\n getElement: () => elementRef.current,\r\n };\r\n },\r\n []\r\n );\r\n\r\n return (\r\n // @ts-ignore\r\n <Tag data-overlayscrollbars-initialize=\"\" ref={elementRef} {...other}>\r\n {element === 'body' ? (\r\n children\r\n ) : (\r\n <div data-overlayscrollbars-contents=\"\" ref={childrenRef}>\r\n {children}\r\n </div>\r\n )}\r\n </Tag>\r\n );\r\n};\r\n\r\nconst OverlayScrollbarsComponentForwardedRef = forwardRef(OverlayScrollbarsComponent) as <\r\n T extends ElementType = 'div'\r\n>(\r\n props: OverlayScrollbarsComponentProps<T>\r\n) => ReturnType<typeof OverlayScrollbarsComponent>;\r\n\r\nexport { OverlayScrollbarsComponentForwardedRef as OverlayScrollbarsComponent };\r\n"],"names":["createDefer","noop","idleId","rafId","wnd","idleSupported","rAF","cAF","rIdle","cIdle","clear","callback","options","useOverlayScrollbars","params","events","defer","requestDefer","cancelDefer","useMemo","instanceRef","useRef","deferRef","optionsRef","eventsRef","useEffect","instance","OverlayScrollbars","_a","target","presentInstance","currDefer","currOptions","currEvents","init","OverlayScrollbarsComponent","props","ref","element","children","other","Tag","elementRef","childrenRef","initialize","osInstance","elm","contentsElm","useImperativeHandle","OverlayScrollbarsComponentForwardedRef","forwardRef"],"mappings":"8VA6BA,MAAMA,EAAc,IAAa,CAE3B,GAAA,OAAO,OAAW,IAAa,CAGjC,MAAMC,EAAO,IAAM,CAAA,EACZ,MAAA,CAACA,EAAMA,CAAI,CACpB,CAGI,IAAAC,EACAC,EACJ,MAAMC,EAAM,OACNC,EAAgB,OAAOD,EAAI,qBAAwB,WACnDE,EAAMF,EAAI,sBACVG,EAAMH,EAAI,qBACVI,EAAQH,EAAgBD,EAAI,oBAAsBE,EAClDG,EAAQJ,EAAgBD,EAAI,mBAAqBG,EACjDG,EAAQ,IAAM,CAClBD,EAAMP,CAAM,EACZK,EAAIJ,CAAK,CAAA,EAGJ,MAAA,CACL,CAACQ,EAAUC,IAAY,CACfF,IACGR,EAAAM,EACPH,EACI,IAAM,CACEK,IAENP,EAAQG,EAAIK,CAAQ,CAAA,EAEtBA,EACJ,OAAOC,GAAY,SAAWA,EAAU,CAAE,QAAS,IAAK,CAAA,CAE5D,EACAF,CAAA,CAEJ,EASaG,EACXC,GACuE,CACvE,KAAM,CAAE,QAAAF,EAAS,OAAAG,EAAQ,MAAAC,CAAM,EAAIF,GAAU,CAAA,EACvC,CAACG,EAAcC,CAAW,EAAIC,EAAAA,QAAenB,EAAa,CAAA,CAAE,EAC5DoB,EAAcC,SAAiD,IAAI,EACnEC,EAAWD,SAAOL,CAAK,EACvBO,EAAaF,SAAOT,CAAO,EAC3BY,EAAYH,SAAON,CAAM,EAE/BU,OAAAA,EAAAA,UAAU,IAAM,CACdH,EAAS,QAAUN,CAAA,EAClB,CAACA,CAAK,CAAC,EAEVS,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASC,CAAa,EAAAN,EAE9BG,EAAW,QAAUX,EAEjBe,EAAA,kBAAkB,MAAMD,CAAQ,GAClCA,EAAS,QAAQd,GAAW,CAAC,EAAG,EAAI,CACtC,EACC,CAACA,CAAO,CAAC,EAEZa,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASC,CAAa,EAAAN,EAE9BI,EAAU,QAAUT,EAEhBY,EAAA,kBAAkB,MAAMD,CAAQ,GAClCA,EAAS,GAAGX,GAAU,CAAC,EAAG,EAAI,CAChC,EACC,CAACA,CAAM,CAAC,EAEXU,EAAA,UACE,IAAM,IAAM,OACEP,KACZU,EAAAR,EAAY,UAAZ,MAAAQ,EAAqB,SACvB,EACA,CAAC,CAAA,EAGIT,EAAA,QACL,IAAM,CACHU,GAAW,CAEV,MAAMC,EAAkBV,EAAY,QAChC,GAAAO,EAAA,kBAAkB,MAAMG,CAAe,EACzC,OAGF,MAAMC,EAAYT,EAAS,QACrBU,EAAcT,EAAW,SAAW,GACpCU,EAAaT,EAAU,SAAW,GAClCU,EAAO,IACVd,EAAY,QAAUO,EAAkB,kBAAAE,EAAQG,EAAaC,CAAU,EAEtEF,EACFd,EAAaiB,EAAMH,CAAS,EAEvBG,GAET,EACA,IAAMd,EAAY,OACpB,EACA,CAAC,CAAA,CAEL,EC3GMe,EAA6B,CACjCC,EACAC,IACwB,CAClB,KAAA,CAAE,QAAAC,EAAU,MAAO,QAAA1B,EAAS,OAAAG,EAAQ,MAAAC,EAAO,SAAAuB,EAAU,GAAGC,CAAU,EAAAJ,EAClEK,EAAMH,EACNI,EAAarB,SAAsB,IAAI,EACvCsB,EAActB,SAAuB,IAAI,EACzC,CAACuB,EAAYC,CAAU,EAAIhC,EAAqB,CAAE,QAAAD,EAAS,OAAAG,EAAQ,MAAAC,CAAA,CAAO,EAEhFS,OAAAA,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASqB,CAAQ,EAAAJ,EACnB,CAAE,QAASK,CAAgB,EAAAJ,EAGjC,GAAI,CAACG,EACH,OAIF,MAAMjB,EAASiB,EAEf,OAAAF,EACEN,IAAY,OACR,CACE,OAAAT,EACA,OAAQ,CACN,KAAM,IACR,CAAA,EAEF,CACE,OAAAA,EACA,SAAU,CACR,SAAUkB,EACV,QAASA,CACX,CACF,CAAA,EAGC,IAAM,OAAA,OAAAnB,EAAAiB,MAAA,YAAAjB,EAAc,UAAQ,EAClC,CAACgB,EAAYN,CAAO,CAAC,EAExBU,EAAA,oBACEX,EACA,KACS,CACL,WAAAQ,EACA,WAAY,IAAMH,EAAW,OAAA,GAGjC,CAAC,CAAA,kBAKAD,EAAI,CAAA,oCAAkC,GAAG,IAAKC,EAAa,GAAGF,CAC5D,EAAAF,IAAY,OACXC,kBAEC,MAAI,CAAA,kCAAgC,GAAG,IAAKI,GAC1CJ,CACH,CAEJ,CAEJ,EAEMU,EAAyCC,aAAWf,CAA0B"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "overlayscrollbars-react",
3
- "version": "0.5.4",
3
+ "version": "0.5.6",
4
4
  "description": "OverlayScrollbars for React.",
5
5
  "author": "Rene Haas | KingSora",
6
6
  "license": "MIT",
@@ -1,8 +1,8 @@
1
1
  import React from 'react';
2
2
  import type { OverlayScrollbars } from 'overlayscrollbars';
3
3
  import type { PartialOptions, EventListeners } from 'overlayscrollbars';
4
- import type { ComponentPropsWithoutRef, ElementRef, ForwardedRef } from 'react';
5
- type OverlayScrollbarsComponentBaseProps<T extends keyof JSX.IntrinsicElements> = ComponentPropsWithoutRef<T> & {
4
+ import type { ComponentPropsWithoutRef, ElementRef, ElementType, ForwardedRef, ReactElement } from 'react';
5
+ type OverlayScrollbarsComponentBaseProps<T extends ElementType = 'div'> = ComponentPropsWithoutRef<T> & {
6
6
  /** Tag of the root element. */
7
7
  element?: T;
8
8
  /** OverlayScrollbars options. */
@@ -12,15 +12,15 @@ type OverlayScrollbarsComponentBaseProps<T extends keyof JSX.IntrinsicElements>
12
12
  /** Whether to defer the initialization to a point in time when the browser is idle. (or to the next frame if `window.requestIdleCallback` is not supported) */
13
13
  defer?: boolean | IdleRequestOptions;
14
14
  };
15
- export type OverlayScrollbarsComponentProps<T extends keyof JSX.IntrinsicElements = 'div'> = OverlayScrollbarsComponentBaseProps<T> & {
15
+ export type OverlayScrollbarsComponentProps<T extends ElementType = 'div'> = OverlayScrollbarsComponentBaseProps<T> & {
16
16
  ref?: ForwardedRef<OverlayScrollbarsComponentRef<T>>;
17
17
  };
18
- export interface OverlayScrollbarsComponentRef<T extends keyof JSX.IntrinsicElements = 'div'> {
18
+ export interface OverlayScrollbarsComponentRef<T extends ElementType = 'div'> {
19
19
  /** Returns the OverlayScrollbars instance or null if not initialized. */
20
20
  osInstance(): OverlayScrollbars | null;
21
21
  /** Returns the root element. */
22
22
  getElement(): ElementRef<T> | null;
23
23
  }
24
- declare const OverlayScrollbarsComponent: <T extends keyof JSX.IntrinsicElements>(props: OverlayScrollbarsComponentBaseProps<T>, ref: React.ForwardedRef<OverlayScrollbarsComponentRef<T>>) => import("react/jsx-runtime").JSX.Element;
25
- declare const OverlayScrollbarsComponentForwardedRef: <T extends keyof JSX.IntrinsicElements>(props: OverlayScrollbarsComponentProps<T>) => ReturnType<typeof OverlayScrollbarsComponent>;
24
+ declare const OverlayScrollbarsComponent: <T extends React.ElementType = "div">(props: OverlayScrollbarsComponentBaseProps<T>, ref: React.ForwardedRef<OverlayScrollbarsComponentRef<T>>) => ReactElement | null;
25
+ declare const OverlayScrollbarsComponentForwardedRef: <T extends React.ElementType = "div">(props: OverlayScrollbarsComponentProps<T>) => ReturnType<typeof OverlayScrollbarsComponent>;
26
26
  export { OverlayScrollbarsComponentForwardedRef as OverlayScrollbarsComponent };