mirrors/OverlayScrollbars
2
0
Fork 0
mirror of https://github.com/tenrok/OverlayScrollbars.git synced 2026-06-14 11:22:29 +03:00
Code Issues Packages Projects Releases Wiki Activity

improve readme

Browse Source
This commit is contained in:
Rene Haas
2022-10-17 16:02:09 +02:00
parent 24456fe1f3
commit f47e2728f7
3 changed files with 24 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -8
View File
@@ -337,35 +337,35 @@ OverlayScrollbars(document.querySelector('#myElement'), {}, {
<details><summary><h6>Events in depth</h6></summary> <details><summary><h6>Events in depth</h6></summary>
> __Note__: Every event receives the `instance` from which it was fired as the first argument. Always. > __Note__: Every event receives the `instance` from which it was invoked as the first argument. Always.
### `initialized` ### `initialized`
| arguments | description | | arguments | description |
| :--- | :--- | | :--- | :--- |
| `instance` | The instance which fired the event. | | `instance` | The instance which invoked the event. |
Is fired after all generated elements, observers and events were appended to the DOM. Is invoked after all generated elements, observers and events were appended to the DOM.
### `updated` ### `updated`
| arguments | description | | arguments | description |
| :--- | :--- | | :--- | :--- |
| `instance` | The instance which fired the event. | | `instance` | The instance which invoked the event. |
| `onUpdatedArgs` | An `object` which describes the update in detail. | | `onUpdatedArgs` | An `object` which describes the update in detail. |
> __Note__: If an update was triggered but nothing changed, the event won't be fired. > __Note__: If an update was triggered but nothing changed, the event won't be invoked.
Is fired after the instace was updated. Is invoked after the instace was updated.
### `destroyed` ### `destroyed`
| arguments | description | | arguments | description |
| :--- | :--- | | :--- | :--- |
| `instance` | The instance which fired the event. | | `instance` | The instance which invoked the event. |
| `canceled` | An `boolean` which indicates whether the initialization was canceled and thus destroyed. | | `canceled` | An `boolean` which indicates whether the initialization was canceled and thus destroyed. |
Is fired 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.
</details> </details>
docs/v2/src/components/index.mdx
+8 -8
View File
@@ -324,35 +324,35 @@ OverlayScrollbars(document.querySelector('#myElement'), {}, {
<h6>Events in depth</h6> <h6>Events in depth</h6>
</summary> </summary>
> __Note__: Every event receives the `instance` from which it was fired as the first argument. Always. > __Note__: Every event receives the `instance` from which it was invoked as the first argument. Always.
### `initialized` ### `initialized`
| arguments | description | | arguments | description |
| :--- | :--- | | :--- | :--- |
| `instance` | The instance which fired the event. | | `instance` | The instance which invoked the event. |
Is fired after all generated elements, observers and events were appended to the DOM. Is invoked after all generated elements, observers and events were appended to the DOM.
### `updated` ### `updated`
| arguments | description | | arguments | description |
| :--- | :--- | | :--- | :--- |
| `instance` | The instance which fired the event. | | `instance` | The instance which invoked the event. |
| `onUpdatedArgs` | An `object` which describes the update in detail. | | `onUpdatedArgs` | An `object` which describes the update in detail. |
> __Note__: If an update was triggered but nothing changed, the event won't be fired. > __Note__: If an update was triggered but nothing changed, the event won't be invoked.
Is fired after the instace was updated. Is invoked after the instace was updated.
### `destroyed` ### `destroyed`
| arguments | description | | arguments | description |
| :--- | :--- | | :--- | :--- |
| `instance` | The instance which fired the event. | | `instance` | The instance which invoked the event. |
| `canceled` | An `boolean` which indicates whether the initialization was canceled and thus destroyed. | | `canceled` | An `boolean` which indicates whether the initialization was canceled and thus destroyed. |
Is fired 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.
</details> </details>
packages/overlayscrollbars/README.md
+8 -8
View File
@@ -337,35 +337,35 @@ OverlayScrollbars(document.querySelector('#myElement'), {}, {
<details><summary><h6>Events in depth</h6></summary> <details><summary><h6>Events in depth</h6></summary>
> __Note__: Every event receives the `instance` from which it was fired as the first argument. Always. > __Note__: Every event receives the `instance` from which it was invoked as the first argument. Always.
### `initialized` ### `initialized`
| arguments | description | | arguments | description |
| :--- | :--- | | :--- | :--- |
| `instance` | The instance which fired the event. | | `instance` | The instance which invoked the event. |
Is fired after all generated elements, observers and events were appended to the DOM. Is invoked after all generated elements, observers and events were appended to the DOM.
### `updated` ### `updated`
| arguments | description | | arguments | description |
| :--- | :--- | | :--- | :--- |
| `instance` | The instance which fired the event. | | `instance` | The instance which invoked the event. |
| `onUpdatedArgs` | An `object` which describes the update in detail. | | `onUpdatedArgs` | An `object` which describes the update in detail. |
> __Note__: If an update was triggered but nothing changed, the event won't be fired. > __Note__: If an update was triggered but nothing changed, the event won't be invoked.
Is fired after the instace was updated. Is invoked after the instace was updated.
### `destroyed` ### `destroyed`
| arguments | description | | arguments | description |
| :--- | :--- | | :--- | :--- |
| `instance` | The instance which fired the event. | | `instance` | The instance which invoked the event. |
| `canceled` | An `boolean` which indicates whether the initialization was canceled and thus destroyed. | | `canceled` | An `boolean` which indicates whether the initialization was canceled and thus destroyed. |
Is fired 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.
</details> </details>