Class MonacoEditorProvider

Constructors

constructor

new MonacoEditorProvider(
    m2p: MonacoToProtocolConverter,
    p2m: ProtocolToMonacoConverter,
    workspace: MonacoWorkspace,
    editorPreferences: EditorPreferences,
    diffNavigatorFactory: MonacoDiffNavigatorFactory,
): MonacoEditorProvider
Parameters
- m2p: MonacoToProtocolConverter
- p2m: ProtocolToMonacoConverter
- workspace: MonacoWorkspace
- editorPreferences: EditorPreferences
- diffNavigatorFactory: MonacoDiffNavigatorFactory
Returns MonacoEditorProvider
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:101

Properties

`Protected`_current

_current: undefined | MonacoEditor

`Protected` `Readonly`diffNavigatorFactory

diffNavigatorFactory: MonacoDiffNavigatorFactory

`Protected` `Readonly`editorPreferences

editorPreferences: EditorPreferences

`Protected` `Readonly`factories

factories: ContributionProvider<MonacoEditorFactory>

`Protected` `Readonly`filePreferences

filePreferences: FileSystemPreferences

`Protected` `Readonly`keybindingRegistry

keybindingRegistry: KeybindingRegistry

`Protected` `Readonly`m2p

m2p: MonacoToProtocolConverter

`Protected` `Readonly`openerService

openerService: OpenerService

`Protected` `Readonly`p2m

p2m: ProtocolToMonacoConverter

`Protected`saveParticipants

saveParticipants: SaveParticipant[]

`Static`inlineOptions

inlineOptions: IEditorConstructionOptions = ...

Accessors

current

get current(): undefined | MonacoEditor
Returns the last focused MonacoEditor. It takes into account inline editors as well. If you are interested only in standalone editors then use MonacoEditor.getCurrent(EditorManager)

Returns undefined | MonacoEditor
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:97

`Protected`diffPreferencePrefixes

get diffPreferencePrefixes(): string[]
Returns string[]
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:260

`Protected`preferencePrefixes

get preferencePrefixes(): string[]
Returns string[]
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:214

Methods

`Protected`createEditor

createEditor(
    uri: URI,
    override: EditorServiceOverrides,
    toDispose: DisposableCollection,
): Promise<MonacoEditor>
Parameters
- uri: URI
- override: EditorServiceOverrides
- toDispose: DisposableCollection
Returns Promise<MonacoEditor>
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:207

createEmbeddedDiffEditor

createEmbeddedDiffEditor(
    parentEditor: MonacoEditor,
    node: HTMLElement,
    originalUri: URI,
    modifiedUri?: URI,
    options?: MonacoDiffEditor.IOptions,
): Promise<MonacoDiffEditor>
Parameters
- parentEditor: MonacoEditor
- node: HTMLElement
- originalUri: URI
- modifiedUri: URI = parentEditor.uri
- Optionaloptions: MonacoDiffEditor.IOptions
Returns Promise<MonacoDiffEditor>
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:439

createInline

createInline(
    uri: URI,
    node: HTMLElement,
    options?: MonacoEditor.IOptions,
): Promise<MonacoEditor>
Creates an instance of the standard MonacoEditor with a StandaloneCodeEditor as its Monaco delegate. Among other differences, these editors execute basic actions like typing or deletion via commands that may be overridden by extensions.
Parameters
- uri: URI
- node: HTMLElement
- Optionaloptions: MonacoEditor.IOptions
Returns Promise<MonacoEditor>
Deprecated
Most use cases for inline editors should be served by createSimpleInline instead.
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:358

`Protected`createMonacoDiffEditor

createMonacoDiffEditor(
    uri: URI,
    override: EditorServiceOverrides,
    toDispose: DisposableCollection,
): Promise<MonacoDiffEditor>
Parameters
- uri: URI
- override: EditorServiceOverrides
- toDispose: DisposableCollection
Returns Promise<MonacoDiffEditor>
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:263

`Protected`createMonacoDiffEditorOptions

createMonacoDiffEditorOptions(
original: MonacoEditorModel,
modified: MonacoEditorModel,
): MonacoDiffEditor.IOptions
Parameters
- original: MonacoEditorModel
- modified: MonacoEditorModel
Returns MonacoDiffEditor.IOptions
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:286

createMonacoEditor

createMonacoEditor(
    uri: URI,
    override: EditorServiceOverrides,
    toDispose: DisposableCollection,
): Promise<MonacoEditor>
Parameters
- uri: URI
- override: EditorServiceOverrides
- toDispose: DisposableCollection
Returns Promise<MonacoEditor>
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:217

