A brief analysis of how to use monaco-editor in angular

How to use monaco-editor in

angular? The following article records the use of monaco-editor in angular that was used in a recent business. I hope it will be helpful to everyone!

Installation dependencies

In angular12 and before you can choose

• monaco-editor
• ngx-monaco-editor

This is no problem but if you use a higher version of angular, you will have to install ngx-monaco-editor using npm. Report an error. [Related tutorial recommendation: "angularjs video tutorial"]

Because the original author seems to have stopped maintaining this library, the final support remains at the angular12 version

Of course you can choose to use --force or --legacy-peer-deps as prompted to solve the problem

But in order to eliminate/avoid some hidden problems, I added it to the original author's Basically, the framework's angular support has been upgraded to 14 and will be updated continuously

@rickzhou/ngx-monaco-editor

github github.com/rick-chou/n…

npm www.npmjs.com/package/@ri…

Of course you can also choose to move the author's source code into your own local code, which is completely fine

• base-editor.ts introduces monaco-editor
• config.ts
• diff-editor.component.ts
• editor.component.ts
• editor.module.ts
• types.ts

##github.com/rick-chou/n…

You only need to move the lib directory Just download the six files and use them as a module in your own project

Use

In fact, all APIs are It can be found in the file

editor.api.d.ts

// 在这个editor下就可以找到所有TS类型
import { editor } from 'monaco-editor';

The following is a record of the commonly used

1, settings

// eg
export const READ_EDITOR_OPTIONS: editor.IEditorOptions = {
  readOnly: true,
  automaticLayout: false,
  minimap: {
    enabled: false,
  },
  renderFinalNewline: false,
  scrollbar: {
    vertical: 'visible',
  },
  mouseWheelZoom: true,
  contextmenu: false,
  fontSize: 16,
  scrollBeyondLastLine: false,
  smoothScrolling: true,
  cursorWidth: 0,
  renderValidationDecorations: 'off',
  colorDecorators: false,
  hideCursorInOverviewRuler: true,
  overviewRulerLanes: 0,
  overviewRulerBorder: false,
};

2, and acquisition editor example

<ngx-monaco-editor
  [options]="readEditorOptions"
  [(ngModel)]="originLogVal"
  (onInit)="initViewEditor($event, false)">
</ngx-monaco-editor>

public initViewEditor(editor: editor.ICodeEditor): void {
  // 这个editor就是实例
  // 下面方法中的editor就是这里的editor
  this.editor = editor
}

3. Get the current cursor position

editor.getPosition()

4. Get the text currently selected by the mouse

editor.getModel().getValueInRange(editor.getSelection());

5. Modify the cursor position

editor.setPosition({
      column: 1,
      lineNumber: 1,
    });

6 , scroll the specified line to the middle of the visual area

editor.revealLineInCenter(1);

7, bind events

editor.onMouseDown(event => {
  // do something
});
editor.onKeyDown(event => {
  // do something
});

8, save/restore snapshot

const snapshot = editor.saveViewState();
editor.restoreViewState(snapshot);

9, block an event

// eg 组件默认的搜索快捷键
function isMac() {
  return /macintosh|mac os x/i.test(navigator.userAgent);
}

editor.onKeyDown(event => {
  if (
    (isMac() && event.browserEvent.key === 'f' && event.metaKey) ||
    (!isMac() && event.browserEvent.key === 'f' && event.ctrlKey)
  ) {
    event.preventDefault();
    event.stopPropagation();
  }
});

For more programming-related knowledge, please visit:

Programming Video! !

The above is the detailed content of A brief analysis of how to use monaco-editor in angular. For more information, please follow other related articles on the PHP Chinese website!