Theia API Documentation v1.65.0
    Preparing search index...

    Interface TextEditorOptions

    Represents a text editor's options

    interface TextEditorOptions {
        cursorStyle?: TextEditorCursorStyle;
        indentSize?: string | number;
        insertSpaces?: string | boolean;
        lineNumbers?: TextEditorLineNumbersStyle;
        tabSize?: string | number;
    }

    Implemented by

    Index

    Properties

    cursorStyle? indentSize? insertSpaces? lineNumbers? tabSize?

    Properties

    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.

    indentSize?: string | number

    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 "tabSize".

    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".

    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.

    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".

    Settings

    Member Visibility

    On This Page

    Properties