feat(connectViewport): allow passing a priority

garthenweb · Feb 16, 2020 · 09a0bfb · 09a0bfb
1 parent 8325ce6
commit 09a0bfb
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/docs/api/ObserveViewport_connectViewport_useViewport.md b/docs/api/ObserveViewport_connectViewport_useViewport.md
@@ -54,6 +54,7 @@ This is just a wrapper for the `ObserveViewport` to implement the HOC pattern.
 |:---|:---|:---:|:---|
 | omit | `['scroll', 'dimensions']` |  | Allows to disable scroll or dimensions events for the higher order component |
 | deferUpdateUntilIdle | boolean |  | Defers to trigger updates until the collector is idle. See [Defer Events](../concepts/defer_events.md). |
+| options.priority | `'low'`, `'normal'`, `'high'`, `'highest'` |  | Allows to set a priority of the update. See [Defer Events](../concepts/scheduler.md) |
 
 ## Example
 

diff --git a/lib/ConnectViewport.tsx b/lib/ConnectViewport.tsx
@@ -2,6 +2,7 @@ import * as React from 'react';
 
 import { IScroll, IDimensions } from './index';
 import ObserveViewport from './ObserveViewport';
+import { PriorityType } from './types';
 
 interface IInjectedProps {
   scroll?: IScroll | null;
@@ -13,6 +14,7 @@ type TPropStrings = 'scroll' | 'dimensions';
 interface IOptions {
   omit?: TPropStrings[];
   deferUpdateUntilIdle?: boolean;
+  priority?: PriorityType;
 }
 
 export default function connect(options: IOptions = {}) {
@@ -34,6 +36,7 @@ export default function connect(options: IOptions = {}) {
             disableScrollUpdates={shouldOmitScroll}
             disableDimensionsUpdates={shouldOmitDimensions}
             deferUpdateUntilIdle={deferUpdateUntilIdle}
+            priority={options.priority}
           >
             {({ scroll, dimensions }) => (
               <WrappedComponent