From cfab69910851579f365aefa3e4b048c54c92a0ff Mon Sep 17 00:00:00 2001
From: Pascal Mugnier <pascal.mugnier@sonarsource.com>
Date: Fri, 4 May 2018 10:23:18 +0200
Subject: [PATCH] SONAR-10036 Autoscroll branch dropdown to selected item

---
 .../component/ComponentNavBranchesMenu.tsx    | 30 +++++++++++++++++--
 .../ComponentNavBranchesMenuItem.tsx          |  3 +-
 .../ComponentNavBranchesMenu-test.tsx.snap    |  8 +++++
 3 files changed, 37 insertions(+), 4 deletions(-)

diff --git a/server/sonar-web/src/main/js/app/components/nav/component/ComponentNavBranchesMenu.tsx b/server/sonar-web/src/main/js/app/components/nav/component/ComponentNavBranchesMenu.tsx
index 10f4b1ba885..5772988c123 100644
--- a/server/sonar-web/src/main/js/app/components/nav/component/ComponentNavBranchesMenu.tsx
+++ b/server/sonar-web/src/main/js/app/components/nav/component/ComponentNavBranchesMenu.tsx
@@ -31,6 +31,7 @@ import {
   isPullRequest,
   isBranch
 } from '../../../../helpers/branches';
+import { scrollToElement } from '../../../../helpers/scrolling';
 import { translate } from '../../../../helpers/l10n';
 import { getBranchLikeUrl } from '../../../../helpers/urls';
 import SearchBox from '../../../../components/controls/SearchBox';
