Options
All
  • Public
  • Public/Protected
  • All
Menu

Module renderer/services/editor

Index

Type aliases

Functions

Type aliases

SimpleCompletionItem

SimpleCompletionItem: { detail?: string; insertText: string; kind?: Monaco.languages.CompletionItemKind; label: string }

Type declaration

  • Optional detail?: string
  • insertText: string
  • Optional kind?: Monaco.languages.CompletionItemKind
  • label: string

SimpleCompletionItemTappers

SimpleCompletionItemTappers: (items: SimpleCompletionItem[]) => void

Type declaration

Functions

deleteLine

  • deleteLine(line: number): void

  • Parameters

    • line: number

    Returns void

getAllCustomEditors

  • Get all custom editors.

    Returns CustomEditor[]

    Editors

Const getDefaultOptions

  • getDefaultOptions(): IStandaloneEditorConstructionOptions

  • Get default editor options.

    Returns IStandaloneEditorConstructionOptions

getEditor

  • getEditor(): IStandaloneCodeEditor

  • Get editor instance.

    Returns IStandaloneCodeEditor

getLineContent

  • getLineContent(line: number): string

  • Get content of line.

    Parameters

    • line: number

    Returns string

getLinesContent

  • getLinesContent(lineStart: number, lineEnd: number): string

  • Get content of lines.

    Parameters

    • lineStart: number
    • lineEnd: number

    Returns string

getMarkdownMonarchLanguage

  • getMarkdownMonarchLanguage(): any

  • Get markdown monarch language.

    Returns any

getMonaco

  • getMonaco(): __module

  • Get Monaco

    Returns __module

    Monaco

getOneIndent

  • getOneIndent(): string

getSelectionInfo

  • getSelectionInfo(): { column: number; line: number; lineCount: number; selectedLength: number; selectedLines: number; selectionCount: number; textLength: number }

  • Get editor selection.

    Returns { column: number; line: number; lineCount: number; selectedLength: number; selectedLines: number; selectionCount: number; textLength: number }

    • column: number
    • line: number
    • lineCount: number
    • selectedLength: number
    • selectedLines: number
    • selectionCount: number
    • textLength: number

getSimpleCompletionItems

  • Get simple completion items.

    Returns SimpleCompletionItem[]

getValue

  • getValue(): string

  • Get text value.

    Returns string

highlightLine

  • highlightLine(line: number | [number, number], reveal: boolean, duration: number): Promise<void>
  • highlightLine(line: number | [number, number], reveal?: boolean, duration?: number): (() => void) | Promise<void>

  • Highlight given line.

    Parameters

    • line: number | [number, number]
    • reveal: boolean
    • duration: number

    Returns Promise<void>

    dispose function

  • Parameters

    • line: number | [number, number]
    • Optional reveal: boolean
    • Optional duration: number

    Returns (() => void) | Promise<void>

insert

  • insert(text: string): void

  • Insert text at current cursor.

    Parameters

    • text: string

    Returns void

insertAt

  • insertAt(position: Position, text: string): void

  • Insert text at position.

    Parameters

    • position: Position
    • text: string

    Returns void

isDefault

  • isDefault(): boolean

  • Get current editor is default or not.

    Returns boolean

isDirty

  • isDirty(): Promise<boolean>

  • Get current editor is dirty or not.

    Returns Promise<boolean>

lookupKeybindingKeys

  • lookupKeybindingKeys(commandId: string): string[] | null

  • Parameters

    • commandId: string

    Returns string[] | null

registerCustomEditor

  • Register a custom editor.

    Parameters

    Returns void

removeCustomEditor

  • removeCustomEditor(name: string): void

  • Remove a custom editor.

    Parameters

    • name: string

      Editor name

    Returns void

replaceLine

  • replaceLine(line: number, text: string): void

  • Replace text value of line.

    Parameters

    • line: number
    • text: string

    Returns void

replaceLines

  • replaceLines(lineStart: number, lineEnd: number, text: string): void

  • Replace text value of lines.

    Parameters

    • lineStart: number
    • lineEnd: number
    • text: string

    Returns void

replaceValue

  • replaceValue(search: string | RegExp, val: string, replaceAll?: boolean): void

  • Replace text value.

    Parameters

    • search: string | RegExp
    • val: string
    • replaceAll: boolean = true

    Returns void

setValue

  • setValue(text: string): void

  • Set text value to editor

    Parameters

    • text: string

    Returns void

switchEditor

  • switchEditor(name: string): void

  • Switch current editor

    Parameters

    • name: string

      Editor name

    Returns void

tapMarkdownMonarchLanguage

  • tapMarkdownMonarchLanguage(tapper: (mdLanguage: any) => void): void

  • Register a markdown monarch language processor.

    Parameters

    • tapper: (mdLanguage: any) => void
        • (mdLanguage: any): void

        • Parameters

          • mdLanguage: any

          Returns void

    Returns void

tapSimpleCompletionItems

toggleTypewriterMode

  • toggleTypewriterMode(): void

  • Toggle typewriter mode.

    Returns void

toggleWrap

  • toggleWrap(): void

  • Toggle editor word wrap.

    Returns void

triggerSave

  • triggerSave(): void

  • Trigger save.

    Returns void

whenEditorReady

  • whenEditorReady(): Promise<{ editor: typeof editor; monaco: typeof monaco }>

  • Ensure editor is ready.

    Returns Promise<{ editor: typeof editor; monaco: typeof monaco }>

Generated using TypeDoc