Fixes #21784: Add editor.minimap.showSlider to control the minimap'…

…s slider visibility
microsoft · Jun 7, 2017 · 6f0d0c6 · 6f0d0c6
1 parent 8535146
commit 6f0d0c6
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 4 deletions.
diff --git a/src/vs/editor/browser/viewParts/minimap/minimap.css b/src/vs/editor/browser/viewParts/minimap/minimap.css
@@ -3,16 +3,19 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-.monaco-editor .minimap-slider {
+/* START cover the case that slider is visible on mouseover */
+.monaco-editor .minimap.slider-mouseover .minimap-slider {
 	opacity: 0;
 	transition: opacity 100ms linear;
 }
-.monaco-editor .minimap:hover .minimap-slider {
+.monaco-editor .minimap.slider-mouseover:hover .minimap-slider {
 	opacity: 1;
 }
-.monaco-editor .minimap-slider.active {
+.monaco-editor .minimap.slider-mouseover .minimap-slider.active {
 	opacity: 1;
 }
+/* END cover the case that slider is visible on mouseover */
+
 .monaco-editor .minimap-shadow-hidden {
 	position: absolute;
 	width: 0;

diff --git a/src/vs/editor/browser/viewParts/minimap/minimap.ts b/src/vs/editor/browser/viewParts/minimap/minimap.ts
@@ -73,6 +73,8 @@ class MinimapOptions {
 
 	public readonly renderMinimap: RenderMinimap;
 
+	public readonly showSlider: 'always' | 'mouseover';
+
 	public readonly pixelRatio: number;
 
 	public readonly lineHeight: number;
@@ -107,8 +109,10 @@ class MinimapOptions {
 	constructor(configuration: editorCommon.IConfiguration) {
 		const pixelRatio = configuration.editor.pixelRatio;
 		const layoutInfo = configuration.editor.layoutInfo;
+		const viewInfo = configuration.editor.viewInfo;
 
 		this.renderMinimap = layoutInfo.renderMinimap | 0;
+		this.showSlider = viewInfo.minimap.showSlider;
 		this.pixelRatio = pixelRatio;
 		this.lineHeight = configuration.editor.lineHeight;
 		this.minimapWidth = layoutInfo.minimapWidth;
@@ -123,6 +127,7 @@ class MinimapOptions {
 
 	public equals(other: MinimapOptions): boolean {
 		return (this.renderMinimap === other.renderMinimap
+			&& this.showSlider === other.showSlider
 			&& this.pixelRatio === other.pixelRatio
 			&& this.lineHeight === other.lineHeight
 			&& this.minimapWidth === other.minimapWidth
@@ -440,7 +445,7 @@ export class Minimap extends ViewPart {
 
 		this._domNode = createFastDomNode(document.createElement('div'));
 		PartFingerprints.write(this._domNode, PartFingerprint.Minimap);
-		this._domNode.setClassName('minimap');
+		this._domNode.setClassName(this._getMinimapDomNodeClassName());
 		this._domNode.setPosition('absolute');
 		this._domNode.setAttribute('role', 'presentation');
 		this._domNode.setAttribute('aria-hidden', 'true');
@@ -549,6 +554,13 @@ export class Minimap extends ViewPart {
 		super.dispose();
 	}
 
+	private _getMinimapDomNodeClassName(): string {
+		if (this._options.showSlider === 'always') {
+			return 'minimap slider-always';
+		}
+		return 'minimap slider-mouseover';
+	}
+
 	public getDomNode(): FastDomNode<HTMLElement> {
 		return this._domNode;
 	}
@@ -585,6 +597,7 @@ export class Minimap extends ViewPart {
 		this._lastRenderData = null;
 		this._buffers = null;
 		this._applyLayout();
+		this._domNode.setClassName(this._getMinimapDomNodeClassName());
 		return true;
 	}
 

diff --git a/src/vs/editor/common/config/commonEditorConfig.ts b/src/vs/editor/common/config/commonEditorConfig.ts
@@ -254,6 +254,12 @@ const editorConfiguration: IConfigurationNode = {
 			'default': EDITOR_DEFAULTS.viewInfo.minimap.enabled,
 			'description': nls.localize('minimap.enabled', "Controls if the minimap is shown")
 		},
+		'editor.minimap.showSlider': {
+			'type': 'string',
+			'enum': ['always', 'mouseover'],
+			'default': EDITOR_DEFAULTS.viewInfo.minimap.showSlider,
+			'description': nls.localize('minimap.showSlider', "Controls whether the minimap slider is automatically hidden.")
+		},
 		'editor.minimap.renderCharacters': {
 			'type': 'boolean',
 			'default': EDITOR_DEFAULTS.viewInfo.minimap.renderCharacters,

diff --git a/src/vs/editor/common/config/editorOptions.ts b/src/vs/editor/common/config/editorOptions.ts
@@ -97,6 +97,11 @@ export interface IEditorMinimapOptions {
 	 * Defaults to false.
 	 */
 	enabled?: boolean;
+	/**
+	 * Control the rendering of the minimap slider.
+	 * Defaults to 'mouseover'.
+	 */
+	showSlider?: 'always' | 'mouseover';
 	/**
 	 * Render the actual text on a line (as opposed to color blocks).
 	 * Defaults to true.
@@ -691,6 +696,7 @@ export interface InternalEditorScrollbarOptions {
 
 export interface InternalEditorMinimapOptions {
 	readonly enabled: boolean;
+	readonly showSlider: 'always' | 'mouseover';
 	readonly renderCharacters: boolean;
 	readonly maxColumn: number;
 }
@@ -1028,6 +1034,7 @@ export class InternalEditorOptions {
 	private static _equalsMinimapOptions(a: InternalEditorMinimapOptions, b: InternalEditorMinimapOptions): boolean {
 		return (
 			a.enabled === b.enabled
+			&& a.showSlider === b.showSlider
 			&& a.renderCharacters === b.renderCharacters
 			&& a.maxColumn === b.maxColumn
 		);
@@ -1474,6 +1481,7 @@ export class EditorOptionsValidator {
 		}
 		return {
 			enabled: _boolean(opts.enabled, defaults.enabled),
+			showSlider: _stringSet<'always' | 'mouseover'>(opts.showSlider, defaults.showSlider, ['always', 'mouseover']),
 			renderCharacters: _boolean(opts.renderCharacters, defaults.renderCharacters),
 			maxColumn: _clampedInt(opts.maxColumn, defaults.maxColumn, 1, 10000),
 		};
@@ -1689,6 +1697,7 @@ export class InternalEditorOptionsFactory {
 				minimap: {
 					enabled: (accessibilityIsOn ? false : opts.viewInfo.minimap.enabled), // DISABLED WHEN SCREEN READER IS ATTACHED
 					renderCharacters: opts.viewInfo.minimap.renderCharacters,
+					showSlider: opts.viewInfo.minimap.showSlider,
 					maxColumn: opts.viewInfo.minimap.maxColumn
 				},
 				fixedOverflowWidgets: opts.viewInfo.fixedOverflowWidgets
@@ -2118,6 +2127,7 @@ export const EDITOR_DEFAULTS: IValidatedEditorOptions = {
 		},
 		minimap: {
 			enabled: true,
+			showSlider: 'mouseover',
 			renderCharacters: true,
 			maxColumn: 120
 		},

diff --git a/src/vs/monaco.d.ts b/src/vs/monaco.d.ts
@@ -2655,6 +2655,11 @@ declare module monaco.editor {
 		 * Defaults to false.
 		 */
 		enabled?: boolean;
+		/**
+		 * Control the rendering of the minimap slider.
+		 * Defaults to 'mouseover'.
+		 */
+		showSlider?: 'always' | 'mouseover';
 		/**
 		 * Render the actual text on a line (as opposed to color blocks).
 		 * Defaults to true.
@@ -3177,6 +3182,7 @@ declare module monaco.editor {
 
 	export interface InternalEditorMinimapOptions {
 		readonly enabled: boolean;
+		readonly showSlider: 'always' | 'mouseover';
 		readonly renderCharacters: boolean;
 		readonly maxColumn: number;
 	}