Class CodeMirrorEditor

CodeMirror editor.

Implements

CodeEditor.IEditor

Constructors

constructor

new CodeMirrorEditor(options): CodeMirrorEditor
Construct a CodeMirror editor.
Parameters
- options: CodeMirrorEditor.IOptions
Returns CodeMirrorEditor
- Defined in packages/codemirror/src/editor.ts:51

Properties

`Private` _configurator

_configurator: IExtensionsHandler

`Private` _editor

_editor: EditorView

`Private` _isDisposed

_isDisposed: boolean = false

`Private` _language

_language: Compartment = ...

`Private` _languages

_languages: IEditorLanguageRegistry

`Private` _model

_model: CodeEditor.IModel

`Private` _uuid

_uuid: string = ''

`Readonly` edgeRequested

edgeRequested: Signal<CodeMirrorEditor, EdgeLocation> = ...

A signal emitted when either the top or bottom edge is requested.

`Readonly` host

host: HTMLElement

The DOM node that hosts the editor.

Accessors

charWidth

get charWidth(): number
The widget of a character in the editor in pixels.

Returns number
Implementation of IEditor.charWidth
- Defined in packages/codemirror/src/editor.ts:163

doc

get doc(): Text
Get the codemirror doc wrapped by the widget.

Returns Text
- Defined in packages/codemirror/src/editor.ts:135

editor

get editor(): EditorView
Get the codemirror editor wrapped by the editor.

Returns EditorView
- Defined in packages/codemirror/src/editor.ts:128

isDisposed

get isDisposed(): boolean
Tests whether the editor is disposed.

Returns boolean
Implementation of IEditor.isDisposed
- Defined in packages/codemirror/src/editor.ts:170

lineCount

get lineCount(): number
Get the number of lines in the editor.

Returns number
Implementation of IEditor.lineCount
- Defined in packages/codemirror/src/editor.ts:142

lineHeight

get lineHeight(): number
The height of a line in the editor in pixels.

Returns number
Implementation of IEditor.lineHeight
- Defined in packages/codemirror/src/editor.ts:156

model

get model(): CodeEditor.IModel
Returns a model for this editor.

Returns CodeEditor.IModel
Implementation of IEditor.model
- Defined in packages/codemirror/src/editor.ts:149

state

get state(): EditorState
Returns EditorState
- Defined in packages/codemirror/src/editor.ts:302

uuid

get uuid(): string
The uuid of this editor;

Returns string
Implementation of IEditor.uuid
- Defined in packages/codemirror/src/editor.ts:118
set uuid(value): void
The uuid of this selection owner.
Parameters
- value: string
Returns void
Implementation of IEditor.uuid
- Defined in packages/codemirror/src/editor.ts:121

Methods

`Private` _evtBlur

_evtBlur(event): void
Handle blur events for the editor.
Parameters
- event: FocusEvent
Returns void
- Defined in packages/codemirror/src/editor.ts:725

`Private` _evtFocus

_evtFocus(event): void
Handle focus events for the editor.
Parameters
- event: FocusEvent
Returns void
- Defined in packages/codemirror/src/editor.ts:713

`Private` _onCursorActivity

_onCursorActivity(): void
Handles a cursor activity event.

Returns void
- Defined in packages/codemirror/src/editor.ts:635

`Private` _onDocChanged

_onDocChanged(update): void
Handles document changes.
Parameters
- update: ViewUpdate
Returns void
- Defined in packages/codemirror/src/editor.ts:681

`Private` _onMimeTypeChanged

_onMimeTypeChanged(): void
Handles a mime type change.

Returns void
- Defined in packages/codemirror/src/editor.ts:612

`Private` _toCodeMirrorPosition

_toCodeMirrorPosition(position): {
ch: number;
line: number;
}
Convert an editor position to a code mirror position.
Parameters
- position: IPosition
Returns {
ch: number;
line: number;
}
- ch: number
- line: number
- Defined in packages/codemirror/src/editor.ts:671

