mirrors/OverlayScrollbars
2
0
Fork 0
mirror of https://github.com/tenrok/OverlayScrollbars.git synced 2026-06-19 17:40:35 +03:00
Code Issues Packages Projects Releases Wiki Activity

improve readme

Browse Source
This commit is contained in:
Rene Haas
2022-11-09 11:23:55 +01:00
parent 8f48002d7a
commit 78cfc44904
2 changed files with 52 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+26 -18
View File
@@ -44,6 +44,7 @@ I created this plugin because I hate ugly and space consuming scrollbars. Simila
- Highly customizable - Highly customizable
- TypeScript support - fully written in TypeScript - TypeScript support - fully written in TypeScript
- Dependency free - 100% self written to ensure small size and best functionality - Dependency free - 100% self written to ensure small size and best functionality
- Framework versions for `react`, `vue` and `angular`
## Getting started ## 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. 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.
</details> </details>
## Instance Methods ## Instance
> __Note__: For now please refer to the <b>TypeScript definitions</b> for a more detailed description. > __Note__: For now please refer to the <b>TypeScript definitions</b> for a more detailed description.
```ts ```ts
interface OverlayScrollbars { interface OverlayScrollbars {
options(): Options; options(): Options;
options(newOptions: DeepPartial<Options>): Options; options(newOptions: PartialOptions, pure?: boolean): Options;
update(force?: boolean): OverlayScrollbars; on(eventListeners: EventListeners, pure?: boolean): () => void;
on<N extends keyof EventListenerArgs>(name: N, listener: EventListener<N>): () => void;
on<N extends keyof EventListenerArgs>(name: N, listener: EventListener<N>[]): () => void;
destroy(): void; off<N extends keyof EventListenerArgs>(name: N, listener: EventListener<N>): void;
off<N extends keyof EventListenerArgs>(name: N, listener: EventListener<N>[]): void;
update(force?: boolean): boolean;
state(): State; state(): State;
elements(): Elements; elements(): Elements;
on(eventListeners: EventListeners): () => void; destroy(): void;
on<N extends keyof EventListenerMap>(name: N, listener: EventListener<N>): () => void;
on<N extends keyof EventListenerMap>(name: N, listener: EventListener<N>[]): () => void;
off<N extends keyof EventListenerMap>(name: N, listener: EventListener<N>): void;
off<N extends keyof EventListenerMap>(name: N, listener: EventListener<N>[]): void;
} }
``` ```
@@ -426,14 +436,12 @@ interface OverlayScrollbars {
```ts ```ts
interface OverlayScrollbarsStatic { interface OverlayScrollbarsStatic {
(target: InitializationTarget): OverlayScrollbars | undefined; (target: InitializationTarget): OverlayScrollbars | undefined;
( (target: InitializationTarget, options: PartialOptions, eventListeners?: EventListeners): OverlayScrollbars;
target: InitializationTarget,
options: DeepPartial<Options>,
eventListeners?: InitialEventListeners
): OverlayScrollbars;
plugin(plugin: Plugin | Plugin[]): void; plugin(plugin: Plugin | Plugin[]): void;
valid(osInstance: any): boolean;
valid(osInstance: any): osInstance is OverlayScrollbars;
env(): Environment; env(): Environment;
} }
``` ```
@@ -481,11 +489,11 @@ You can write and publish your own Plugins. This section is a work in progress.
<tr> <tr>
<td> <td>
<a href="https://www.browserstack.com" target="_blank"> <a href="https://www.browserstack.com" target="_blank">
<img align="center" src="https://kingsora.github.io/OverlayScrollbars/img/browserstack.png" width="250"> <img align="center" src="https://kingsora.github.io/OverlayScrollbars/img/browserstack.png" width="250">
</a> </a>
</td> </td>
<td> <td>
Thanks to <a href="https://www.browserstack.com" target="_blank">BrowserStack</a> for sponsoring open source projects and letting me test OverlayScrollbars for free. Thanks to <a href="https://www.browserstack.com" target="_blank">BrowserStack</a> for sponsoring open source projects and letting me test OverlayScrollbars for free.
</td> </td>
</tr> </tr>
</tbody> </tbody>
packages/overlayscrollbars/README.md
+26 -18
View File
@@ -44,6 +44,7 @@ I created this plugin because I hate ugly and space consuming scrollbars. Simila
- Highly customizable - Highly customizable
- TypeScript support - fully written in TypeScript - TypeScript support - fully written in TypeScript
- Dependency free - 100% self written to ensure small size and best functionality - Dependency free - 100% self written to ensure small size and best functionality
- Framework versions for `react`, `vue` and `angular`
## Getting started ## 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. 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.
</details> </details>
## Instance Methods ## Instance
> __Note__: For now please refer to the <b>TypeScript definitions</b> for a more detailed description. > __Note__: For now please refer to the <b>TypeScript definitions</b> for a more detailed description.
```ts ```ts
interface OverlayScrollbars { interface OverlayScrollbars {
options(): Options; options(): Options;
options(newOptions: DeepPartial<Options>): Options; options(newOptions: PartialOptions, pure?: boolean): Options;
update(force?: boolean): OverlayScrollbars; on(eventListeners: EventListeners, pure?: boolean): () => void;
on<N extends keyof EventListenerArgs>(name: N, listener: EventListener<N>): () => void;
on<N extends keyof EventListenerArgs>(name: N, listener: EventListener<N>[]): () => void;
destroy(): void; off<N extends keyof EventListenerArgs>(name: N, listener: EventListener<N>): void;
off<N extends keyof EventListenerArgs>(name: N, listener: EventListener<N>[]): void;
update(force?: boolean): boolean;
state(): State; state(): State;
elements(): Elements; elements(): Elements;
on(eventListeners: EventListeners): () => void; destroy(): void;
on<N extends keyof EventListenerMap>(name: N, listener: EventListener<N>): () => void;
on<N extends keyof EventListenerMap>(name: N, listener: EventListener<N>[]): () => void;
off<N extends keyof EventListenerMap>(name: N, listener: EventListener<N>): void;
off<N extends keyof EventListenerMap>(name: N, listener: EventListener<N>[]): void;
} }
``` ```
@@ -426,14 +436,12 @@ interface OverlayScrollbars {
```ts ```ts
interface OverlayScrollbarsStatic { interface OverlayScrollbarsStatic {
(target: InitializationTarget): OverlayScrollbars | undefined; (target: InitializationTarget): OverlayScrollbars | undefined;
( (target: InitializationTarget, options: PartialOptions, eventListeners?: EventListeners): OverlayScrollbars;
target: InitializationTarget,
options: DeepPartial<Options>,
eventListeners?: InitialEventListeners
): OverlayScrollbars;
plugin(plugin: Plugin | Plugin[]): void; plugin(plugin: Plugin | Plugin[]): void;
valid(osInstance: any): boolean;
valid(osInstance: any): osInstance is OverlayScrollbars;
env(): Environment; env(): Environment;
} }
``` ```
@@ -481,11 +489,11 @@ You can write and publish your own Plugins. This section is a work in progress.
<tr> <tr>
<td> <td>
<a href="https://www.browserstack.com" target="_blank"> <a href="https://www.browserstack.com" target="_blank">
<img align="center" src="https://kingsora.github.io/OverlayScrollbars/img/browserstack.png" width="250"> <img align="center" src="https://kingsora.github.io/OverlayScrollbars/img/browserstack.png" width="250">
</a> </a>
</td> </td>
<td> <td>
Thanks to <a href="https://www.browserstack.com" target="_blank">BrowserStack</a> for sponsoring open source projects and letting me test OverlayScrollbars for free. Thanks to <a href="https://www.browserstack.com" target="_blank">BrowserStack</a> for sponsoring open source projects and letting me test OverlayScrollbars for free.
</td> </td>
</tr> </tr>
</tbody> </tbody>