@codingame/monaco-vscode-api 20.1.0 → 20.2.0

package/vscode/src/vs/base/browser/ui/sash/sash.css

@@ -1,49 +1,66 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
 :root {
 	--vscode-sash-size: 4px;
 	--vscode-sash-hover-size: 4px;
 }
+
 .monaco-sash {
 	position: absolute;
 	z-index: 35;
 	touch-action: none;
 }
+
 .monaco-sash.disabled {
 	pointer-events: none;
 }
+
 .monaco-sash.mac.vertical {
 	cursor: col-resize;
 }
+
 .monaco-sash.vertical.minimum {
 	cursor: e-resize;
 }
+
 .monaco-sash.vertical.maximum {
 	cursor: w-resize;
 }
+
 .monaco-sash.mac.horizontal {
 	cursor: row-resize;
 }
+
 .monaco-sash.horizontal.minimum {
 	cursor: s-resize;
 }
+
 .monaco-sash.horizontal.maximum {
 	cursor: n-resize;
 }
+
 .monaco-sash.disabled {
 	cursor: default !important;
 	pointer-events: none !important;
 }
+
 .monaco-sash.vertical {
 	cursor: ew-resize;
 	top: 0;
 	width: var(--vscode-sash-size);
 	height: 100%;
 }
+
 .monaco-sash.horizontal {
 	cursor: ns-resize;
 	left: 0;
 	width: 100%;
 	height: var(--vscode-sash-size);
 }
+
 .monaco-sash:not(.disabled) > .orthogonal-drag-handle {
 	content: " ";
 	height: calc(var(--vscode-sash-size) * 2);
@@ -53,18 +70,21 @@
 	cursor: all-scroll;
 	position: absolute;
 }
+
 .monaco-sash.horizontal.orthogonal-edge-north:not(.disabled)
 	> .orthogonal-drag-handle.start,
 .monaco-sash.horizontal.orthogonal-edge-south:not(.disabled)
 	> .orthogonal-drag-handle.end {
 	cursor: nwse-resize;
 }
+
 .monaco-sash.horizontal.orthogonal-edge-north:not(.disabled)
 	> .orthogonal-drag-handle.end,
 .monaco-sash.horizontal.orthogonal-edge-south:not(.disabled)
 	> .orthogonal-drag-handle.start {
 	cursor: nesw-resize;
 }
+
 .monaco-sash.vertical > .orthogonal-drag-handle.start {
 	left: calc(var(--vscode-sash-size) * -0.5);
 	top: calc(var(--vscode-sash-size) * -1);
@@ -81,6 +101,7 @@
 	top: calc(var(--vscode-sash-size) * -0.5);
 	right: calc(var(--vscode-sash-size) * -1);
 }
+
 .monaco-sash:before {
 	content: '';
 	pointer-events: none;
@@ -89,30 +110,40 @@
 	height: 100%;
 	background: transparent;
 }
+
 .monaco-workbench:not(.reduce-motion) .monaco-sash:before {
 	transition: background-color 0.1s ease-out;
 }
+
 .monaco-sash.hover:before,
 .monaco-sash.active:before {
 	background: var(--vscode-sash-hoverBorder);
 }
+
 .monaco-sash.vertical:before {
 	width: var(--vscode-sash-hover-size);
 	left: calc(50% - (var(--vscode-sash-hover-size) / 2));
 }
+
 .monaco-sash.horizontal:before {
 	height: var(--vscode-sash-hover-size);
 	top: calc(50% - (var(--vscode-sash-hover-size) / 2));
 }
+
 .pointer-events-disabled {
 	pointer-events: none !important;
 }
+
+/** Debug **/
+
 .monaco-sash.debug {
 	background: cyan;
 }
+
 .monaco-sash.debug.disabled {
 	background: rgba(0, 255, 255, 0.2);
 }
+
 .monaco-sash.debug:not(.disabled) > .orthogonal-drag-handle {
 	background: red;
 }

package/vscode/src/vs/base/browser/ui/sash/sash.d.ts

@@ -1,10 +1,16 @@
 import { Event } from "../../../common/event.js";
 import { Disposable } from "../../../common/lifecycle.js";
+/**
+ * A vertical sash layout provider provides position and height for a sash.
+ */
 export interface IVerticalSashLayoutProvider {
     getVerticalSashLeft(sash: Sash): number;
     getVerticalSashTop?(sash: Sash): number;
     getVerticalSashHeight?(sash: Sash): number;
 }
+/**
+ * A vertical sash layout provider provides position and width for a sash.
+ */
 export interface IHorizontalSashLayoutProvider {
     getHorizontalSashTop(sash: Sash): number;
     getHorizontalSashLeft?(sash: Sash): number;
@@ -30,10 +36,36 @@ export interface IBoundarySashes {
     readonly left?: Sash;
 }
 export interface ISashOptions {
+    /**
+     * Whether a sash is horizontal or vertical.
+     */
     readonly orientation: Orientation;
+    /**
+     * The width or height of a vertical or horizontal sash, respectively.
+     */
     readonly size?: number;
+    /**
+     * A reference to another sash, perpendicular to this one, which
+     * aligns at the start of this one. A corner sash will be created
+     * automatically at that location.
+     *
+     * The start of a horizontal sash is its left-most position.
+     * The start of a vertical sash is its top-most position.
+     */
     readonly orthogonalStartSash?: Sash;
+    /**
+     * A reference to another sash, perpendicular to this one, which
+     * aligns at the end of this one. A corner sash will be created
+     * automatically at that location.
+     *
+     * The end of a horizontal sash is its right-most position.
+     * The end of a vertical sash is its bottom-most position.
+     */
     readonly orthogonalEndSash?: Sash;
+    /**
+     * Provides a hint as to what mouse cursor to use whenever the user
+     * hovers over a corner sash provided by this and an orthogonal sash.
+     */
     readonly orthogonalEdge?: OrthogonalEdge;
 }
 export interface IVerticalSashOptions extends ISashOptions {
@@ -47,13 +79,44 @@ export declare enum Orientation {
     HORIZONTAL = 1
 }
 export declare enum SashState {
+    /**
+     * Disable any UI interaction.
+     */
     Disabled = 0,
+    /**
+     * Allow dragging down or to the right, depending on the sash orientation.
+     *
+     * Some OSs allow customizing the mouse cursor differently whenever
+     * some resizable component can't be any smaller, but can be larger.
+     */
     AtMinimum = 1,
+    /**
+     * Allow dragging up or to the left, depending on the sash orientation.
+     *
+     * Some OSs allow customizing the mouse cursor differently whenever
+     * some resizable component can't be any larger, but can be smaller.
+     */
     AtMaximum = 2,
+    /**
+     * Enable dragging.
+     */
     Enabled = 3
 }
 export declare function setGlobalSashSize(size: number): void;
 export declare function setGlobalHoverDelay(size: number): void;
+/**
+ * The {@link Sash} is the UI component which allows the user to resize other
+ * components. It's usually an invisible horizontal or vertical line which, when
+ * hovered, becomes highlighted and can be dragged along the perpendicular dimension
+ * to its direction.
+ *
+ * Features:
+ * - Touch event handling
+ * - Corner sash support
+ * - Hover with different mouse cursor support
+ * - Configurable hover size
+ * - Linked sash support, for 2x2 corner sashes
+ */
 export declare class Sash extends Disposable {
     private el;
     private layoutProvider;
@@ -78,21 +141,83 @@ export declare class Sash extends Disposable {
     get state(): SashState;
     get orthogonalStartSash(): Sash | undefined;
     get orthogonalEndSash(): Sash | undefined;
+    /**
+     * The state of a sash defines whether it can be interacted with by the user
+     * as well as what mouse cursor to use, when hovered.
+     */
     set state(state: SashState);
+    /**
+     * An event which fires whenever the user starts dragging this sash.
+     */
     readonly onDidStart: Event<ISashEvent>;
+    /**
+     * An event which fires whenever the user moves the mouse while
+     * dragging this sash.
+     */
     readonly onDidChange: Event<ISashEvent>;
+    /**
+     * An event which fires whenever the user double clicks this sash.
+     */
     readonly onDidReset: Event<void>;
+    /**
+     * An event which fires whenever the user stops dragging this sash.
+     */
     readonly onDidEnd: Event<void>;
+    /**
+     * A linked sash will be forwarded the same user interactions and events
+     * so it moves exactly the same way as this sash.
+     *
+     * Useful in 2x2 grids. Not meant for widespread usage.
+     */
     linkedSash: Sash | undefined;
+    /**
+     * A reference to another sash, perpendicular to this one, which
+     * aligns at the start of this one. A corner sash will be created
+     * automatically at that location.
+     *
+     * The start of a horizontal sash is its left-most position.
+     * The start of a vertical sash is its top-most position.
+     */
     set orthogonalStartSash(sash: Sash | undefined);
+    /**
+     * A reference to another sash, perpendicular to this one, which
+     * aligns at the end of this one. A corner sash will be created
+     * automatically at that location.
+     *
+     * The end of a horizontal sash is its right-most position.
+     * The end of a vertical sash is its bottom-most position.
+     */
     set orthogonalEndSash(sash: Sash | undefined);
+    /**
+     * Create a new vertical sash.
+     *
+     * @param container A DOM node to append the sash to.
+     * @param verticalLayoutProvider A vertical layout provider.
+     * @param options The options.
+     */
     constructor(container: HTMLElement, verticalLayoutProvider: IVerticalSashLayoutProvider, options: IVerticalSashOptions);
+    /**
+     * Create a new horizontal sash.
+     *
+     * @param container A DOM node to append the sash to.
+     * @param horizontalLayoutProvider A horizontal layout provider.
+     * @param options The options.
+     */
     constructor(container: HTMLElement, horizontalLayoutProvider: IHorizontalSashLayoutProvider, options: IHorizontalSashOptions);
     private onPointerStart;
     private onPointerDoublePress;
     private static onMouseEnter;
     private static onMouseLeave;
+    /**
+     * Forcefully stop any user interactions with this sash.
+     * Useful when hiding a parent component, while the user is still
+     * interacting with the sash.
+     */
     clearSashHoverState(): void;
+    /**
+     * Layout the sash. The sash will size and position itself
+     * based on its provided {@link ISashLayoutProvider layout provider}.
+     */
     layout(): void;
     private getOrthogonalSash;
     dispose(): void;

package/vscode/src/vs/base/browser/ui/scrollbar/abstractScrollbar.d.ts

@@ -36,7 +36,13 @@ export declare abstract class AbstractScrollbar extends Widget {
     slider: FastDomNode<HTMLElement>;
     protected _shouldRender: boolean;
     constructor(opts: AbstractScrollbarOptions);
+    /**
+     * Creates the dom node for an arrow & adds it to the container
+     */
     protected _createArrow(opts: ScrollbarArrowOptions): void;
+    /**
+     * Creates the slider dom node, adds it to the container & hooks up the events
+     */
     protected _createSlider(top: number, left: number, width: number | undefined, height: number | undefined): void;
     protected _onElementSize(visibleSize: number): boolean;
     protected _onElementScrollSize(elementScrollSize: number): boolean;

package/vscode/src/vs/base/browser/ui/scrollbar/media/scrollbars.css

@@ -1,11 +1,22 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+/* Arrows */
 .monaco-scrollable-element > .scrollbar > .scra {
 	cursor: pointer;
 	font-size: 11px !important;
 }
+
 .monaco-scrollable-element > .visible {
 	opacity: 1;
+
+	/* Background rule added for IE9 - to allow clicks on dom node */
 	background:rgba(0,0,0,0);
+
 	transition: opacity 100ms linear;
+	/* In front of peek view */
 	z-index: 11;
 }
 .monaco-scrollable-element > .invisible {
@@ -15,6 +26,8 @@
 .monaco-scrollable-element > .invisible.fade {
 	transition: opacity 800ms linear;
 }
+
+/* Scrollable Content Inset Shadow */
 .monaco-scrollable-element > .shadow {
 	position: absolute;
 	display: none;
@@ -45,12 +58,15 @@
 .monaco-scrollable-element > .shadow.top.left {
 	box-shadow: var(--vscode-scrollbar-shadow) 6px 0 6px -6px inset;
 }
+
 .monaco-scrollable-element > .scrollbar > .slider {
 	background: var(--vscode-scrollbarSlider-background);
 }
+
 .monaco-scrollable-element > .scrollbar > .slider:hover {
 	background: var(--vscode-scrollbarSlider-hoverBackground);
 }
+
 .monaco-scrollable-element > .scrollbar > .slider.active {
 	background: var(--vscode-scrollbarSlider-activeBackground);
 }

package/vscode/src/vs/base/browser/ui/scrollbar/scrollableElement.d.ts

@@ -17,6 +17,11 @@ export declare class MouseWheelClassifier {
     isPhysicalMouseWheel(): boolean;
     acceptStandardWheelEvent(e: StandardWheelEvent): void;
     accept(timestamp: number, deltaX: number, deltaY: number): void;
+    /**
+     * A score between 0 and 1 for `item`.
+     *  - a score towards 0 indicates that the source appears to be a physical mouse wheel
+     *  - a score towards 1 indicates that the source appears to be a touchpad or magic mouse, etc.
+     */
     private _computeScore;
     private _isAlmostInt;
 }
@@ -45,12 +50,25 @@ export declare abstract class AbstractScrollableElement extends Widget {
     get options(): Readonly<ScrollableElementResolvedOptions>;
     protected constructor(element: HTMLElement, options: ScrollableElementCreationOptions, scrollable: Scrollable);
     dispose(): void;
+    /**
+     * Get the generated 'scrollable' dom node
+     */
     getDomNode(): HTMLElement;
     getOverviewRulerLayoutInfo(): IOverviewRulerLayoutInfo;
+    /**
+     * Delegate a pointer down event to the vertical scrollbar.
+     * This is to help with clicking somewhere else and having the scrollbar react.
+     */
     delegateVerticalScrollbarPointerDown(browserEvent: PointerEvent): void;
     getScrollDimensions(): IScrollDimensions;
     setScrollDimensions(dimensions: INewScrollDimensions): void;
+    /**
+     * Update the class name of the scrollable element.
+     */
     updateClassName(newClassName: string): void;
+    /**
+     * Update configuration options for the scrollbar.
+     */
     updateOptions(newOptions: ScrollableElementChangeOptions): void;
     setRevealOnScroll(value: boolean): void;
     delegateScrollFromMouseWheelEvent(browserEvent: IMouseWheelEvent): void;
@@ -58,6 +76,10 @@ export declare abstract class AbstractScrollableElement extends Widget {
     private _setListeningToMouseWheel;
     private _onMouseWheel;
     private _onDidScroll;
+    /**
+     * Render / mutate the DOM now.
+     * Should be used together with the ctor option `lazyRender`.
+     */
     renderNow(): void;
     private _render;
     private _onDragStart;

package/vscode/src/vs/base/browser/ui/scrollbar/scrollableElementOptions.d.ts

@@ -1,28 +1,126 @@
 import { ScrollbarVisibility } from "../../../common/scrollable.js";
 export interface ScrollableElementCreationOptions {
+    /**
+     * The scrollable element should not do any DOM mutations until renderNow() is called.
+     * Defaults to false.
+     */
     lazyRender?: boolean;
+    /**
+     * CSS Class name for the scrollable element.
+     */
     className?: string;
+    /**
+     * Drop subtle horizontal and vertical shadows.
+     * Defaults to false.
+     */
     useShadows?: boolean;
+    /**
+     * Handle mouse wheel (listen to mouse wheel scrolling).
+     * Defaults to true
+     */
     handleMouseWheel?: boolean;
+    /**
+     * If mouse wheel is handled, make mouse wheel scrolling smooth.
+     * Defaults to true.
+     */
     mouseWheelSmoothScroll?: boolean;
+    /**
+     * Make scrolling inertial - mostly useful with touchpad on linux.
+     */
     inertialScroll?: boolean;
+    /**
+     * Flip axes. Treat vertical scrolling like horizontal and vice-versa.
+     * Defaults to false.
+     */
     flipAxes?: boolean;
+    /**
+     * If enabled, will scroll horizontally when scrolling vertical.
+     * Defaults to false.
+     */
     scrollYToX?: boolean;
+    /**
+     * Consume all mouse wheel events if a scrollbar is needed (i.e. scrollSize > size).
+     * Defaults to false.
+     */
     consumeMouseWheelIfScrollbarIsNeeded?: boolean;
+    /**
+     * Always consume mouse wheel events, even when scrolling is no longer possible.
+     * Defaults to false.
+     */
     alwaysConsumeMouseWheel?: boolean;
+    /**
+     * A multiplier to be used on the `deltaX` and `deltaY` of mouse wheel scroll events.
+     * Defaults to 1.
+     */
     mouseWheelScrollSensitivity?: number;
+    /**
+     * FastScrolling mulitplier speed when pressing `Alt`
+     * Defaults to 5.
+     */
     fastScrollSensitivity?: number;
+    /**
+     * Whether the scrollable will only scroll along the predominant axis when scrolling both
+     * vertically and horizontally at the same time.
+     * Prevents horizontal drift when scrolling vertically on a trackpad.
+     * Defaults to true.
+     */
     scrollPredominantAxis?: boolean;
+    /**
+     * Height for vertical arrows (top/bottom) and width for horizontal arrows (left/right).
+     * Defaults to 11.
+     */
     arrowSize?: number;
+    /**
+     * The dom node events should be bound to.
+     * If no listenOnDomNode is provided, the dom node passed to the constructor will be used for event listening.
+     */
     listenOnDomNode?: HTMLElement;
+    /**
+     * Control the visibility of the horizontal scrollbar.
+     * Accepted values: 'auto' (on mouse over), 'visible' (always visible), 'hidden' (never visible)
+     * Defaults to 'auto'.
+     */
     horizontal?: ScrollbarVisibility;
+    /**
+     * Height (in px) of the horizontal scrollbar.
+     * Defaults to 10.
+     */
     horizontalScrollbarSize?: number;
+    /**
+     * Height (in px) of the horizontal scrollbar slider.
+     * Defaults to `horizontalScrollbarSize`
+     */
     horizontalSliderSize?: number;
+    /**
+     * Render arrows (left/right) for the horizontal scrollbar.
+     * Defaults to false.
+     */
     horizontalHasArrows?: boolean;
+    /**
+     * Control the visibility of the vertical scrollbar.
+     * Accepted values: 'auto' (on mouse over), 'visible' (always visible), 'hidden' (never visible)
+     * Defaults to 'auto'.
+     */
     vertical?: ScrollbarVisibility;
+    /**
+     * Width (in px) of the vertical scrollbar.
+     * Defaults to 10.
+     */
     verticalScrollbarSize?: number;
+    /**
+     * Width (in px) of the vertical scrollbar slider.
+     * Defaults to `verticalScrollbarSize`
+     */
     verticalSliderSize?: number;
+    /**
+     * Render arrows (top/bottom) for the vertical scrollbar.
+     * Defaults to false.
+     */
     verticalHasArrows?: boolean;
+    /**
+     * Scroll gutter clicks move by page vs. jump to position.
+     * Defaults to false.
+     */
     scrollByPage?: boolean;
 }
 export interface ScrollableElementChangeOptions {

package/vscode/src/vs/base/browser/ui/scrollbar/scrollbarArrow.d.ts

@@ -1,5 +1,8 @@
 import { Widget } from "../widget.js";
 import { ThemeIcon } from "../../../common/themables.js";
+/**
+ * The arrow image size.
+ */
 export declare const ARROW_IMG_SIZE = 11;
 export interface ScrollbarArrowOptions {
     onActivate: () => void;

package/vscode/src/vs/base/browser/ui/scrollbar/scrollbarState.d.ts

@@ -1,11 +1,41 @@
 export declare class ScrollbarState {
+    /**
+     * For the vertical scrollbar: the width.
+     * For the horizontal scrollbar: the height.
+     */
     private _scrollbarSize;
+    /**
+     * For the vertical scrollbar: the height of the pair horizontal scrollbar.
+     * For the horizontal scrollbar: the width of the pair vertical scrollbar.
+     */
     private _oppositeScrollbarSize;
+    /**
+     * For the vertical scrollbar: the height of the scrollbar's arrows.
+     * For the horizontal scrollbar: the width of the scrollbar's arrows.
+     */
     private readonly _arrowSize;
+    /**
+     * For the vertical scrollbar: the viewport height.
+     * For the horizontal scrollbar: the viewport width.
+     */
     private _visibleSize;
+    /**
+     * For the vertical scrollbar: the scroll height.
+     * For the horizontal scrollbar: the scroll width.
+     */
     private _scrollSize;
+    /**
+     * For the vertical scrollbar: the scroll top.
+     * For the horizontal scrollbar: the scroll left.
+     */
     private _scrollPosition;
+    /**
+     * `visibleSize` - `oppositeScrollbarSize`
+     */
     private _computedAvailableSize;
+    /**
+     * (`scrollSize` > 0 && `scrollSize` > `visibleSize`)
+     */
     private _computedIsNeeded;
     private _computedSliderSize;
     private _computedSliderRatio;
@@ -26,7 +56,20 @@ export declare class ScrollbarState {
     isNeeded(): boolean;
     getSliderSize(): number;
     getSliderPosition(): number;
+    /**
+     * Compute a desired `scrollPosition` such that `offset` ends up in the center of the slider.
+     * `offset` is based on the same coordinate system as the `sliderPosition`.
+     */
     getDesiredScrollPositionFromOffset(offset: number): number;
+    /**
+     * Compute a desired `scrollPosition` from if offset is before or after the slider position.
+     * If offset is before slider, treat as a page up (or left).  If after, page down (or right).
+     * `offset` and `_computedSliderPosition` are based on the same coordinate system.
+     * `_visibleSize` corresponds to a "page" of lines in the returned coordinate system.
+     */
     getDesiredScrollPositionFromOffsetPaged(offset: number): number;
+    /**
+     * Compute a desired `scrollPosition` such that the slider moves by `delta`.
+     */
     getDesiredScrollPositionFromDelta(delta: number): number;
 }

package/vscode/src/vs/base/browser/ui/selectBox/selectBox.css

@@ -1,22 +1,33 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
 .monaco-select-box {
 	width: 100%;
 	cursor: pointer;
 	border-radius: 2px;
 }
+
 .monaco-select-box-dropdown-container {
 	font-size: 13px;
 	font-weight: normal;
 	text-transform: none;
 }
+
+/** Actions */
+
 .monaco-action-bar .action-item.select-container {
 	cursor: default;
 }
+
 .monaco-action-bar .action-item .monaco-select-box {
 	cursor: pointer;
 	min-width: 100px;
 	min-height: 18px;
 	padding: 2px 23px 2px 8px;
 }
+
 .mac .monaco-action-bar .action-item .monaco-select-box {
 	font-size: 11px;
 	border-radius: 5px;