@manta-eu/react/use-can-scroll

Reference for @manta-eu/react/use-can-scroll as it is on main.

Type Aliases

ScrollAxis

ScrollAxis = "x" | "y" | "both"

ScrollMetrics

ScrollMetrics = Pick<HTMLElement, "scrollLeft" | "scrollTop" | "scrollWidth" | "scrollHeight" | "clientWidth" | "clientHeight">

UseCanScrollOptions

UseCanScrollOptions<T> = object

Type Parameters

T

T extends HTMLElement

Properties

axis

axis: ScrollAxis

observeMutations?

optional observeMutations?: boolean

ref?

optional ref?: RefObject<T | null>

thresholdPx?

optional thresholdPx?: number

Functions

scrollEdges()

scrollEdges(metrics, thresholdPx, axis): object

Parameters

metrics

ScrollMetrics

thresholdPx

number

axis

ScrollAxis

Returns

object

canScrollDown

canScrollDown: boolean

canScrollLeft

canScrollLeft: boolean

canScrollRight

canScrollRight: boolean

canScrollUp

canScrollUp: boolean

useCanScroll()

useCanScroll<T>(options): object

Type Parameters

T

T extends HTMLElement = HTMLDivElement

Parameters

options

UseCanScrollOptions<T>

Returns

object

canScrollDown

canScrollDown: boolean

canScrollLeft

canScrollLeft: boolean

canScrollRight

canScrollRight: boolean

canScrollUp

canScrollUp: boolean

ref

ref: RefObject<T | null>