sonarqube/server/sonar-web/src/main/js/hooks/useFollowScroll.ts

/*
 * SonarQube
 * Copyright (C) 2009-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
import { throttle } from 'lodash';
import { useEffect, useState } from 'react';

const THROTTLE_DELAY = 10;

export default function useFollowScroll() {
  const [left, setLeft] = useState(0);
  const [top, setTop] = useState(0);
  const [scrolledOnce, setScrolledOnce] = useState(false);

  useEffect(() => {
    const followScroll = throttle(() => {
      if (document.documentElement) {
        setLeft(document.documentElement.scrollLeft);
        setTop(document.documentElement.scrollTop);
        setScrolledOnce(true);
      }
    }, THROTTLE_DELAY);

    document.addEventListener('scroll', followScroll);
    return () => document.removeEventListener('scroll', followScroll);
  }, []);

  return { left, top, scrolledOnce };
}