sussudio
Version:
An unofficial VS Code Internal API
39 lines (38 loc) • 1.76 kB
text/typescript
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { Modifiers } from "./keybindings.mjs";
import { OperatingSystem } from "./platform.mjs";
export interface ModifierLabels {
readonly ctrlKey: string;
readonly shiftKey: string;
readonly altKey: string;
readonly metaKey: string;
readonly separator: string;
}
export interface KeyLabelProvider<T extends Modifiers> {
(keybinding: T): string | null;
}
export declare class ModifierLabelProvider {
readonly modifierLabels: ModifierLabels[];
constructor(mac: ModifierLabels, windows: ModifierLabels, linux?: ModifierLabels);
toLabel<T extends Modifiers>(OS: OperatingSystem, chords: readonly T[], keyLabelProvider: KeyLabelProvider<T>): string | null;
}
/**
* A label provider that prints modifiers in a suitable format for displaying in the UI.
*/
export declare const UILabelProvider: ModifierLabelProvider;
/**
* A label provider that prints modifiers in a suitable format for ARIA.
*/
export declare const AriaLabelProvider: ModifierLabelProvider;
/**
* A label provider that prints modifiers in a suitable format for Electron Accelerators.
* See https://github.com/electron/electron/blob/master/docs/api/accelerator.md
*/
export declare const ElectronAcceleratorLabelProvider: ModifierLabelProvider;
/**
* A label provider that prints modifiers in a suitable format for user settings.
*/
export declare const UserSettingsLabelProvider: ModifierLabelProvider;