[5982] Add the ability to trigger context menu entries with key bindings

Bug: #5982
Signed-off-by: Gwendal Daniel <gwendal.daniel@obeosoft.com>

Author: gdaniel

CHANGELOG.adoc

@@ -61,6 +61,9 @@ The `SingleClickOnDiagramElementTool` builder now requires a list of key binding
 - https://github.com/eclipse-sirius/sirius-web/issues/6202[#6202] [diagram] Custom node layout handlers must now set `isDragNodeSource`.
 An example can be found with `EllipseNodeConverter.ts`.
 `useDropNodeStyle` now has a new parameter `isDragNodeSource`.
+- https://github.com/eclipse-sirius/sirius-web/issues/5982[#5982] [tree] Add the ability to trigger context menu entries using key bindings.
+The `TreeItemContextMenuEntryBuilder` subclasses now require a list of key bindings.
+`IKeyBindingConverter` and `KeyBindingConverter` have been moved from their respective packages to `org.eclipse.sirius.components.view.emf`.
 
 
 === Dependency update
@@ -109,6 +112,9 @@ The key bindings are visible in the palette next to the tool name.
 A key binding needs to contain at least one of `Control`, `Alt`, or `Meta` to be executed by the frontend.
 - https://github.com/eclipse-sirius/sirius-web/issues/3488[#3488] [diagram] Restore auto-layout support for diagrams
 - https://github.com/eclipse-sirius/sirius-web/issues/5062[#5062] [sirius-web] Add new "views explorer" view
+- https://github.com/eclipse-sirius/sirius-web/issues/5982[#5982] [tree] Add the ability to trigger context menu entries using key bindings.
+As for diagram tools, it is now possible to add `KeyBinding` instances to context menu entries in trees.
+Note that for the moment, only entries that aren't overridden in the frontend can be triggered with key bindings, although it is possible to define key bindings for any entry.
 
 
 === Improvements

integration-tests-playwright/playwright/e2e/explorer/key-bindings.spec.ts

@@ -0,0 +1,43 @@
+/*******************************************************************************
+ * Copyright (c) 2026 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 { expect, test } from '@playwright/test';
+import { PlaywrightExplorer } from '../../helpers/PlaywrightExplorer';
+import { PlaywrightProject } from '../../helpers/PlaywrightProject';
+
+test.describe('explorer - key bindings', () => {
+  let projectId;
+  let playwrightExplorer;
+  test.beforeEach(async ({ page, request }) => {
+    const project = await new PlaywrightProject(request).createProject('Studio', 'blank-studio-template');
+    projectId = project.projectId;
+
+    await page.goto(`/projects/${projectId}/edit/`);
+
+    playwrightExplorer = new PlaywrightExplorer(page);
+    await playwrightExplorer.uploadDocument('studioKeyBindings.xml');
+  });
+
+  test('When clicking on a tree item and entering a valid key binding, then the corresponding entry is executed', async ({
+    page,
+  }) => {
+    // Reload the page to display the explorer selection button (which is only present if a domain model is in the editing context)
+    page.reload();
+    await playwrightExplorer.openExplorer('Domain explorer by DSL');
+    await playwrightExplorer.expand('studioKeyBindings.xml');
+    await playwrightExplorer.expand('domain');
+    await playwrightExplorer.select('[Entity] Entity1 {}');
+    const entity1Item = await playwrightExplorer.getTreeItemLabel('[Entity] Entity1 {}');
+    entity1Item.press('ControlOrMeta+b');
+    await expect(page.getByTestId('impact-analysis-dialog')).toBeAttached();
+  });
+});

integration-tests-playwright/playwright/helpers/PlaywrightExplorer.ts

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2025 Obeo.
+ * Copyright (c) 2025, 2026 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
@@ -91,4 +91,9 @@ export class PlaywrightExplorer {
     await this.explorerLocator.getByTestId(`${treeItemLabel}-more`).click();
     await this.page.getByTestId(`push-selection-to-${selectionTargetLabel}`).click();
   }
+
+  async openExplorer(explorerDescriptionLabel: string) {
+    await this.page.getByTestId('tree-descriptions-menu-icon').click();
+    await this.page.getByRole('menuitem').filter({ hasText: explorerDescriptionLabel }).click();
+  }
 }

packages/core/frontend/sirius-components-core/src/index.ts

@@ -34,6 +34,8 @@ export { useData } from './extension/useData';
 export * from './filter/FilterBar';
 export type * from './graphql/GQLTypes.types';
 export * from './icon/IconOverlay';
+export { KeyBinding } from './key-binding/KeyBinding';
+export type { GQLKeyBinding, KeyBindingProps } from './key-binding/KeyBinding.types';
 export * from './label/StyledLabel';
 export * from './label/StyledLabel.type';
 export * from './materialui';

…s-palette/src/key-binding/KeyBinding.tsx …ents-core/src/key-binding/KeyBinding.tsxpackages/palette/frontend/sirius-components-palette/src/key-binding/KeyBinding.tsx renamed to packages/core/frontend/sirius-components-core/src/key-binding/KeyBinding.tsx packages/palette/frontend/sirius-components-palette/src/key-binding/KeyBinding.tsx renamed to packages/core/frontend/sirius-components-core/src/key-binding/KeyBinding.tsx

@@ -11,9 +11,14 @@
  *     Obeo - initial API and implementation
  *******************************************************************************/
 
