From 46f7a5d452a10ba8146e25de0e771127dfcf0aac Mon Sep 17 00:00:00 2001 From: Brian Ingles Date: Fri, 22 Mar 2024 12:08:05 -0500 Subject: [PATCH] Comment (#1858) --- packages/react-hooks/src/usePopoverOnScrollRef.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/react-hooks/src/usePopoverOnScrollRef.ts b/packages/react-hooks/src/usePopoverOnScrollRef.ts index 34fd181a8a..688eac9145 100644 --- a/packages/react-hooks/src/usePopoverOnScrollRef.ts +++ b/packages/react-hooks/src/usePopoverOnScrollRef.ts @@ -15,7 +15,8 @@ export interface UsePopoverOnScrollRefResult { * event listener to * @param onScroll Scroll event listener function to attach * @param getInitialScrollPosition Function to retrieve the initial scroll - * position. If it returns `null`, no scrolling will occur. + * position. If no function is given, or if the function returns `null`, no + * initial scrolling will occur. */ export function usePopoverOnScrollRef( findScrollArea: (ref: T | null) => HTMLElement | null,