Comment (#1858)

deephaven · Mar 22, 2024 · 46f7a5d · 46f7a5d
1 parent e9a61b7
commit 46f7a5d
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/packages/react-hooks/src/usePopoverOnScrollRef.ts b/packages/react-hooks/src/usePopoverOnScrollRef.ts
@@ -15,7 +15,8 @@ export interface UsePopoverOnScrollRefResult<T> {
  * 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<T>(
  findScrollArea: (ref: T | null) => HTMLElement | null,