chore(ui): Dialog UI for upcoming settings menu

packages/trace-viewer/src/ui/shared/dialog.tsx

@@ -0,0 +1,145 @@
+/*
+  Copyright (c) Microsoft Corporation.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+import * as React from 'react';
+
+export interface DialogProps {
+  className?: string;
+  open: boolean;
+  width: number;
+  verticalOffset?: number;
+  requestClose?: () => void;
+  anchor?: React.RefObject<HTMLElement>;
+}
+
+export const Dialog: React.FC<React.PropsWithChildren<DialogProps>> = ({
+  className,
+  open,
+  width,
+  verticalOffset,
+  requestClose,
+  anchor,
+  children,
+}) => {
+  const dialogRef = React.useRef<HTMLDialogElement>(null);
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  const [_, setRecalculateDimensionsCount] = React.useState(0);
+
+  let style: React.CSSProperties | undefined = undefined;
+
+  if (anchor?.current) {
+    const bounds = anchor.current.getBoundingClientRect();
+
+    style = {
+      margin: 0,
+      top: bounds.bottom + (verticalOffset ?? 0),
+      left: buildTopLeftCoord(bounds, width),
+      width,
+      zIndex: 1,
+    };
+  }
+
+  React.useEffect(() => {
+    const onClick = (event: MouseEvent) => {
+      if (!dialogRef.current || !(event.target instanceof Node))
+        return;
+
+      if (!dialogRef.current.contains(event.target))
+        requestClose?.();
+    };
+
+    const onKeyDown = (event: KeyboardEvent) => {
+      if (event.key === 'Escape')
+        requestClose?.();
+    };
+
+    if (open) {
+      document.addEventListener('mousedown', onClick);
+      document.addEventListener('keydown', onKeyDown);
+
+      return () => {
+        document.removeEventListener('mousedown', onClick);
+        document.removeEventListener('keydown', onKeyDown);
+      };
+    }
+
+    return () => {};
+  }, [open, requestClose]);
+
+  React.useEffect(() => {
+    const onResize = () => setRecalculateDimensionsCount(count => count + 1);
+
+    window.addEventListener('resize', onResize);
+
+    return () => {
+      window.removeEventListener('resize', onResize);
+    };
+  }, []);
+
+  return (
+    open && (
+      <dialog ref={dialogRef} style={style} className={className} open>
+        {children}
+      </dialog>
+    )
+  );
+};
+
+const buildTopLeftCoord = (bounds: DOMRect, width: number): number => {
+  const leftAlignCoord = buildTopLeftCoordWithAlignment(bounds, width, 'left');
+
+  if (leftAlignCoord.inBounds)
+    return leftAlignCoord.value;
+
+  const rightAlignCoord = buildTopLeftCoordWithAlignment(
+      bounds,
+      width,
+      'right'
+  );
+
+  if (rightAlignCoord.inBounds)
+    return rightAlignCoord.value;
+
+  return leftAlignCoord.value;
+};
+
+const buildTopLeftCoordWithAlignment = (
+  bounds: DOMRect,
+  width: number,
+  alignment: 'left' | 'right'
+): {
+  value: number;
+  inBounds: boolean;
+} => {
+  const maxLeft = document.documentElement.clientWidth;
+
+  if (alignment === 'left') {
+    const value = bounds.left;
+
+    return {
+      value,
+      inBounds: value + width <= maxLeft,
+    };
+  } else {
+    const value = bounds.right - width;
+
+    return {
+      value,
+      inBounds: bounds.right - width >= 0,
+    };
+  }
+};