useOverlayScrollListener

Monitors scroll event of a parent element.

Import#


import { useOverlayScrollListener } from 'primereact/hooks';

Basic#

When any ancestor component of the button is scrolled, the overlay gets hidden. This is especially useful to avoid alignment issues when the overlay is attached to the document body via a Portal.


const [bindOverlayScrollListener, unbindOverlayScrollListener] = useOverlayScrollListener({
    target: buttonRef.current,
    listener: handleScroll,
    options: { passive: true },
    when: visible
});