`Protected`createMonacoEditorOptions

createMonacoEditorOptions(model: MonacoEditorModel): MonacoEditor.IOptions
Parameters
- model: MonacoEditorModel
Returns MonacoEditor.IOptions
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:239

`Protected`createOptions

createOptions(prefixes: string[], uri: string): Record<string, any>
Parameters
- prefixes: string[]
- uri: string
Returns Record<string, any>
Deprecated
always pass a language as an overrideIdentifier
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:306
createOptions(
    prefixes: string[],
    uri: string,
    overrideIdentifier: string,
): Record<string, any>
Parameters
- prefixes: string[]
- uri: string
- overrideIdentifier: string
Returns Record<string, any>
Deprecated
always pass a language as an overrideIdentifier
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:307

createSimpleInline

createSimpleInline(
    uri: URI,
    node: HTMLElement,
    options?: MonacoEditor.IOptions,
    widgetOptions?: ICodeEditorWidgetOptions,
): Promise<SimpleMonacoEditor>
Creates an instance of the standard MonacoEditor with a CodeEditorWidget as its Monaco delegate. In addition to the service customizability of the StandaloneCodeEditor,This editor allows greater customization the editor contributions active in the widget. See ICodeEditorWidgetOptions.contributions.
Parameters
- uri: URI
- node: HTMLElement
- Optionaloptions: MonacoEditor.IOptions
- OptionalwidgetOptions: ICodeEditorWidgetOptions
Returns Promise<SimpleMonacoEditor>
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:386

`Protected`doCreateEditor

doCreateEditor<T>(
    uri: URI,
    factory: (
        override: EditorServiceOverrides,
        toDispose: DisposableCollection,
    ) => Promise<T>,
): Promise<T>
Type Parameters
- T
Parameters
- uri: URI
- factory: (
  override: EditorServiceOverrides,
  toDispose: DisposableCollection,
  ) => Promise<T>
Returns Promise<T>
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:129

`Protected`doSetOption

doSetOption(obj: Record<string, any>, value: any, names: string[]): void
Parameters
- obj: Record<string, any>
- value: any
- names: string[]
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:331

`Protected`formatOnSave

formatOnSave(
    editor: MonacoEditor,
    model: MonacoEditorModel,
    cancellationToken: CancellationToken,
    options: SaveOptions,
): Promise<void>
Parameters
- editor: MonacoEditor
- model: MonacoEditorModel
- cancellationToken: CancellationToken
- options: SaveOptions
Returns Promise<void>
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:534

get

get(uri: URI): Promise<MonacoEditor>
Parameters
- uri: URI
Returns Promise<MonacoEditor>
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:124

getDiffNavigator

getDiffNavigator(editor: TextEditor): DiffNavigator
Parameters
- editor: TextEditor
Returns DiffNavigator
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:346

`Protected`getModel

getModel(uri: URI, toDispose: DisposableCollection): Promise<MonacoEditorModel>
Parameters
- uri: URI
- toDispose: DisposableCollection
Returns Promise<MonacoEditorModel>
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:110

init

init(): void
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:478

`Protected`injectKeybindingResolver

injectKeybindingResolver(editor: MonacoEditor): void
Parameters
- editor: MonacoEditor
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:192

`Protected`insertFinalNewline

insertFinalNewline(editorModel: MonacoEditorModel): void
Parameters
- editorModel: MonacoEditorModel
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:563

`Protected`interceptOpen

interceptOpen(
monacoUri: string | Uri,
monacoOptions?: OpenInternalOptions | OpenExternalOptions,
): Promise<boolean>
Intercept internal Monaco open calls and delegate to OpenerService.
Parameters
- monacoUri: string | Uri
- OptionalmonacoOptions: OpenInternalOptions | OpenExternalOptions
Returns Promise<boolean>
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:166

registerSaveParticipant

registerSaveParticipant(saveParticipant: SaveParticipant): Disposable
Parameters
- saveParticipant: SaveParticipant
Returns Disposable
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:489

runSaveParticipants

runSaveParticipants(
    editor: MonacoEditor,
    cancellationToken: CancellationToken,
    options?: SaveOptions,
): Promise<void>
Parameters
- editor: MonacoEditor
- cancellationToken: CancellationToken
- Optionaloptions: SaveOptions
Returns Promise<void>
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:515

`Protected`setOption

setOption(
    preferenceName: string,
    value: any,
    prefixes: string[],
    options?: Record<string, any>,
): { [name: string]: any }
Parameters
- preferenceName: string
- value: any
- prefixes: string[]
- options: Record<string, any> = {}
Returns { [name: string]: any }
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:316

