[Chrome Grid] Make dashboard grid support custom scroll container (elastic#241823)

## Summary

Should address 

close elastic#241706


```
feature_flags.overrides:
  core.chrome.layoutType: 'grid'
```


### Checklist

Check the PR satisfies following conditions. 

Reviewers should verify this PR satisfies this list as well.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This was checked for breaking HTTP API changes, and any breaking
changes have been approved by the breaking-change committee. The
`release_note:breaking` label should be applied in these situations.
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] The PR description includes the appropriate Release Notes section,
and the correct `release_note:*` label is applied per the
[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
- [ ] Review the [backport
guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing)
and apply applicable `backport:*` labels.

### Identify risks

Does this PR introduce any risks? For example, consider risks like hard
to test bugs, performance regression, potential of data loss.

Describe the risk, its severity, and mitigation for each identified
risk. Invite stakeholders and evaluate how to proceed before merging.

- [ ] [See some risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)
- [ ] ...

Author: Dosant

src/platform/packages/private/kbn-grid-layout/README.md

@@ -1,3 +1,3 @@
 # @kbn/grid-layout
 
-Contains a simple drag and drop layout engine for Kibana Dashboards.
+Contains a drag and drop layout engine for Kibana Dashboards.

src/platform/packages/private/kbn-grid-layout/grid/types.ts

@@ -16,6 +16,7 @@ import type {
   GridSectionData,
   MainSection,
 } from './grid_section';
+import type { ScrollContainer } from './utils/scroll_container';
 
 /**
  * The settings for how the grid should be rendered
@@ -63,6 +64,7 @@ export interface GridLayoutStateManager {
   accessMode$: BehaviorSubject<GridAccessMode>;
   gridDimensions$: BehaviorSubject<ObservedSize>;
   runtimeSettings$: BehaviorSubject<RuntimeGridSettings>;
+  scrollContainer$: BehaviorSubject<ScrollContainer>;
 
   activePanelEvent$: BehaviorSubject<ActivePanelEvent | undefined>;
   activeSectionEvent$: BehaviorSubject<ActiveSectionEvent | undefined>;

src/platform/packages/private/kbn-grid-layout/grid/use_grid_layout_events/keyboard_utils.ts

@@ -7,16 +7,19 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
+import { getScrollTop, scrollToContainer, type ScrollContainer } from '../utils/scroll_container';
+
 export const updateClientY = (
   currentY: number,
   stepY: number,
   isCloseToEdge: boolean,
-  type = 'drag'
+  type = 'drag',
+  scrollContainer: ScrollContainer
 ) => {
   if (isCloseToEdge) {
     switch (type) {
       case 'drag':
-        window.scrollTo({ top: window.scrollY + stepY, behavior: 'smooth' });
+        scrollToContainer(scrollContainer, getScrollTop(scrollContainer) + stepY, 'smooth');
         return currentY;
       case 'resize':
         setTimeout(() =>

src/platform/packages/private/kbn-grid-layout/grid/use_grid_layout_events/panel/events.ts

@@ -107,6 +107,7 @@ export const useGridLayoutPanelEvents = ({
           onStart,
           onMove,
           onEnd,
+          scrollContainer: gridLayoutStateManager.scrollContainer$.getValue(),
         });
       } else if (isTouchEvent(e)) {
         startTouchInteraction({

src/platform/packages/private/kbn-grid-layout/grid/use_grid_layout_events/panel/utils.ts

@@ -9,6 +9,7 @@
 
 import { euiThemeVars } from '@kbn/ui-theme';
 
+import { getScrollDimensions, isAtBottomOfPage } from '../../utils/scroll_container';
 import type { ActivePanelEvent, GridPanelData } from '../../grid_panel';
 import type { GridLayoutStateManager, RuntimeGridSettings } from '../../types';
 import { updateClientY } from '../keyboard_utils';
@@ -134,6 +135,7 @@ export const getNextKeyboardPositionForPanel = (
   const stepX = columnPixelWidth + gutterSize;
   const stepY = rowHeight + gutterSize;
   const gridPosition = gridLayoutStateManager.layoutRef.current?.getBoundingClientRect();
+  const scrollContainer = gridLayoutStateManager.scrollContainer$.getValue();
 
   switch (ev.code) {
     case KeyboardCode.Right: {
@@ -159,26 +161,34 @@ export const getNextKeyboardPositionForPanel = (
 
     case KeyboardCode.Down: {
       // check if we are at the end of the scroll of the page
-      const bottomOfPageReached = window.innerHeight + window.scrollY >= document.body.scrollHeight;
+      const bottomOfPageReached = isAtBottomOfPage(scrollContainer);
+
       // check if next key will cross the bottom edge
       // if we're at the end of the scroll of the page, the dragged handle can go down even more so we can reorder with the last row
       const bottomMaxPosition = bottomOfPageReached
         ? panelPosition.bottom + stepY - (panelPosition.bottom - panelPosition.top) * 0.5
         : panelPosition.bottom + stepY + KEYBOARD_DRAG_BOTTOM_LIMIT;
 
-      const isCloseToBottom = bottomMaxPosition > window.innerHeight;
+      const { clientHeight } = getScrollDimensions(scrollContainer);
+      const isCloseToBottom = bottomMaxPosition > clientHeight;
 
       return {
         ...handlePosition,
-        clientY: updateClientY(handlePosition.clientY, stepY, isCloseToBottom, type),
+        clientY: updateClientY(
+          handlePosition.clientY,
+          stepY,
+          isCloseToBottom,
+          type,
+          scrollContainer
+        ),
       };
     }
     case KeyboardCode.Up: {
       // check if next key will cross the top edge
       const isCloseToTop = panelPosition.top - stepY - keyboardDragTopLimit < 0;
       return {
         ...handlePosition,
-        clientY: updateClientY(handlePosition.clientY, -stepY, isCloseToTop, type),
+        clientY: updateClientY(handlePosition.clientY, -stepY, isCloseToTop, type, scrollContainer),
       };
     }
     default:

src/platform/packages/private/kbn-grid-layout/grid/use_grid_layout_events/section/events.ts

@@ -76,6 +76,7 @@ export const useGridLayoutSectionEvents = ({ sectionId }: { sectionId: string })
           onStart,
           onMove,
           onEnd,
+          scrollContainer: gridLayoutStateManager.scrollContainer$.getValue(),
         });
       } else if (isTouchEvent(e)) {
         startTouchInteraction({

src/platform/packages/private/kbn-grid-layout/grid/use_grid_layout_events/section/utils.ts

@@ -7,6 +7,7 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
+import { getScrollDimensions, isAtBottomOfPage } from '../../utils/scroll_container';
 import type { GridLayoutStateManager } from '../../types';
 import { updateClientY } from '../keyboard_utils';
 import type { UserKeyboardEvent } from '../sensors/keyboard/types';
@@ -28,21 +29,29 @@ export const getNextKeyboardPosition = (
   const headerRef = headerRefs[sectionId];
   const headerRefHeight = (headerRef?.getBoundingClientRect().height ?? 48) * 0.5;
   const stepY = headerRefHeight;
+  const scrollContainer = gridLayoutStateManager.scrollContainer$.getValue();
 
   switch (ev.code) {
     case KeyboardCode.Down: {
-      const bottomOfPageReached = window.innerHeight + window.scrollY >= document.body.scrollHeight;
+      const bottomOfPageReached = isAtBottomOfPage(scrollContainer);
 
       // check if next key will cross the bottom edge
       // if we're at the bottom of the page, the handle can go down even more so we can reorder with the last row
       const bottomMaxPosition = bottomOfPageReached
         ? handlePosition.clientY + stepY
         : handlePosition.clientY + 2 * stepY;
-      const isCloseToBottom = bottomMaxPosition > window.innerHeight;
+      const { clientHeight } = getScrollDimensions(scrollContainer);
+      const isCloseToBottom = bottomMaxPosition > clientHeight;
 
       return {
         ...handlePosition,
-        clientY: updateClientY(handlePosition.clientY, stepY, isCloseToBottom),
+        clientY: updateClientY(
+          handlePosition.clientY,
+          stepY,
+          isCloseToBottom,
+          'drag',
+          scrollContainer
+        ),
       };
     }
     case KeyboardCode.Up: {
@@ -51,7 +60,13 @@ export const getNextKeyboardPosition = (
 
       return {
         ...handlePosition,
-        clientY: updateClientY(handlePosition.clientY, -stepY, isCloseToTop),
+        clientY: updateClientY(
+          handlePosition.clientY,
+          -stepY,
+          isCloseToTop,
+          'drag',
+          scrollContainer
+        ),
       };
     }
     default:

src/platform/packages/private/kbn-grid-layout/grid/use_grid_layout_events/sensors/autoscroll.ts

@@ -7,6 +7,12 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
+import {
+  getClientHeight,
+  getScrollDimensions,
+  scrollByContainer,
+  type ScrollContainer,
+} from '../../utils/scroll_container';
 import type { UserMouseEvent } from './mouse';
 
 const DEADZONE = 0.35; // percent of the distance from the center of the screen on either side of the middle is considered deadzone and will not scroll.
@@ -21,7 +27,7 @@ export const stopAutoScroll = () => {
   shouldAutoScroll = false;
 };
 
-export const startAutoScroll = () => {
+export const startAutoScroll = (container: ScrollContainer) => {
   if (shouldAutoScroll) return;
   shouldAutoScroll = true;
 
@@ -34,9 +40,10 @@ export const startAutoScroll = () => {
 
     if (latestMouseEvent) {
       // Scroll faster depending on how far the user's drag is from the center of the screen.
-      const distanceFromCenterOfScreen = window.innerHeight / 2 - latestMouseEvent.clientY;
+      const clientHeight = getClientHeight(container);
+      const distanceFromCenterOfScreen = clientHeight / 2 - latestMouseEvent.clientY;
       const scrollDirection = distanceFromCenterOfScreen > 0 ? 'up' : 'down';
-      const distanceFromCenterOfScreenPercentage = distanceFromCenterOfScreen / window.innerHeight;
+      const distanceFromCenterOfScreenPercentage = distanceFromCenterOfScreen / clientHeight;
 
       const dragDistanceSpeedMultiplier = Math.min(
         1,
@@ -47,11 +54,10 @@ export const startAutoScroll = () => {
       );
 
       // scroll slower as we approach the bottom or the top of the page.
-      const distanceToTop = scrollDirection === 'up' ? window.scrollY : Number.MAX_VALUE;
+      const { scrollTop, scrollHeight } = getScrollDimensions(container);
+      const distanceToTop = scrollDirection === 'up' ? scrollTop : Number.MAX_VALUE;
       const distanceToBottom =
-        scrollDirection === 'down'
-          ? document.body.scrollHeight - window.innerHeight - window.scrollY
-          : Number.MAX_VALUE;
+        scrollDirection === 'down' ? scrollHeight - clientHeight - scrollTop : Number.MAX_VALUE;
       const nearestScrollEdgeDistance = Math.min(distanceToTop, distanceToBottom);
       const edgeSlowdownMultiplier = Math.min(
         1,
@@ -63,7 +69,7 @@ export const startAutoScroll = () => {
         PIXELS_PER_SECOND * (dragDistanceSpeedMultiplier * edgeSlowdownMultiplier) * deltaTime;
 
       if (pixelsToScroll > 0) {
-        window.scrollBy({ top: scrollDirection === 'up' ? -pixelsToScroll : pixelsToScroll });
+        scrollByContainer(container, scrollDirection === 'up' ? -pixelsToScroll : pixelsToScroll);
       }
     }
 

src/platform/packages/private/kbn-grid-layout/grid/use_grid_layout_events/sensors/mouse.ts

@@ -7,6 +7,7 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
+import type { ScrollContainer } from '../../utils/scroll_container';
 import type { UserInteractionEvent } from '../types';
 import { handleAutoscroll, startAutoScroll, stopAutoScroll } from './autoscroll';
 
@@ -34,15 +35,17 @@ export const startMouseInteraction = ({
   onStart,
   onMove,
   onEnd,
+  scrollContainer,
 }: {
   e: UserMouseEvent;
   onStart: (e: UserInteractionEvent) => void;
   onMove: (e: UserInteractionEvent) => void;
   onEnd: () => void;
+  scrollContainer: ScrollContainer;
 }) => {
   if (e.button !== MOUSE_BUTTON_LEFT) return;
   e.stopPropagation();
-  startAutoScroll();
+  startAutoScroll(scrollContainer);
 
   const handleMouseMove = (ev: UserMouseEvent) => {
     handleAutoscroll(ev);

src/platform/packages/private/kbn-grid-layout/grid/use_grid_layout_state.ts

@@ -37,6 +37,7 @@ import type {
 import { getGridLayout, getOrderedLayout } from './utils/conversions';
 import { isLayoutEqual } from './utils/equality_checks';
 import { shouldShowMobileView } from './utils/mobile_view';
+import { getScrollContainer } from './utils/scroll_container';
 
 export const useGridLayoutState = ({
   layout,
@@ -99,6 +100,7 @@ export const useGridLayoutState = ({
     const orderedLayout = getOrderedLayout(layout);
     const gridLayout$ = new BehaviorSubject<OrderedLayout>(orderedLayout);
     const gridDimensions$ = new BehaviorSubject<ObservedSize>({ width: 0, height: 0 });
+    const scrollContainer$ = new BehaviorSubject(getScrollContainer());
     const activePanelEvent$ = new BehaviorSubject<ActivePanelEvent | undefined>(undefined);
     const activeSectionEvent$ = new BehaviorSubject<ActiveSectionEvent | undefined>(undefined);
 
@@ -125,6 +127,7 @@ export const useGridLayoutState = ({
       accessMode$,
       gridDimensions$,
       runtimeSettings$,
+      scrollContainer$,
       expandedPanelId$,
       isMobileView$: new BehaviorSubject<boolean>(
         shouldShowMobileView(accessMode, euiTheme.breakpoint.m)