bingyi/vscode-extension-samples
1
0
Fork 0
mirror of https://github.com/microsoft/vscode-extension-samples.git synced 2026-06-13 07:10:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update comments for api

Browse Source
This commit is contained in:
Peng Lyu
2019-03-15 12:52:20 -07:00
parent 5e09c1f3ad
commit 62af066dec
1 changed files with 24 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
comment-sample/src/typings/vscode.proposed.d.ts vendored
View File

@ -79,6 +79,11 @@ declare module 'vscode' {
* Defaults to Collapsed.
*/
collapsibleState?: CommentThreadCollapsibleState;
/**
* Dispose this comment thread.
* Once disposed, the comment thread will be removed from visible text editors and Comments Panel.
*/
dispose(): void;
}
@ -95,6 +100,11 @@ declare module 'vscode' {
* The text of the comment
*/
body: MarkdownString;
/**
* Optional label describing the [Comment](#Comment)
* Label will be rendered next to userName if exists.
*/
label?: string;
/**
@ -112,16 +122,15 @@ declare module 'vscode' {
*/
selectCommand?: Command;
/**
* The command to be executed when users try to save the edits to the comment
*/
editCommand?: Command;
deleteCommand?: Command;
commentReactions?: CommentReaction[];
}
interface CommentReaction {
readonly label?: string;
readonly iconPath?: string | Uri;
count?: number;
readonly hasReacted?: boolean;
/**
* The command to be executed when users try to delete the comment
*/
deleteCommand?: Command;
}
export interface CommentInputBox {
@ -133,6 +142,9 @@ declare module 'vscode' {
}
export interface CommentingRangeProvider {
/**
* Provide a list of ranges which allow new comment threads creation or null for a given document
*/
provideCommentingRanges(document: TextDocument, token: CancellationToken): ProviderResult<Range[]>;
}
@ -159,6 +171,10 @@ declare module 'vscode' {
* The active (focused) [comment input box](#CommentInputBox).
*/
readonly inputBox?: CommentInputBox;
/**
* Create a [CommentThread](#CommentThread)
*/
createCommentThread(id: string, resource: Uri, range: Range, comments: Comment[]): CommentThread;
/**
@ -171,7 +187,6 @@ declare module 'vscode' {
* Optional new comment thread factory.
*/
emptyCommentThreadFactory?: EmptyCommentThreadFactory;
/**
* Dispose this comment controller.
*/