katanakit-js / useIsAtTop

Function: useIsAtTop()

function useIsAtTop(threshold?): boolean;

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

Checks whether the page is scrolled to (or near) the top.

Parameters

Parameter	Type	Default value	Description
threshold	number	0	Pixel tolerance (default: 0).

Returns

boolean

true if scrollY <= threshold.