dots.vscode.comment-controller
A comment controller is able to provide {@link CommentThread comments} support to the editor and provide users various ways to interact with comments.
A comment controller is able to provide {@link CommentThread comments} support to the editor and
provide users various ways to interact with comments.commenting-range-providercljs
(commenting-range-provider comment-controller)Optional commenting range provider. Provide a list {@link Range ranges} which support commenting to any given resource uri.
If not provided, users cannot leave any comments.
Returns: CommentingRangeProvider | undefined
Optional commenting range provider. Provide a list {@link Range ranges} which support commenting to any given resource uri.
If not provided, users cannot leave any comments.
**Returns:** `CommentingRangeProvider | undefined`create-comment-threadcljs
(create-comment-thread comment-controller uri range comments)Create a {@link CommentThread comment thread}. The comment thread will be displayed in visible text editors (if the resource matches) and Comments Panel once created.
Parameters:
uri:Uri- The uri of the document the thread has been created on.range:Range- The range the comment thread is located within the document.comments:readonly Comment[]- The ordered comments of the thread.
Returns: CommentThread
Create a {@link CommentThread comment thread}. The comment thread will be displayed in visible text editors (if the resource matches)
and Comments Panel once created.
**Parameters:**
- `uri`: `Uri` - The uri of the document the thread has been created on.
- `range`: `Range` - The range the comment thread is located within the document.
- `comments`: `readonly Comment[]` - The ordered comments of the thread.
**Returns:** `CommentThread`disposecljs
(dispose comment-controller)Dispose this comment controller.
Once disposed, all {@link CommentThread comment threads} created by this comment controller will also be removed from the editor and Comments Panel.
Returns: void
Dispose this comment controller.
Once disposed, all {@link CommentThread comment threads} created by this comment controller will also be removed from the editor
and Comments Panel.
**Returns:** `void`idcljs
(id comment-controller)The id of this comment controller.
Returns: string
The id of this comment controller. **Returns:** `string`
labelcljs
(label comment-controller)The human-readable label of this comment controller.
Returns: string
The human-readable label of this comment controller. **Returns:** `string`
optionscljs
(options comment-controller)Comment controller options
Returns: CommentOptions | undefined
Comment controller options **Returns:** `CommentOptions | undefined`
reaction-handlercljs
(reaction-handler comment-controller)Optional reaction handler for creating and deleting reactions on a {@link Comment }.
Returns: ((comment: Comment, reaction: CommentReaction) => Thenable<void>) | undefined
Optional reaction handler for creating and deleting reactions on a {@link Comment }.
**Returns:** `((comment: Comment, reaction: CommentReaction) => Thenable<void>) | undefined`set-commenting-range-provider!cljs
(set-commenting-range-provider! comment-controller value)Optional commenting range provider. Provide a list {@link Range ranges} which support commenting to any given resource uri.
If not provided, users cannot leave any comments.
Optional commenting range provider. Provide a list {@link Range ranges} which support commenting to any given resource uri.
If not provided, users cannot leave any comments.set-options!cljs
(set-options! comment-controller value)Comment controller options
Comment controller options
set-reaction-handler!cljs
(set-reaction-handler! comment-controller value)Optional reaction handler for creating and deleting reactions on a {@link Comment }.
Optional reaction handler for creating and deleting reactions on a {@link Comment }.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close