@@ -51,6 +52,8 @@ interface State {
 
 export default class ComponentNavBranchesMenu extends React.PureComponent<Props, State> {
   private node?: HTMLElement | null;
+  private listNode?: HTMLUListElement | null;
+  private selectedBranchNode?: HTMLLIElement | null;
 
   static contextTypes = {
     router: PropTypes.object
@@ -63,12 +66,26 @@ export default class ComponentNavBranchesMenu extends React.PureComponent<Props,
 
   componentDidMount() {
     window.addEventListener('click', this.handleClickOutside);
+    this.scrollToSelectedBranch(false);
+  }
+
+  componentDidUpdate() {
+    this.scrollToSelectedBranch(true);
   }
 
   componentWillUnmount() {
     window.removeEventListener('click', this.handleClickOutside);
   }
 
+  scrollToSelectedBranch(smooth: boolean) {
+    if (this.listNode && this.selectedBranchNode) {
+      scrollToElement(this.selectedBranchNode, {
+        parent: this.listNode,
+        smooth
+      });
+    }
+  }
+
   getFilteredBranchLikes = () => {
     const query = this.state.query.toLowerCase();
     return sortBranchesAsTree(this.props.branchLikes).filter(branchLike => {
@@ -190,7 +207,7 @@ export default class ComponentNavBranchesMenu extends React.PureComponent<Props,
         !showOrphanHeader && isPullRequest(branchLike) && !isPullRequest(previous);
       const showShortLivingBranchHeader =
         !showOrphanHeader && isShortLivingBranch(branchLike) && !isShortLivingBranch(previous);
-
+      const isSelected = isSameBranchLike(branchLike, selected);
       return (
         <React.Fragment key={getBranchLikeKey(branchLike)}>
           {showDivider && <li className="divider" />}
@@ -218,15 +235,22 @@ export default class ComponentNavBranchesMenu extends React.PureComponent<Props,
           <ComponentNavBranchesMenuItem
             branchLike={branchLike}
             component={this.props.component}
+            innerRef={node =>
+              (this.selectedBranchNode = isSelected ? node : this.selectedBranchNode)
+            }
             key={getBranchLikeKey(branchLike)}
             onSelect={this.handleSelect}
-            selected={isSameBranchLike(branchLike, selected)}
+            selected={isSelected}
           />
         </React.Fragment>
       );
     });
 
-    return <ul className="menu menu-vertically-limited">{items}</ul>;
+    return (
+      <ul className="menu menu-vertically-limited" ref={node => (this.listNode = node)}>
+        {items}
+      </ul>
+    );
   };
 
   render() {
diff --git a/server/sonar-web/src/main/js/app/components/nav/component/ComponentNavBranchesMenuItem.tsx b/server/sonar-web/src/main/js/app/components/nav/component/ComponentNavBranchesMenuItem.tsx
index 316ee5f06b1..8788fe657c1 100644
--- a/server/sonar-web/src/main/js/app/components/nav/component/ComponentNavBranchesMenuItem.tsx
+++ b/server/sonar-web/src/main/js/app/components/nav/component/ComponentNavBranchesMenuItem.tsx
@@ -39,6 +39,7 @@ export interface Props {
   component: Component;
   onSelect: (branchLike: BranchLike) => void;
   selected: boolean;
+  innerRef?: (node: HTMLLIElement) => void;
 }
 
 export default function ComponentNavBranchesMenuItem({ branchLike, ...props }: Props) {
@@ -51,7 +52,7 @@ export default function ComponentNavBranchesMenuItem({ branchLike, ...props }: P
     (isShortLivingBranch(branchLike) && !branchLike.isOrphan) || isPullRequest(branchLike);
 
   return (
-    <li key={getBranchLikeKey(branchLike)} onMouseEnter={handleMouseEnter}>
+    <li key={getBranchLikeKey(branchLike)} onMouseEnter={handleMouseEnter} ref={props.innerRef}>
       <Link
         className={classNames('navbar-context-meta-branch-menu-item', {
           active: props.selected
diff --git a/server/sonar-web/src/main/js/app/components/nav/component/__tests__/__snapshots__/ComponentNavBranchesMenu-test.tsx.snap b/server/sonar-web/src/main/js/app/components/nav/component/__tests__/__snapshots__/ComponentNavBranchesMenu-test.tsx.snap
index c104c23e7d3..cac918b4985 100644
--- a/server/sonar-web/src/main/js/app/components/nav/component/__tests__/__snapshots__/ComponentNavBranchesMenu-test.tsx.snap
+++ b/server/sonar-web/src/main/js/app/components/nav/component/__tests__/__snapshots__/ComponentNavBranchesMenu-test.tsx.snap
@@ -33,6 +33,7 @@ exports[`renders list 1`] = `
             "key": "component",
           }
         }
+        innerRef={[Function]}
         key="branch-master"
         onSelect={[Function]}
         selected={true}
@@ -66,6 +67,7 @@ exports[`renders list 1`] = `
             "key": "component",
           }
         }
+        innerRef={[Function]}
         key="pull-request-1234"
         onSelect={[Function]}
         selected={false}
@@ -111,6 +113,7 @@ exports[`renders list 1`] = `
             "key": "component",
           }
         }
+        innerRef={[Function]}
         key="branch-baz"
         onSelect={[Function]}
         selected={false}
@@ -140,6 +143,7 @@ exports[`renders list 1`] = `
             "key": "component",
           }
         }
+        innerRef={[Function]}
         key="branch-foo"
         onSelect={[Function]}
         selected={false}
@@ -164,6 +168,7 @@ exports[`renders list 1`] = `
             "key": "component",
           }
         }
+        innerRef={[Function]}
         key="branch-bar"
         onSelect={[Function]}
         selected={false}
@@ -209,6 +214,7 @@ exports[`renders list 1`] = `
             "key": "component",
           }
         }
+        innerRef={[Function]}
         key="branch-baz"
         onSelect={[Function]}
         selected={false}
@@ -265,6 +271,7 @@ exports[`searches 1`] = `
             "key": "component",
           }
         }
+        innerRef={[Function]}
         key="branch-foobar"
         onSelect={[Function]}
         selected={true}
@@ -289,6 +296,7 @@ exports[`searches 1`] = `
             "key": "component",
           }
         }
+        innerRef={[Function]}
         key="branch-bar"
         onSelect={[Function]}
         selected={false}
-- 
2.39.5