monaco-review
    Preparing search index...

    Interface ReviewManagerConfig

    interface ReviewManagerConfig {
        commentIndent?: number;
        commentIndentOffset?: number;
        editButtonAddText?: string;
        editButtonEnableRemove?: boolean;
        editButtonOffset?: string;
        editButtonRemoveText?: string;
        formatDate?: FormatDate;
        keybindings?: ReviewManagerKeybindings;
        onActiveCommentChanged?: (comment: ReviewComment | undefined) => void;
        readOnly?: boolean;
        renderComment?: (
            isActive: boolean,
            comment: ReviewCommentIterItem,
        ) => HTMLElement;
        renderText?: (text: string) => string | HTMLElement;
        reviewCommentIconActive?: string;
        reviewCommentIconSelect?: string;
        setClassNames?: boolean;
        showInRuler?: boolean;
        styles?: Record<string, unknown>;
        verticalOffset?: number;
    }
    Index

    Properties

    commentIndent? commentIndentOffset? editButtonAddText? editButtonEnableRemove? editButtonOffset? editButtonRemoveText? formatDate? keybindings? onActiveCommentChanged? readOnly? renderComment? renderText? reviewCommentIconActive? reviewCommentIconSelect? setClassNames? showInRuler? styles? verticalOffset?

    Properties

    commentIndent?: number
    commentIndentOffset?: number
    editButtonAddText?: string
    editButtonEnableRemove?: boolean
    editButtonOffset?: string
    editButtonRemoveText?: string
    formatDate?: FormatDate
    keybindings?: ReviewManagerKeybindings
    onActiveCommentChanged?: (comment: ReviewComment | undefined) => void

    Called when the active (selected) comment changes, including to undefined.

    readOnly?: boolean
    renderComment?: (
        isActive: boolean,
        comment: ReviewCommentIterItem,
    ) => HTMLElement
    renderText?: (text: string) => string | HTMLElement

    Custom renderer for comment text (e.g. a markdown library). A returned string is sanitized with DOMPurify before being set as innerHTML; a returned HTMLElement is appended as-is (sanitization is the caller's responsibility). When omitted, comment text is rendered as plain text.

    reviewCommentIconActive?: string
    reviewCommentIconSelect?: string
    setClassNames?: boolean
    showInRuler?: boolean
    styles?: Record<string, unknown>
    verticalOffset?: number

    Settings

    Member Visibility

    On This Page

    Properties