From cf9cda1cf61a3e7f506ec40fd65d97b79fc56557 Mon Sep 17 00:00:00 2001 From: Rene Haas Date: Tue, 1 Nov 2022 14:06:26 +0100 Subject: [PATCH] improve documentation --- README.md | 4 +++- packages/overlayscrollbars-react/src/useOverlayScrollbars.ts | 4 ++-- packages/overlayscrollbars/README.md | 4 +++- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2a1630f..cc943ae 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ I created this plugin because I hate ugly and space consuming scrollbars. Simila ## Getting started -### npm & Node +### npm & node OverlayScrollbars can be downloaded from [npm](https://www.npmjs.com/package/overlayscrollbars) or the package manager of your choice: ```sh npm install overlayscrollbars @@ -58,6 +58,8 @@ import 'overlayscrollbars/overlayscrollbars.css'; import { OverlayScrollbars } from 'overlayscrollbars'; ``` +> __Note__: In older node versions use `'overlayscrollbars/styles/overlayscrollbars.css'` as the import path for the CSS file. + ### Manual download & embedding
diff --git a/packages/overlayscrollbars-react/src/useOverlayScrollbars.ts b/packages/overlayscrollbars-react/src/useOverlayScrollbars.ts index 52c599f..60c21ba 100644 --- a/packages/overlayscrollbars-react/src/useOverlayScrollbars.ts +++ b/packages/overlayscrollbars-react/src/useOverlayScrollbars.ts @@ -14,16 +14,16 @@ export type UseOverlayScrollbarsInstance = () => OverlayScrollbars | null; * @param events OverlayScrollbars events. * @returns A tuple with two values: * The first value is the initialization function. - * The second value is an function which returns the current OverlayScrollbars instance or null if not initialized. + * The second value is a function which returns the current OverlayScrollbars instance or null if not initialized. */ export const useOverlayScrollbars = ( options?: PartialOptions, events?: EventListeners ): [UseOverlayScrollbarsInitialization, UseOverlayScrollbarsInstance] => { const osInstanceRef = useRef(null); + const offInitialEventsRef = useRef<(() => void) | void>(); const optionsRef = useRef(); const eventsRef = useRef(); - const offInitialEventsRef = useRef<(() => void) | void>(); useEffect(() => { const { current: instance } = osInstanceRef; diff --git a/packages/overlayscrollbars/README.md b/packages/overlayscrollbars/README.md index 2a1630f..cc943ae 100644 --- a/packages/overlayscrollbars/README.md +++ b/packages/overlayscrollbars/README.md @@ -47,7 +47,7 @@ I created this plugin because I hate ugly and space consuming scrollbars. Simila ## Getting started -### npm & Node +### npm & node OverlayScrollbars can be downloaded from [npm](https://www.npmjs.com/package/overlayscrollbars) or the package manager of your choice: ```sh npm install overlayscrollbars @@ -58,6 +58,8 @@ import 'overlayscrollbars/overlayscrollbars.css'; import { OverlayScrollbars } from 'overlayscrollbars'; ``` +> __Note__: In older node versions use `'overlayscrollbars/styles/overlayscrollbars.css'` as the import path for the CSS file. + ### Manual download & embedding