Source: https://primereact.org/hooks/useoverlayscrolllistener/

Introducing PrimeReact v11 Alpha 🥁Learn More

• SearchK

• 10.9.7

  • v11(11.0.0)

  • v10(10.9.7)

  • v9(9.6.3)

• HOOK

• API

useOverlayScrollListener

Monitors scroll event of a parent element.

Import#

---

import { useOverlayScrollListener } from 'primereact/hooks';
         

Copy

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.

Show

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

Copy

• Import

• Basic

PrimeReact 10.9.7 by PrimeTek