Class ReviewManager

constructor

• new ReviewManager(
      editor: IStandaloneCodeEditor,
      currentUser: string,
      onChange?: OnActionsChanged,
      config?: ReviewManagerConfig,
      verbose?: boolean,
  ): ReviewManager

  Parameters

  • editor: IStandaloneCodeEditor
  • currentUser: string
  • OptionalonChange: OnActionsChanged
  • Optionalconfig: ReviewManagerConfig
  • Optionalverbose: boolean

  Returns ReviewManager

OptionalactiveComment

canAddCondition

canCancelCondition

commentHeightCache

config

currentCommentDecorations

OptionalcurrentLineDecorationLineNumber

currentLineDecorations

currentUser

editId

editor

editorConfig

editorElements

editorMode

events

inlineToolbarElements

OptionalonChange

store

verbose

OptionalwidgetInlineCommentEditor

OptionalwidgetInlineToolbar

addActions

• addActions(): void

  Returns void

addComment

• addComment(
      lineNumber: number,
      text: string,
      selection?: CodeSelection,
  ): ReviewCommentEvent

  Parameters

  • lineNumber: number
  • text: string
  • Optionalselection: CodeSelection

  Returns ReviewCommentEvent

applyStyles

• applyStyles(element: HTMLElement, className: string): void

  Parameters

  • element: HTMLElement
  • className: string

  Returns void

calculateConfirmButtonText

• calculateConfirmButtonText(): | "Add Comment"
  | "Reply to Comment"
  | "Edit Comment"

  Returns "Add Comment" | "Reply to Comment" | "Edit Comment"

createCustomCssClasses

• createCustomCssClasses(): void

  Returns void

createInlineEditButtonsElement

• createInlineEditButtonsElement(): InlineToolbarElements

  Returns InlineToolbarElements

createInlineEditorElement

• createInlineEditorElement(): EditorElements

  Returns EditorElements

createInlineEditorWidget

• createInlineEditorWidget(): EditorElements

  Returns EditorElements

createInlineToolbarWidget

• createInlineToolbarWidget(): InlineToolbarElements

  Returns InlineToolbarElements

dispose

• dispose(): void

  Removes all view zones, decorations, widgets, actions and event listeners that this ReviewManager attached to the editor. Call this when unmounting the editor or the hosting component.

  Returns void

filterAndMapComments

• filterAndMapComments(
      lineNumbers: number[],
      fn: (comment: ReviewComment) => void,
  ): void

  Parameters

  • lineNumbers: number[]
  • fn: (comment: ReviewComment) => void

  Returns void

generateId

• generateId(): string

  Returns string

getActivePosition

• getActivePosition(): number | undefined

  Returns number | undefined

getComments

• getComments(): ReviewComment[]

  Returns the current comments (computed from the event log).

  Returns ReviewComment[]

getDateTimeNow

• getDateTimeNow(): number

  Returns number

getRenderState

• getRenderState(commentId: string): RenderStoreItem

  Parameters

  • commentId: string

  Returns RenderStoreItem

getThemedColor

• getThemedColor(name: string): string

  Parameters

  • name: string

  Returns string

handleAddComment

• handleAddComment(): void

  Returns void

handleCancel

• handleCancel(): void

  Returns void

handleMouseDown

• handleMouseDown(ev: IEditorMouseEvent & IEventRenderStoreItem): void

  Parameters

  • ev: IEditorMouseEvent & IEventRenderStoreItem

  Returns void

handleMouseMove

• handleMouseMove(ev: IEditorMouseEvent & IEventRenderStoreItem): void

  Parameters

  • ev: IEditorMouseEvent & IEventRenderStoreItem

  Returns void

handleTextAreaKeyDown

• handleTextAreaKeyDown(e: KeyboardEvent): void

  Parameters

  • e: KeyboardEvent

  Returns void

layoutInlineCommentEditor

• layoutInlineCommentEditor(): void

  Returns void

layoutInlineToolbar

• layoutInlineToolbar(): void

  Returns void

load

• load(events: ReviewCommentEvent[]): void

  Parameters

  • events: ReviewCommentEvent[]

  Returns void

loadFromStore

• loadFromStore(store: ReviewCommentStore, events: ReviewCommentEvent[]): void

  Parameters

  • store: ReviewCommentStore
  • events: ReviewCommentEvent[]

  Returns void

navigateToComment

• navigateToComment(direction: NavigationDirection): void

  Parameters

  • direction: NavigationDirection

  Returns void

refreshComments

• refreshComments(): void

  Returns void

removeComment

• removeComment(id: string): ReviewCommentEvent

  Parameters

  • id: string

  Returns ReviewCommentEvent

renderAddCommentLineDecoration

• renderAddCommentLineDecoration(lineNumber?: number): void

  Parameters

  • OptionallineNumber: number

  Returns void

selectComment

• selectComment(commentId: string | undefined): void

  Programmatically select a comment by id - activates it, shows the toolbar and scrolls it into view. Pass undefined to clear the selection.

  Parameters

  • commentId: string | undefined

  Returns void

setActiveComment

• setActiveComment(comment?: ReviewComment, reason?: string): boolean

  Parameters

  • Optionalcomment: ReviewComment
  • Optionalreason: string

  Returns boolean

setEditorMode

• setEditorMode(mode: EditorMode, why?: string): void

  Parameters

  • mode: EditorMode
  • why: string = ""

  Returns void

setReadOnlyMode

• setReadOnlyMode(value: boolean): void

  Parameters

  • value: boolean

  Returns void