aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/src/main/js/helpers/scrolling.js
blob: e0ee20ab024d4f1e2db43eaa2b101c1e44c713f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
/*
 * SonarQube
 * Copyright (C) 2009-2017 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.
 */
// @flow
import { debounce } from 'lodash';

const SCROLLING_DURATION = 100;
const SCROLLING_INTERVAL = 10;
const SCROLLING_STEPS = SCROLLING_DURATION / SCROLLING_INTERVAL;

const getScrollPosition = (element: HTMLElement): number => {
  return element === window ? window.scrollY : element.scrollTop;
};

const scrollElement = (element: HTMLElement, position: number) => {
  if (element === window) {
    window.scrollTo(0, position);
  } else {
    element.scrollTop = position;
  }
};

let smoothScrollTop = (y: number, parent) => {
  const scrollTop = getScrollPosition(parent);
  const scrollingDown = y > scrollTop;
  const step = Math.ceil(Math.abs(y - scrollTop) / SCROLLING_STEPS);
  let stepsDone = 0;

  const interval = setInterval(
    () => {
      const scrollTop = getScrollPosition(parent);
      if (scrollTop === y || SCROLLING_STEPS === stepsDone) {
        clearInterval(interval);
      } else {
        let goal;
        if (scrollingDown) {
          goal = Math.min(y, scrollTop + step);
        } else {
          goal = Math.max(y, scrollTop - step);
        }
        stepsDone++;
        scrollElement(parent, goal);
      }
    },
    SCROLLING_INTERVAL
  );
};

smoothScrollTop = debounce(smoothScrollTop, SCROLLING_DURATION, { leading: true });

export const scrollToElement = (
  element: HTMLElement,
  topOffset: number = 0,
  bottomOffset: number = 0,
  parent: HTMLElement = window
) => {
  const { top, bottom } = element.getBoundingClientRect();
  const scrollTop = getScrollPosition(parent);
  const height: number = parent === window
    ? window.innerHeight
    : parent.getBoundingClientRect().height;

  const parentTop = parent === window ? 0 : parent.getBoundingClientRect().top;

  if (top - parentTop < topOffset) {
    smoothScrollTop(scrollTop - topOffset + top - parentTop, parent);
  }

  if (bottom - parentTop > height - bottomOffset) {
    smoothScrollTop(scrollTop + bottom - parentTop - height + bottomOffset, parent);
  }
};