@ng-util/monaco-editor

Monaco Code Editor for Angular.

Inspired by ngx-monaco-editor.

Demo

• Stackblitz
• Codesandbox

Usage

Installation

Install from npm repository:

1npm install @ng-util/monaco-editor --save

Configure monaco-editor library

Currently this library only supports load monaco-editor with AMD mode. The default is to use cdn (https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.20.0/min) lazy loading。

If you are using local monaco editor library, you could add the following:

"assets": [
  {
    "glob": "**/*",
    "input": "node_modules/monaco-editor/min/vs",
    "output": "/lib/vs"
  }
],

And configure baseUrl via NuMonacoEditorModule.forRoot.

1NuMonacoEditorModule.forRoot({
2  baseUrl: `lib`,
3}),

Sample

Include NuMonacoEditorModule in Main Module and Feature Modules where you want to use the editor component.(eg: app.module.ts):

1import { NgModule } from '@angular/core';
2import { NuMonacoEditorModule } from '@ng-util/monaco-editor';
3
4@NgModule({
5  imports: [
6    NuMonacoEditorModule  // And use `provideNuMonacoEditorConfig` to modify the global configuration
7  ],
8})
9export class AppModule { }

Create Editor options in component.

1import { Component } from '@angular/core';
2
3@Component({
4  selector: 'app-root',
5  template: `<nu-monaco-editor [(ngModel)]="value" [options]="editorOptions"></nu-monaco-editor>`,
6})
7export class DemoComponent {
8  value: string = 'const a = 1;';
9  editorOptions = { theme: 'vs-dark', language: 'typescript' };
10}

Or monaco diff editor:

1import { Component } from '@angular/core';
2import { NuMonacoEditorDiffModel } from '@ng-util/monaco-editor';
3
4@Component({
5  selector: 'app-root',
6  template: `<nu-monaco-diff-editor [options]="editorOptions" [old]="old" [new]="new"></nu-monaco-diff-editor>`,
7})
8export class DemoComponent {
9  editorOptions = { theme: 'vs-dark', language: 'javascript' };
10  old: NuMonacoEditorDiffModel = { code: `<p>1</p>` };
11  new: NuMonacoEditorDiffModel = { code: `<p>2</p>` };
12}

Events

Output event can be divided into different stages of feedback according to the type attribute. When you need to initialize init, you can program the editor in one step.

1import { Component } from '@angular/core';
2import { NuMonacoEditorEvent } from '@ng-util/monaco-editor';
3
4@Component({
5  selector: 'app-root',
6  template: `<nu-monaco-editor [(ngModel)]="value" [options]="editorOptions" (event)="showEvent($event)"></nu-monaco-editor>`,
7})
8export class DemoComponent {
9  value: string = 'const a = 1;';
10  editorOptions = { theme: 'vs-dark', language: 'javascript' };
11
12  showEvent(e: NuMonacoEditorEvent): void {
13    if (e.type === 'init') {
14      // doing
15    }
16  }
17}

Configurations

forRoot() method of NuMonacoEditorModule accepts config of type NuMonacoEditorConfig.

1NuMonacoEditorModule.forRoot({
2  baseUrl: ``, // The base URL to monaco editor library assets via AMD (RequireJS), Default: `https://cdnjs.cloudflare.com/ajax/libs/monaco-editor/0.20.0/min`
3  defaultOptions: {}, // Default options when creating editors
4  monacoLoad: (m) => {} // The event after the first loading of the monaco editor library is completed, use this function to extend monaco editor functionalities.
5}),

Configure JSON Defaults

monacoLoad property of NuMonacoEditorConfig can be used to configure JSON default.

1NuMonacoEditorModule.forRoot({
2  defaultOptions: { scrollBeyondLastLine: false },
3  monacoLoad: () => {
4    const uri = monaco.Uri.parse('a://b/foo.json');
5    monaco.languages.json.jsonDefaults.setDiagnosticsOptions({
6      validate: true,
7      schemas: [
8        {
9          uri: 'http://myserver/foo-schema.json',
10          fileMatch: [uri.toString()],
11          schema: {
12            type: 'object',
13            properties: {
14              p1: {
15                enum: ['v1', 'v2'],
16              },
17              p2: {
18                $ref: 'http://myserver/bar-schema.json',
19              },
20            },
21          },
22        },
23        {
24          uri: 'http://myserver/bar-schema.json',
25          fileMatch: [uri.toString()],
26          schema: {
27            type: 'object',
28            properties: {
29              q1: {
30                enum: ['x1', 'x2'],
31              },
32            },
33          },
34        },
35      ],
36    });
37  },
38}),

Now pass model config of type NuMonacoEditorModule to Editor Component.

1import { Component } from '@angular/core';
2import { NuMonacoEditorEvent, NuMonacoEditorModel } from '@ng-util/monaco-editor';
3
4@Component({
5  selector: 'app-demo',
6  template: `
7  <nu-monaco-editor #a [(ngModel)]="value" [model]="model" (event)="showEvent($event)"></nu-monaco-editor>
8  <button (click)="a.editor.getAction('editor.action.formatDocument').run()">Format document</button>
9  `,
10})
11export class DemoComponent {
12  value = '{"p1":"a"}';
13  model: NuMonacoEditorModel;
14
15  showEvent(e: NuMonacoEditorEvent) {
16    if (e.type === 'init') {
17      this.model = {
18        language: 'json',
19        uri: monaco.Uri.parse('a://b/foo.json'),
20      };
21    }
22  }
23}

API

nu-monaco-editor

Property	Description	Type	Default
[placeholder]	Placeholder of monaco editor, Can change the style via defining the .monaco-editor-placeholder CSS.	string	-
[height]	Height of monaco editor	string	200px
[disabled]	Disabled of monaco editor	boolean	false
[autoFormat]	Whether to automatically format the document	boolean	true
[options]	Default options when creating editors	monaco.editor.IStandaloneEditorConstructionOptions	-
[model]	Model of monaco editor	NuMonacoEditorModel	-
[delay]	Delay init monaco editor, unit: ms	number	0
(event)	Event callback	EventEmitter<NuMonacoEditorEvent>	-

nu-monaco-diff-editor

Property	Description	Type	Default
[height]	Height of monaco editor	string	200px
[disabled]	Disabled of monaco editor	boolean	false
[options]	Default options when creating editors	monaco.editor.IStandaloneEditorConstructionOptions	-
[old]	Old model of monaco editor	NuMonacoEditorDiffModel	-
[new]	New model of monaco editor	NuMonacoEditorDiffModel	-
[delay]	Delay init monaco editor, unit: ms	number	0
(event)	Event callback	EventEmitter<NuMonacoEditorEvent>	-

License

The MIT License (see the LICENSE file for the full text)