mirror of
https://github.com/microsoft/vscode.git
synced 2026-05-02 06:21:50 +01:00
Merge pull request #244302 from mjbvz/chat-status
Add chat status API proposal
This commit is contained in:
61
src/vscode-dts/vscode.proposed.chatStatusItem.d.ts
vendored
Normal file
61
src/vscode-dts/vscode.proposed.chatStatusItem.d.ts
vendored
Normal file
@@ -0,0 +1,61 @@
|
||||
/*---------------------------------------------------------------------------------------------
|
||||
* Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
* Licensed under the MIT License. See License.txt in the project root for license information.
|
||||
*--------------------------------------------------------------------------------------------*/
|
||||
|
||||
declare module 'vscode' {
|
||||
|
||||
export interface ChatStatusItem {
|
||||
/**
|
||||
* The identifier of this item.
|
||||
*/
|
||||
readonly id: string;
|
||||
|
||||
/**
|
||||
* The main name of the entry, like 'Indexing Status'
|
||||
*/
|
||||
title: string;
|
||||
|
||||
/**
|
||||
* Optional additional description of the entry.
|
||||
*
|
||||
* This is rendered after the title. Supports Markdown style links (`[text](http://example.com)`) and rendering of
|
||||
* {@link ThemeIcon theme icons} via the `$(<name>)`-syntax.
|
||||
*/
|
||||
description: string;
|
||||
|
||||
/**
|
||||
* Optional additional details of the entry.
|
||||
*
|
||||
* This is rendered less prominently after the title. Supports Markdown style links (`[text](http://example.com)`) and rendering of
|
||||
* {@link ThemeIcon theme icons} via the `$(<name>)`-syntax.
|
||||
*/
|
||||
detail: string | undefined;
|
||||
|
||||
/**
|
||||
* Shows the entry in the chat status.
|
||||
*/
|
||||
show(): void;
|
||||
|
||||
/**
|
||||
* Hide the entry in the chat status.
|
||||
*/
|
||||
hide(): void;
|
||||
|
||||
/**
|
||||
* Dispose and free associated resources
|
||||
*/
|
||||
dispose(): void;
|
||||
}
|
||||
|
||||
namespace window {
|
||||
/**
|
||||
* Create a new chat status item.
|
||||
*
|
||||
* @param id The unique identifier of the status bar item.
|
||||
*
|
||||
* @returns A new chat status item.
|
||||
*/
|
||||
export function createChatStatusItem(id: string): ChatStatusItem;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user