[3740] Add keyboard shortcut for object duplication

Bug: #3740 Signed-off-by: Laurent Fasani <[email protected]> Signed-off-by: Florian ROUËNÉ <[email protected]>
eclipse-sirius · Jan 3, 2025 · 152fd2a · 152fd2a
1 parent 3b6b2a9
commit 152fd2a
Show file tree

Hide file tree

Showing 6 changed files with 110 additions and 18 deletions.
diff --git a/...-web/frontend/sirius-web-application/src/modals/duplicate-object/DuplicateObjectModal.tsx b/...-web/frontend/sirius-web-application/src/modals/duplicate-object/DuplicateObjectModal.tsx
@@ -53,7 +53,8 @@ const useDuplicateObjectModalStyles = makeStyles()((theme) => ({
 
 export const DuplicateObjectModal = ({
   editingContextId,
-  item,
+  objectToDuplicateId,
+  objectToDuplicateKind,
   onObjectDuplicated,
   onClose,
 }: DuplicateObjectModalProps) => {
@@ -79,11 +80,11 @@ export const DuplicateObjectModal = ({
         variables: {
           editingContextId,
           containerId: state.containerSelection.entries[0].id,
-          containedObjectId: item.id,
+          containedObjectId: objectToDuplicateId,
         },
       });
     }
-  }, [state.containerSelection, item]);
+  }, [state.containerSelection, objectToDuplicateId]);
 
   useEffect(() => {
     if (containmentFeatureNames) {
@@ -99,7 +100,7 @@ export const DuplicateObjectModal = ({
   const onDuplicate = () => {
     duplicateObject(
       editingContextId,
-      item.id,
+      objectToDuplicateId,
       state.containerSelection.entries[0]?.id,
       state.containmentFeatureName,
       state.duplicateContent,
@@ -141,8 +142,8 @@ export const DuplicateObjectModal = ({
   };
 
   const treeId: string = `modelBrowser://container?ownerKind=${encodeURIComponent(
-    item.kind
-  )}&targetType=${encodeURIComponent(item.kind)}&isContainment=true`;
+    objectToDuplicateKind
+  )}&targetType=${encodeURIComponent(objectToDuplicateKind)}&isContainment=true`;
   const { tree } = useDuplicateDialogTreeSubscription(editingContextId, treeId, state.expanded, state.maxDepth);
 
   return (

diff --git a/...frontend/sirius-web-application/src/modals/duplicate-object/DuplicateObjectModal.types.ts b/...frontend/sirius-web-application/src/modals/duplicate-object/DuplicateObjectModal.types.ts
@@ -14,7 +14,8 @@ import { Selection } from '@eclipse-sirius/sirius-components-core';
 
 export interface DuplicateObjectModalProps {
   editingContextId: string;
-  item: any;
+  objectToDuplicateId: string;
+  objectToDuplicateKind: string;
   onObjectDuplicated: (object: Selection) => void;
   onClose: () => void;
 }

diff --git a/...ges/sirius-web/frontend/sirius-web-application/src/views/edit-project/EditProjectView.tsx b/...ges/sirius-web/frontend/sirius-web-application/src/views/edit-project/EditProjectView.tsx
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2019, 2024 Obeo.
+ * Copyright (c) 2019, 2025 Obeo.
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
  * which accompanies this distribution, and is available at
@@ -45,6 +45,7 @@ import { NewDocumentModalContribution } from './TreeToolBarContributions/NewDocu
 import { UploadDocumentModalContribution } from './TreeToolBarContributions/UploadDocumentModalContribution';
 import { UndoRedo } from './UndoRedo';
 import { useProjectAndRepresentationMetadata } from './useProjectAndRepresentationMetadata';
+import { KeyboardShortcut } from './KeyboardShortcut';
 
 const useEditProjectViewStyles = makeStyles()((_) => ({
   editProjectView: {
@@ -129,15 +130,17 @@ export const EditProjectView = () => {
         <SelectionContextProvider initialSelection={initialSelection}>
           <OmniboxProvider initialContextEntries={initialContextEntries}>
             <UndoRedo>
-              <EditProjectNavbar readOnly={readOnly} />
-              <TreeToolBarProvider>
-                <Workbench
-                  editingContextId={context.project.currentEditingContext.id}
-                  initialRepresentationSelected={context.representation}
-                  onRepresentationSelected={onRepresentationSelected}
-                  readOnly={readOnly}
-                />
-              </TreeToolBarProvider>
+              <KeyboardShortcut editingContextId={context.project.currentEditingContext.id} readOnly={readOnly}>
+                <EditProjectNavbar readOnly={readOnly} />
+                <TreeToolBarProvider>
+                  <Workbench
+                    editingContextId={context.project.currentEditingContext.id}
+                    initialRepresentationSelected={context.representation}
+                    onRepresentationSelected={onRepresentationSelected}
+                    readOnly={readOnly}
+                  />
+                </TreeToolBarProvider>
+              </KeyboardShortcut>
             </UndoRedo>
           </OmniboxProvider>
         </SelectionContextProvider>

diff --git a/...es/sirius-web/frontend/sirius-web-application/src/views/edit-project/KeyboardShortcut.tsx b/...es/sirius-web/frontend/sirius-web-application/src/views/edit-project/KeyboardShortcut.tsx
@@ -0,0 +1,68 @@
+/*******************************************************************************
+ * Copyright (c) 2025 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+import { useEffect, useState } from 'react';
+import { Selection, useSelection } from '@eclipse-sirius/sirius-components-core';
+import { DuplicateObjectModal } from '../../modals/duplicate-object/DuplicateObjectModal';
+import { KeyboardShortcutProps } from './KeyboardShortcut.types';
+
+export const KeyboardShortcut = ({ editingContextId, readOnly, children }: KeyboardShortcutProps) => {
+  const [open, setOpen] = useState<boolean>(false);
+  const { selection, setSelection } = useSelection();
+
+  const duplicateObjectModalOpen = () => {
+    if (selection && selection.entries.length === 1) {
+      const selectionEntryItem = selection.entries[0];
+      if (selectionEntryItem && selectionEntryItem.kind.startsWith('siriusComponents://semantic')) {
+        setOpen(true);
+      }
+    }
+  };
+
+  const duplicateObjectKeyPressHandler = (e) => {
+    if ((e.ctrlKey || e.metaKey) && e.key === 'd') {
+      e.preventDefault();
+      duplicateObjectModalOpen();
+    }
+  };
+
+  useEffect(() => {
+    if (!readOnly) {
+      window.addEventListener('keydown', duplicateObjectKeyPressHandler);
+    }
+    return () => window.removeEventListener('keydown', duplicateObjectKeyPressHandler);
+  }, [selection, readOnly]);
+
+  const onObjectCreated = (selection: Selection) => {
+    setSelection(selection);
+    setOpen(false);
+  };
+
+  const onClose = () => {
+    setOpen(false);
+  };
+
+  return (
+    <>
+      {children}
+      {open ? (
+        <DuplicateObjectModal
+          editingContextId={editingContextId}
+          objectToDuplicateId={selection.entries[0].id}
+          objectToDuplicateKind={selection.entries[0].kind}
+          onObjectDuplicated={onObjectCreated}
+          onClose={onClose}
+        />
+      ) : null}
+    </>
+  );
+};
diff --git a/...rius-web/frontend/sirius-web-application/src/views/edit-project/KeyboardShortcut.types.ts b/...rius-web/frontend/sirius-web-application/src/views/edit-project/KeyboardShortcut.types.ts
@@ -0,0 +1,18 @@
+/*******************************************************************************
+ * Copyright (c) 2025 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+
+export type KeyboardShortcutProps = {
+  editingContextId: string;
+  readOnly: boolean;
+  children: React.ReactNode;
+};
diff --git a/...d/sirius-web-application/src/views/edit-project/ObjectTreeItemContextMenuContribution.tsx b/...d/sirius-web-application/src/views/edit-project/ObjectTreeItemContextMenuContribution.tsx
@@ -65,7 +65,8 @@ export const ObjectTreeItemContextMenuContribution = forwardRef(
       modalElement = (
         <DuplicateObjectModal
           editingContextId={editingContextId}
-          item={item}
+          objectToDuplicateId={item.id}
+          objectToDuplicateKind={item.kind}
           onObjectDuplicated={onObjectCreated}
           onClose={onClose}
         />