[6295] Make it possible to hide the minimap by default by florianbarbin · Pull Request #6305 · eclipse-sirius/sirius-web

florianbarbin · 2026-03-18T17:05:08Z

The specifier can choose to hide the minimap by default for a specific diagram description
The minimap hide/reveal action is now persisted for a specific diagram.

Bug: #6295

Pull request template

General purpose

What is the main goal of this pull request?

Project management

Has the pull request been added to the relevant project and milestone? (Only if you know that your work is part of a specific iteration such as the current one)
Have the priority: and pr: labels been added to the pull request? (In case of doubt, start with the labels priority: low and pr: to review later)
Have the relevant issues been added to the pull request?
Have the relevant labels been added to the issues? (area:, difficulty:, type:)
Have the relevant issues been added to the same project and milestone as the pull request?
Has the CHANGELOG.adoc been updated to reference the relevant issues?
Have the relevant API breaks been described in the CHANGELOG.adoc? (Including changes in the GraphQL API)
In case of a change with a visual impact, are there any screenshots in the CHANGELOG.adoc? For example in doc/screenshots/2022.5.0-my-new-feature.png

Architectural decision records (ADR)

Does the title of the commit contributing the ADR start with [doc]?
Are the ADRs mentioned in the relevant section of the CHANGELOG.adoc?

Dependencies

Are the new / upgraded dependencies mentioned in the relevant section of the CHANGELOG.adoc?
Are the new dependencies justified in the CHANGELOG.adoc?

Frontend

This section is not relevant if your contribution does not come with changes to the frontend.

General purpose

Is the code properly tested? (Plain old JavaScript tests for business code and tests based on React Testing Library for the components)

Typing

We need to improve the typing of our code, as such, we require every contribution to come with proper TypeScript typing for both changes contributing new files and those modifying existing files.
Please ensure that the following statements are true for each file created or modified (this may require you to improve code outside of your contribution).

Backend

This section is not relevant if your contribution does not come with changes to the backend.

General purpose

Are all the event handlers tested?
Are the event processor tested?
Is the business code (services) tested?
Are diagram layout changes tested?

Architecture

Are data structure classes properly separated from behavioral classes?
Are all the relevant fields final?
Is any data structure mutable? If so, please write a comment indicating why
Are behavioral classes either stateless or side effect free?

Review

How to test this PR?

Please describe here the various use cases to test this pull request

Has the Kiwi TCMS test suite been updated with tests for this contribution?

frouene · 2026-03-19T07:36:04Z

...java/org/eclipse/sirius/components/collaborative/diagrams/dto/ShowMinimapSuccessPayload.java

