Skip to content

Commit 4611fa8

Browse files
committed
feat(*): export a version
The version is currently no used but can be used in the future to check for compatibility when ViewportProviders with different versions are rendered within the same tree. Therefore it is required to introduce it now. Issue: #3
1 parent b2d3fef commit 4611fa8

File tree

6 files changed

+12927
-0
lines changed

6 files changed

+12927
-0
lines changed

lib/ObserveViewport.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ interface IContext {
3636
) => void;
3737
removeViewportChangeListener: (handler: TViewportChangeHandler) => void;
3838
hasRootProviderAsParent: boolean;
39+
version: string;
3940
}
4041

4142
export default class ObserveViewport extends React.Component<IProps, IState> {

lib/ViewportProvider.tsx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import {
77
IViewportCollectorUpdateOptions,
88
} from './types';
99
import ViewportCollector from './ViewportCollector';
10+
import { VERSION } from './index';
1011

1112
interface IListener extends IViewportChangeOptions {
1213
handler: TViewportChangeHandler;
@@ -19,6 +20,7 @@ const ViewportContext = React.createContext({
1920
options: IViewportChangeOptions,
2021
) => {},
2122
hasRootProviderAsParent: false,
23+
version: VERSION,
2224
});
2325

2426
export const Consumer = ViewportContext.Consumer;
@@ -67,6 +69,7 @@ export default class ViewportProvider extends React.PureComponent {
6769
addViewportChangeListener: this.addViewportChangeListener,
6870
removeViewportChangeListener: this.removeViewportChangeListener,
6971
hasRootProviderAsParent: true,
72+
version: VERSION,
7073
};
7174
return (
7275
<React.Fragment>

lib/index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@ export {
55
} from './ObserveBoundingClientRect';
66
export { default as ObserveViewport } from './ObserveViewport';
77
export { IRect, IScroll, IDimensions } from './types';
8+
9+
export const VERSION = '__VERSION__';

0 commit comments

Comments
 (0)