VS Code API
    Preparing search index...

    Interface CommentController

    A comment controller is able to provide comments support to the editor and provide users various ways to interact with comments.

    interface CommentController {
        commentingRangeProvider?: CommentingRangeProvider;
        id: string;
        label: string;
        options?: CommentOptions;
        reactionHandler?: (
            comment: Comment,
            reaction: CommentReaction,
        ) => Thenable<void>;
        createCommentThread(
            uri: Uri,
            range: Range,
            comments: readonly Comment[],
        ): CommentThread;
        dispose(): void;
    }
    Index

    Properties

    commentingRangeProvider? id label options? reactionHandler?

    Methods

    createCommentThread dispose

    Properties

    commentingRangeProvider?: CommentingRangeProvider

    Optional commenting range provider. Provide a list ranges which support commenting to any given resource uri.

    If not provided, users cannot leave any comments.

    id: string

    The id of this comment controller.

    label: string

    The human-readable label of this comment controller.

    options?: CommentOptions

    Comment controller options

    reactionHandler?: (
        comment: Comment,
        reaction: CommentReaction,
    ) => Thenable<void>

    Optional reaction handler for creating and deleting reactions on a Comment.

    Methods

    • Create a 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

    • Dispose this comment controller.

      Once disposed, all comment threads created by this comment controller will also be removed from the editor and Comments Panel.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods