Comment (#1858)

deephaven · Mar 22, 2024 · e9a61b7 · e9a61b7
1 parent 2519882
commit e9a61b7
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
@@ -14,7 +14,8 @@ export interface UsePopoverOnScrollRefResult<T> {
  * @param findScrollArea Function to retreive the DOM element to attach a scroll
  * event listener to
  * @param onScroll Scroll event listener function to attach
- * @param getInitialScrollPosition Function to retrieve the initial scroll position.
+ * @param getInitialScrollPosition Function to retrieve the initial scroll
+ * position. If it returns `null`, no scrolling will occur.
  */
 export function usePopoverOnScrollRef<T>(
  findScrollArea: (ref: T | null) => HTMLElement | null,