[doc] Add pitch for minimap default visibility#6302
Open
florianbarbin wants to merge 1 commit intomasterfrom
Open
[doc] Add pitch for minimap default visibility#6302florianbarbin wants to merge 1 commit intomasterfrom
florianbarbin wants to merge 1 commit intomasterfrom
Conversation
florianbarbin
force-pushed
the
fba/doc/minimapShap
branch
from
69f9b3b to
b4285c1
Compare
florianbarbin
force-pushed
the
fba/doc/minimapShap
branch
2 times, most recently
from
2dd2c2c to
f0c80b1
Compare
florianbarbin
force-pushed
the
fba/doc/minimapShap
branch
from
f0c80b1 to
2169af3
Compare
frouene
force-pushed
the
fba/doc/minimapShap
branch
from
10004fb to
4b41004
Compare
Contributor
|
I've updated the shape to fit the new format with pitches |
frouene
force-pushed
the
fba/doc/minimapShap
branch
from
4b41004 to
aa66237
Compare
frouene
approved these changes
Mar 27, 2026
sbegaudeau
requested changes
Mar 27, 2026
Member
sbegaudeau
left a comment
sbegaudeau
left a comment
There was a problem hiding this comment.
What about the existing values in local storage? How are they removed?
| :status: proposed | ||
| :consulted: Florian Rouëné | ||
| :informed: Florian Rouëné | ||
| :deciders: Stéphane Bégaudeau |
Member
There was a problem hiding this comment.
- 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
|
|
||
| == 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. |
Member
There was a problem hiding this comment.
One sentence per line (the same comment can be repeated for the whole file)
|
|
||
| 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. |
|
|
||
| boolean canHandle(IEditingContext editingContext, DiagramContext diagramContext, DiagramDescription diagramDescription); | ||
|
|
||
| boolean showMinimap(IEditingContext editingContext, DiagramContext diagramContext, DiagramDescription diagramDescription); |
Member
There was a problem hiding this comment.
Why showMinimap? It does not show the minimap, it computes the minimap visibility.
Contributor
Author
There was a problem hiding this comment.
I propose minimapVisible
sbegaudeau
changed the title
Bug: #6295 Signed-off-by: Florian Barbin <florian.barbin@obeosoft.com>
florianbarbin
force-pushed
the
fba/doc/minimapShap
branch
from
aa66237 to
57f83ed
Compare
florianbarbin
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Bug: #6295
Pull request template
General purpose
What is the main goal of this pull request?
Project management
priority:andpr:labels been added to the pull request? (In case of doubt, start with the labelspriority: lowandpr: to review later)area:,difficulty:,type:)CHANGELOG.adocbeen updated to reference the relevant issues?CHANGELOG.adoc? (Including changes in the GraphQL API)CHANGELOG.adoc? For example indoc/screenshots/2022.5.0-my-new-feature.pngArchitectural decision records (ADR)
[doc]?CHANGELOG.adoc?Dependencies
CHANGELOG.adoc?CHANGELOG.adoc?Frontend
This section is not relevant if your contribution does not come with changes to the frontend.
General purpose
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).
useMutation<DATA_TYPE, VARIABLE_TYPE>(…)useQuery<DATA_TYPE, VARIABLE_TYPE>(…)useSubscription<DATA_TYPE, VARIABLE_TYPE>(…)useMachine<CONTEXT_TYPE, EVENTS_TYPE>(…)useState<STATE_TYPE>(…)?.(if the GraphQL API specifies that a field cannot benull, do not treat it has potentiallynullfor example)let diagram: Diagram | null = null;)Backend
This section is not relevant if your contribution does not come with changes to the backend.
General purpose
Architecture
Review
How to test this PR?
Please describe here the various use cases to test this pull request