`Private` _toPosition

_toPosition(position): {
column: number;
line: number;
}
Convert a code mirror position to an editor position.
Parameters
- position: {
  ch: number;
  line: number;
  }
  - ch: number
  - line: number
Returns {
column: number;
line: number;
}
- column: number
- line: number
- Defined in packages/codemirror/src/editor.ts:661

`Private` _toSelection

_toSelection(selection): ITextSelection
Converts a code mirror selection to an editor selection.
Parameters
- selection: {
      anchor: {
          ch: number;
          line: number;
      };
      head: {
          ch: number;
          line: number;
      };
  }
  - anchor: {
    ch: number;
    line: number;
    }
    - ch: number
    - line: number
  - head: {
    ch: number;
    line: number;
    }
    - ch: number
    - line: number
Returns ITextSelection
- Defined in packages/codemirror/src/editor.ts:647

blur

blur(): void
Explicitly blur the editor.

Returns void
Implementation of IEditor.blur
- Defined in packages/codemirror/src/editor.ts:298

clearHistory

clearHistory(): void
Clear the undo history.

Returns void
Implementation of IEditor.clearHistory
- Defined in packages/codemirror/src/editor.ts:277

cursorCoords

cursorCoords(where, mode?): {
    bottom: number;
    left: number;
    top: number;
}
Parameters
- where: boolean
- Optional mode: "window" | "page" | "local"
Returns {
    bottom: number;
    left: number;
    top: number;
}
- bottom: number
- left: number
- top: number
- Defined in packages/codemirror/src/editor.ts:315

dispose

dispose(): void
Dispose of the resources held by the widget.

Returns void
Implementation of IEditor.dispose
- Defined in packages/codemirror/src/editor.ts:177

execCommand

execCommand(command): void
Execute a codemirror command on the editor.
Parameters
- command: Command | StateCommand
  The name of the command to execute.
Returns void
- Defined in packages/codemirror/src/editor.ts:566

firstLine

firstLine(): number
Returns number
- Defined in packages/codemirror/src/editor.ts:306

focus

focus(): void
Brings browser focus to this editor text.

Returns void
Implementation of IEditor.focus
- Defined in packages/codemirror/src/editor.ts:284

getCoordinateForPosition

getCoordinateForPosition(position): null | ICoordinate
Get the window coordinates given a cursor position.
Parameters
- position: IPosition
Returns null | ICoordinate
Implementation of IEditor.getCoordinateForPosition
- Defined in packages/codemirror/src/editor.ts:359

getCursorPosition

getCursorPosition(): IPosition
Returns the primary position of the cursor, never null.

Returns IPosition
Implementation of IEditor.getCursorPosition
- Defined in packages/codemirror/src/editor.ts:388

getLine

getLine(line): undefined | string
Returns the content for the given line number.
Parameters
- line: number
Returns undefined | string
Implementation of IEditor.getLine
- Defined in packages/codemirror/src/editor.ts:237

getOffsetAt

getOffsetAt(position): number
Find an offset for the given position.
Parameters
- position: IPosition
Returns number
Implementation of IEditor.getOffsetAt
- Defined in packages/codemirror/src/editor.ts:246

getOption

getOption(option): unknown
Get a config option for the editor.
Parameters
- option: string
Returns unknown
Implementation of IEditor.getOption
- Defined in packages/codemirror/src/editor.ts:193

getPositionAt

getPositionAt(offset): IPosition
Find a position for the given offset.
Parameters
- offset: number
Returns IPosition
Implementation of IEditor.getPositionAt
- Defined in packages/codemirror/src/editor.ts:254

getPositionForCoordinate

getPositionForCoordinate(coordinate): null | IPosition
Get the cursor position given window coordinates.
Parameters
- coordinate: ICoordinate
  The desired coordinate.
Returns null | IPosition
The position of the coordinates, or null if not contained in the editor.
Implementation of IEditor.getPositionForCoordinate
- Defined in packages/codemirror/src/editor.ts:375

