Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions packages/web-api-hooks/src/useViewportScale.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { renderHook } from '@testing-library/react-hooks';

import { useViewportScale } from '.';

test('useViewportScale falls back to 1.0', () => {
const { result } = renderHook(() => useViewportScale());
expect(result.current).toEqual(1.0);
});
22 changes: 12 additions & 10 deletions packages/web-api-hooks/src/useViewportScale.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import { useEffect, useState } from 'react';

import { canUseDOM, managedEventListener } from './utils';
import { canUseVisualViewport, managedEventListener } from './utils';

/**
* Tracks visual viewport scale.
*
* ⚗️ _The underlying technology is experimental. Please be aware about browser compatibility before using this in production._
*
* @returns Pinch-zoom scaling factor, falling back to `0` when unavailable.
* @returns Pinch-zoom scaling factor, falling back to `1.0` when unavailable.
*
* @example
* function Component() {
Expand All @@ -17,16 +17,18 @@ import { canUseDOM, managedEventListener } from './utils';
*/
export default function useViewportScale(): number {
const [scale, setScale] = useState(
canUseDOM ? window.visualViewport.scale : 0,
canUseVisualViewport ? window.visualViewport.scale : 1.0,
);

useEffect(
() =>
managedEventListener(window.visualViewport, 'resize', () => {
setScale(window.visualViewport.scale);
}),
[],
);
useEffect(() => {
if (!canUseVisualViewport) {
return;
}

managedEventListener(window.visualViewport, 'resize', () => {
setScale(window.visualViewport.scale);
});
}, []);

return scale;
}
8 changes: 8 additions & 0 deletions packages/web-api-hooks/src/useViewportScrollCoords.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { renderHook } from '@testing-library/react-hooks';

import { useViewportScrollCoords } from '.';

test('useViewportScrollCoords falls back to [0, 0]', () => {
const { result } = renderHook(() => useViewportScrollCoords());
expect(result.current).toEqual([0, 0]);
});
29 changes: 17 additions & 12 deletions packages/web-api-hooks/src/useViewportScrollCoords.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { useEffect, useState } from 'react';

import { canUseDOM, managedEventListener } from './utils';
import { canUseVisualViewport, managedEventListener } from './utils';

/**
* Tracks visual viewport scroll position.
Expand All @@ -17,21 +17,26 @@ import { canUseDOM, managedEventListener } from './utils';
*/
export default function useViewportScrollCoords(): Readonly<[number, number]> {
const [coords, setCoords] = useState<Readonly<[number, number]>>(
canUseDOM
canUseVisualViewport
? [window.visualViewport.pageLeft, window.visualViewport.pageTop]
: [0, 0],
);

useEffect(
() =>
managedEventListener(window.visualViewport, 'scroll', () => {
setCoords([
window.visualViewport.pageLeft,
window.visualViewport.pageTop,
]);
}),
[],
);
useEffect(() => {
if (!canUseVisualViewport) {
return;
}

function handler(): void {
setCoords([
window.visualViewport.pageLeft,
window.visualViewport.pageTop,
]);
}

managedEventListener(window?.visualViewport, 'scroll', handler);
managedEventListener(window?.visualViewport, 'resize', handler);
}, []);

return coords;
}
2 changes: 2 additions & 0 deletions packages/web-api-hooks/src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import { EventMap } from './types';

export const canUseDOM = typeof window !== 'undefined';

export const canUseVisualViewport = canUseDOM && 'visualViewport' in window;

export function dethunkify<T>(value: T | (() => T)): T {
return typeof value === 'function' ? (value as () => T)() : value;
}
Expand Down