Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TextEditorOptions

Represents a text editor's options

Hierarchy

  • TextEditorOptions

Index

Properties

Properties

Optional cursorStyle

cursorStyle?: TextEditorCursorStyle

The rendering style of the cursor in this editor. When getting a text editor's options, this property will always be present. When setting a text editor's options, this property is optional.

Optional insertSpaces

insertSpaces?: string | boolean

When pressing Tab insert n spaces. When getting a text editor's options, this property will always be a boolean (resolved). When setting a text editor's options, this property is optional and it can be a boolean or "auto".

Optional lineNumbers

lineNumbers?: TextEditorLineNumbersStyle

Render relative line numbers w.r.t. the current line number. When getting a text editor's options, this property will always be present. When setting a text editor's options, this property is optional.

Optional tabSize

tabSize?: string | number

The size in spaces a tab takes. This is used for two purposes:

  • the rendering width of a tab character;
  • the number of spaces to insert when insertSpaces is true.

When getting a text editor's options, this property will always be a number (resolved). When setting a text editor's options, this property is optional and it can be a number or "auto".