Options
All
  • Public
  • Public/Protected
  • All
Menu

The configuration options for an editor.

Hierarchy

  • IConfig

Index

Properties

autoClosingBrackets

autoClosingBrackets: boolean

Whether to automatically close brackets after opening them.

codeFolding

codeFolding: boolean

Whether to allow code folding

cursorBlinkRate

cursorBlinkRate: number

Half-period in milliseconds used for cursor blinking. By setting this to zero, blinking can be disabled. A negative value hides the cursor entirely.

fontFamily

fontFamily: string

User preferred font family for text editors.

fontSize

fontSize: number

User preferred size in pixel of the font used in text editors.

Optional handlePaste

handlePaste: boolean

Whether the editor should handle paste events.

insertSpaces

insertSpaces: boolean

Whether to insert spaces when pressing Tab.

lineHeight

lineHeight: number

User preferred text line height, as a multiplier of font size.

lineNumbers

lineNumbers: boolean

Whether line numbers should be displayed.

lineWrap

lineWrap: "wordWrapColumn" | "off" | "on" | "bounded"

Control the line wrapping of the editor. Possible values are:

  • "off", lines will never wrap.
  • "on", lines will wrap at the viewport border.
  • "wordWrapColumn", lines will wrap at wordWrapColumn.
  • "bounded", lines will wrap at minimum between viewport width and wordWrapColumn.

matchBrackets

matchBrackets: boolean

Whether to highlight matching brackets when one of them is selected.

readOnly

readOnly: boolean

Whether the editor is read-only.

rulers

rulers: number[]

Column index at which rulers should be added.

showTrailingSpace

showTrailingSpace: boolean

Whether to highlight trailing whitespace

tabSize

tabSize: number

The number of spaces a tab is equal to.

wordWrapColumn

wordWrapColumn: number

The column where to break text line.

Generated using TypeDoc