Theia API Documentation v1.66.0
    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: 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 can leave comments in any document opened in the editor.

    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

    Settings

    Member Visibility

    On This Page

    Properties
    Methods