You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/api/ObserveViewport_connectViewport_useViewport.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -10,9 +10,9 @@ Render props are easy to implement in the most situations but the event handler
10
10
11
11
| Property | Type | Required? | Description |
12
12
|:---|:---|:---:|:---|
13
-
| onUpdate | function || Triggers as soon as a viewport update was detected. Contains the `IViewport` as the first argument and the last return of `recalculateLayoutBeforeUpdate` as the second argument |
14
-
| recalculateLayoutBeforeUpdate | function || Enables a way to calculate layout information for all components as a badge before the onUpdate call. Contains the `IViewport` as the first argument. See [recalculateLayoutBeforeUpdate](../concepts/recalculateLayoutBeforeUpdate.md)|
15
-
| children | function || Like `onUpdate` but expects to return that will be rendered on the page. Contains the `IViewport` as the first argument. |
13
+
| onUpdate | function || Triggers as soon as a viewport update was detected. Contains the `Viewport` as the first argument and the last return of `recalculateLayoutBeforeUpdate` as the second argument |
14
+
| recalculateLayoutBeforeUpdate | function || Enables a way to calculate layout information for all components as a badge before the onUpdate call. Contains the `Viewport` as the first argument. See [recalculateLayoutBeforeUpdate](../concepts/recalculateLayoutBeforeUpdate.md)|
15
+
| children | function || Like `onUpdate` but expects to return that will be rendered on the page. Contains the `Viewport` as the first argument. |
16
16
| deferUpdateUntilIdle | boolean || Defers to trigger updates until the collector is idle. See [Defer Events](../concepts/defer_events.md)|
17
17
| priority |`'low'`, `'normal'`, `'high'`, `'highest'`|| Allows to set a priority of the update. See [Defer Events](../concepts/scheduler.md)|
@@ -129,12 +129,12 @@ Hook effects allow to trigger side effects on change without updating the compon
129
129
130
130
| Argument | Type | Required? | Description |
131
131
|:---|:---|:---:|:---|
132
-
| effect | (IViewport\|IScroll\|IDimensions) => void | x | Disables updates to scroll events (only for `useViewport`) |
132
+
| effect | (Viewport\|Scroll\|Dimensions) => void | x | Disables updates to scroll events (only for `useViewport`) |
133
133
| options.disableScrollUpdates | boolean || Disables updates to scroll events (only for `useViewport`) |
134
134
| options.disableDimensionsUpdates | boolean || Disables updates to dimensions events (only for `useViewport`) |
135
135
| options.deferUpdateUntilIdle | boolean || Defers to trigger updates until the collector is idle. See [Defer Events](../concepts/defer_events.md)|
136
136
| options.priority |`'low'`, `'normal'`, `'high'`, `'highest'`|| Allows to set a priority of the update. See [Defer Events](../concepts/scheduler.md)|
137
-
| options.recalculateLayoutBeforeUpdate | function || Enables a way to calculate layout information for all components as a badge before the effect call. Contains `IViewport`, `IScroll` or `IDimensions` as the first argument, dependent of the used hook. See [recalculateLayoutBeforeUpdate](../concepts/recalculateLayoutBeforeUpdate.md)|
137
+
| options.recalculateLayoutBeforeUpdate | function || Enables a way to calculate layout information for all components as a badge before the effect call. Contains `Viewport`, `Scroll` or `Dimensions` as the first argument, dependent of the used hook. See [recalculateLayoutBeforeUpdate](../concepts/recalculateLayoutBeforeUpdate.md)|
138
138
| deps | array || Array with dependencies. In case a value inside the array changes, this will force an update to the effect function |
0 commit comments