getRange

getRange(from, to, separator?): string
Parameters
- from: {
  ch: number;
  line: number;
  }
  - ch: number
  - line: number
- to: {
  ch: number;
  line: number;
  }
  - ch: number
  - line: number
- Optional separator: string
Returns string
- Defined in packages/codemirror/src/editor.ts:325

getSelection

getSelection(): ITextSelection
Returns the primary selection, never null.

Returns ITextSelection
Implementation of IEditor.getSelection
- Defined in packages/codemirror/src/editor.ts:421

getSelections

getSelections(): ITextSelection[]
Gets the selections for all the cursors, never null or empty.

Returns ITextSelection[]
Implementation of IEditor.getSelections
- Defined in packages/codemirror/src/editor.ts:435

getTokenAt

getTokenAt(offset): CodeEditor.IToken
Get the token at a given editor position.
Parameters
- offset: number
Returns CodeEditor.IToken
Implementation of IEditor.getTokenAt
- Defined in packages/codemirror/src/editor.ts:514

getTokenAtCursor

getTokenAtCursor(): CodeEditor.IToken
Get the token a the cursor position.

Returns CodeEditor.IToken
Implementation of IEditor.getTokenAtCursor
- Defined in packages/codemirror/src/editor.ts:547

getTokens

getTokens(): CodeEditor.IToken[]
Get a list of tokens for the current editor text content.

Returns CodeEditor.IToken[]
Implementation of IEditor.getTokens
- Defined in packages/codemirror/src/editor.ts:491

handleEvent

handleEvent(event): void
Handle the DOM events for the editor.
Parameters
- event: Event
  The DOM event sent to the editor.
  
  Notes
  This method implements the DOM EventListener interface and is called in response to events on the editor's DOM node. It should not be called directly by user code.
Returns void
- Defined in packages/codemirror/src/editor.ts:697

hasFocus

hasFocus(): boolean
Test whether the editor has keyboard focus.

Returns boolean
Implementation of IEditor.hasFocus
- Defined in packages/codemirror/src/editor.ts:291

hasOption

hasOption(option): boolean
Whether the option exists or not.
Parameters
- option: string
Returns boolean
- Defined in packages/codemirror/src/editor.ts:200

injectExtension

injectExtension(ext): void
Alpha Experimental
Inject an extension into the editor
Parameters
- ext: Extension
  CodeMirror 6 extension
Returns void
Implementation of IEditor.injectExtension
- Defined in packages/codemirror/src/editor.ts:230

lastLine

lastLine(): number
Returns number
- Defined in packages/codemirror/src/editor.ts:311

newIndentedLine

newIndentedLine(): void
Insert a new indented line at the current cursor position.

Returns void
Implementation of IEditor.newIndentedLine
- Defined in packages/codemirror/src/editor.ts:554

`Protected` onConfigChanged

onConfigChanged(configurator, changes): void
Parameters
- configurator: IExtensionsHandler
- changes: Record<string, any>
Returns void
- Defined in packages/codemirror/src/editor.ts:570

`Protected` onKeydown

onKeydown(event): boolean
Handle keydown events from the editor.
Parameters
- event: KeyboardEvent
Returns boolean
- Defined in packages/codemirror/src/editor.ts:580

redo

redo(): void
Redo one undone edit.

Returns void
Implementation of IEditor.redo
- Defined in packages/codemirror/src/editor.ts:270

replaceSelection

replaceSelection(text): void
Replaces the current selection with the given text.

Behaviour for multiple selections is undefined.
Parameters
- text: string
  The text to be inserted.
Returns void
Implementation of IEditor.replaceSelection
- Defined in packages/codemirror/src/editor.ts:475

revealPosition

revealPosition(position): void
Reveal the given position in the editor.
Parameters
- position: IPosition
Returns void
Implementation of IEditor.revealPosition
- Defined in packages/codemirror/src/editor.ts:338