-import { GQLKeyBinding } from '../Palette.types';
-
 export interface KeyBindingProps {
   keyBinding: GQLKeyBinding;
   'data-testid'?: string;
 }
+
+export interface GQLKeyBinding {
+  isCtrl: boolean;
+  isMeta: boolean;
+  isAlt: boolean;
+  key: string;
+}

…ette/src/key-binding/KeyBinding.types.ts …core/src/key-binding/KeyBinding.types.tspackages/palette/frontend/sirius-components-palette/src/key-binding/KeyBinding.types.ts renamed to packages/core/frontend/sirius-components-core/src/key-binding/KeyBinding.types.ts packages/palette/frontend/sirius-components-palette/src/key-binding/KeyBinding.types.ts renamed to packages/core/frontend/sirius-components-core/src/key-binding/KeyBinding.types.ts

@@ -11,6 +11,7 @@
  *     Obeo - initial API and implementation
  *******************************************************************************/
 
+import { GQLKeyBinding } from '@eclipse-sirius/sirius-components-core';
 import { PaletteExtensionSectionProps } from './PaletteExtensionSection.types';
 
 export interface ContextualPaletteStyleProps {
@@ -60,13 +61,6 @@ export interface GQLSingleClickOnDiagramElementTool extends GQLTool {
   keyBindings: GQLKeyBinding[];
 }
 
-export interface GQLKeyBinding {
-  isCtrl: boolean;
-  isMeta: boolean;
-  isAlt: boolean;
-  key: string;
-}
-
 export interface GQLPalette {
   id: string;
   quickAccessTools: GQLTool[];

packages/palette/frontend/sirius-components-palette/src/Palette.types.ts

@@ -11,13 +11,12 @@
  *     Obeo - initial API and implementation
  *******************************************************************************/
 
-import { IconOverlay } from '@eclipse-sirius/sirius-components-core';
+import { IconOverlay, KeyBinding } from '@eclipse-sirius/sirius-components-core';
 import ListItemButton from '@mui/material/ListItemButton';
 import ListItemIcon from '@mui/material/ListItemIcon';
 import ListItemText from '@mui/material/ListItemText';
 import Tooltip from '@mui/material/Tooltip';
 import { makeStyles } from 'tss-react/mui';
-import { KeyBinding } from '../key-binding/KeyBinding';
 import { isSingleClickOnDiagramElementTool } from '../Palette';
 import { GQLTool } from '../Palette.types';
 import { ToolListItemProps } from './ToolListItem.types';

packages/palette/frontend/sirius-components-palette/src/tool-list-item/ToolListItem.tsx

@@ -27,6 +27,7 @@
 import org.eclipse.sirius.components.view.TextStylePalette;
 import org.eclipse.sirius.components.view.View;
 import org.eclipse.sirius.components.view.builder.generated.tree.TreeBuilders;
+import org.eclipse.sirius.components.view.builder.generated.view.KeyBindingBuilder;
 import org.eclipse.sirius.components.view.builder.generated.view.ViewBuilders;
 import org.eclipse.sirius.components.view.emf.tree.ITreeIdProvider;
 import org.eclipse.sirius.components.view.tree.FetchTreeItemContextMenuEntryKind;
@@ -292,12 +293,29 @@ private List<TreeItemContextMenuEntry> getContextMenuEntries() {
                 .preconditionExpression(AQL_SELF_IS_AN_ENTITY)
                 .urlExression("https://eclipse.dev/sirius/sirius-web.html")
                 .kind(FetchTreeItemContextMenuEntryKind.OPEN)
+                .keyBindings(new KeyBindingBuilder()
+                                .ctrl(true)
+                                .key("m")
+                                .build(),
+                        new KeyBindingBuilder()
+                                .meta(true)
+                                .key("m")
+                                .build()
+                )
                 .build();
         this.toggleAbstractMenuEntry = new TreeBuilders().newSingleClickTreeItemContextMenuEntry()
                 .labelExpression("Toggle abstract")
                 .preconditionExpression(AQL_SELF_IS_AN_ENTITY)
                 .body(callService.build())
                 .withImpactAnalysis(true)
+                .keyBindings(new KeyBindingBuilder()
+                                .ctrl(true)
+                                .key("b")
+                                .build(),
+                        new KeyBindingBuilder()
+                                .meta(true)
+                                .key("b")
+                                .build())
                 .build();
 
         var expandAllMenuEntry = new TreeBuilders().newCustomTreeItemContextMenuEntry()

packages/sirius-web/backend/sirius-web-application/src/main/java/org/eclipse/sirius/web/application/studio/services/representations/DomainViewTreeDescriptionProvider.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2025 Obeo.
+ * Copyright (c) 2025, 2026 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
@@ -96,7 +96,7 @@ public List<ITreeItemContextMenuEntry> getTreeItemContextMenuEntries(IEditingCon
             result.addAll(this.getLibraryRelatedEntries(emfEditingContext, treeItem));
         }
         if (treeItem.isHasChildren()) {
-            result.add(new SingleClickTreeItemContextMenuEntry(EXPAND_ALL, "", List.of(), false));
+            result.add(new SingleClickTreeItemContextMenuEntry(EXPAND_ALL, "", List.of(), false, List.of()));
         }
         return result;
     }
@@ -110,9 +110,9 @@ private List<ITreeItemContextMenuEntry> getDocumentContextMenuEntries(IEMFEditin
 
             List<ITreeItemContextMenuEntry> entries = new ArrayList<>();
             if (!this.readOnlyObjectPredicate.test(resource)) {
-                entries.add(new SingleClickTreeItemContextMenuEntry(NEW_ROOT_OBJECT, "", List.of(), false));
+                entries.add(new SingleClickTreeItemContextMenuEntry(NEW_ROOT_OBJECT, "", List.of(), false, List.of()));
             }
-            entries.add(new SingleClickTreeItemContextMenuEntry(DOWNLOAD_DOCUMENT, "", List.of(), false));
+            entries.add(new SingleClickTreeItemContextMenuEntry(DOWNLOAD_DOCUMENT, "", List.of(), false, List.of()));
             return entries;
         }
         return List.of();
@@ -126,9 +126,9 @@ private List<ITreeItemContextMenuEntry> getObjectContextMenuEntries(IEMFEditingC
             var object = optionalEObject.get();
             if (!this.readOnlyObjectPredicate.test(object)) {
                 return List.of(
-                        new SingleClickTreeItemContextMenuEntry(NEW_OBJECT, "", List.of(), false),
-                        new SingleClickTreeItemContextMenuEntry(NEW_REPRESENTATION, "", List.of(), false),
-                        new SingleClickTreeItemContextMenuEntry(DUPLICATE_OBJECT, "", List.of(), false)
+                        new SingleClickTreeItemContextMenuEntry(NEW_OBJECT, "", List.of(), false, List.of()),
+                        new SingleClickTreeItemContextMenuEntry(NEW_REPRESENTATION, "", List.of(), false, List.of()),
+                        new SingleClickTreeItemContextMenuEntry(DUPLICATE_OBJECT, "", List.of(), false, List.of())
                 );
             }
         }
@@ -141,7 +141,7 @@ private List<ITreeItemContextMenuEntry> getRepresentationContextMenuEntries(IEMF
                 .map(RepresentationMetadata.class::cast);
         if (optionalRepresentationMetadata.isPresent()) {
             return List.of(
-                    new SingleClickTreeItemContextMenuEntry(DUPLICATE_REPRESENTATION, "", List.of(), false)
+                    new SingleClickTreeItemContextMenuEntry(DUPLICATE_REPRESENTATION, "", List.of(), false, List.of())
             );
         }
         return List.of();
@@ -171,8 +171,8 @@ private List<ITreeItemContextMenuEntry> getLibraryRelatedEntries(IEMFEditingCont
             var libraryMetadataAdapter = optionalLibraryMetadataAdapter.get();
             if (this.isDirectDependency(editingContext, libraryMetadataAdapter)) {
                 // We do not support the update or removal of a transitive dependency for the moment.
-                result.add(new SingleClickTreeItemContextMenuEntry(UPDATE_LIBRARY, "Update the library", List.of(), true));
-                result.add(new SingleClickTreeItemContextMenuEntry(REMOVE_LIBRARY, "Remove library", List.of("/icons/remove_library.svg"), true));
+                result.add(new SingleClickTreeItemContextMenuEntry(UPDATE_LIBRARY, "Update the library", List.of(), true, List.of()));
+                result.add(new SingleClickTreeItemContextMenuEntry(REMOVE_LIBRARY, "Remove library", List.of("/icons/remove_library.svg"), true, List.of()));
             }
         }
         return result;