+ *
+ * @author fbarbin
+ */
+public record ShowMinimapSuccessPayload(UUID id, Boolean showMinimap) implements IPayload {


Does this need to be a Boolean rather than a boolean ?

frouene · 2026-03-19T07:36:53Z

...a/org/eclipse/sirius/components/collaborative/diagrams/handlers/ShowMinimapEventHandler.java

+    public void handle(One<IPayload> payloadSink, Many<ChangeDescription> changeDescriptionSink, IEditingContext editingContext, DiagramContext diagramContext, IDiagramInput diagramInput) {
+        this.counter.increment();
+
+        String message = this.messageService.invalidInput(diagramInput.getClass().getSimpleName(), GetToolbarInput.class.getSimpleName());


Wrong input in the error message

fixed, copy paste issue :D

frouene · 2026-03-19T07:46:28Z

...ew-emf/src/main/java/org/eclipse/sirius/components/view/emf/diagram/ShowMinimapProvider.java

+            VariableManager variableManager = new VariableManager();
+            variableManager.put(VariableManager.SELF, targetElement);
+            variableManager.put(IEditingContext.EDITING_CONTEXT, editingContext);
+            variableManager.put(DiagramContext.DIAGRAM_CONTEXT, diagramContext);


What is this variableManager for? It's not an expression that can be evaluated.

frouene · 2026-03-19T07:50:05Z

...ew-emf/src/main/java/org/eclipse/sirius/components/view/emf/diagram/ShowMinimapProvider.java

+ * @author fbarbin
+ */
+@Service
+public class ShowMinimapProvider implements IShowMinimapProvider {


This implementation is specific for the view description, it should be mentioned in its name.
By the way what happen if it's not a view description, I think that this code will not work.
I think we need to add a canHandle method to the interface

Done: I added a canHandle on the service and the EventHandler take a list of IShowMinimapProvider and use the first one that can handle.

The name of this class still doesn't make it clear that it's meant to handle descriptions from the view.
I think it might be a good idea to specify that.

something like DiagramDescriptionViewShowMinimapProvider ?

Even just ViewShowMinimapProvider is enough for me

frouene · 2026-03-19T09:04:23Z

integration-tests-playwright/playwright/e2e/diagrams/diagram.spec.ts

+
+    //4. We switch to the initial Topography diagram
+    const representationItem = await explorer.getTreeItemLabel('Topography');
+    representationItem.click();


await missing

frouene · 2026-03-19T09:04:54Z

integration-tests-playwright/playwright/e2e/diagrams/diagram.spec.ts

+    await expect(page.locator('.react-flow__minimap')).toBeAttached();
+
+    //4. We switch to the initial Topography diagram
+    const representationItem = await explorer.getTreeItemLabel('Topography');


could be done with explorer.select

frouene · 2026-03-20T09:59:58Z

...a/org/eclipse/sirius/components/collaborative/diagrams/handlers/ShowMinimapEventHandler.java

+                DiagramDescription diagramDescription = optionalDiagramDescription.get();
+                var optionalShowMinimapProvider = this.showMinimapProviders.stream()
+                        .filter(iShowMinimapProvider -> iShowMinimapProvider.canHandle(editingContext, diagramContext, diagramDescription))
+                        .findFirst();


To test the functionality, I wanted to create a simple scenario where the minimap is only displayed once there is at least one node on the diagram. The problem with this approach (where we simply look for the first provider that returns true) is that, depending on the order in which Spring scans the beans, we might end up having to skip beans in order to implement a new mechanism.
I wonder if it wouldn’t be better to take all providers with canHandle set to true and aggregate all the booleans (using an and operator) to get a consolidated value.

I have changed the code to perform a reduce operation (with and operator) with each providers that can handle the request

- The specifier can choose to hide the minimap by default for a specific diagram description - The minimap hide/reveal action is now persisted for a specific diagram. Bug: #6295 Signed-off-by: Florian Barbin <florian.barbin@obeosoft.com> Signed-off-by: Florian ROUËNÉ <florian.rouene@obeosoft.com>

frouene · 2026-03-26T14:57:05Z

I just moved the entry in the changelog to be in the 2026.3.0 section.
Can me merged after build

florianbarbin added this to the 2026.5.0 milestone Mar 18, 2026

florianbarbin added pr: to review later priority: high labels Mar 18, 2026

florianbarbin force-pushed the fba/enh/minimap branch 2 times, most recently from 0e5490b to 035c8d6 Compare March 18, 2026 17:07

florianbarbin linked an issue Mar 18, 2026 that may be closed by this pull request

Add the ability to hide the mini map by default #6295

Open

frouene requested changes Mar 19, 2026

View reviewed changes

florianbarbin force-pushed the fba/enh/minimap branch from 035c8d6 to 23e633c Compare March 19, 2026 08:17

florianbarbin changed the base branch from fba/doc/minimapShap to cooldown March 19, 2026 08:24

florianbarbin changed the base branch from cooldown to fba/doc/minimapShap March 19, 2026 08:26

frouene reviewed Mar 19, 2026

View reviewed changes

florianbarbin requested a review from frouene March 19, 2026 09:30

florianbarbin force-pushed the fba/enh/minimap branch 2 times, most recently from 25d9a82 to b76394f Compare March 20, 2026 09:00

florianbarbin force-pushed the fba/doc/minimapShap branch from f0c80b1 to 2169af3 Compare March 20, 2026 09:01

florianbarbin force-pushed the fba/enh/minimap branch from b76394f to c90ca3e Compare March 20, 2026 09:01

frouene reviewed Mar 20, 2026

View reviewed changes

florianbarbin force-pushed the fba/enh/minimap branch from c90ca3e to bcb48fb Compare March 20, 2026 10:33

florianbarbin requested a review from frouene March 20, 2026 10:33

florianbarbin force-pushed the fba/enh/minimap branch from bcb48fb to 0785d3d Compare March 20, 2026 10:39

frouene force-pushed the fba/enh/minimap branch from 0785d3d to aadc04e Compare March 26, 2026 14:55

frouene approved these changes Mar 26, 2026

View reviewed changes

frouene merged commit 10004fb into fba/doc/minimapShap Mar 27, 2026
4 of 5 checks passed

frouene deleted the fba/enh/minimap branch March 27, 2026 07:27

Conversation

florianbarbin commented Mar 18, 2026

Pull request template

General purpose

Project management

Architectural decision records (ADR)

Dependencies

Frontend

General purpose

Typing

Backend

General purpose

Architecture

Review

How to test this PR?

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

florianbarbin Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

frouene commented Mar 26, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

florianbarbin Mar 19, 2026 •

edited

Loading