Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve naming of "editor.minimap.mode" setting and its values #91405

Closed
weinand opened this issue Feb 25, 2020 · 4 comments
Closed

Improve naming of "editor.minimap.mode" setting and its values #91405

weinand opened this issue Feb 25, 2020 · 4 comments
Assignees
Labels
bug Issue identified by VS Code Team member as probable bug editor-minimap Code/Text minimap widget issues verified Verification succeeded
Milestone

Comments

@weinand
Copy link
Contributor

weinand commented Feb 25, 2020

Testing #91250:

When reading the following in my settings file, I have no idea what this means:

"editor.minimap.mode": "actual",

And I have a hard time understanding what the other two "modes" "contain" and "cover" really mean.

So I tried hard to understand what is controlled by the "mode". On a mathematical level it is a "projection", but this is not something to "throw" at users.

On a simpler level it is the "size" of the minimap.

Based on this we could rename "mode" to "size" and use these values and descriptions:

  • "sameSize": Minimap has the same size as the editor contents (and might scroll).
  • "shrink": The minimap will shrink as necessary to never be larger than the editor (no scrolling).
  • "shrinkOrExpand": The minimap will stretch or shrink as necessary to fill the height of the editor (no scrolling).
@weinand weinand changed the title Improve naming of "editor.minimap.mode" setting Improve naming of "editor.minimap.mode" setting and its values Feb 25, 2020
@alexdima alexdima added the editor-minimap Code/Text minimap widget issues label Feb 26, 2020
@alexdima alexdima added this to the February 2020 milestone Feb 26, 2020
@alexdima
Copy link
Member

alexdima commented Feb 27, 2020

actual contain cover
small image image image
large image image image
current minimap.mode: actual minimap.mode: contain minimap.mode: cover
opt1 minimap.size: sameSize minimap.size: shrink minimap.size: shrinkOrExpand
opt2 minimap.height: proportional minimap.height: fit minimap.height: fill

@alexdima
Copy link
Member

We decided in the standup to go with minimap.size and the values proportional, fit and fill.

@alexdima alexdima added the bug Issue identified by VS Code Team member as probable bug label Feb 27, 2020
@mjbvz mjbvz added the verified Verification succeeded label Feb 27, 2020
@gjsjohnmurray
Copy link
Contributor

We decided in the standup to go with minimap.size and the values proportional, fit and fill.

Is it too late to lobby for this to be changed to minimap.height rather than minimap.size? Reason being, I'd like to request a future enhancement that'd allow me to set a maximum pixel width for the minimap. On wide screens the way the minimap width increases proportionally to the display width of the file means it can become unnecessarily wide.

Narrow:
image

Wide:
image

Seems to me that the left-side portion of the minimap is often sufficient to give me a sense of where I need to scroll to.

@gjsjohnmurray
Copy link
Contributor

Nevermind. I've just noticed editor.minimap.maxColumn already exists.

With "editor.minimap.maxColumn": 30 my wide screen layout becomes:
image

@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Issue identified by VS Code Team member as probable bug editor-minimap Code/Text minimap widget issues verified Verification succeeded
Projects
None yet
Development

No branches or pull requests

4 participants