diff --git a/README.md b/README.md index cc943ae..c8e1fa4 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,7 @@ I created this plugin because I hate ugly and space consuming scrollbars. Simila - Highly customizable - TypeScript support - fully written in TypeScript - Dependency free - 100% self written to ensure small size and best functionality + - Framework versions for `react`, `vue` and `angular` ## Getting started @@ -391,31 +392,40 @@ Is invoked after the instace was updated. Is invoked after all generated elements, observers and events were removed from the DOM. +### `scroll` + +| arguments | description | +| :--- | :--- | +| `instance` | The instance which invoked the event. | +| `event` | The original `event` argument of the DOM event. | + +Is invoked by scrolling the viewport. + -## Instance Methods +## Instance > __Note__: For now please refer to the TypeScript definitions for a more detailed description. ```ts interface OverlayScrollbars { options(): Options; - options(newOptions: DeepPartial): Options; + options(newOptions: PartialOptions, pure?: boolean): Options; - update(force?: boolean): OverlayScrollbars; + on(eventListeners: EventListeners, pure?: boolean): () => void; + on(name: N, listener: EventListener): () => void; + on(name: N, listener: EventListener[]): () => void; - destroy(): void; + off(name: N, listener: EventListener): void; + off(name: N, listener: EventListener[]): void; + + update(force?: boolean): boolean; state(): State; elements(): Elements; - on(eventListeners: EventListeners): () => void; - on(name: N, listener: EventListener): () => void; - on(name: N, listener: EventListener[]): () => void; - - off(name: N, listener: EventListener): void; - off(name: N, listener: EventListener[]): void; + destroy(): void; } ``` @@ -426,14 +436,12 @@ interface OverlayScrollbars { ```ts interface OverlayScrollbarsStatic { (target: InitializationTarget): OverlayScrollbars | undefined; - ( - target: InitializationTarget, - options: DeepPartial, - eventListeners?: InitialEventListeners - ): OverlayScrollbars; + (target: InitializationTarget, options: PartialOptions, eventListeners?: EventListeners): OverlayScrollbars; plugin(plugin: Plugin | Plugin[]): void; - valid(osInstance: any): boolean; + + valid(osInstance: any): osInstance is OverlayScrollbars; + env(): Environment; } ``` @@ -481,11 +489,11 @@ You can write and publish your own Plugins. This section is a work in progress. - + - Thanks to BrowserStack for sponsoring open source projects and letting me test OverlayScrollbars for free. + Thanks to BrowserStack for sponsoring open source projects and letting me test OverlayScrollbars for free. diff --git a/packages/overlayscrollbars/README.md b/packages/overlayscrollbars/README.md index cc943ae..c8e1fa4 100644 --- a/packages/overlayscrollbars/README.md +++ b/packages/overlayscrollbars/README.md @@ -44,6 +44,7 @@ I created this plugin because I hate ugly and space consuming scrollbars. Simila - Highly customizable - TypeScript support - fully written in TypeScript - Dependency free - 100% self written to ensure small size and best functionality + - Framework versions for `react`, `vue` and `angular` ## Getting started @@ -391,31 +392,40 @@ Is invoked after the instace was updated. Is invoked after all generated elements, observers and events were removed from the DOM. +### `scroll` + +| arguments | description | +| :--- | :--- | +| `instance` | The instance which invoked the event. | +| `event` | The original `event` argument of the DOM event. | + +Is invoked by scrolling the viewport. + -## Instance Methods +## Instance > __Note__: For now please refer to the TypeScript definitions for a more detailed description. ```ts interface OverlayScrollbars { options(): Options; - options(newOptions: DeepPartial): Options; + options(newOptions: PartialOptions, pure?: boolean): Options; - update(force?: boolean): OverlayScrollbars; + on(eventListeners: EventListeners, pure?: boolean): () => void; + on(name: N, listener: EventListener): () => void; + on(name: N, listener: EventListener[]): () => void; - destroy(): void; + off(name: N, listener: EventListener): void; + off(name: N, listener: EventListener[]): void; + + update(force?: boolean): boolean; state(): State; elements(): Elements; - on(eventListeners: EventListeners): () => void; - on(name: N, listener: EventListener): () => void; - on(name: N, listener: EventListener[]): () => void; - - off(name: N, listener: EventListener): void; - off(name: N, listener: EventListener[]): void; + destroy(): void; } ``` @@ -426,14 +436,12 @@ interface OverlayScrollbars { ```ts interface OverlayScrollbarsStatic { (target: InitializationTarget): OverlayScrollbars | undefined; - ( - target: InitializationTarget, - options: DeepPartial, - eventListeners?: InitialEventListeners - ): OverlayScrollbars; + (target: InitializationTarget, options: PartialOptions, eventListeners?: EventListeners): OverlayScrollbars; plugin(plugin: Plugin | Plugin[]): void; - valid(osInstance: any): boolean; + + valid(osInstance: any): osInstance is OverlayScrollbars; + env(): Environment; } ``` @@ -481,11 +489,11 @@ You can write and publish your own Plugins. This section is a work in progress. - + - Thanks to BrowserStack for sponsoring open source projects and letting me test OverlayScrollbars for free. + Thanks to BrowserStack for sponsoring open source projects and letting me test OverlayScrollbars for free.