TextDocumentDecoration | Sourcegraph extension API

A text document decoration changes the appearance of a range in the document and/or adds other content to it.

Hierarchy

ThemableDecorationStyle
- TextDocumentDecoration

Index

Properties

Optional after

after: DecorationAttachmentRenderOptions

Content to display after the range.

Optional backgroundColor

backgroundColor: undefined | string

The CSS background-color property value for the line.

Optional border

border: undefined | string

The CSS border property value for the line.

Optional borderColor

borderColor: undefined | string

The CSS border-color property value for the line.

Optional borderWidth

borderWidth: undefined | string

The CSS border-width property value for the line.

Optional dark

dark: ThemableDecorationStyle

Overwrite style for dark themes.

Optional isWholeLine

isWholeLine: undefined | false | true

If true, the decoration applies to all lines in the range (inclusive), even if not all characters on the line are included.

Optional light

light: ThemableDecorationStyle

Overwrite style for light themes.

range

range: Range

The range that the decoration applies to. Currently, decorations are only applied only on the start line, and the entire line. Multiline and intra-line ranges are not supported.