From 3fbda0f35b7c39864e030f617ae667dae947e1e3 Mon Sep 17 00:00:00 2001
From: Nathan Marrs <nathanielmarrs@gmail.com>
Date: Mon, 16 May 2022 10:28:19 -0700
Subject: [PATCH] Canvas: Improve constraint selection ux (#48837)

---
 .../canvas/editor/ConstraintSelectionBox.tsx  | 183 ++++++++++++++++++
 .../panel/canvas/editor/PlacementEditor.tsx   |  40 ++--
 2 files changed, 211 insertions(+), 12 deletions(-)
 create mode 100644 public/app/plugins/panel/canvas/editor/ConstraintSelectionBox.tsx

diff --git a/public/app/plugins/panel/canvas/editor/ConstraintSelectionBox.tsx b/public/app/plugins/panel/canvas/editor/ConstraintSelectionBox.tsx
new file mode 100644
index 00000000000..8c815bc5c98
--- /dev/null
+++ b/public/app/plugins/panel/canvas/editor/ConstraintSelectionBox.tsx
@@ -0,0 +1,183 @@
+import { css } from '@emotion/css';
+import React from 'react';
+
+import { GrafanaTheme2 } from '@grafana/data';
+import { useStyles2 } from '@grafana/ui';
+import { Constraint, HorizontalConstraint, VerticalConstraint } from 'app/features/canvas';
+
+interface Props {
+  onVerticalConstraintChange: (v: VerticalConstraint) => void;
+  onHorizontalConstraintChange: (h: HorizontalConstraint) => void;
+  currentConstraints: Constraint;
+}
+
+export const ConstraintSelectionBox = ({
+  onVerticalConstraintChange,
+  onHorizontalConstraintChange,
+  currentConstraints,
+}: Props) => {
+  const styles = useStyles2(getStyles(currentConstraints));
+
+  const onClickTopConstraint = () => {
+    onVerticalConstraintChange(VerticalConstraint.Top);
+  };
+
+  const onClickBottomConstraint = () => {
+    onVerticalConstraintChange(VerticalConstraint.Bottom);
+  };
+
+  const onClickVerticalCenterConstraint = () => {
+    onVerticalConstraintChange(VerticalConstraint.Center);
+  };
+
+  const onClickLeftConstraint = () => {
+    onHorizontalConstraintChange(HorizontalConstraint.Left);
+  };
+
+  const onClickRightConstraint = () => {
+    onHorizontalConstraintChange(HorizontalConstraint.Right);
+  };
+
+  const onClickHorizontalCenterConstraint = () => {
+    onHorizontalConstraintChange(HorizontalConstraint.Center);
+  };
+
+  return (
+    <svg
+      version="1.0"
+      xmlns="http://www.w3.org/2000/svg"
+      width="75.000000pt"
+      height="75.000000pt"
+      viewBox="0 0 228.000000 228.000000"
+      preserveAspectRatio="xMidYMid meet"
+    >
+      <g transform="translate(0.000000,228.000000) scale(0.100000,-0.100000)" fill="#000000" stroke="none">
+        <path
+          fill="#e5e5e5"
+          d="M198 2028 l-28 -32 0 -912 0 -912 31 -31 31 -31 915 0 915 0 29 29
+29 29 0 917 0 917 -27 29 -28 29 -920 0 -920 0 -27 -32z m1876 -17 c15 -16 16
+-98 16 -927 0 -860 -1 -909 -18 -926 -17 -17 -66 -18 -927 -18 -862 0 -910 1
+-927 18 -17 17 -18 65 -18 926 0 832 1 911 16 927 16 18 45 19 468 21 248 2
+659 2 912 0 431 -2 462 -4 478 -21z"
+        />
+        <rect className={styles.topConstraint} height="228" width="46" y="1735" x="1123" />
+        <rect
+          className={styles.constraintHover}
+          onClick={onClickTopConstraint}
+          height="350"
+          width="300"
+          y="1680"
+          x="995"
+          fill="transparent"
+        />
+        <rect className={styles.bottomConstraint} height="228" width="46" y="210" x="1123" />
+        <rect
+          className={styles.constraintHover}
+          onClick={onClickBottomConstraint}
+          height="350"
+          width="300"
+          y="135"
+          x="995"
+          fill="transparent"
+        />
+        <rect className={styles.leftConstraint} height="46" width="228" y="1060" x="265" />
+        <rect
+          className={styles.constraintHover}
+          onClick={onClickLeftConstraint}
+          height="300"
+          width="350"
+          y="925"
+          x="200"
+          fill="transparent"
+        />
+        <rect className={styles.rightConstraint} height="46" width="228" y="1060" x="1795" />
+        <rect
+          className={styles.constraintHover}
+          onClick={onClickRightConstraint}
+          height="300"
+          width="350"
+          y="925"
+          x="1730"
+          fill="transparent"
+        />
+        <path
+          className={styles.box}
+          d="M568 1669 c-17 -9 -18 -48 -18 -584 0 -558 1 -575 19 -585 27 -14
+1125 -14 1152 0 18 10 19 27 19 580 0 504 -2 570 -16 584 -14 14 -80 16 -577
+16 -363 -1 -568 -4 -579 -11z m1119 -42 c4 -5 4 -1079 0 -1084 -5 -4 -1079 -4
+-1084 0 -5 6 -4 1077 1 1085 4 7 1076 6 1083 -1z"
+        />
+        <rect className={styles.verticalCenterConstraint} height="456" width="46" y="855" x="1123" />
+        <rect
+          className={styles.constraintHover}
+          onClick={onClickVerticalCenterConstraint}
+          height="660"
+          width="300"
+          y="750"
+          x="995"
+          fill="transparent"
+        />
+        <rect className={styles.horizontalCenterConstraint} height="46" width="456" y="1060" x="918" />
+        <rect
+          className={styles.constraintHover}
+          onClick={onClickHorizontalCenterConstraint}
+          height="300"
+          width="660"
+          y="925"
+          x="815"
+          fill="transparent"
+        />
+      </g>
+    </svg>
+  );
+};
+
+const getStyles = (currentConstraints: Constraint) => (theme: GrafanaTheme2) => {
+  const HOVER_COLOR = '#daebf7';
+  const HOVER_OPACITY = '0.6';
+  const SELECTED_COLOR = '#0d99ff';
+
+  const selectionBoxColor = theme.isDark ? '#ffffff' : '#000000';
+
+  return {
+    constraintHover: css`
+      &:hover {
+        fill: ${HOVER_COLOR};
+        fill-opacity: ${HOVER_OPACITY};
+      }
+    `,
+    topConstraint: css`
+      ${currentConstraints.vertical === VerticalConstraint.Top
+        ? `width: 92pt; x: 1085; fill: ${SELECTED_COLOR};`
+        : `fill: ${selectionBoxColor};`}
+    `,
+    bottomConstraint: css`
+      ${currentConstraints.vertical === VerticalConstraint.Bottom
+        ? `width: 92pt; x: 1085; fill: ${SELECTED_COLOR};`
+        : `fill: ${selectionBoxColor};`}
+    `,
+    leftConstraint: css`
+      ${currentConstraints.horizontal === HorizontalConstraint.Left
+        ? `height: 92pt; y: 1014; fill: ${SELECTED_COLOR};`
+        : `fill: ${selectionBoxColor};`}
+    `,
+    rightConstraint: css`
+      ${currentConstraints.horizontal === HorizontalConstraint.Right
+        ? `height: 92pt; y: 1014; fill: ${SELECTED_COLOR};`
+        : `fill: ${selectionBoxColor};`}
+    `,
+    horizontalCenterConstraint: css`
+      ${currentConstraints.horizontal === HorizontalConstraint.Center
+        ? `height: 92pt; y: 1014; fill: ${SELECTED_COLOR};`
+        : `fill: ${selectionBoxColor};`}
+    `,
+    verticalCenterConstraint: css`
+      ${currentConstraints.vertical === VerticalConstraint.Center
+        ? `width: 92pt; x: 1085; fill: ${SELECTED_COLOR};`
+        : `fill: ${selectionBoxColor};`}
+    `,
+    box: css`
+      fill: ${selectionBoxColor};
+    `,
+  };
+};
diff --git a/public/app/plugins/panel/canvas/editor/PlacementEditor.tsx b/public/app/plugins/panel/canvas/editor/PlacementEditor.tsx
index b64564f6dc4..7916ef11743 100644
--- a/public/app/plugins/panel/canvas/editor/PlacementEditor.tsx
+++ b/public/app/plugins/panel/canvas/editor/PlacementEditor.tsx
@@ -3,12 +3,13 @@ import { useObservable } from 'react-use';
 import { Subject } from 'rxjs';
 
 import { SelectableValue, StandardEditorProps } from '@grafana/data';
-import { Field, InlineField, InlineFieldRow, Select, VerticalGroup } from '@grafana/ui';
+import { Field, HorizontalGroup, InlineField, InlineFieldRow, Select, VerticalGroup } from '@grafana/ui';
 import { HorizontalConstraint, Placement, VerticalConstraint } from 'app/features/canvas';
 import { NumberInput } from 'app/features/dimensions/editors/NumberInput';
 
 import { PanelOptions } from '../models.gen';
 
+import { ConstraintSelectionBox } from './ConstraintSelectionBox';
 import { CanvasEditorOptions } from './elementEditor';
 
 const places: Array<keyof Placement> = ['top', 'left', 'bottom', 'right', 'width', 'height'];
@@ -46,15 +47,23 @@ export const PlacementEditor: FC<StandardEditorProps<any, CanvasEditorOptions, P
   const { options } = element;
   const { placement, constraint: layout } = options;
 
-  const onHorizontalConstraintChange = (h: SelectableValue<HorizontalConstraint>) => {
-    element.options.constraint!.horizontal = h.value;
+  const onHorizontalConstraintSelect = (h: SelectableValue<HorizontalConstraint>) => {
+    onHorizontalConstraintChange(h.value!);
+  };
+
+  const onHorizontalConstraintChange = (h: HorizontalConstraint) => {
+    element.options.constraint!.horizontal = h;
     element.setPlacementFromConstraint();
     settings.scene.revId++;
     settings.scene.save(true);
   };
 
-  const onVerticalConstraintChange = (v: SelectableValue<VerticalConstraint>) => {
-    element.options.constraint!.vertical = v.value;
+  const onVerticalConstraintSelect = (v: SelectableValue<VerticalConstraint>) => {
+    onVerticalConstraintChange(v.value!);
+  };
+
+  const onVerticalConstraintChange = (v: VerticalConstraint) => {
+    element.options.constraint!.vertical = v;
     element.setPlacementFromConstraint();
     settings.scene.revId++;
     settings.scene.save(true);
@@ -68,14 +77,21 @@ export const PlacementEditor: FC<StandardEditorProps<any, CanvasEditorOptions, P
 
   return (
     <div>
-      <VerticalGroup>
-        <Select options={verticalOptions} onChange={onVerticalConstraintChange} value={layout?.vertical} />
-        <Select
-          options={horizontalOptions}
-          onChange={onHorizontalConstraintChange}
-          value={options.constraint?.horizontal}
+      <HorizontalGroup>
+        <ConstraintSelectionBox
+          onVerticalConstraintChange={onVerticalConstraintChange}
+          onHorizontalConstraintChange={onHorizontalConstraintChange}
+          currentConstraints={element.options.constraint ?? {}}
         />
-      </VerticalGroup>
+        <VerticalGroup>
+          <Select options={verticalOptions} onChange={onVerticalConstraintSelect} value={layout?.vertical} />
+          <Select
+            options={horizontalOptions}
+            onChange={onHorizontalConstraintSelect}
+            value={options.constraint?.horizontal}
+          />
+        </VerticalGroup>
+      </HorizontalGroup>
       <br />
 
       <Field label="Position">