@covalent/code-editor

TdCodeEditorComponent: td-code-editor

is component for code editing based on Covalent and Monaco Editor. The component can run in both Electron and Web Browsers.

API Summary

#### Inputs

- value?: string
- value of the code editor instance
- language?: string
- language used for syntax in the editor instance
- registerLanguage?: function()
- registers a custom Language within the editor
- editorStyle?: string
- Additional Styling applied to Editor Container
- theme?: string
- Theme used to style the Editor
- editorOptions?: object
- Editor Options Object of valid Configurations listed here: https://microsoft.github.io/monaco-editor/api/interfaces/monaco.editor.ieditoroptions.html
- layout?: function()
- Instructs the editor to remeasure its container

#### Properties

- isFullScreen?: boolean
- Is the editor currently in Full Screen mode
- fullScreenKeyBinding?: number
- Sets the KeyCode for shortcutting to Fullscreen. Options listed see here: https://microsoft.github.io/monaco-editor/api/enums/monaco.keycode.html

#### Events

- editorInitialized?: function($event)
- Emitted when Editor is finished initializing. Event passes a reference to the actual editor instance that can be used to call additional operations outside of the Angular component.
- editorConfigurationChanged?: function($event)
- Emitted when configuration of the Editor changes
- editorLanguageChanged?: function($event)
- Emitted when the language of the Editor changes

Installation

This component can be installed as npm package.

``bash
npm install @covalent/code-editor
`

Setup

Due to an known issue in Monaco Editor version 0.20.0 https://github.com/microsoft/monaco-editor/issues/1842 regarding errors arising when quickly disposing editor instances, utilize the 0.17.1 version of monaco-editor.

If you notice issues with icons not loading there's a known issue with css-loader that prevents it from loading the file font correctly https://github.com/microsoft/monaco-editor/issues/2742 downgrade to css-loader@5.2.7.

We utilize the ESM build of the Monaco Editor. To include this build, you must utilize custom webpack. See https://github.com/Microsoft/monaco-editor/blob/master/docs/integrate-esm.md for more information.

Install the webpack custom builder.

`bash
npm install --save-dev @angular-builders/custom-webpack
`

Install the Monaco Editor webpack extension plugin.

`bash
npm install --save-dev monaco-editor-webpack-plugin
`

Create a webpack config file utilizing the Monaco Editor webpack plugin. Languages and features can be included/excluded to control the resulting image size.

`javascript
const MonacoWebpackPlugin = require('monaco-editor-webpack-plugin');

module.exports = {
// target should only be specified when including component in Electron app
target: 'electron-renderer',
module: {
rules: [
{
test: /\.css$/,
use: ['style-loader'],
},
{
test: /\.ttf$/,
type: 'asset/resource',
},
],
},
plugins: [
new MonacoWebpackPlugin({
languages: ['css', 'html', 'javascript', 'sql', 'typescript'],
features: ['contextmenu', 'clipboard', 'find'],
}),
],
};
`

If using Webpack 4 or lower, it is necessary to use the file-loader instead of Asset Modules like the code below:

`javascript
{
test: /\.ttf$/,
use: ['file-loader']
}
`

Note: If you are including this component in an Electron application, define the electron-renderer target. See Electron example here:
https://github.com/Teradata/covalent-electron/blob/main/monaco-webpack.config.js

Reference the webpack file in your angular.json build config.

`json
...
"build": {
"builder": "@angular-builders/custom-webpack:browser",
"options": {
"customWebpackConfig": {
"path": "./monaco-webpack.config.js",
"mergeStrategies": {
"module.rules": "prepend"
}
},
...
`

Import the CovalentCodeEditorModule in your NgModule:

`typescript
import { CovalentCodeEditorModule } from '@covalent/code-editor';
@NgModule({
imports: [
CovalentCodeEditorModule,
...
],
...
})
export class MyModule {}
`

Example

`html

`

Running unit tests

Run nx test angular-code-editor` to execute the unit tests.