feat(data-modeling): add side panel COMPASS-9476 (#7111)

mabaasit · web-flow · commit 369ef5ec6dc0 · 2025-07-15T11:13:23.000+02:00
add diagram editor side panel
diff --git a/packages/compass-data-modeling/src/components/data-modeling.tsx b/packages/compass-data-modeling/src/components/data-modeling.tsx
@@ -5,6 +5,7 @@ import SavedDiagramsList from './saved-diagrams-list';
 import NewDiagramFormModal from './new-diagram-form';
 import type { DataModelingState } from '../store/reducer';
 import { DiagramProvider } from '@mongodb-js/diagramming';
+import DiagramEditorSidePanel from './diagram-editor-side-panel';
 type DataModelingPluginInitialProps = {
   showList: boolean;
 };
@@ -19,6 +20,7 @@ const DataModeling: React.FunctionComponent<DataModelingPluginInitialProps> = ({
       ) : (
         <DiagramProvider fitView>
           <DiagramEditor />
+          <DiagramEditorSidePanel />
         </DiagramProvider>
       )}
       <NewDiagramFormModal></NewDiagramFormModal>
diff --git a/packages/compass-data-modeling/src/components/diagram-editor-side-panel.tsx b/packages/compass-data-modeling/src/components/diagram-editor-side-panel.tsx
@@ -0,0 +1,64 @@
+import React from 'react';
+import { connect } from 'react-redux';
+import type { DataModelingState } from '../store/reducer';
+import { closeSidePanel } from '../store/side-panel';
+import {
+  Button,
+  css,
+  cx,
+  Body,
+  spacing,
+  palette,
+  useDarkMode,
+} from '@mongodb-js/compass-components';
+
+const containerStyles = css({
+  width: '400px',
+  height: '100%',
+
+  display: 'flex',
+  flexDirection: 'column',
+  alignItems: 'center',
+  justifyContent: 'center',
+  gap: spacing[400],
+  borderLeft: `1px solid ${palette.gray.light2}`,
+});
+
+const darkModeContainerStyles = css({
+  borderLeftColor: palette.gray.dark2,
+});
+
+type DiagramEditorSidePanelProps = {
+  isOpen: boolean;
+  onClose: () => void;
+};
+
+function DiagmramEditorSidePanel({
+  isOpen,
+  onClose,
+}: DiagramEditorSidePanelProps) {
+  const isDarkMode = useDarkMode();
+  if (!isOpen) {
+    return null;
+  }
+  return (
+    <div className={cx(containerStyles, isDarkMode && darkModeContainerStyles)}>
+      <Body>This feature is under development.</Body>
+      <Button onClick={onClose} variant="primary" size="small">
+        Close Side Panel
+      </Button>
+    </div>
+  );
+}
+
+export default connect(
+  (state: DataModelingState) => {
+    const { sidePanel } = state;
+    return {
+      isOpen: sidePanel.isOpen,
+    };
+  },
+  {
+    onClose: closeSidePanel,
+  }
+)(DiagmramEditorSidePanel);
diff --git a/packages/compass-data-modeling/src/components/diagram-editor.tsx b/packages/compass-data-modeling/src/components/diagram-editor.tsx
@@ -38,6 +38,7 @@ import type { StaticModel } from '../services/data-model-storage';
 import DiagramEditorToolbar from './diagram-editor-toolbar';
 import ExportDiagramModal from './export-diagram-modal';
 import { useLogger } from '@mongodb-js/compass-logging/provider';
+import { openSidePanel } from '../store/side-panel';
 
 const loadingContainerStyles = css({
   width: '100%',
@@ -188,6 +189,7 @@ const DiagramEditor: React.FunctionComponent<{
   onCancelClick: () => void;
   onApplyInitialLayout: (positions: Record<string, [number, number]>) => void;
   onMoveCollection: (ns: string, newPosition: [number, number]) => void;
+  onOpenSidePanel: () => void;
 }> = ({
   diagramLabel,
   step,
@@ -196,6 +198,7 @@ const DiagramEditor: React.FunctionComponent<{
   onCancelClick,
   onApplyInitialLayout,
   onMoveCollection,
+  onOpenSidePanel,
 }) => {
   const { log, mongoLogId } = useLogger('COMPASS-DATA-MODELING-DIAGRAM-EDITOR');
   const isDarkMode = useDarkMode();
@@ -332,6 +335,10 @@ const DiagramEditor: React.FunctionComponent<{
             title={diagramLabel}
             edges={edges}
             nodes={areNodesReady ? nodes : []}
+            onEdgeClick={() => {
+              // TODO: we have to open a side panel with edge details
+              onOpenSidePanel();
+            }}
             fitViewOptions={{
               maxZoom: 1,
               minZoom: 0.25,
@@ -370,5 +377,6 @@ export default connect(
     onCancelClick: cancelAnalysis,
     onApplyInitialLayout: applyInitialLayout,
     onMoveCollection: moveCollection,
+    onOpenSidePanel: openSidePanel,
   }
 )(DiagramEditor);
diff --git a/packages/compass-data-modeling/src/store/reducer.ts b/packages/compass-data-modeling/src/store/reducer.ts
@@ -20,25 +20,30 @@ import type {
   ExportDiagramActions,
 } from './export-diagram';
 import { exportDiagramReducer } from './export-diagram';
+import type { SidePanelActions, SidePanelActionTypes } from './side-panel';
+import { sidePanelReducer } from './side-panel';
 
 const reducer = combineReducers({
   step: stepReducer,
   generateDiagramWizard: generateDiagramWizardReducer,
   analysisProgress: analysisProcessReducer,
   diagram: diagramReducer,
   exportDiagram: exportDiagramReducer,
+  sidePanel: sidePanelReducer,
 });
 
 export type DataModelingActions =
   | GenerateDiagramWizardActions
   | AnalysisProgressActions
   | DiagramActions
+  | SidePanelActions
   | ExportDiagramActions;
 
 export type DataModelingActionTypes =
   | GenerateDiagramWizardActionTypes
   | AnalysisProcessActionTypes
   | DiagramActionTypes
+  | SidePanelActionTypes
   | ExportDiagramActionTypes;
 
 export type DataModelingState = ReturnType<typeof reducer>;
diff --git a/packages/compass-data-modeling/src/store/side-panel.ts b/packages/compass-data-modeling/src/store/side-panel.ts
@@ -0,0 +1,52 @@
+import type { Reducer } from 'redux';
+import { isAction } from './util';
+
+export type SidePanelState = {
+  isOpen: boolean;
+};
+
+export enum SidePanelActionTypes {
+  SIDE_PANEL_OPENED = 'data-modeling/side-panel/SIDE_PANEL_OPENED',
+  SIDE_PANEL_CLOSED = 'data-modeling/side-panel/SIDE_PANEL_CLOSED',
+}
+
+export type SidePanelOpenedAction = {
+  type: SidePanelActionTypes.SIDE_PANEL_OPENED;
+};
+
+export type SidePanelClosedAction = {
+  type: SidePanelActionTypes.SIDE_PANEL_CLOSED;
+};
+
+export type SidePanelActions = SidePanelOpenedAction | SidePanelClosedAction;
+
+const INITIAL_STATE: SidePanelState = {
+  isOpen: false,
+};
+
+export const sidePanelReducer: Reducer<SidePanelState> = (
+  state = INITIAL_STATE,
+  action
+) => {
+  if (isAction(action, SidePanelActionTypes.SIDE_PANEL_OPENED)) {
+    return {
+      ...state,
+      isOpen: true,
+    };
+  }
+  if (isAction(action, SidePanelActionTypes.SIDE_PANEL_CLOSED)) {
+    return {
+      ...state,
+      isOpen: false,
+    };
+  }
+  return state;
+};
+
+export const openSidePanel = (): SidePanelOpenedAction => ({
+  type: SidePanelActionTypes.SIDE_PANEL_OPENED,
+});
+
+export const closeSidePanel = (): SidePanelClosedAction => ({
+  type: SidePanelActionTypes.SIDE_PANEL_CLOSED,
+});
