[doc] Add pitch for minimap default visibility by florianbarbin · Pull Request #6302 · eclipse-sirius/sirius-web

florianbarbin · 2026-03-17T13:50:51Z

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-27T08:16:57Z

I've updated the shape to fit the new format with pitches

sbegaudeau

What about the existing values in local storage? How are they removed?

sbegaudeau · 2026-03-27T13:40:48Z

+:status: proposed
+:consulted: Florian Rouëné
+:informed: Florian Rouëné
+:deciders: Stéphane Bégaudeau


It's funny that I'm the decider yet I am not affected this PR nor asked to review it

Commits for pitches and adrs uses the doc tag and are not assigned to the issue to not close it

The pitch is not merged nor accepted yet the work seems to be done already

sbegaudeau · 2026-03-27T13:41:04Z

+
+== Problem
+
+Currently, the minimap visibility is controlled by a global `localStorage` setting. If a user hides the minimap on one diagram, it remains hidden on all diagrams. Furthermore, diagram specifiers have no way to define a default state for their diagram via the View DSL.


One sentence per line (the same comment can be repeated for the whole file)

No it's not done, far from it. I'll do it myself to make this pitch move forward.

sbegaudeau · 2026-03-27T13:42:49Z

+
+1.  **View DSL integration:** Add a property to the View DSL, on the `DiagramDescription` to set the initial `showMinimap` state.
+2.  **State Lookup:** On diagram component mount, the app checks for a user preference in `localStorage` keyed by the diagram ID. If null, it falls back to the default View DSL value.
+3.  **Removal of Global Key:** Deprecate the existing global `sirius-diagram-mini-map-visibility` key to prevent state pollution.


Remove or deprecate?

It is still written deprecate...

sbegaudeau · 2026-03-27T13:47:44Z

+
+    boolean canHandle(IEditingContext editingContext, DiagramContext diagramContext, DiagramDescription diagramDescription);
+
+    boolean showMinimap(IEditingContext editingContext, DiagramContext diagramContext, DiagramDescription diagramDescription);


Why showMinimap? It does not show the minimap, it computes the minimap visibility.

I propose minimapVisible

It's a function, it should start with a verb, something like isMinimapVisible

The service will have be named isMinimapVisible (I moved the code in another Draft PR) but the field in the graphQL API and description will be named minimapVisible. It is the case for autoLayout

sbegaudeau · 2026-04-01T13:44:21Z

+
+== Rabbit holes
+* **Diagram Identification:** If IDs are non-persistent (transient diagrams), the user preference will be lost.
+* **Storage Bloat:** If a user views thousands of diagrams, `localStorage` will accumulate thousands of small keys. We should consider to delete the oldest keys when deleting a diagram.


This will require an answer at the technical level (I don't need an ADR for that but it will have to be fixed in the code), we can't just create stuff on the machine of the end users without any cleanup solution.

The problem here (which also applies to the delete preference ask) is that someone else might have already deleted the project or representation.

So, at the technical level, we will need at least to track the last time we had to interact with the data in question. If we did not use some local storage data for a year, we can probably delete it

sbegaudeau · 2026-04-07T08:32:30Z

+* **Nice-to-have:** A "Reset to Default" button in the UI to clear the `localStorage` override.
+
+== Rabbit holes
+* **Diagram Identification:** If IDs are non-persistent (transient diagrams), the user preference will be lost.


Those are not related, the representation can be transient and its id stable over time

Bug: #6295 Signed-off-by: Florian Barbin <florian.barbin@obeosoft.com>

florianbarbin added this to the 2026.5.0 milestone Mar 17, 2026

florianbarbin added difficulty: medium pr: to review soon priority: low labels Mar 17, 2026

florianbarbin force-pushed the fba/doc/minimapShap branch from 69f9b3b to b4285c1 Compare March 17, 2026 13:53

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

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

Open

florianbarbin mentioned this pull request Mar 17, 2026

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

Open

florianbarbin force-pushed the fba/doc/minimapShap branch 2 times, most recently from 2dd2c2c to f0c80b1 Compare March 18, 2026 16:36

florianbarbin changed the base branch from master to cooldown March 19, 2026 08:25

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

frouene force-pushed the fba/doc/minimapShap branch from 10004fb to 4b41004 Compare March 27, 2026 08:15

frouene changed the base branch from cooldown to master March 27, 2026 08:17

frouene removed the difficulty: medium label Mar 27, 2026

frouene force-pushed the fba/doc/minimapShap branch from 4b41004 to aa66237 Compare March 27, 2026 08:20

frouene approved these changes Mar 27, 2026

View reviewed changes

sbegaudeau requested changes Mar 27, 2026

View reviewed changes

sbegaudeau changed the title ~~[6295] Add shape for minimap default visibility~~ [6295] Add pitch for minimap default visibility Mar 27, 2026

florianbarbin force-pushed the fba/doc/minimapShap branch from aa66237 to 57f83ed Compare March 30, 2026 13:05

florianbarbin requested a review from sbegaudeau March 30, 2026 13:08

florianbarbin changed the title ~~[6295] Add pitch for minimap default visibility~~ [doc] Add pitch for minimap default visibility Mar 30, 2026

florianbarbin removed a link to an issue Mar 30, 2026

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

Open

florianbarbin force-pushed the fba/doc/minimapShap branch from 57f83ed to 222aac0 Compare March 31, 2026 14:51

florianbarbin added priority: high and removed priority: low labels Mar 31, 2026

sbegaudeau reviewed Apr 1, 2026

View reviewed changes

florianbarbin force-pushed the fba/doc/minimapShap branch from 222aac0 to 6c7c593 Compare April 1, 2026 14:09

florianbarbin requested a review from sbegaudeau April 1, 2026 14:09

sbegaudeau reviewed Apr 7, 2026

View reviewed changes

sbegaudeau force-pushed the fba/doc/minimapShap branch from 6c7c593 to f7d1c1b Compare April 7, 2026 08:36

[6295] Add a pitch for minimap default visibility

f8bb85d

Bug: #6295 Signed-off-by: Florian Barbin <florian.barbin@obeosoft.com>

sbegaudeau force-pushed the fba/doc/minimapShap branch from f7d1c1b to f8bb85d Compare April 7, 2026 08:36

sbegaudeau approved these changes Apr 7, 2026

View reviewed changes

sbegaudeau merged commit bc56f62 into master Apr 7, 2026
2 checks passed

sbegaudeau deleted the fba/doc/minimapShap branch April 7, 2026 08:41

sbegaudeau self-assigned this Apr 7, 2026


		== Problem

		Currently, the minimap visibility is controlled by a global `localStorage` setting. If a user hides the minimap on one diagram, it remains hidden on all diagrams. Furthermore, diagram specifiers have no way to define a default state for their diagram via the View DSL.


		boolean canHandle(IEditingContext editingContext, DiagramContext diagramContext, DiagramDescription diagramDescription);

		boolean showMinimap(IEditingContext editingContext, DiagramContext diagramContext, DiagramDescription diagramDescription);

Conversation

florianbarbin commented Mar 17, 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!

frouene commented Mar 27, 2026

Uh oh!

sbegaudeau left a comment

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants