@codingame/monaco-vscode-api 36.2.7 → 37.0.0

package/vscode/src/vs/platform/actionWidget/browser/actionList.d.ts

@@ -30,13 +30,36 @@ export interface IActionListDelegate<T> {
  */
 export interface IActionListItemHover {
     /**
-     * Content to display in the hover. Can be a markdown string or an HTMLElement for full DOM control.
+     * Content to display in the hover. Pass a function to build the content the first
+     * time the panel opens, for content that is expensive to construct.
      */
-    readonly content?: string | IMarkdownString | HTMLElement;
+    readonly content?: string | IMarkdownString | HTMLElement | (() => HTMLElement);
     /**
      * Optional disposable associated with the hover content (e.g. from rendered markdown).
      */
     readonly disposable?: IDisposable;
+    /**
+     * Enables keyboard access and a clickable row chevron for the hover panel.
+     * The chevron can be hidden with {@link IActionListItemHover.showIndicator}.
+     */
+    readonly expandable?: boolean;
+    /** Whether to show the expandable hover's row chevron. Defaults to true. */
+    readonly showIndicator?: boolean;
+    /**
+     * CSS class set on the hover panel while this item's hover is showing, so a
+     * consumer can style the panel without reaching for the content inside it.
+     */
+    readonly panelClassName?: string;
+    /** Align the panel's adjoining edge with the outer action widget rather than its inset list. */
+    readonly alignToParent?: boolean;
+    /** Keep the initial top edge as content or rows change, scrolling at the viewport edge. */
+    readonly preserveVerticalPosition?: boolean;
+}
+export interface IActionListUpdateOptions {
+    /** Retain the open hover when its replacement item returns the same content element. */
+    readonly preserveHover?: boolean;
+    /** Animate a visible focused item's move. The caller must respect reduced motion. */
+    readonly animateItemMove?: boolean;
 }
 /**
  * Optional inline toggle switch rendered inside an action list item, shown on its
@@ -52,6 +75,8 @@ export interface IActionListItemInlineToggle {
     readonly onChange: (checked: boolean) => void;
     /** Optional accessible/hover title for the switch. Defaults to {@link label}. */
     readonly title?: string;
+    /** Whether the switch is read-only. */
+    readonly disabled?: boolean;
 }
 export interface IActionListItem<T> {
     readonly item?: T;
@@ -71,6 +96,10 @@ export interface IActionListItem<T> {
      * Optional inline toggle switch rendered on its own row inside the item.
      */
     readonly inlineToggle?: IActionListItemInlineToggle;
+    /**
+     * Optional toggle switch rendered on the same row as the label.
+     */
+    readonly standaloneToggle?: IActionListItemInlineToggle;
     readonly description?: string | IMarkdownString;
     /**
      * Optional accessible description used in place of {@link description} for
@@ -91,6 +120,11 @@ export interface IActionListItem<T> {
     readonly keybinding?: ResolvedKeybinding;
     canPreview?: boolean | undefined;
     readonly hideIcon?: boolean;
+    /**
+     * CSS classes rendered in the item's icon slot, for icons that are not
+     * codicons (e.g. themed file icons). Takes precedence over `group.icon`.
+     */
+    readonly iconClasses?: readonly string[];
     readonly tooltip?: string;
     /**
      * Optional toolbar actions shown when the item is focused or hovered.
@@ -108,7 +142,7 @@ export interface IActionListItem<T> {
      */
     readonly isSectionToggle?: boolean;
     /**
-     * Optional CSS class name to add to the row container.
+     * Optional CSS class names to add to the row container, separated by spaces.
      */
     readonly className?: string;
     /**
@@ -139,6 +173,11 @@ export interface IActionListHeaderLink {
     /** Target opened via the opener service when the link is activated. */
     readonly uri: URI;
 }
+export interface IActionListCloseAnimation {
+    readonly className: string;
+    readonly duration: number;
+    readonly requiredAncestorClasses?: readonly string[];
+}
 /**
  * Options for configuring the action list.
  */
@@ -151,6 +190,12 @@ export interface IActionListOptions {
      * Placeholder text for the filter input.
      */
     readonly filterPlaceholder?: string;
+    /** Initial text for the filter input. */
+    readonly initialFilterValue?: string;
+    /** Keep focus in the filter while navigating and accepting results, using combobox semantics. */
+    readonly filterAsCombobox?: boolean;
+    /** Reveals a filter when printable text is typed in a list without a filter input. */
+    readonly onType?: (text: string) => void;
     /**
      * Optional actions shown in the filter row, to the right of the input.
      */
@@ -201,11 +246,18 @@ export interface IActionListOptions {
      * When true and filtering is enabled, focuses the filter input when the list opens.
      */
     readonly focusFilterOnOpen?: boolean;
+    /** Optional action item id to focus when the list opens. */
+    readonly initialFocusItemId?: string;
+    /** Show immediate, persistent previews for the focused or hovered row. */
+    readonly persistentHover?: boolean;
     /**
-     * When false, non-submenu items do not reserve space for the submenu chevron.
-     * Defaults to true for alignment consistency.
+     * Controls the gutter kept for the submenu chevron on items that have none.
+     * - `true` (default): kept while some item shows a chevron.
+     * - `'always'`: kept regardless, for lists whose items gain and lose their chevron
+     *   while the popup stays open, where a collapsing gutter would shift every row.
+     * - `false`: never kept.
      */
-    readonly reserveSubmenuSpace?: boolean;
+    readonly reserveSubmenuSpace?: boolean | "always";
     /**
      * When true, items without an explicit `tooltip` or `hover` do not get a
      * default "{keybinding} to Apply" tooltip. Useful for non-code-action lists
@@ -237,6 +289,21 @@ export interface IActionListOptions {
      * Optional CSS class name added to the action list container, for scoped styling.
      */
     readonly className?: string;
+    /**
+     * Optional CSS class name added to the containing action widget.
+     */
+    readonly widgetClassName?: string;
+    /**
+     * Optional CSS class and duration used to animate the containing action widget
+     * before the context view is hidden.
+     */
+    readonly closeAnimation?: IActionListCloseAnimation;
+    /**
+     * Optional fixed side of the anchor where the action list should render.
+     */
+    readonly anchorPosition?: AnchorPosition;
+    /** Uses the available height instead of the usual fractional viewport cap. */
+    readonly useFullHeight?: boolean;
 }
 /**
  * A standalone action list widget that handles core list rendering, filtering,
@@ -252,6 +319,7 @@ export declare class ActionListWidget<T> extends Disposable {
     private readonly _instantiationService;
     readonly domNode: HTMLElement;
     private readonly _list;
+    private _initialFocusItemId;
     protected readonly _actionLineHeight: number;
     protected readonly _headerLineHeight = 24;
     protected readonly _separatorLineHeight = 8;
@@ -263,9 +331,19 @@ export declare class ActionListWidget<T> extends Disposable {
     private _submenuShowTimeout;
     private _currentSubmenuWidget;
     private _currentSubmenuElement;
+    private _submenuPanelClassName;
+    private _layoutSubmenu;
+    private readonly _itemMoveAnimation;
+    private _submenuSide;
+    private _submenuPointerOrigin;
+    private _submenuPointerGraceDeadline;
+    /** The row currently reporting `aria-expanded`, reset when its panel closes. */
+    private _expandedTrigger;
     private readonly _collapsedSections;
     private _filterText;
+    private _imeSessionInProgress;
     private _suppressHover;
+    private _ignoreInitialHover;
     private _hasLaidOut;
     private readonly _filterInput;
     private readonly _filterContainer;
@@ -273,6 +351,8 @@ export declare class ActionListWidget<T> extends Disposable {
     private _headerContainer;
     private readonly _filterCts;
     private readonly _groupTitleByIndex;
+    private readonly _standaloneToggles;
+    private _visibleMenuItems;
     private readonly _onDidRequestLayout;
     /**
      * Fired when the widget's visible item set changes and the parent should
@@ -281,6 +361,7 @@ export declare class ActionListWidget<T> extends Disposable {
     readonly onDidRequestLayout: import("../../../base/common/event.js").Event<void>;
     constructor(user: string, _supportsPreview: boolean, items: readonly IActionListItem<T>[], _delegate: IActionListDelegate<T>, accessibilityProvider: Partial<IListAccessibilityProvider<IActionListItem<T>>> | undefined, _options: IActionListOptions | undefined, _keybindingService: IKeybindingService, _openerService: IOpenerService, _instantiationService: IInstantiationService);
     private _toggleSection;
+    private _revealFirstItemOfSection;
     private _applyOrUpdateFilter;
     private _applyFilter;
     /**
@@ -291,17 +372,23 @@ export declare class ActionListWidget<T> extends Disposable {
     get footerContainer(): HTMLElement | undefined;
     get headerContainer(): HTMLElement | undefined;
     get filterInput(): HTMLInputElement | undefined;
+    get closeAnimation(): IActionListCloseAnimation | undefined;
     private focusCondition;
+    private _updateFilterActiveDescendant;
     focus(): void;
     clearFocus(): void;
     getFocusedElement(): IActionListItem<T> | undefined;
+    /** Shows the checked item's hover, falling back to the focused item for persistent previews. */
+    showHoverForCheckedItem(): void;
     /**
      * Replaces the items in the list in place, preserving the current filter,
-     * without closing or repositioning the widget. When {@link focusItemId} is
-     * provided, that item ({@link IActionListItem.item}'s `id`) is focused;
-     * otherwise the previously focused item is preserved (matched by id).
+     * without closing the widget. When {@link focusItemId} is provided, that item
+     * ({@link IActionListItem.item}'s `id`) is focused; otherwise the previously
+     * focused item is preserved (matched by id). The widget only re-measures when
+     * the number of visible rows changed.
      */
-    updateItems(items: readonly IActionListItem<T>[], focusItemId?: string): void;
+    updateItems(items: readonly IActionListItem<T>[], focusItemId?: string, options?: IActionListUpdateOptions): void;
+    private _animateItemMove;
     /**
      * Focuses the item whose {@link IActionListItem.item}'s `id` matches
      * {@link itemId}, without rebuilding the list. Re-applies the focus after the
@@ -324,10 +411,14 @@ export declare class ActionListWidget<T> extends Disposable {
      * for items with a detail (second line).
      */
     protected _getItemHeight(item: IActionListItem<T>): number;
+    /** Row heights depend on the options of the tab the items belong to, not the shown one. */
+    private _itemHeightWith;
     /**
      * Computes the total height of all items (including collapsed/filtered items).
      */
     computeFullHeight(): number;
+    /** Height the list would need for `items`, leaving out anything in a collapsed section. */
+    computeHeightForItems(items: readonly IActionListItem<T>[], collapsedSections: ReadonlySet<string> | undefined, options: IActionListOptions | undefined): number;
     /**
      * Computes the total height of visible items in the list.
      */
@@ -339,6 +430,7 @@ export declare class ActionListWidget<T> extends Disposable {
     computeMaxWidth(minWidth: number): number;
     focusPrevious(): void;
     focusNext(): void;
+    private _focusFilterResult;
     collapseFocusedSection(): void;
     expandFocusedSection(): void;
     toggleFocusedSection(): boolean;
@@ -348,6 +440,7 @@ export declare class ActionListWidget<T> extends Disposable {
     private onFocus;
     private _removeItem;
     private _recomputeGroupTitles;
+    private _measureItemWidths;
     private _computeToolbarWidth;
     private _getRowElement;
     private _showHoverForElement;
@@ -364,6 +457,8 @@ export declare class ActionListWidget<T> extends Disposable {
     private _scheduleSubmenuHide;
     private _cancelSubmenuHide;
     private _scheduleSubmenuShow;
+    private _updateSubmenuPointer;
+    private _resetSubmenuPointer;
     private _cancelSubmenuShow;
     private onListHover;
     private onListClick;
@@ -381,11 +476,18 @@ export declare class ActionList<T> extends Disposable {
     private _cachedMaxWidth;
     private _hasLaidOut;
     private _showAbove;
+    /** Height to size against instead of the current contents. Survives re-layouts. */
+    private _fixedContentHeight;
+    private readonly _preferredAnchorPosition;
+    private readonly _useFullHeight;
+    private readonly _widgetClassName;
     get domNode(): HTMLElement;
     get filterContainer(): HTMLElement | undefined;
     get footerContainer(): HTMLElement | undefined;
     get headerContainer(): HTMLElement | undefined;
     get filterInput(): HTMLInputElement | undefined;
+    get closeAnimation(): IActionListCloseAnimation | undefined;
+    get widgetClassName(): string | undefined;
     /**
      * Returns the resolved anchor position after the first layout.
      * Used by the context view delegate to lock the dropdown direction.
@@ -393,7 +495,8 @@ export declare class ActionList<T> extends Disposable {
     get anchorPosition(): AnchorPosition | undefined;
     constructor(user: string, preview: boolean, items: readonly IActionListItem<T>[], _delegate: IActionListDelegate<T>, accessibilityProvider: Partial<IListAccessibilityProvider<IActionListItem<T>>> | undefined, options: IActionListOptions | undefined, anchor: HTMLElement | StandardMouseEvent | IAnchor, _contextViewService: IContextViewService, _layoutService: ILayoutService, instantiationService: IInstantiationService);
     focus(): void;
-    hide(didCancel?: boolean): void;
+    showHoverForCheckedItem(): void;
+    hide(didCancel?: boolean, hideContextView?: boolean): void;
     clearFilter(): boolean;
     focusPrevious(): void;
     focusNext(): void;
@@ -401,10 +504,12 @@ export declare class ActionList<T> extends Disposable {
     expandFocusedSection(): void;
     toggleFocusedSection(): boolean;
     acceptSelected(preview?: boolean): void;
-    updateItems(items: readonly IActionListItem<T>[], focusItemId?: string): void;
+    updateItems(items: readonly IActionListItem<T>[], focusItemId?: string, options?: IActionListUpdateOptions): void;
+    /** Height the list would need for `items`, for a caller sizing against other contents. */
+    computeHeightForItems(items: readonly IActionListItem<T>[], collapsedSections: ReadonlySet<string> | undefined, options: IActionListOptions | undefined): number;
     focusItemById(itemId: string): void;
     private hasDynamicHeight;
     private computeActionWidgetVerticalChromeHeight;
     private computeHeight;
-    layout(minWidth: number): number;
+    layout(minWidth: number, fixedContentHeight?: number): number;
 }