revealSelection

revealSelection(selection): void
Reveal the given selection in the editor.
Parameters
- selection: IRange
Returns void
Implementation of IEditor.revealSelection
- Defined in packages/codemirror/src/editor.ts:348

setCursorPosition

setCursorPosition(position, options?): void
Set the primary position of the cursor.

Notes
This will remove any secondary cursors.
Parameters
- position: IPosition
- options: {
      bias?: number;
      origin?: string;
      scroll?: boolean;
  } = {}
  - Optional bias?: number
  - Optional origin?: string
  - Optional scroll?: boolean
Returns void
Deprecated
options bias and origin are not used
Implementation of IEditor.setCursorPosition
- Defined in packages/codemirror/src/editor.ts:401

setOption

setOption(option, value): void
Set a config option for the editor.
Parameters
- option: string
- value: unknown
Returns void
Implementation of IEditor.setOption
- Defined in packages/codemirror/src/editor.ts:207

setOptions

setOptions(options): void
Set config options for the editor.

This method is preferred when setting several options. The options are set within an operation, which only performs the costly update at the end, and not after every option is set.
Parameters
- options: Record<string, any>
Returns void
Implementation of IEditor.setOptions
- Defined in packages/codemirror/src/editor.ts:219

setSelection

setSelection(selection): void
Set the primary selection. This will remove any secondary cursors.
Parameters
- selection: IRange
Returns void
Implementation of IEditor.setSelection
- Defined in packages/codemirror/src/editor.ts:428

setSelections

setSelections(selections): void
Sets the selections for all the cursors, should not be empty. Cursors will be removed or added, as necessary. Passing an empty array resets a cursor position to the start of a document.
Parameters
- selections: IRange[]
Returns void
Implementation of IEditor.setSelections
- Defined in packages/codemirror/src/editor.ts:456

undo

undo(): void
Undo one edit (if any undo events are stored).

Returns void
Implementation of IEditor.undo
- Defined in packages/codemirror/src/editor.ts:263

Class CodeMirrorEditor

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CodeMirrorEditor

Properties

Private _configurator

Private _editor

Private _isDisposed

Private _language

Private _languages

Private _model

Private _uuid

Readonly edgeRequested

Readonly host

Accessors

charWidth

Returns number

doc

Returns Text

editor

Returns EditorView

isDisposed

Returns boolean

lineCount

Returns number

lineHeight

Returns number

model

Returns CodeEditor.IModel

state

Returns EditorState

uuid

Returns string

Parameters

Returns void

Methods

Private _evtBlur

Parameters

Returns void

Private _evtFocus

Parameters

Returns void

Private _onCursorActivity

Returns void

Private _onDocChanged

Parameters

Returns void

Private _onMimeTypeChanged

Returns void

Private _toCodeMirrorPosition

Parameters

Returns { ch: number; line: number; }

ch: number

line: number

Private _toPosition

Parameters

ch: number

line: number

Returns { column: number; line: number; }

column: number

line: number

Private _toSelection

Parameters

anchor: { ch: number; line: number; }

ch: number

line: number

head: { ch: number; line: number; }

ch: number

line: number

Returns ITextSelection

blur

Returns void

clearHistory

`Private` _configurator

`Private` _editor

`Private` _isDisposed

`Private` _language

`Private` _languages

`Private` _model

`Private` _uuid

`Readonly` edgeRequested

`Readonly` host

`Private` _evtBlur

`Private` _evtFocus

`Private` _onCursorActivity

`Private` _onDocChanged

`Private` _onMimeTypeChanged

`Private` _toCodeMirrorPosition

Returns {
ch: number;
line: number;
}

`Private` _toPosition

Returns {
column: number;
line: number;
}

`Private` _toSelection

anchor: {
ch: number;
line: number;
}

head: {
ch: number;
line: number;
}

Returns {
bottom: number;
left: number;
top: number;
}