Code mirror web component



This is a wrapper for CodeMirror library. It has been adjusted to work inside shadow DOM.
The component is used by Advanced REST Client and API Console.

Required imports

CodeMirror library has to be included into the document before inserting this element to the DOM.
CodeMirror 6 possibly will be working with ES imports but this is not set in stone at the moment.

Below is the default set of scripts to be added to the document.

``html







`

If you are using JSON linter

`html




`

Finally, if your application will use modes that aren't included in the document, you should set import URI. This will be used to resolve modes dependencies.

`html

`

Accessing options

The element exposes setOption() function that should be used to directly set editor option.

`javascript
cm.setOption('extraKeys', {
'Ctrl-Space': (cm) => {
CodeMirror.showHint(cm, CodeMirror.hint['http-headers'], {
container: containerRef
});
}
});
`

Additionally, the element has the editor property which is a reference to the CodeMirror instance.

Rendering hidden element

If the element is active but not visible then you may need to call refresh() function on a CodeMirror instance
after showing the element.

`javascript
parent.style.display = 'block';
cm.editor.refresh();
`

Styling

See codemirror-styles.js file for CSS variables definition.

Usage

$3

`sh
npm install --save @advanced-rest-client/code-mirror
`

$3

`html






function myScript() {
return 100;
}



`

$3

`js
import { LitElement, html } from 'lit-element';
import '@advanced-rest-client/code-mirror/code-mirror.js';

class SampleElement extends PolymerElement {
render() {
return html

;
}

_valueHandler(e) {
this.value = e.detail.value;
}
}
customElements.define('sample-element', SampleElement);
`

Development

`sh
git clone https://github.com/advanced-rest-client/code-mirror
cd code-mirror
npm install
`

$3

`sh
npm start
`

$3

`sh
npm test
``