`Protected`shouldFormat

shouldFormat(model: MonacoEditorModel, options: SaveOptions): boolean
Parameters
- model: MonacoEditorModel
- options: SaveOptions
Returns boolean
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:503

`Protected`toOptionName

toOptionName(preferenceName: string, prefixes: string[]): string
Parameters
- preferenceName: string
- prefixes: string[]
Returns string
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:323

`Protected`updateMonacoDiffEditorOptions

updateMonacoDiffEditorOptions(
    editor: MonacoDiffEditor,
    event?: EditorPreferenceChange,
    resourceUri?: string,
): void
Parameters
- editor: MonacoDiffEditor
- Optionalevent: EditorPreferenceChange
- OptionalresourceUri: string
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:293

`Protected`updateMonacoEditorOptions

updateMonacoEditorOptions(
editor: MonacoEditor,
event?: EditorPreferenceChange,
): void
Parameters
- editor: MonacoEditor
- Optionalevent: EditorPreferenceChange
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:247

`Protected`updateReadOnlyMessage

updateReadOnlyMessage(
options: MonacoEditor.IOptions,
readOnly: boolean | MarkdownString,
): void
Parameters
- options: MonacoEditor.IOptions
- readOnly: boolean | MarkdownString
Returns void
- Defined in packages/monaco/src/browser/monaco-editor-provider.ts:235

Class MonacoEditorProvider

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MonacoEditorProvider

Properties

Protected_current

Protected ReadonlydiffNavigatorFactory

Protected ReadonlyeditorPreferences

Protected Readonlyfactories

Protected ReadonlyfilePreferences

Protected ReadonlykeybindingRegistry

Protected Readonlym2p

Protected ReadonlyopenerService

Protected Readonlyp2m

ProtectedsaveParticipants

Protected ReadonlysaveProviderContributions

Protected Readonlyservices

Protected Readonlyworkspace

StaticinlineOptions

Accessors

current

Returns undefined | MonacoEditor

ProtecteddiffPreferencePrefixes

Returns string[]

ProtectedpreferencePrefixes

Returns string[]

Methods

ProtectedcreateEditor

Parameters

Returns Promise<MonacoEditor>

createEmbeddedDiffEditor

Parameters

Returns Promise<MonacoDiffEditor>

createInline

Parameters

Returns Promise<MonacoEditor>

Deprecated

ProtectedcreateMonacoDiffEditor

Parameters

Returns Promise<MonacoDiffEditor>

ProtectedcreateMonacoDiffEditorOptions

Parameters

Returns MonacoDiffEditor.IOptions

createMonacoEditor

Parameters

Returns Promise<MonacoEditor>

ProtectedcreateMonacoEditorOptions

Parameters

Returns MonacoEditor.IOptions

ProtectedcreateOptions

Parameters

Returns Record<string, any>

Deprecated

Parameters

Returns Record<string, any>

Deprecated

createSimpleInline

Parameters

Returns Promise<SimpleMonacoEditor>

ProtecteddoCreateEditor

Type Parameters

Parameters

Returns Promise<T>

ProtecteddoSetOption

Parameters

Returns void

ProtectedformatOnSave

Parameters

Returns Promise<void>

get

Parameters

Returns Promise<MonacoEditor>

getDiffNavigator

Parameters

`Protected`_current

`Protected` `Readonly`diffNavigatorFactory

`Protected` `Readonly`editorPreferences

`Protected` `Readonly`factories

`Protected` `Readonly`filePreferences

`Protected` `Readonly`keybindingRegistry

`Protected` `Readonly`m2p

`Protected` `Readonly`openerService

`Protected` `Readonly`p2m

`Protected`saveParticipants

`Protected` `Readonly`saveProviderContributions

`Protected` `Readonly`services

`Protected` `Readonly`workspace

`Static`inlineOptions

`Protected`diffPreferencePrefixes

`Protected`preferencePrefixes

`Protected`createEditor

`Protected`createMonacoDiffEditor

`Protected`createMonacoDiffEditorOptions

`Protected`createMonacoEditorOptions

`Protected`createOptions

`Protected`doCreateEditor

`Protected`doSetOption

`Protected`formatOnSave

`Protected`getModel

`Protected`injectKeybindingResolver

`Protected`insertFinalNewline

`Protected`interceptOpen

`Protected`setOption

`Protected`shouldFormat

`Protected`toOptionName

`Protected`updateMonacoDiffEditorOptions

`Protected`updateMonacoEditorOptions

`Protected`updateReadOnlyMessage