Interface IDiffEditorBaseOptions

interface IDiffEditorBaseOptions {
    accessibilityVerbose?: boolean;
    compactMode?: boolean;
    diffAlgorithm?: "advanced" | "legacy";
    diffCodeLens?: boolean;
    diffWordWrap?: "off" | "on" | "inherit";
    enableSplitViewResizing?: boolean;
    experimental?: {
        showEmptyDecorations?: boolean;
        showMoves?: boolean;
        useTrueInlineView?: boolean;
    };
    hideUnchangedRegions?: {
        contextLineCount?: number;
        enabled?: boolean;
        minimumLineCount?: number;
        revealLineCount?: number;
    };
    ignoreTrimWhitespace?: boolean;
    isInEmbeddedEditor?: boolean;
    maxComputationTime?: number;
    maxFileSize?: number;
    onlyShowAccessibleDiffViewer?: boolean;
    originalEditable?: boolean;
    renderGutterMenu?: boolean;
    renderIndicators?: boolean;
    renderMarginRevertIcon?: boolean;
    renderOverviewRuler?: boolean;
    renderSideBySide?: boolean;
    renderSideBySideInlineBreakpoint?: number;
    splitViewDefaultRatio?: number;
    useInlineViewWhenSpaceIsLimited?: boolean;
}

Hierarchy (view full)

Properties

accessibilityVerbose? compactMode? diffAlgorithm? diffCodeLens? diffWordWrap? enableSplitViewResizing? experimental? hideUnchangedRegions? ignoreTrimWhitespace? isInEmbeddedEditor? maxComputationTime? maxFileSize? onlyShowAccessibleDiffViewer? originalEditable? renderGutterMenu? renderIndicators? renderMarginRevertIcon? renderOverviewRuler? renderSideBySide? renderSideBySideInlineBreakpoint? splitViewDefaultRatio? useInlineViewWhenSpaceIsLimited?

Properties

Optional accessibilityVerbose

accessibilityVerbose?: boolean

Whether the diff editor aria label should be verbose.

Optional compactMode

compactMode?: boolean

If set, the diff editor is optimized for small views. Defaults to false.

Optional diffAlgorithm

diffAlgorithm?: "advanced" | "legacy"

Diff Algorithm

Optional diffCodeLens

diffCodeLens?: boolean

Should the diff editor enable code lens? Defaults to false.

Optional diffWordWrap

diffWordWrap?: "off" | "on" | "inherit"

Control the wrapping of the diff editor.

Optional enableSplitViewResizing

enableSplitViewResizing?: boolean

Allow the user to resize the diff editor split view. Defaults to true.

Optional experimental

experimental?: {
    showEmptyDecorations?: boolean;
    showMoves?: boolean;
    useTrueInlineView?: boolean;
}

Type declaration

  • Optional showEmptyDecorations?: boolean
  • Optional showMoves?: boolean

    Defaults to false.

  • Optional useTrueInlineView?: boolean

    Only applies when renderSideBySide is set to false.

Optional hideUnchangedRegions

hideUnchangedRegions?: {
    contextLineCount?: number;
    enabled?: boolean;
    minimumLineCount?: number;
    revealLineCount?: number;
}

Type declaration

  • Optional contextLineCount?: number
  • Optional enabled?: boolean
  • Optional minimumLineCount?: number
  • Optional revealLineCount?: number

Optional ignoreTrimWhitespace

ignoreTrimWhitespace?: boolean

Compute the diff by ignoring leading/trailing whitespace Defaults to true.

Optional isInEmbeddedEditor

isInEmbeddedEditor?: boolean

Is the diff editor inside another editor Defaults to false

Optional maxComputationTime

maxComputationTime?: number

Timeout in milliseconds after which diff computation is cancelled. Defaults to 5000.

Optional maxFileSize

maxFileSize?: number

Maximum supported file size in MB. Defaults to 50.

Optional onlyShowAccessibleDiffViewer

onlyShowAccessibleDiffViewer?: boolean

If the diff editor should only show the difference review mode.

Optional originalEditable

originalEditable?: boolean

Original model should be editable? Defaults to false.

Optional renderGutterMenu

renderGutterMenu?: boolean

Indicates if the gutter menu should be rendered.

Optional renderIndicators

renderIndicators?: boolean

Render +/- indicators for added/deleted changes. Defaults to true.

Optional renderMarginRevertIcon

renderMarginRevertIcon?: boolean

Shows icons in the glyph margin to revert changes. Default to true.

Optional renderOverviewRuler

renderOverviewRuler?: boolean

Is the diff editor should render overview ruler Defaults to true

Optional renderSideBySide

renderSideBySide?: boolean

Render the differences in two side-by-side editors. Defaults to true.

Optional renderSideBySideInlineBreakpoint

renderSideBySideInlineBreakpoint?: number

When renderSideBySide is enabled, useInlineViewWhenSpaceIsLimited is set, and the diff editor has a width less than renderSideBySideInlineBreakpoint, the inline view is used.

Optional splitViewDefaultRatio

splitViewDefaultRatio?: number

The default ratio when rendering side-by-side editors. Must be a number between 0 and 1, min sizes apply. Defaults to 0.5

Optional useInlineViewWhenSpaceIsLimited

useInlineViewWhenSpaceIsLimited?: boolean

When renderSideBySide is enabled, useInlineViewWhenSpaceIsLimited is set, and the diff editor has a width less than renderSideBySideInlineBreakpoint, the inline view is used.

Settings

Member Visibility

Theme

On This Page

accessibilityVerbosecompactModediffAlgorithmdiffCodeLensdiffWordWrapenableSplitViewResizingexperimentalhideUnchangedRegionsignoreTrimWhitespaceisInEmbeddedEditormaxComputationTimemaxFileSizeonlyShowAccessibleDiffVieweroriginalEditablerenderGutterMenurenderIndicatorsrenderMarginRevertIconrenderOverviewRulerrenderSideBySiderenderSideBySideInlineBreakpointsplitViewDefaultRatiouseInlineViewWhenSpaceIsLimited