overlayscrollbars-react 0.5.0 → 0.5.2
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 +10 -1
- package/README.md +13 -3
- package/overlayscrollbars-react.cjs.js +2 -0
- package/overlayscrollbars-react.cjs.js.map +1 -0
- package/overlayscrollbars-react.es.js +51 -48
- package/overlayscrollbars-react.es.js.map +1 -1
- package/overlayscrollbars-react.umd.js +1 -1
- package/overlayscrollbars-react.umd.js.map +1 -1
- package/package.json +9 -1
- package/types/OverlayScrollbarsComponent.d.ts +25 -60
- package/types/overlayscrollbars-react.d.ts +2 -2
- package/types/useOverlayScrollbars.d.ts +20 -20
package/CHANGELOG.md
CHANGED
|
@@ -1,12 +1,21 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.5.2
|
|
4
|
+
|
|
5
|
+
- Improve `Server Side Rendering` behavior by creating additional markup only on the client with the hydration phase.
|
|
6
|
+
- Improve `deferred initialization` where the time between created markup and actual initialization is masked with CSS.
|
|
7
|
+
|
|
8
|
+
## 0.5.1
|
|
9
|
+
|
|
10
|
+
- The `package.json` has now an appropriate `exports` field to optimize builds in modern bundlers.
|
|
11
|
+
|
|
3
12
|
## 0.5.0
|
|
4
13
|
|
|
5
14
|
### Features
|
|
6
15
|
|
|
7
16
|
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
17
|
- `OverlayScrollbarsComponent` accepts now the `defer` property
|
|
9
|
-
- `useOverlayScrollbars` params accept now the `defer`
|
|
18
|
+
- `useOverlayScrollbars` params accept now the `defer` property
|
|
10
19
|
- `useOverlayScrollbars` will now always try to destroy the instance if the component unmounts.
|
|
11
20
|
|
|
12
21
|
### Breaking Changes
|
package/README.md
CHANGED
|
@@ -12,11 +12,21 @@
|
|
|
12
12
|
[](#)
|
|
13
13
|
|
|
14
14
|
</div>
|
|
15
|
+
<h3 align="center">
|
|
16
|
+
<a href="https://kingsora.github.io/OverlayScrollbars">Website</a>
|
|
17
|
+
•
|
|
18
|
+
<a href="https://kingsora.github.io/OverlayScrollbars/examples">Examples</a>
|
|
19
|
+
</h3>
|
|
15
20
|
|
|
16
21
|
# OverlayScrollbars for React
|
|
17
22
|
|
|
18
23
|
This is the official OverlayScrollbars React wrapper.
|
|
19
24
|
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
- Online example on [StackBlitz](https://stackblitz.com/edit/overlayscrollbars-react)
|
|
28
|
+
- Example App in the [Repository](https://github.com/KingSora/OverlayScrollbars/tree/master/examples/react)
|
|
29
|
+
|
|
20
30
|
## Installation
|
|
21
31
|
|
|
22
32
|
```sh
|
|
@@ -64,8 +74,8 @@ import { OverlayScrollbarsComponent } from "overlayscrollbars-react";
|
|
|
64
74
|
|
|
65
75
|
### Properties
|
|
66
76
|
|
|
67
|
-
The component accepts all properties of
|
|
68
|
-
Additionally it has
|
|
77
|
+
The component accepts all properties of regular elements such as `div` and `span`.
|
|
78
|
+
Additionally it has custom optional properties:
|
|
69
79
|
|
|
70
80
|
- `element`: accepts a `string` which represents the tag of the root element.
|
|
71
81
|
- `options`: accepts an `object` which represents the OverlayScrollbars options.
|
|
@@ -121,7 +131,7 @@ The hook will destroy the instance automatically if the component unmounts.
|
|
|
121
131
|
### Parameters
|
|
122
132
|
|
|
123
133
|
Parameters are optional and similar to the `OverlayScrollbarsComponent`.
|
|
124
|
-
Its an `object` with
|
|
134
|
+
Its an `object` with optional properties:
|
|
125
135
|
|
|
126
136
|
- `options`: accepts an `object` which represents the OverlayScrollbars options.
|
|
127
137
|
- `events`: accepts an `object` which represents the OverlayScrollbars events.
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const e=require("react"),p=require("overlayscrollbars"),I=n=>n&&typeof n=="object"&&"default"in n?n:{default:n},E=I(e),w=()=>{if(typeof window>"u"){const c=()=>{};return[c,c]}let n,o;const r=window,l=typeof r.requestIdleCallback=="function",u=r.requestAnimationFrame,f=r.cancelAnimationFrame,s=l?r.requestIdleCallback:u,i=l?r.cancelIdleCallback:f,a=()=>{i(n),f(o)};return[(c,t)=>{a(),n=s(l?()=>{a(),o=u(c)}:c,typeof t=="object"?t:{timeout:2233})},a]},O=n=>{const{options:o,events:r,defer:l}=n||{},[u,f]=e.useMemo(w,[]),s=e.useRef(null),i=e.useRef(l),a=e.useRef(o),c=e.useRef(r);return e.useEffect(()=>{i.current=l},[l]),e.useEffect(()=>{const{current:t}=s;a.current=o,p.OverlayScrollbars.valid(t)&&t.options(o||{},!0)},[o]),e.useEffect(()=>{const{current:t}=s;c.current=r,p.OverlayScrollbars.valid(t)&&t.on(r||{},!0)},[r]),e.useEffect(()=>()=>{var t;f(),(t=s.current)==null||t.destroy()},[]),e.useMemo(()=>[t=>{const d=s.current;if(p.OverlayScrollbars.valid(d))return;const y=i.current,m=a.current||{},b=c.current||{},v=()=>s.current=p.OverlayScrollbars(t,m,b);y?u(v,y):v()},()=>s.current],[])},g=(n,o)=>{const{element:r="div",options:l,events:u,defer:f,children:s,...i}=n,a=r,c=e.useRef(null),t=e.useRef(null),[d,y]=e.useState(!1),[m,b]=O({options:l,events:u,defer:f});return e.useEffect(()=>{y(!0)},[]),e.useEffect(()=>{const{current:v}=c,{current:R}=t;return d&&v&&R&&m({target:v,elements:{viewport:R,content:R}}),()=>{var S;return(S=b())==null?void 0:S.destroy()}},[d,m,r]),e.useImperativeHandle(o,()=>({osInstance:b,getElement:()=>c.current}),[]),E.default.createElement(a,{"data-overlayscrollbars-initialize":"",ref:c,...i},d?E.default.createElement("div",{ref:t,"data-overlayscrollbars-contents":!0},s):s)},q=e.forwardRef(g);exports.OverlayScrollbarsComponent=q;exports.useOverlayScrollbars=O;
|
|
2
|
+
//# sourceMappingURL=overlayscrollbars-react.cjs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"overlayscrollbars-react.cjs.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, useState } 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 [hydrated, setHydrated] = useState(false);\r\n const [initialize, osInstance] = useOverlayScrollbars({ options, events, defer });\r\n\r\n useEffect(() => {\r\n setHydrated(true);\r\n }, []);\r\n\r\n useEffect(() => {\r\n const { current: elm } = elementRef;\r\n const { current: childrenElm } = childrenRef;\r\n if (hydrated && 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 }, [hydrated, 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 {hydrated ? (\r\n <div ref={childrenRef} data-overlayscrollbars-contents>\r\n {children}\r\n </div>\r\n ) : (\r\n children\r\n )}\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","hydrated","setHydrated","useState","initialize","osInstance","elm","childrenElm","useImperativeHandle","React","OverlayScrollbarsComponentForwardedRef","forwardRef"],"mappings":"mOA4BMA,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,KAAaC,CAAU,EAAAJ,EAClEK,EAAMH,EACNI,EAAarB,SAAsB,IAAI,EACvCsB,EAActB,SAAuB,IAAI,EACzC,CAACuB,EAAUC,CAAW,EAAIC,WAAS,EAAK,EACxC,CAACC,EAAYC,CAAU,EAAInC,EAAqB,CAAE,QAAAD,EAAS,OAAAG,EAAQ,MAAAC,CAAA,CAAO,EAEhFS,OAAAA,EAAAA,UAAU,IAAM,CACdoB,EAAY,EAAI,CAClB,EAAG,CAAE,CAAA,EAELpB,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASwB,CAAQ,EAAAP,EACnB,CAAE,QAASQ,CAAgB,EAAAP,EAC7B,OAAAC,GAAYK,GAAOC,GACVH,EAAA,CACT,OAAQE,EACR,SAAU,CACR,SAAUC,EACV,QAASA,CACX,CAAA,CACD,EAEI,IAAM,OAAA,OAAAtB,EAAAoB,MAAA,YAAApB,EAAc,UAC1B,EAAA,CAACgB,EAAUG,EAAYT,CAAO,CAAC,EAElCa,EAAA,oBACEd,EACA,KACS,CACL,WAAAW,EACA,WAAY,IAAMN,EAAW,OAAA,GAGjC,CAAC,CAAA,EAKAU,EAAA,QAAA,cAAAX,EAAA,CAAI,oCAAkC,GAAG,IAAKC,EAAa,GAAGF,CAAA,EAC5DI,EACEQ,EAAAA,QAAA,cAAA,MAAA,CAAI,IAAKT,EAAa,kCAA+B,EAAA,EACnDJ,CACH,EAEAA,CAEJ,CAEJ,EAEMc,EAAyCC,aAAWnB,CAA0B"}
|
|
@@ -1,86 +1,89 @@
|
|
|
1
|
-
import
|
|
2
|
-
import { OverlayScrollbars as
|
|
3
|
-
const
|
|
1
|
+
import S, { useMemo as C, useRef as d, useEffect as f, forwardRef as E, useState as O, useImperativeHandle as h } from "react";
|
|
2
|
+
import { OverlayScrollbars as I } from "overlayscrollbars";
|
|
3
|
+
const F = () => {
|
|
4
4
|
if (typeof window > "u") {
|
|
5
|
-
const
|
|
5
|
+
const r = () => {
|
|
6
6
|
};
|
|
7
|
-
return [
|
|
7
|
+
return [r, r];
|
|
8
8
|
}
|
|
9
9
|
let l, c;
|
|
10
|
-
const t = window, o = typeof t.requestIdleCallback == "function", a = t.requestAnimationFrame, i = t.cancelAnimationFrame,
|
|
10
|
+
const t = window, o = typeof t.requestIdleCallback == "function", a = t.requestAnimationFrame, i = t.cancelAnimationFrame, n = o ? t.requestIdleCallback : a, u = o ? t.cancelIdleCallback : i, s = () => {
|
|
11
11
|
u(l), i(c);
|
|
12
12
|
};
|
|
13
13
|
return [
|
|
14
|
-
(
|
|
15
|
-
s(), l =
|
|
14
|
+
(r, e) => {
|
|
15
|
+
s(), l = n(
|
|
16
16
|
o ? () => {
|
|
17
|
-
s(), c = a(
|
|
18
|
-
} :
|
|
17
|
+
s(), c = a(r);
|
|
18
|
+
} : r,
|
|
19
19
|
typeof e == "object" ? e : { timeout: 2233 }
|
|
20
20
|
);
|
|
21
21
|
},
|
|
22
22
|
s
|
|
23
23
|
];
|
|
24
|
-
},
|
|
25
|
-
const { options: c, events: t, defer: o } = l || {}, [a, i] =
|
|
26
|
-
return
|
|
24
|
+
}, q = (l) => {
|
|
25
|
+
const { options: c, events: t, defer: o } = l || {}, [a, i] = C(F, []), n = d(null), u = d(o), s = d(c), r = d(t);
|
|
26
|
+
return f(() => {
|
|
27
27
|
u.current = o;
|
|
28
|
-
}, [o]),
|
|
29
|
-
const { current: e } =
|
|
30
|
-
s.current = c,
|
|
31
|
-
}, [c]),
|
|
32
|
-
const { current: e } =
|
|
33
|
-
|
|
34
|
-
}, [t]),
|
|
28
|
+
}, [o]), f(() => {
|
|
29
|
+
const { current: e } = n;
|
|
30
|
+
s.current = c, I.valid(e) && e.options(c || {}, !0);
|
|
31
|
+
}, [c]), f(() => {
|
|
32
|
+
const { current: e } = n;
|
|
33
|
+
r.current = t, I.valid(e) && e.on(t || {}, !0);
|
|
34
|
+
}, [t]), f(
|
|
35
35
|
() => () => {
|
|
36
36
|
var e;
|
|
37
|
-
i(), (e =
|
|
37
|
+
i(), (e = n.current) == null || e.destroy();
|
|
38
38
|
},
|
|
39
39
|
[]
|
|
40
|
-
),
|
|
40
|
+
), C(
|
|
41
41
|
() => [
|
|
42
42
|
(e) => {
|
|
43
|
-
const
|
|
44
|
-
if (
|
|
43
|
+
const m = n.current;
|
|
44
|
+
if (I.valid(m))
|
|
45
45
|
return;
|
|
46
|
-
const
|
|
47
|
-
|
|
46
|
+
const v = u.current, y = s.current || {}, b = r.current || {}, p = () => n.current = I(e, y, b);
|
|
47
|
+
v ? a(p, v) : p();
|
|
48
48
|
},
|
|
49
|
-
() =>
|
|
49
|
+
() => n.current
|
|
50
50
|
],
|
|
51
51
|
[]
|
|
52
52
|
);
|
|
53
|
-
},
|
|
54
|
-
const { element: t = "div", options: o, events: a, defer: i, children:
|
|
55
|
-
return
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
53
|
+
}, A = (l, c) => {
|
|
54
|
+
const { element: t = "div", options: o, events: a, defer: i, children: n, ...u } = l, s = t, r = d(null), e = d(null), [m, v] = O(!1), [y, b] = q({ options: o, events: a, defer: i });
|
|
55
|
+
return f(() => {
|
|
56
|
+
v(!0);
|
|
57
|
+
}, []), f(() => {
|
|
58
|
+
const { current: p } = r, { current: R } = e;
|
|
59
|
+
return m && p && R && y({
|
|
60
|
+
target: p,
|
|
59
61
|
elements: {
|
|
60
|
-
viewport:
|
|
61
|
-
content:
|
|
62
|
+
viewport: R,
|
|
63
|
+
content: R
|
|
62
64
|
}
|
|
63
65
|
}), () => {
|
|
64
|
-
var
|
|
65
|
-
return (
|
|
66
|
+
var w;
|
|
67
|
+
return (w = b()) == null ? void 0 : w.destroy();
|
|
66
68
|
};
|
|
67
|
-
}, [y, t]),
|
|
69
|
+
}, [m, y, t]), h(
|
|
68
70
|
c,
|
|
69
71
|
() => ({
|
|
70
|
-
osInstance:
|
|
71
|
-
getElement: () =>
|
|
72
|
+
osInstance: b,
|
|
73
|
+
getElement: () => r.current
|
|
72
74
|
}),
|
|
73
75
|
[]
|
|
74
|
-
), /* @__PURE__ */
|
|
76
|
+
), /* @__PURE__ */ S.createElement(s, {
|
|
75
77
|
"data-overlayscrollbars-initialize": "",
|
|
76
|
-
ref:
|
|
78
|
+
ref: r,
|
|
77
79
|
...u
|
|
78
|
-
}, /* @__PURE__ */
|
|
79
|
-
ref: e
|
|
80
|
-
|
|
81
|
-
},
|
|
80
|
+
}, m ? /* @__PURE__ */ S.createElement("div", {
|
|
81
|
+
ref: e,
|
|
82
|
+
"data-overlayscrollbars-contents": !0
|
|
83
|
+
}, n) : n);
|
|
84
|
+
}, k = E(A);
|
|
82
85
|
export {
|
|
83
|
-
|
|
84
|
-
|
|
86
|
+
k as OverlayScrollbarsComponent,
|
|
87
|
+
q as useOverlayScrollbars
|
|
85
88
|
};
|
|
86
89
|
//# 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\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
|
+
{"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, useState } 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 [hydrated, setHydrated] = useState(false);\r\n const [initialize, osInstance] = useOverlayScrollbars({ options, events, defer });\r\n\r\n useEffect(() => {\r\n setHydrated(true);\r\n }, []);\r\n\r\n useEffect(() => {\r\n const { current: elm } = elementRef;\r\n const { current: childrenElm } = childrenRef;\r\n if (hydrated && 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 }, [hydrated, 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 {hydrated ? (\r\n <div ref={childrenRef} data-overlayscrollbars-contents>\r\n {children}\r\n </div>\r\n ) : (\r\n children\r\n )}\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","hydrated","setHydrated","useState","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,GCjHMe,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,GAAUC,CAAW,IAAIC,EAAS,EAAK,GACxC,CAACC,GAAYC,CAAU,IAAInC,EAAqB,EAAE,SAAAD,GAAS,QAAAG,GAAQ,OAAAC,EAAA,CAAO;AAEhF,SAAAS,EAAU,MAAM;AACd,IAAAoB,EAAY,EAAI;AAAA,EAClB,GAAG,CAAE,CAAA,GAELpB,EAAU,MAAM;AACR,UAAA,EAAE,SAASwB,EAAQ,IAAAP,GACnB,EAAE,SAASQ,EAAgB,IAAAP;AAC7B,WAAAC,KAAYK,KAAOC,KACVH,EAAA;AAAA,MACT,QAAQE;AAAA,MACR,UAAU;AAAA,QACR,UAAUC;AAAA,QACV,SAASA;AAAA,MACX;AAAA,IAAA,CACD,GAEI,MAAM;;AAAA,cAAAtB,IAAAoB,QAAA,gBAAApB,EAAc;AAAA;AAAA,EAC1B,GAAA,CAACgB,GAAUG,GAAYT,CAAO,CAAC,GAElCa;AAAA,IACEd;AAAA,IACA,OACS;AAAA,MACL,YAAAW;AAAA,MACA,YAAY,MAAMN,EAAW;AAAA,IAAA;AAAA,IAGjC,CAAC;AAAA,EAAA,GAKA,gBAAAU,EAAA,cAAAX,GAAA;AAAA,IAAI,qCAAkC;AAAA,IAAG,KAAKC;AAAA,IAAa,GAAGF;AAAA,EAAA,GAC5DI,IACE,gBAAAQ,EAAA,cAAA,OAAA;AAAA,IAAI,KAAKT;AAAA,IAAa,mCAA+B;AAAA,EAAA,GACnDJ,CACH,IAEAA,CAEJ;AAEJ,GAEMc,IAAyCC,EAAWnB,CAA0B;"}
|
|
@@ -1,2 +1,2 @@
|
|
|
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
|
|
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 E=(n=>n&&typeof n=="object"&&"default"in n?n:{default:n})(e),w=()=>{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]},I=n=>{const{options:l,events:r,defer:u}=n||{},[i,a]=e.useMemo(w,[]),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 p=s.current;if(y.OverlayScrollbars.valid(p))return;const m=d.current,b=f.current||{},S=o.current||{},v=()=>s.current=y.OverlayScrollbars(t,b,S);m?i(v,m):v()},()=>s.current],[])},q=(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),[p,m]=e.useState(!1),[b,S]=I({options:u,events:i,defer:a});return e.useEffect(()=>{m(!0)},[]),e.useEffect(()=>{const{current:v}=o,{current:O}=t;return p&&v&&O&&b({target:v,elements:{viewport:O,content:O}}),()=>{var h;return(h=S())==null?void 0:h.destroy()}},[p,b,r]),e.useImperativeHandle(l,()=>({osInstance:S,getElement:()=>o.current}),[]),E.default.createElement(f,{"data-overlayscrollbars-initialize":"",ref:o,...d},p?E.default.createElement("div",{ref:t,"data-overlayscrollbars-contents":!0},s):s)},C=e.forwardRef(q);c.OverlayScrollbarsComponent=C,c.useOverlayScrollbars=I,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\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"}
|
|
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, useState } 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 [hydrated, setHydrated] = useState(false);\r\n const [initialize, osInstance] = useOverlayScrollbars({ options, events, defer });\r\n\r\n useEffect(() => {\r\n setHydrated(true);\r\n }, []);\r\n\r\n useEffect(() => {\r\n const { current: elm } = elementRef;\r\n const { current: childrenElm } = childrenRef;\r\n if (hydrated && 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 }, [hydrated, 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 {hydrated ? (\r\n <div ref={childrenRef} data-overlayscrollbars-contents>\r\n {children}\r\n </div>\r\n ) : (\r\n children\r\n )}\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","hydrated","setHydrated","useState","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,ECjHMe,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,EAAUC,CAAW,EAAIC,WAAS,EAAK,EACxC,CAACC,EAAYC,CAAU,EAAInC,EAAqB,CAAE,QAAAD,EAAS,OAAAG,EAAQ,MAAAC,CAAA,CAAO,EAEhFS,OAAAA,EAAAA,UAAU,IAAM,CACdoB,EAAY,EAAI,CAClB,EAAG,CAAE,CAAA,EAELpB,EAAAA,UAAU,IAAM,CACR,KAAA,CAAE,QAASwB,CAAQ,EAAAP,EACnB,CAAE,QAASQ,CAAgB,EAAAP,EAC7B,OAAAC,GAAYK,GAAOC,GACVH,EAAA,CACT,OAAQE,EACR,SAAU,CACR,SAAUC,EACV,QAASA,CACX,CAAA,CACD,EAEI,IAAM,OAAA,OAAAtB,EAAAoB,MAAA,YAAApB,EAAc,UAC1B,EAAA,CAACgB,EAAUG,EAAYT,CAAO,CAAC,EAElCa,EAAA,oBACEd,EACA,KACS,CACL,WAAAW,EACA,WAAY,IAAMN,EAAW,OAAA,GAGjC,CAAC,CAAA,EAKAU,EAAA,QAAA,cAAAX,EAAA,CAAI,oCAAkC,GAAG,IAAKC,EAAa,GAAGF,CAAA,EAC5DI,EACEQ,EAAAA,QAAA,cAAA,MAAA,CAAI,IAAKT,EAAa,kCAA+B,EAAA,EACnDJ,CACH,EAEAA,CAEJ,CAEJ,EAEMc,EAAyCC,aAAWnB,CAA0B"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "overlayscrollbars-react",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.2",
|
|
4
4
|
"description": "OverlayScrollbars for React.",
|
|
5
5
|
"author": "Rene Haas | KingSora",
|
|
6
6
|
"license": "MIT",
|
|
@@ -18,6 +18,7 @@
|
|
|
18
18
|
"hook",
|
|
19
19
|
"hooks",
|
|
20
20
|
"styleable",
|
|
21
|
+
"custom",
|
|
21
22
|
"scrollbar",
|
|
22
23
|
"scrollbars",
|
|
23
24
|
"scroll"
|
|
@@ -25,6 +26,13 @@
|
|
|
25
26
|
"main": "overlayscrollbars-react.umd.js",
|
|
26
27
|
"module": "overlayscrollbars-react.es.js",
|
|
27
28
|
"types": "types/overlayscrollbars-react.d.ts",
|
|
29
|
+
"exports": {
|
|
30
|
+
".": {
|
|
31
|
+
"require": "./overlayscrollbars-react.cjs.js",
|
|
32
|
+
"import": "./overlayscrollbars-react.es.js",
|
|
33
|
+
"types": "./types/overlayscrollbars-react.d.ts"
|
|
34
|
+
}
|
|
35
|
+
},
|
|
28
36
|
"peerDependencies": {
|
|
29
37
|
"react": ">=16.8.0",
|
|
30
38
|
"overlayscrollbars": "^2.0.0"
|
|
@@ -1,60 +1,25 @@
|
|
|
1
|
-
import type { OverlayScrollbars } from 'overlayscrollbars';
|
|
2
|
-
import type { PartialOptions, EventListeners } from 'overlayscrollbars';
|
|
3
|
-
import type { ComponentPropsWithoutRef, ElementRef, ForwardedRef } from 'react';
|
|
4
|
-
|
|
5
|
-
/** Tag of the root element. */
|
|
6
|
-
element?: T;
|
|
7
|
-
/** OverlayScrollbars options. */
|
|
8
|
-
options?: PartialOptions | false | null;
|
|
9
|
-
/** OverlayScrollbars events. */
|
|
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;
|
|
13
|
-
};
|
|
14
|
-
export
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
paddingAbsolute?: boolean | undefined;
|
|
27
|
-
showNativeOverlaidScrollbars?: boolean | undefined;
|
|
28
|
-
update?: {
|
|
29
|
-
elementEvents?: [elementSelector: string, eventNames: string][] | null | undefined;
|
|
30
|
-
debounce?: number | [timeout: number, maxWait: number] | null | undefined;
|
|
31
|
-
attributes?: string[] | null | undefined;
|
|
32
|
-
ignoreMutation?: ((mutation: MutationRecord) => any) | null | undefined;
|
|
33
|
-
} | undefined;
|
|
34
|
-
overflow?: {
|
|
35
|
-
x?: import("overlayscrollbars").OverflowBehavior | undefined;
|
|
36
|
-
y?: import("overlayscrollbars").OverflowBehavior | undefined;
|
|
37
|
-
} | undefined;
|
|
38
|
-
scrollbars?: {
|
|
39
|
-
theme?: string | null | undefined;
|
|
40
|
-
visibility?: import("overlayscrollbars").ScrollbarsVisibilityBehavior | undefined;
|
|
41
|
-
autoHide?: import("overlayscrollbars").ScrollbarsAutoHideBehavior | undefined;
|
|
42
|
-
autoHideDelay?: number | undefined;
|
|
43
|
-
dragScroll?: boolean | undefined;
|
|
44
|
-
clickScroll?: boolean | undefined;
|
|
45
|
-
pointers?: string[] | null | undefined;
|
|
46
|
-
} | undefined;
|
|
47
|
-
} | null | undefined;
|
|
48
|
-
/** OverlayScrollbars events. */
|
|
49
|
-
events?: false | {
|
|
50
|
-
initialized?: ((instance: OverlayScrollbars) => void) | ((instance: OverlayScrollbars) => void)[] | null | undefined;
|
|
51
|
-
updated?: ((instance: OverlayScrollbars, onUpdatedArgs: import("overlayscrollbars").OnUpdatedEventListenerArgs) => void) | ((instance: OverlayScrollbars, onUpdatedArgs: import("overlayscrollbars").OnUpdatedEventListenerArgs) => void)[] | null | undefined;
|
|
52
|
-
destroyed?: ((instance: OverlayScrollbars, canceled: boolean) => void) | ((instance: OverlayScrollbars, canceled: boolean) => void)[] | null | undefined;
|
|
53
|
-
scroll?: ((instance: OverlayScrollbars, event: Event) => void) | ((instance: OverlayScrollbars, event: Event) => void)[] | null | undefined;
|
|
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;
|
|
57
|
-
} & {
|
|
58
|
-
ref?: ForwardedRef<OverlayScrollbarsComponentRef<T>> | undefined;
|
|
59
|
-
}) => ReturnType<typeof OverlayScrollbarsComponent>;
|
|
60
|
-
export { OverlayScrollbarsComponentForwardedRef as OverlayScrollbarsComponent };
|
|
1
|
+
import type { OverlayScrollbars } from 'overlayscrollbars';
|
|
2
|
+
import type { PartialOptions, EventListeners } from 'overlayscrollbars';
|
|
3
|
+
import type { ComponentPropsWithoutRef, ElementRef, ForwardedRef } from 'react';
|
|
4
|
+
type OverlayScrollbarsComponentBaseProps<T extends keyof JSX.IntrinsicElements> = ComponentPropsWithoutRef<T> & {
|
|
5
|
+
/** Tag of the root element. */
|
|
6
|
+
element?: T;
|
|
7
|
+
/** OverlayScrollbars options. */
|
|
8
|
+
options?: PartialOptions | false | null;
|
|
9
|
+
/** OverlayScrollbars events. */
|
|
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;
|
|
13
|
+
};
|
|
14
|
+
export type OverlayScrollbarsComponentProps<T extends keyof JSX.IntrinsicElements = 'div'> = OverlayScrollbarsComponentBaseProps<T> & {
|
|
15
|
+
ref?: ForwardedRef<OverlayScrollbarsComponentRef<T>>;
|
|
16
|
+
};
|
|
17
|
+
export interface OverlayScrollbarsComponentRef<T extends keyof JSX.IntrinsicElements = 'div'> {
|
|
18
|
+
/** Returns the OverlayScrollbars instance or null if not initialized. */
|
|
19
|
+
osInstance(): OverlayScrollbars | null;
|
|
20
|
+
/** Returns the root element. */
|
|
21
|
+
getElement(): ElementRef<T> | null;
|
|
22
|
+
}
|
|
23
|
+
declare const OverlayScrollbarsComponent: <T extends keyof JSX.IntrinsicElements>(props: OverlayScrollbarsComponentBaseProps<T>, ref: ForwardedRef<OverlayScrollbarsComponentRef<T>>) => JSX.Element;
|
|
24
|
+
declare const OverlayScrollbarsComponentForwardedRef: <T extends keyof JSX.IntrinsicElements>(props: OverlayScrollbarsComponentProps<T>) => ReturnType<typeof OverlayScrollbarsComponent>;
|
|
25
|
+
export { OverlayScrollbarsComponentForwardedRef as OverlayScrollbarsComponent };
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export * from './OverlayScrollbarsComponent';
|
|
2
|
-
export * from './useOverlayScrollbars';
|
|
1
|
+
export * from './OverlayScrollbarsComponent';
|
|
2
|
+
export * from './useOverlayScrollbars';
|
|
@@ -1,20 +1,20 @@
|
|
|
1
|
-
import type { InitializationTarget } from 'overlayscrollbars';
|
|
2
|
-
import type { OverlayScrollbarsComponentProps, OverlayScrollbarsComponentRef } from './OverlayScrollbarsComponent';
|
|
3
|
-
export interface UseOverlayScrollbarsParams {
|
|
4
|
-
/** OverlayScrollbars options. */
|
|
5
|
-
options?: OverlayScrollbarsComponentProps['options'];
|
|
6
|
-
/** OverlayScrollbars events. */
|
|
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'];
|
|
10
|
-
}
|
|
11
|
-
export
|
|
12
|
-
export
|
|
13
|
-
/**
|
|
14
|
-
* Hook for advanced usage of OverlayScrollbars. (When the OverlayScrollbarsComponent is not enough)
|
|
15
|
-
* @param params Parameters for customization.
|
|
16
|
-
* @returns A tuple with two values:
|
|
17
|
-
* The first value is the initialization function, it takes one argument which is the `InitializationTarget`.
|
|
18
|
-
* The second value is a function which returns the current OverlayScrollbars instance or `null` if not initialized.
|
|
19
|
-
*/
|
|
20
|
-
export declare const useOverlayScrollbars: (params?: UseOverlayScrollbarsParams) => [UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance];
|
|
1
|
+
import type { InitializationTarget } from 'overlayscrollbars';
|
|
2
|
+
import type { OverlayScrollbarsComponentProps, OverlayScrollbarsComponentRef } from './OverlayScrollbarsComponent';
|
|
3
|
+
export interface UseOverlayScrollbarsParams {
|
|
4
|
+
/** OverlayScrollbars options. */
|
|
5
|
+
options?: OverlayScrollbarsComponentProps['options'];
|
|
6
|
+
/** OverlayScrollbars events. */
|
|
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'];
|
|
10
|
+
}
|
|
11
|
+
export type UseOverlayScrollbarsInitialization = (target: InitializationTarget) => void;
|
|
12
|
+
export type UseOverlayScrollbarsInstance = () => ReturnType<OverlayScrollbarsComponentRef['osInstance']>;
|
|
13
|
+
/**
|
|
14
|
+
* Hook for advanced usage of OverlayScrollbars. (When the OverlayScrollbarsComponent is not enough)
|
|
15
|
+
* @param params Parameters for customization.
|
|
16
|
+
* @returns A tuple with two values:
|
|
17
|
+
* The first value is the initialization function, it takes one argument which is the `InitializationTarget`.
|
|
18
|
+
* The second value is a function which returns the current OverlayScrollbars instance or `null` if not initialized.
|
|
19
|
+
*/
|
|
20
|
+
export declare const useOverlayScrollbars: (params?: UseOverlayScrollbarsParams) => [UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance];
|