katanakit-js / useGetScrollPosition

Function: useGetScrollPosition()

function useGetScrollPosition(): {
  x: number;
  y: number;
};

Defined in: src/infrastructure/viewport/viewport.service.ts:105

Returns the current scroll position as { x, y }.

Returns

{
  x: number;
  y: number;
}

A ScrollPosition object.

x

x: number;

y

y: number;

Example

const { x, y } = useGetScrollPosition();