Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atularen/ngx-monaco-editor
Monaco Editor component for Angular 2 and Above
https://github.com/atularen/ngx-monaco-editor
angular angular2 angular4 angular5 angular6 angular7 angular8 monaco-editor
Last synced: about 4 hours ago
JSON representation
Monaco Editor component for Angular 2 and Above
- Host: GitHub
- URL: https://github.com/atularen/ngx-monaco-editor
- Owner: atularen
- License: mit
- Created: 2017-08-10T18:13:32.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-02T13:39:09.000Z (5 months ago)
- Last Synced: 2024-11-29T13:47:41.112Z (13 days ago)
- Topics: angular, angular2, angular4, angular5, angular6, angular7, angular8, monaco-editor
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/ngx-monaco-editor
- Size: 828 KB
- Stars: 428
- Watchers: 16
- Forks: 154
- Open Issues: 146
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
- awesome-angular - ngx-monaco-editor - Monaco Editor component for Angular 2 and Above. (Uncategorized / Uncategorized)
README
# Monaco Editor Component for Angular 2 and above.
- Angular <= 4: v3.x.x
- Angular 5: v5.x.x
- Angular 6: v6.x.x
- Angular 7: v7.x.x
- Angular 8: v8.x.x
- Angular 9: v9.x.x
- Angular 10: v10.x.x
- Angular 12: v12.x.x
Using this Module you can utilize the Monaco Editor as an Angular Component. Feel free to contribute, raise feature requests and make it better.
Supports all the options available in monaco-editor [Monaco Editor Options](https://microsoft.github.io/monaco-editor/api/interfaces/monaco.editor.ieditorconstructionoptions.html)
## Setup
### Installation
Install from npm repository:
```
npm install monaco-editor ngx-monaco-editor --save
```
For angular version 6 use v6.x.x
```
npm install [email protected] --save
```
Add the glob to assets in `.angular-cli.json` schema - `projects.[project-name].architect.build` (to make monaco-editor lib available to the app):
```typescript
{
"options": {
{
"assets": [
{ "glob": "**/*", "input": "node_modules/monaco-editor", "output": "assets/monaco-editor" }
],
...
}
...
},
...
}
```
For Angular 6 and below, add the glob to assets in `angular.json`
```typescript
{
"apps": [
{
"assets": [
{ "glob": "**/*", "input": "../node_modules/ngx-monaco-editor/assets/monaco", "output": "./assets/monaco/" }
],
...
}
...
],
...
}
```
### Sample
Include MonacoEditorModule in Main Module and Feature Modules where you want to use the editor component.(eg: app.module.ts):
```typescript
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { FormsModule } from '@angular/forms';
import { AppComponent } from './app.component';
import { MonacoEditorModule } from 'ngx-monaco-editor';
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
FormsModule,
MonacoEditorModule.forRoot() // use forRoot() in main app module only.
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule {
}
```
Create Editor options in component.(eg: app.component.ts)
```typescript
import { Component } from '@angular/core';
@Component({
selector: 'app-root',
templateUrl: './app.component.html'
})
export class AppComponent {
editorOptions = {theme: 'vs-dark', language: 'javascript'};
code: string= 'function x() {\nconsole.log("Hello world!");\n}';
}
```
Include editor in html with options and ngModel bindings.(eg: app.component.html)
```html
```
Include diff-editor in html with options.(eg: app.component.html)
```html
```
```typescript
import { Component } from '@angular/core';
import { DiffEditorModel } from 'ngx-monaco-editor';
@Component({
selector: 'app-root',
templateUrl: './app.component.html'
})
export class AppComponent {
options = {
theme: 'vs-dark'
};
originalModel: DiffEditorModel = {
code: 'heLLo world!',
language: 'text/plain'
};
modifiedModel: DiffEditorModel = {
code: 'hello orlando!',
language: 'text/plain'
};
}
```
### Styling
To match height of container element add height: 100% and wrap in container
```html
```
Add class to editor tag. (eg. class="my-code-editor")
```html
```
Add styling in css/scss file:
```scss
.my-code-editor {
.editor-container {
height: calc(100vh - 100px);
}
}
```
Set automaticLayout option to adjust editor size dynamically. Recommended when using in modal dialog or tabs where editor is not visible initially.
### Events
Output event (onInit) expose editor instance that can be used for performing custom operations on the editor.
```html
```
```typescript
export class AppComponent {
editorOptions = {theme: 'vs-dark', language: 'javascript'};
code: string= 'function x() {\nconsole.log("Hello world!");\n}';
onInit(editor) {
let line = editor.getPosition();
console.log(line);
}
}
```
## Configurations
`forRoot()` method of MonacoEditorModule accepts config of type `NgxMonacoEditorConfig`.
```typescript
import { NgModule } from '@angular/core';
import { FormsModule } from '@angular/forms';
import { BrowserModule } from '@angular/platform-browser';
import { MonacoEditorModule, NgxMonacoEditorConfig } from 'ngx-monaco-editor';
import { AppComponent } from './app.component';
const monacoConfig: NgxMonacoEditorConfig = {
baseUrl: 'app-name/assets', // configure base path cotaining monaco-editor directory after build default: './assets'
defaultOptions: { scrollBeyondLastLine: false }, // pass default options to be used
onMonacoLoad: () => { console.log((window).monaco); } // here monaco object will be available as window.monaco use this function to extend monaco editor functionalities.
};
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
FormsModule,
MonacoEditorModule.forRoot(monacoConfig)
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule {
}
```
### Configure JSON Defaults
`onMonacoLoad` property of `NgxMonacoEditorConfig` can be used to configure JSON default.
```typescript
import { NgModule } from '@angular/core';
import { FormsModule } from '@angular/forms';
import { BrowserModule } from '@angular/platform-browser';
import { MonacoEditorModule, NgxMonacoEditorConfig } from 'ngx-monaco-editor';
import { AppComponent } from './app.component';
export function onMonacoLoad() {
console.log((window as any).monaco);
const uri = monaco.Uri.parse('a://b/foo.json');
monaco.languages.json.jsonDefaults.setDiagnosticsOptions({
validate: true,
schemas: [{
uri: 'http://myserver/foo-schema.json',
fileMatch: [uri.toString()],
schema: {
type: 'object',
properties: {
p1: {
enum: ['v1', 'v2']
},
p2: {
$ref: 'http://myserver/bar-schema.json'
}
}
}
}, {
uri: 'http://myserver/bar-schema.json',
fileMatch: [uri.toString()],
schema: {
type: 'object',
properties: {
q1: {
enum: ['x1', 'x2']
}
}
}
}]
});
}
const monacoConfig: NgxMonacoEditorConfig = {
baseUrl: 'assets',
defaultOptions: { scrollBeyondLastLine: false },
onMonacoLoad
};
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
FormsModule,
MonacoEditorModule.forRoot(monacoConfig)
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule {
}
```
Now pass model config of type `NgxEditorModel` to Editor Component
```typescript
@Component({
selector: 'app-root',
template: ``,
styles: []
})
export class AppComponent {
options = {
theme: 'vs-dark'
};
jsonCode = [
'{',
' "p1": "v3",',
' "p2": false',
'}'
].join('\n');
model: NgxEditorModel = {
value: this.jsonCode,
language: 'json',
uri: monaco.Uri.parse('a://b/foo.json')
};
}
```
## Links
[Monaco Editor](https://github.com/Microsoft/monaco-editor/)
[Monaco Editor Options](https://microsoft.github.io/monaco-editor/api/interfaces/monaco.editor.ieditorconstructionoptions.html)
## License
MIT © [Atul Kumar](https://github.com/atularen)