mirror of
https://github.com/coder/code-server.git
synced 2026-05-28 16:09:35 +00:00
Merge commit 'be3e8236086165e5e45a5a10783823874b3f3ebd' as 'lib/vscode'
This commit is contained in:
Joe Previte
307
lib/vscode/src/vs/platform/dialogs/common/dialogs.ts
Normal file
307
lib/vscode/src/vs/platform/dialogs/common/dialogs.ts
Normal file
@@ -0,0 +1,307 @@
|
||||
/*---------------------------------------------------------------------------------------------
|
||||
* Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
* Licensed under the MIT License. See License.txt in the project root for license information.
|
||||
*--------------------------------------------------------------------------------------------*/
|
||||
|
||||
import Severity from 'vs/base/common/severity';
|
||||
import { createDecorator } from 'vs/platform/instantiation/common/instantiation';
|
||||
import { URI } from 'vs/base/common/uri';
|
||||
import { basename } from 'vs/base/common/resources';
|
||||
import { localize } from 'vs/nls';
|
||||
import { ITelemetryData } from 'vs/platform/telemetry/common/telemetry';
|
||||
|
||||
export interface FileFilter {
|
||||
extensions: string[];
|
||||
name: string;
|
||||
}
|
||||
|
||||
export type DialogType = 'none' | 'info' | 'error' | 'question' | 'warning';
|
||||
|
||||
export interface ICheckbox {
|
||||
label: string;
|
||||
checked?: boolean;
|
||||
}
|
||||
|
||||
export interface IConfirmation {
|
||||
title?: string;
|
||||
type?: DialogType;
|
||||
message: string;
|
||||
detail?: string;
|
||||
primaryButton?: string;
|
||||
secondaryButton?: string;
|
||||
checkbox?: ICheckbox;
|
||||
}
|
||||
|
||||
export interface IConfirmationResult {
|
||||
|
||||
/**
|
||||
* Will be true if the dialog was confirmed with the primary button
|
||||
* pressed.
|
||||
*/
|
||||
confirmed: boolean;
|
||||
|
||||
/**
|
||||
* This will only be defined if the confirmation was created
|
||||
* with the checkbox option defined.
|
||||
*/
|
||||
checkboxChecked?: boolean;
|
||||
}
|
||||
|
||||
export interface IShowResult {
|
||||
|
||||
/**
|
||||
* Selected choice index. If the user refused to choose,
|
||||
* then a promise with index of `cancelId` option is returned. If there is no such
|
||||
* option then promise with index `0` is returned.
|
||||
*/
|
||||
choice: number;
|
||||
|
||||
/**
|
||||
* This will only be defined if the confirmation was created
|
||||
* with the checkbox option defined.
|
||||
*/
|
||||
checkboxChecked?: boolean;
|
||||
}
|
||||
|
||||
export interface IInputResult extends IShowResult {
|
||||
|
||||
/**
|
||||
* Values for the input fields as provided by the user
|
||||
* or `undefined` if none.
|
||||
*/
|
||||
values?: string[];
|
||||
}
|
||||
|
||||
export interface IPickAndOpenOptions {
|
||||
forceNewWindow?: boolean;
|
||||
defaultUri?: URI;
|
||||
telemetryExtraData?: ITelemetryData;
|
||||
availableFileSystems?: string[];
|
||||
}
|
||||
|
||||
export interface ISaveDialogOptions {
|
||||
/**
|
||||
* A human-readable string for the dialog title
|
||||
*/
|
||||
title?: string;
|
||||
|
||||
/**
|
||||
* The resource the dialog shows when opened.
|
||||
*/
|
||||
defaultUri?: URI;
|
||||
|
||||
/**
|
||||
* A set of file filters that are used by the dialog. Each entry is a human readable label,
|
||||
* like "TypeScript", and an array of extensions.
|
||||
*/
|
||||
filters?: FileFilter[];
|
||||
|
||||
/**
|
||||
* A human-readable string for the ok button
|
||||
*/
|
||||
saveLabel?: string;
|
||||
|
||||
/**
|
||||
* Specifies a list of schemas for the file systems the user can save to. If not specified, uses the schema of the defaultURI or, if also not specified,
|
||||
* the schema of the current window.
|
||||
*/
|
||||
availableFileSystems?: readonly string[];
|
||||
}
|
||||
|
||||
export interface IOpenDialogOptions {
|
||||
/**
|
||||
* A human-readable string for the dialog title
|
||||
*/
|
||||
title?: string;
|
||||
|
||||
/**
|
||||
* The resource the dialog shows when opened.
|
||||
*/
|
||||
defaultUri?: URI;
|
||||
|
||||
/**
|
||||
* A human-readable string for the open button.
|
||||
*/
|
||||
openLabel?: string;
|
||||
|
||||
/**
|
||||
* Allow to select files, defaults to `true`.
|
||||
*/
|
||||
canSelectFiles?: boolean;
|
||||
|
||||
/**
|
||||
* Allow to select folders, defaults to `false`.
|
||||
*/
|
||||
canSelectFolders?: boolean;
|
||||
|
||||
/**
|
||||
* Allow to select many files or folders.
|
||||
*/
|
||||
canSelectMany?: boolean;
|
||||
|
||||
/**
|
||||
* A set of file filters that are used by the dialog. Each entry is a human readable label,
|
||||
* like "TypeScript", and an array of extensions.
|
||||
*/
|
||||
filters?: FileFilter[];
|
||||
|
||||
/**
|
||||
* Specifies a list of schemas for the file systems the user can load from. If not specified, uses the schema of the defaultURI or, if also not available,
|
||||
* the schema of the current window.
|
||||
*/
|
||||
availableFileSystems?: readonly string[];
|
||||
}
|
||||
|
||||
export const IDialogService = createDecorator<IDialogService>('dialogService');
|
||||
|
||||
export interface IDialogOptions {
|
||||
cancelId?: number;
|
||||
detail?: string;
|
||||
checkbox?: ICheckbox;
|
||||
}
|
||||
|
||||
export interface IInput {
|
||||
placeholder?: string;
|
||||
type?: 'text' | 'password'
|
||||
value?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* A service to bring up modal dialogs.
|
||||
*
|
||||
* Note: use the `INotificationService.prompt()` method for a non-modal way to ask
|
||||
* the user for input.
|
||||
*/
|
||||
export interface IDialogService {
|
||||
|
||||
readonly _serviceBrand: undefined;
|
||||
|
||||
/**
|
||||
* Ask the user for confirmation with a modal dialog.
|
||||
*/
|
||||
confirm(confirmation: IConfirmation): Promise<IConfirmationResult>;
|
||||
|
||||
/**
|
||||
* Present a modal dialog to the user.
|
||||
*
|
||||
* @returns A promise with the selected choice index. If the user refused to choose,
|
||||
* then a promise with index of `cancelId` option is returned. If there is no such
|
||||
* option then promise with index `0` is returned.
|
||||
*/
|
||||
show(severity: Severity, message: string, buttons: string[], options?: IDialogOptions): Promise<IShowResult>;
|
||||
|
||||
/**
|
||||
* Present a modal dialog to the user asking for input.
|
||||
*
|
||||
* @returns A promise with the selected choice index. If the user refused to choose,
|
||||
* then a promise with index of `cancelId` option is returned. If there is no such
|
||||
* option then promise with index `0` is returned. In addition, the values for the
|
||||
* inputs are returned as well.
|
||||
*/
|
||||
input(severity: Severity, message: string, buttons: string[], inputs: IInput[], options?: IDialogOptions): Promise<IInputResult>;
|
||||
|
||||
/**
|
||||
* Present the about dialog to the user.
|
||||
*/
|
||||
about(): Promise<void>;
|
||||
}
|
||||
|
||||
export const IFileDialogService = createDecorator<IFileDialogService>('fileDialogService');
|
||||
|
||||
/**
|
||||
* A service to bring up file dialogs.
|
||||
*/
|
||||
export interface IFileDialogService {
|
||||
|
||||
readonly _serviceBrand: undefined;
|
||||
|
||||
/**
|
||||
* The default path for a new file based on previously used files.
|
||||
* @param schemeFilter The scheme of the file path. If no filter given, the scheme of the current window is used.
|
||||
*/
|
||||
defaultFilePath(schemeFilter?: string): URI | undefined;
|
||||
|
||||
/**
|
||||
* The default path for a new folder based on previously used folders.
|
||||
* @param schemeFilter The scheme of the folder path. If no filter given, the scheme of the current window is used.
|
||||
*/
|
||||
defaultFolderPath(schemeFilter?: string): URI | undefined;
|
||||
|
||||
/**
|
||||
* The default path for a new workspace based on previously used workspaces.
|
||||
* @param schemeFilter The scheme of the workspace path. If no filter given, the scheme of the current window is used.
|
||||
*/
|
||||
defaultWorkspacePath(schemeFilter?: string, filename?: string): URI | undefined;
|
||||
|
||||
/**
|
||||
* Shows a file-folder selection dialog and opens the selected entry.
|
||||
*/
|
||||
pickFileFolderAndOpen(options: IPickAndOpenOptions): Promise<void>;
|
||||
|
||||
/**
|
||||
* Shows a file selection dialog and opens the selected entry.
|
||||
*/
|
||||
pickFileAndOpen(options: IPickAndOpenOptions): Promise<void>;
|
||||
|
||||
/**
|
||||
* Shows a folder selection dialog and opens the selected entry.
|
||||
*/
|
||||
pickFolderAndOpen(options: IPickAndOpenOptions): Promise<void>;
|
||||
|
||||
/**
|
||||
* Shows a workspace selection dialog and opens the selected entry.
|
||||
*/
|
||||
pickWorkspaceAndOpen(options: IPickAndOpenOptions): Promise<void>;
|
||||
|
||||
/**
|
||||
* Shows a save file dialog and save the file at the chosen file URI.
|
||||
*/
|
||||
pickFileToSave(defaultUri: URI, availableFileSystems?: string[]): Promise<URI | undefined>;
|
||||
|
||||
/**
|
||||
* Shows a save file dialog and returns the chosen file URI.
|
||||
*/
|
||||
showSaveDialog(options: ISaveDialogOptions): Promise<URI | undefined>;
|
||||
|
||||
/**
|
||||
* Shows a confirm dialog for saving 1-N files.
|
||||
*/
|
||||
showSaveConfirm(fileNamesOrResources: (string | URI)[]): Promise<ConfirmResult>;
|
||||
|
||||
/**
|
||||
* Shows a open file dialog and returns the chosen file URI.
|
||||
*/
|
||||
showOpenDialog(options: IOpenDialogOptions): Promise<URI[] | undefined>;
|
||||
}
|
||||
|
||||
export const enum ConfirmResult {
|
||||
SAVE,
|
||||
DONT_SAVE,
|
||||
CANCEL
|
||||
}
|
||||
|
||||
const MAX_CONFIRM_FILES = 10;
|
||||
export function getFileNamesMessage(fileNamesOrResources: readonly (string | URI)[]): string {
|
||||
const message: string[] = [];
|
||||
message.push(...fileNamesOrResources.slice(0, MAX_CONFIRM_FILES).map(fileNameOrResource => typeof fileNameOrResource === 'string' ? fileNameOrResource : basename(fileNameOrResource)));
|
||||
|
||||
if (fileNamesOrResources.length > MAX_CONFIRM_FILES) {
|
||||
if (fileNamesOrResources.length - MAX_CONFIRM_FILES === 1) {
|
||||
message.push(localize('moreFile', "...1 additional file not shown"));
|
||||
} else {
|
||||
message.push(localize('moreFiles', "...{0} additional files not shown", fileNamesOrResources.length - MAX_CONFIRM_FILES));
|
||||
}
|
||||
}
|
||||
|
||||
message.push('');
|
||||
return message.join('\n');
|
||||
}
|
||||
|
||||
export interface INativeOpenDialogOptions {
|
||||
forceNewWindow?: boolean;
|
||||
|
||||
defaultPath?: string;
|
||||
|
||||
telemetryEventName?: string;
|
||||
telemetryExtraData?: ITelemetryData;
|
||||
}
|
||||
Reference in New Issue
Block a user