overlayscrollbars-react 0.4.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.5.0
4
+
5
+ ### Features
6
+
7
+ Added the possibility 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)
8
+ - `OverlayScrollbarsComponent` accepts now the `defer` property
9
+ - `useOverlayScrollbars` params accept now the `defer` key
10
+ - `useOverlayScrollbars` will now always try to destroy the instance if the component unmounts.
11
+
12
+ ### Breaking Changes
13
+
14
+ - Because initialization can be deferred now, the `initialize` function of the `useOverlayScrollbars` hook isn't returning the instance anymore. Use the `instance` function of the `useOverlayScrollbars` hook instead.
15
+
3
16
  ## 0.4.0
4
17
 
5
18
  Depends on `OverlayScrollbars` version `^2.0.0` and `React` version `>=16.8.0`.
@@ -7,8 +20,8 @@ The component was rewritten using `hooks`. ([#218](https://github.com/KingSora/O
7
20
 
8
21
  ### Features
9
22
 
10
- - `OverlayScrollbarsComponent` has now the `events` property
11
- - `OverlayScrollbarsComponent` has now the `element` property
23
+ - `OverlayScrollbarsComponent` accepts now the `events` property
24
+ - `OverlayScrollbarsComponent` accepts now the `element` property
12
25
  - The `useOverlayScrollbars` hook was added for advanced usage
13
26
 
14
27
  ### Breaking Changes
package/README.md CHANGED
@@ -57,7 +57,7 @@ import { OverlayScrollbarsComponent } from "overlayscrollbars-react";
57
57
 
58
58
  // ...
59
59
 
60
- <OverlayScrollbarsComponent>
60
+ <OverlayScrollbarsComponent defer>
61
61
  example content
62
62
  </OverlayScrollbarsComponent>
63
63
  ```
@@ -70,15 +70,19 @@ Additionally it has three optional properties: `element`, `options` and `events`
70
70
  - `element`: accepts a `string` which represents the tag of the root element.
71
71
  - `options`: accepts an `object` which represents the OverlayScrollbars options.
72
72
  - `events`: accepts an `object` which represents the OverlayScrollbars events.
73
+ - `defer`: accepts an `boolean` or `object`. Defers the initialization to a point in time when the browser is idle.
73
74
 
74
75
  > __Note__: None of the properties has to be memoized.
75
76
 
77
+ > __Note__: Its **highly recommended** to use the `defer` option whenever possible to defer the initialization to a browser's idle period.
78
+
76
79
  ```jsx
77
80
  // example usage
78
81
  <OverlayScrollbarsComponent
79
82
  element="span"
80
83
  options={{ scrollbars: { autoHide: 'scroll' } }}
81
84
  events={{ scroll: () => { /* ... */ } }}
85
+ defer
82
86
  />
83
87
  ```
84
88
 
@@ -100,11 +104,10 @@ import { useOverlayScrollbars } from "overlayscrollbars-react";
100
104
  // example usage
101
105
  const Component = () => {
102
106
  const ref = useRef();
103
- const [initialize, instance] = useOverlayScrollbars({ options, events });
107
+ const [initialize, instance] = useOverlayScrollbars({ options, events, defer });
104
108
 
105
109
  useEffect(() => {
106
- const osInstance = initialize(ref.current);
107
- return () => osInstance.destroy();
110
+ initialize(ref.current);
108
111
  }, [initialize]);
109
112
 
110
113
  return <div ref={ref} />
@@ -113,6 +116,8 @@ const Component = () => {
113
116
 
114
117
  The hook is for advanced usage and lets you control the whole initialization process. This is useful if you want to integrate it with other plugins such as `react-window` or `react-virtualized`.
115
118
 
119
+ The hook will destroy the instance automatically if the component unmounts.
120
+
116
121
  ### Parameters
117
122
 
118
123
  Parameters are optional and similar to the `OverlayScrollbarsComponent`.
@@ -120,12 +125,13 @@ Its an `object` with two optional properties:
120
125
 
121
126
  - `options`: accepts an `object` which represents the OverlayScrollbars options.
122
127
  - `events`: accepts an `object` which represents the OverlayScrollbars events.
128
+ - `defer`: accepts an `boolean` or `object`. Defers the initialization to a point in time when the browser is idle.
123
129
 
124
130
  ### Return
125
131
 
126
132
  The `useOverlayScrollbars` hook returns a `tuple` with two values:
127
133
 
128
- - The first value is the `initialization` function, it takes one argument which is the `InitializationTarget` and returns the OverlayScrollbars instance.
134
+ - The first value is the `initialization` function, it takes one argument which is the `InitializationTarget`.
129
135
  - The second value is a function which returns the current OverlayScrollbars instance or `null` if not initialized.
130
136
 
131
137
  > __Note__: The identity of both functions is stable and won't change, thus they can safely be used in any dependency array.
@@ -1,61 +1,86 @@
1
- import R, { useRef as c, useEffect as d, useMemo as E, forwardRef as O, useImperativeHandle as I } from "react";
2
- import { OverlayScrollbars as u } from "overlayscrollbars";
3
- const S = (f) => {
4
- const { options: r, events: n } = f || {}, t = c(null), s = c(r), l = c(n);
5
- return d(() => {
6
- const { current: e } = t;
7
- s.current = r, u.valid(e) && e.options(r || {}, !0);
8
- }, [r]), d(() => {
9
- const { current: e } = t;
10
- l.current = n, u.valid(e) && e.on(n || {}, !0);
11
- }, [n]), E(
1
+ import b, { useMemo as w, useRef as f, useEffect as v, forwardRef as C, useImperativeHandle as E } from "react";
2
+ import { OverlayScrollbars as R } from "overlayscrollbars";
3
+ const O = () => {
4
+ if (typeof window > "u") {
5
+ const n = () => {
6
+ };
7
+ return [n, n];
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);
12
+ };
13
+ return [
14
+ (n, e) => {
15
+ s(), l = r(
16
+ o ? () => {
17
+ s(), c = a(n);
18
+ } : n,
19
+ typeof e == "object" ? e : { timeout: 2233 }
20
+ );
21
+ },
22
+ s
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(() => {
29
+ const { current: e } = r;
30
+ s.current = c, R.valid(e) && e.options(c || {}, !0);
31
+ }, [c]), v(() => {
32
+ const { current: e } = r;
33
+ n.current = t, R.valid(e) && e.on(t || {}, !0);
34
+ }, [t]), v(
35
+ () => () => {
36
+ var e;
37
+ i(), (e = r.current) == null || e.destroy();
38
+ },
39
+ []
40
+ ), w(
12
41
  () => [
13
42
  (e) => {
14
- const a = t.current;
15
- if (u.valid(a))
16
- return a;
17
- const o = s.current || {}, i = l.current || {};
18
- return t.current = u(
19
- e,
20
- o,
21
- i
22
- );
43
+ const y = r.current;
44
+ if (R.valid(y))
45
+ return;
46
+ const d = u.current, I = s.current || {}, m = n.current || {}, p = () => r.current = R(e, I, m);
47
+ d ? a(p, d) : p();
23
48
  },
24
- () => t.current
49
+ () => r.current
25
50
  ],
26
51
  []
27
52
  );
28
- }, h = (f, r) => {
29
- const { element: n = "div", options: t, events: s, children: l, ...e } = f, a = n, o = c(null), i = c(null), [m, y] = S({ options: t, events: s });
30
- return d(() => {
31
- const { current: p } = o, { current: v } = i;
32
- if (p && v) {
33
- const b = m({
34
- target: p,
35
- elements: {
36
- viewport: v,
37
- content: v
38
- }
39
- });
40
- return () => b.destroy();
41
- }
42
- }, [m, n]), I(
43
- r,
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: I } = n, { current: m } = e;
57
+ return I && m && y({
58
+ target: I,
59
+ elements: {
60
+ viewport: m,
61
+ content: m
62
+ }
63
+ }), () => {
64
+ var p;
65
+ return (p = d()) == null ? void 0 : p.destroy();
66
+ };
67
+ }, [y, t]), E(
68
+ c,
44
69
  () => ({
45
- osInstance: y,
46
- getElement: () => o.current
70
+ osInstance: d,
71
+ getElement: () => n.current
47
72
  }),
48
73
  []
49
- ), /* @__PURE__ */ R.createElement(a, {
74
+ ), /* @__PURE__ */ b.createElement(s, {
50
75
  "data-overlayscrollbars-initialize": "",
51
- ref: o,
52
- ...e
53
- }, /* @__PURE__ */ R.createElement("div", {
54
- ref: i
55
- }, l));
56
- }, C = O(h);
76
+ ref: n,
77
+ ...u
78
+ }, /* @__PURE__ */ b.createElement("div", {
79
+ ref: e
80
+ }, r));
81
+ }, A = C(F);
57
82
  export {
58
- C as OverlayScrollbarsComponent,
83
+ A as OverlayScrollbarsComponent,
59
84
  S as useOverlayScrollbars
60
85
  };
61
86
  //# sourceMappingURL=overlayscrollbars-react.es.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"overlayscrollbars-react.es.js","sources":["../src/useOverlayScrollbars.ts","../src/OverlayScrollbarsComponent.tsx"],"sourcesContent":["import { 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\nexport interface UseOverlayScrollbarsParams {\r\n /** OverlayScrollbars options. */\r\n options?: OverlayScrollbarsComponentProps['options'];\r\n /** OverlayScrollbars events. */\r\n events?: OverlayScrollbarsComponentProps['events'];\r\n}\r\n\r\nexport type UseOverlayScrollbarsInitialization = (\r\n target: InitializationTarget\r\n) => OverlayScrollbars;\r\n\r\nexport type UseOverlayScrollbarsInstance = () => ReturnType<\r\n OverlayScrollbarsComponentRef['osInstance']\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` and returns the OverlayScrollbars instance.\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 } = params || {};\r\n const instanceRef = useRef<ReturnType<UseOverlayScrollbarsInstance>>(null);\r\n const optionsRef = useRef(options);\r\n const eventsRef = useRef(events);\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 return useMemo<[UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance]>(\r\n () => [\r\n (target: InitializationTarget): OverlayScrollbars => {\r\n // if already initialized return the current instance\r\n const presentInstance = instanceRef.current;\r\n if (OverlayScrollbars.valid(presentInstance)) {\r\n return presentInstance;\r\n }\r\n\r\n const currOptions = optionsRef.current || {};\r\n const currEvents = eventsRef.current || {};\r\n const osInstance = (instanceRef.current = OverlayScrollbars(\r\n target,\r\n currOptions,\r\n currEvents\r\n ));\r\n\r\n return osInstance;\r\n },\r\n () => instanceRef.current,\r\n ],\r\n []\r\n );\r\n};\r\n","import { 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\nexport type OverlayScrollbarsComponentProps<T extends keyof JSX.IntrinsicElements = '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 };\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: OverlayScrollbarsComponentProps<T>,\r\n ref: ForwardedRef<OverlayScrollbarsComponentRef<T>>\r\n) => {\r\n const { element = 'div', options, events, 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 });\r\n\r\n useEffect(() => {\r\n const { current: elm } = elementRef;\r\n const { current: childrenElm } = childrenRef;\r\n if (elm && childrenElm) {\r\n const instance = 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 () => instance.destroy();\r\n }\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 ref={childrenRef}>{children}</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 ref?: ForwardedRef<OverlayScrollbarsComponentRef<T>>;\r\n }\r\n) => ReturnType<typeof OverlayScrollbarsComponent>;\r\n\r\nexport { OverlayScrollbarsComponentForwardedRef as OverlayScrollbarsComponent };\r\n"],"names":["useOverlayScrollbars","params","options","events","instanceRef","useRef","optionsRef","eventsRef","useEffect","instance","OverlayScrollbars","useMemo","target","presentInstance","currOptions","currEvents","OverlayScrollbarsComponent","props","ref","element","children","other","Tag","elementRef","childrenRef","initialize","osInstance","elm","childrenElm","useImperativeHandle","React","OverlayScrollbarsComponentForwardedRef","forwardRef"],"mappings":";;AA8Ba,MAAAA,IAAuB,CAClCC,MACuE;AACvE,QAAM,EAAE,SAAAC,GAAS,QAAAC,MAAWF,KAAU,CAAA,GAChCG,IAAcC,EAAiD,IAAI,GACnEC,IAAaD,EAAOH,CAAO,GAC3BK,IAAYF,EAAOF,CAAM;AAE/B,SAAAK,EAAU,MAAM;AACR,UAAA,EAAE,SAASC,EAAa,IAAAL;AAE9B,IAAAE,EAAW,UAAUJ,GAEjBQ,EAAkB,MAAMD,CAAQ,KAClCA,EAAS,QAAQP,KAAW,CAAC,GAAG,EAAI;AAAA,EACtC,GACC,CAACA,CAAO,CAAC,GAEZM,EAAU,MAAM;AACR,UAAA,EAAE,SAASC,EAAa,IAAAL;AAE9B,IAAAG,EAAU,UAAUJ,GAEhBO,EAAkB,MAAMD,CAAQ,KAClCA,EAAS,GAAGN,KAAU,CAAC,GAAG,EAAI;AAAA,EAChC,GACC,CAACA,CAAM,CAAC,GAEJQ;AAAA,IACL,MAAM;AAAA,MACJ,CAACC,MAAoD;AAEnD,cAAMC,IAAkBT,EAAY;AAChC,YAAAM,EAAkB,MAAMG,CAAe;AAClC,iBAAAA;AAGH,cAAAC,IAAcR,EAAW,WAAW,IACpCS,IAAaR,EAAU,WAAW;AAOjC,eANaH,EAAY,UAAUM;AAAA,UACxCE;AAAA,UACAE;AAAA,UACAC;AAAA,QAAA;AAAA,MAIJ;AAAA,MACA,MAAMX,EAAY;AAAA,IACpB;AAAA,IACA,CAAC;AAAA,EAAA;AAEL,GC1DMY,IAA6B,CACjCC,GACAC,MACG;AACH,QAAM,EAAE,SAAAC,IAAU,OAAO,SAAAjB,GAAS,QAAAC,GAAQ,UAAAiB,MAAaC,EAAU,IAAAJ,GAC3DK,IAAMH,GACNI,IAAalB,EAAsB,IAAI,GACvCmB,IAAcnB,EAAuB,IAAI,GACzC,CAACoB,GAAYC,CAAU,IAAI1B,EAAqB,EAAE,SAAAE,GAAS,QAAAC,GAAQ;AAEzE,SAAAK,EAAU,MAAM;AACR,UAAA,EAAE,SAASmB,EAAQ,IAAAJ,GACnB,EAAE,SAASK,EAAgB,IAAAJ;AACjC,QAAIG,KAAOC,GAAa;AACtB,YAAMnB,IAAWgB,EAAW;AAAA,QAC1B,QAAQE;AAAA,QACR,UAAU;AAAA,UACR,UAAUC;AAAA,UACV,SAASA;AAAA,QACX;AAAA,MAAA,CACD;AAEM,aAAA,MAAMnB,EAAS;IACxB;AAAA,EAAA,GACC,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,GAKA,gBAAAO,EAAA,cAAAR,GAAA;AAAA,IAAI,qCAAkC;AAAA,IAAG,KAAKC;AAAA,IAAa,GAAGF;AAAA,EAAA,GAC5D,gBAAAS,EAAA,cAAA,OAAA;AAAA,IAAI,KAAKN;AAAA,EAAA,GAAcJ,CAAS,CACnC;AAEJ,GAEMW,IAAyCC,EAAWhB,CAA0B;"}
1
+ {"version":3,"file":"overlayscrollbars-react.es.js","sources":["../src/useOverlayScrollbars.ts","../src/OverlayScrollbarsComponent.tsx"],"sourcesContent":["import { 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","import { 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\nexport type OverlayScrollbarsComponentProps<T extends keyof JSX.IntrinsicElements = '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 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: OverlayScrollbarsComponentProps<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 ref={childrenRef}>{children}</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 ref?: ForwardedRef<OverlayScrollbarsComponentRef<T>>;\r\n }\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":";;AA4BA,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,GCtHMe,IAA6B,CACjCC,GACAC,MACG;AACG,QAAA,EAAE,SAAAC,IAAU,OAAO,SAAA1B,GAAS,QAAAG,GAAQ,OAAAC,GAAO,UAAAuB,MAAaC,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,GAKA,gBAAAO,EAAA,cAAAR,GAAA;AAAA,IAAI,qCAAkC;AAAA,IAAG,KAAKC;AAAA,IAAa,GAAGF;AAAA,EAAA,GAC5D,gBAAAS,EAAA,cAAA,OAAA;AAAA,IAAI,KAAKN;AAAA,EAAA,GAAcJ,CAAS,CACnC;AAEJ,GAEMW,IAAyCC,EAAWhB,CAA0B;"}
@@ -1,2 +1,2 @@
1
- (function(n,e){typeof exports=="object"&&typeof module<"u"?e(exports,require("react"),require("overlayscrollbars")):typeof define=="function"&&define.amd?define(["exports","react","overlayscrollbars"],e):(n=typeof globalThis<"u"?globalThis:n||self,e(n.OverlayScrollbarsReact={},n.React,n.OverlayScrollbarsGlobal))})(this,function(n,e,u){"use strict";const y=(t=>t&&typeof t=="object"&&"default"in t?t:{default:t})(e),m=t=>{const{options:l,events:s}=t||{},o=e.useRef(null),i=e.useRef(l),a=e.useRef(s);return e.useEffect(()=>{const{current:r}=o;i.current=l,u.OverlayScrollbars.valid(r)&&r.options(l||{},!0)},[l]),e.useEffect(()=>{const{current:r}=o;a.current=s,u.OverlayScrollbars.valid(r)&&r.on(s||{},!0)},[s]),e.useMemo(()=>[r=>{const f=o.current;if(u.OverlayScrollbars.valid(f))return f;const c=i.current||{},d=a.current||{};return o.current=u.OverlayScrollbars(r,c,d)},()=>o.current],[])},O=(t,l)=>{const{element:s="div",options:o,events:i,children:a,...r}=t,f=s,c=e.useRef(null),d=e.useRef(null),[v,E]=m({options:o,events:i});return e.useEffect(()=>{const{current:b}=c,{current:p}=d;if(b&&p){const h=v({target:b,elements:{viewport:p,content:p}});return()=>h.destroy()}},[v,s]),e.useImperativeHandle(l,()=>({osInstance:E,getElement:()=>c.current}),[]),y.default.createElement(f,{"data-overlayscrollbars-initialize":"",ref:c,...r},y.default.createElement("div",{ref:d},a))},S=e.forwardRef(O);n.OverlayScrollbarsComponent=S,n.useOverlayScrollbars=m,Object.defineProperties(n,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}})});
1
+ (function(c,e){typeof exports=="object"&&typeof module<"u"?e(exports,require("react"),require("overlayscrollbars")):typeof define=="function"&&define.amd?define(["exports","react","overlayscrollbars"],e):(c=typeof globalThis<"u"?globalThis:c||self,e(c.OverlayScrollbarsReact={},c.React,c.OverlayScrollbarsGlobal))})(this,function(c,e,y){"use strict";const O=(n=>n&&typeof n=="object"&&"default"in n?n:{default:n})(e),I=()=>{if(typeof window>"u"){const o=()=>{};return[o,o]}let n,l;const r=window,u=typeof r.requestIdleCallback=="function",i=r.requestAnimationFrame,a=r.cancelAnimationFrame,s=u?r.requestIdleCallback:i,d=u?r.cancelIdleCallback:a,f=()=>{d(n),a(l)};return[(o,t)=>{f(),n=s(u?()=>{f(),l=i(o)}:o,typeof t=="object"?t:{timeout:2233})},f]},E=n=>{const{options:l,events:r,defer:u}=n||{},[i,a]=e.useMemo(I,[]),s=e.useRef(null),d=e.useRef(u),f=e.useRef(l),o=e.useRef(r);return e.useEffect(()=>{d.current=u},[u]),e.useEffect(()=>{const{current:t}=s;f.current=l,y.OverlayScrollbars.valid(t)&&t.options(l||{},!0)},[l]),e.useEffect(()=>{const{current:t}=s;o.current=r,y.OverlayScrollbars.valid(t)&&t.on(r||{},!0)},[r]),e.useEffect(()=>()=>{var t;a(),(t=s.current)==null||t.destroy()},[]),e.useMemo(()=>[t=>{const b=s.current;if(y.OverlayScrollbars.valid(b))return;const p=d.current,S=f.current||{},v=o.current||{},m=()=>s.current=y.OverlayScrollbars(t,S,v);p?i(m,p):m()},()=>s.current],[])},w=(n,l)=>{const{element:r="div",options:u,events:i,defer:a,children:s,...d}=n,f=r,o=e.useRef(null),t=e.useRef(null),[b,p]=E({options:u,events:i,defer:a});return e.useEffect(()=>{const{current:S}=o,{current:v}=t;return S&&v&&b({target:S,elements:{viewport:v,content:v}}),()=>{var m;return(m=p())==null?void 0:m.destroy()}},[b,r]),e.useImperativeHandle(l,()=>({osInstance:p,getElement:()=>o.current}),[]),O.default.createElement(f,{"data-overlayscrollbars-initialize":"",ref:o,...d},O.default.createElement("div",{ref:t},s))},h=e.forwardRef(w);c.OverlayScrollbarsComponent=h,c.useOverlayScrollbars=E,Object.defineProperties(c,{__esModule:{value:!0},[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":["import { 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\nexport interface UseOverlayScrollbarsParams {\r\n /** OverlayScrollbars options. */\r\n options?: OverlayScrollbarsComponentProps['options'];\r\n /** OverlayScrollbars events. */\r\n events?: OverlayScrollbarsComponentProps['events'];\r\n}\r\n\r\nexport type UseOverlayScrollbarsInitialization = (\r\n target: InitializationTarget\r\n) => OverlayScrollbars;\r\n\r\nexport type UseOverlayScrollbarsInstance = () => ReturnType<\r\n OverlayScrollbarsComponentRef['osInstance']\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` and returns the OverlayScrollbars instance.\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 } = params || {};\r\n const instanceRef = useRef<ReturnType<UseOverlayScrollbarsInstance>>(null);\r\n const optionsRef = useRef(options);\r\n const eventsRef = useRef(events);\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 return useMemo<[UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance]>(\r\n () => [\r\n (target: InitializationTarget): OverlayScrollbars => {\r\n // if already initialized return the current instance\r\n const presentInstance = instanceRef.current;\r\n if (OverlayScrollbars.valid(presentInstance)) {\r\n return presentInstance;\r\n }\r\n\r\n const currOptions = optionsRef.current || {};\r\n const currEvents = eventsRef.current || {};\r\n const osInstance = (instanceRef.current = OverlayScrollbars(\r\n target,\r\n currOptions,\r\n currEvents\r\n ));\r\n\r\n return osInstance;\r\n },\r\n () => instanceRef.current,\r\n ],\r\n []\r\n );\r\n};\r\n","import { 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\nexport type OverlayScrollbarsComponentProps<T extends keyof JSX.IntrinsicElements = '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 };\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: OverlayScrollbarsComponentProps<T>,\r\n ref: ForwardedRef<OverlayScrollbarsComponentRef<T>>\r\n) => {\r\n const { element = 'div', options, events, 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 });\r\n\r\n useEffect(() => {\r\n const { current: elm } = elementRef;\r\n const { current: childrenElm } = childrenRef;\r\n if (elm && childrenElm) {\r\n const instance = 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 () => instance.destroy();\r\n }\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 ref={childrenRef}>{children}</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 ref?: ForwardedRef<OverlayScrollbarsComponentRef<T>>;\r\n }\r\n) => ReturnType<typeof OverlayScrollbarsComponent>;\r\n\r\nexport { OverlayScrollbarsComponentForwardedRef as OverlayScrollbarsComponent };\r\n"],"names":["useOverlayScrollbars","params","options","events","instanceRef","useRef","optionsRef","eventsRef","useEffect","instance","OverlayScrollbars","useMemo","target","presentInstance","currOptions","currEvents","OverlayScrollbarsComponent","props","ref","element","children","other","Tag","elementRef","childrenRef","initialize","osInstance","elm","childrenElm","useImperativeHandle","React","OverlayScrollbarsComponentForwardedRef","forwardRef"],"mappings":"iaA8BaA,EACXC,GACuE,CACvE,KAAM,CAAE,QAAAC,EAAS,OAAAC,GAAWF,GAAU,CAAA,EAChCG,EAAcC,SAAiD,IAAI,EACnEC,EAAaD,SAAOH,CAAO,EAC3BK,EAAYF,SAAOF,CAAM,EAE/BK,OAAAA,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASC,CAAa,EAAAL,EAE9BE,EAAW,QAAUJ,EAEjBQ,EAAA,kBAAkB,MAAMD,CAAQ,GAClCA,EAAS,QAAQP,GAAW,CAAC,EAAG,EAAI,CACtC,EACC,CAACA,CAAO,CAAC,EAEZM,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASC,CAAa,EAAAL,EAE9BG,EAAU,QAAUJ,EAEhBO,EAAA,kBAAkB,MAAMD,CAAQ,GAClCA,EAAS,GAAGN,GAAU,CAAC,EAAG,EAAI,CAChC,EACC,CAACA,CAAM,CAAC,EAEJQ,EAAA,QACL,IAAM,CACHC,GAAoD,CAEnD,MAAMC,EAAkBT,EAAY,QAChC,GAAAM,EAAA,kBAAkB,MAAMG,CAAe,EAClC,OAAAA,EAGH,MAAAC,EAAcR,EAAW,SAAW,GACpCS,EAAaR,EAAU,SAAW,GAOjC,OANaH,EAAY,QAAUM,EAAA,kBACxCE,EACAE,EACAC,CAAA,CAIJ,EACA,IAAMX,EAAY,OACpB,EACA,CAAC,CAAA,CAEL,EC1DMY,EAA6B,CACjCC,EACAC,IACG,CACH,KAAM,CAAE,QAAAC,EAAU,MAAO,QAAAjB,EAAS,OAAAC,EAAQ,SAAAiB,KAAaC,CAAU,EAAAJ,EAC3DK,EAAMH,EACNI,EAAalB,SAAsB,IAAI,EACvCmB,EAAcnB,SAAuB,IAAI,EACzC,CAACoB,EAAYC,CAAU,EAAI1B,EAAqB,CAAE,QAAAE,EAAS,OAAAC,EAAQ,EAEzEK,OAAAA,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASmB,CAAQ,EAAAJ,EACnB,CAAE,QAASK,CAAgB,EAAAJ,EACjC,GAAIG,GAAOC,EAAa,CACtB,MAAMnB,EAAWgB,EAAW,CAC1B,OAAQE,EACR,SAAU,CACR,SAAUC,EACV,QAASA,CACX,CAAA,CACD,EAEM,MAAA,IAAMnB,EAAS,SACxB,CAAA,EACC,CAACgB,EAAYN,CAAO,CAAC,EAExBU,EAAA,oBACEX,EACA,KACS,CACL,WAAAQ,EACA,WAAY,IAAMH,EAAW,OAAA,GAGjC,CAAC,CAAA,EAKAO,EAAA,QAAA,cAAAR,EAAA,CAAI,oCAAkC,GAAG,IAAKC,EAAa,GAAGF,CAAA,EAC5DS,EAAA,QAAA,cAAA,MAAA,CAAI,IAAKN,CAAA,EAAcJ,CAAS,CACnC,CAEJ,EAEMW,EAAyCC,aAAWhB,CAA0B"}
1
+ {"version":3,"file":"overlayscrollbars-react.umd.js","sources":["../src/useOverlayScrollbars.ts","../src/OverlayScrollbarsComponent.tsx"],"sourcesContent":["import { 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","import { 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\nexport type OverlayScrollbarsComponentProps<T extends keyof JSX.IntrinsicElements = '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 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: OverlayScrollbarsComponentProps<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 ref={childrenRef}>{children}</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 ref?: ForwardedRef<OverlayScrollbarsComponentRef<T>>;\r\n }\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":"iaA4BMA,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,ECtHMe,EAA6B,CACjCC,EACAC,IACG,CACG,KAAA,CAAE,QAAAC,EAAU,MAAO,QAAA1B,EAAS,OAAAG,EAAQ,MAAAC,EAAO,SAAAuB,KAAaC,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,QAAA,cAAAR,EAAA,CAAI,oCAAkC,GAAG,IAAKC,EAAa,GAAGF,CAAA,EAC5DS,EAAA,QAAA,cAAA,MAAA,CAAI,IAAKN,CAAA,EAAcJ,CAAS,CACnC,CAEJ,EAEMW,EAAyCC,aAAWhB,CAA0B"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "overlayscrollbars-react",
3
- "version": "0.4.0",
3
+ "version": "0.5.0",
4
4
  "description": "OverlayScrollbars for React.",
5
5
  "author": "Rene Haas | KingSora",
6
6
  "license": "MIT",
@@ -8,6 +8,8 @@ export declare type OverlayScrollbarsComponentProps<T extends keyof JSX.Intrinsi
8
8
  options?: PartialOptions | false | null;
9
9
  /** OverlayScrollbars events. */
10
10
  events?: EventListeners | false | null;
11
+ /** 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) */
12
+ defer?: boolean | IdleRequestOptions;
11
13
  };
12
14
  export interface OverlayScrollbarsComponentRef<T extends keyof JSX.IntrinsicElements = 'div'> {
13
15
  /** Returns the OverlayScrollbars instance or null if not initialized. */
@@ -50,6 +52,8 @@ declare const OverlayScrollbarsComponentForwardedRef: <T extends keyof JSX.Intri
50
52
  destroyed?: ((instance: OverlayScrollbars, canceled: boolean) => void) | ((instance: OverlayScrollbars, canceled: boolean) => void)[] | null | undefined;
51
53
  scroll?: ((instance: OverlayScrollbars, event: Event) => void) | ((instance: OverlayScrollbars, event: Event) => void)[] | null | undefined;
52
54
  } | null | undefined;
55
+ /** 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) */
56
+ defer?: boolean | IdleRequestOptions | undefined;
53
57
  } & {
54
58
  ref?: ForwardedRef<OverlayScrollbarsComponentRef<T>> | undefined;
55
59
  }) => ReturnType<typeof OverlayScrollbarsComponent>;
@@ -1,4 +1,3 @@
1
- import { OverlayScrollbars } from 'overlayscrollbars';
2
1
  import type { InitializationTarget } from 'overlayscrollbars';
3
2
  import type { OverlayScrollbarsComponentProps, OverlayScrollbarsComponentRef } from './OverlayScrollbarsComponent';
4
3
  export interface UseOverlayScrollbarsParams {
@@ -6,14 +5,16 @@ export interface UseOverlayScrollbarsParams {
6
5
  options?: OverlayScrollbarsComponentProps['options'];
7
6
  /** OverlayScrollbars events. */
8
7
  events?: OverlayScrollbarsComponentProps['events'];
8
+ /** 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) */
9
+ defer?: OverlayScrollbarsComponentProps['defer'];
9
10
  }
10
- export declare type UseOverlayScrollbarsInitialization = (target: InitializationTarget) => OverlayScrollbars;
11
+ export declare type UseOverlayScrollbarsInitialization = (target: InitializationTarget) => void;
11
12
  export declare type UseOverlayScrollbarsInstance = () => ReturnType<OverlayScrollbarsComponentRef['osInstance']>;
12
13
  /**
13
14
  * Hook for advanced usage of OverlayScrollbars. (When the OverlayScrollbarsComponent is not enough)
14
15
  * @param params Parameters for customization.
15
16
  * @returns A tuple with two values:
16
- * The first value is the initialization function, it takes one argument which is the `InitializationTarget` and returns the OverlayScrollbars instance.
17
+ * The first value is the initialization function, it takes one argument which is the `InitializationTarget`.
17
18
  * The second value is a function which returns the current OverlayScrollbars instance or `null` if not initialized.
18
19
  */
19
20
  export declare const useOverlayScrollbars: (params?: UseOverlayScrollbarsParams) => [UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance];