浅析angular中怎么使用monaco-editor

263 阅读 0 评论 174 点赞

我是靠谱客的博主悲凉砖头，这篇文章主要介绍浅析angular中怎么使用monaco-editor，现在分享给大家，希望可以做个参考。

angular中怎么使用monaco-editor？下面本篇文章记录下最近的一次业务中用到的 monaco-editor 在 angular 中的使用，希望对大家有所帮助！

安装依赖

在 angular12 及之前你可以选择

monaco-editor
ngx-monaco-editor

这是没有问题的但是如果你使用了更高版本的 angular 在使用 npm 安装 ngx-monaco-editor 时会报错。【相关教程推荐：《angularjs视频教程》】

因为原作者似乎已经停止了对这个库的维护最终的支持停留在了 angular12 版本

当然你选择可以选择正如提示那样用 --force 或者 --legacy-peer-deps 来解决问题

但是为了消除/避免隐藏的一些问题我在原作者的基础上将框架的 angular 支持提升到了 14 并且会一直更新

当然你也可以选择将作者的源代码移入自己的本地代码中这也是完全没有问题的

base-editor.ts 引入 monaco-editor
config.ts
diff-editor.component.ts
editor.component.ts
editor.module.ts
types.ts

你只需要移动 lib 目录下的六个文件然后把它们当成自己项目中的一个 module 去使用就好了

使用

其实所有的 api 都可以在 editor.api.d.ts 这个文件中找到

复制代码// 在这个editor下就可以找到所有TS类型
import { editor } from 'monaco-editor';1
2
// 在这个editor下就可以找到所有TS类型
import { editor } from 'monaco-editor';
登录后复制

下面记录一下常用的

1、设置

复制代码// 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,
};1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// 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、获取editor实例

复制代码<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
}1
2
3
4
5
6
7
8
9
10
11
<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、获取当前光标位置

复制代码editor.getPosition()1
editor.getPosition()
登录后复制

4、获取当前鼠标选中的文本

复制代码editor.getModel().getValueInRange(editor.getSelection());1
editor.getModel().getValueInRange(editor.getSelection());
登录后复制

5、修改光标位置

复制代码editor.setPosition({
      column: 1,
      lineNumber: 1,
    });1
2
3
4
editor.setPosition({
      column: 1,
      lineNumber: 1,
    });
登录后复制

6、滚动指定行到可视区中间

复制代码editor.revealLineInCenter(1);1
editor.revealLineInCenter(1);
登录后复制

7、绑定事件

复制代码editor.onMouseDown(event => {
  // do something
});
editor.onKeyDown(event => {
  // do something
});1
2
3
4
5
6
editor.onMouseDown(event => {
  // do something
});
editor.onKeyDown(event => {
  // do something
});
登录后复制

8、保存/恢复快照

复制代码const snapshot = editor.saveViewState();
editor.restoreViewState(snapshot);1
2
const snapshot = editor.saveViewState();
editor.restoreViewState(snapshot);
登录后复制

9、阻止某个事件

复制代码// 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();
  }
});1
2
3
4
5
6
7
8
9
10
11
12
13
14
// 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();
  }
});
登录后复制