Ghost/ghost/admin/app/components/gh-cm-editor.js
Kevin Ansfield 1dad18a06c Added language selection to code cards (#1180)
no issue

- Added a language indicator when in rendered mode and a language input when in edit mode
- Allow code card language to be set with <code>```lang</code>+<kbd>Space/Enter</kbd> expansion 
    - previously <code>\`\`\`</code> would immediately create a code card, the <kbd>Space/Enter</kbd> is now necessary for the insertion to occur
    - lang is optional <code>\`\`\`</code>+<kbd>Space/Enter</kbd> will insert a code card with no language selected
    - requires <kbd>Enter</kbd> to be pressed to finalise the expansion and insert the card
    - added hook for text expansions to skip newline creation for when they are triggered with <kbd>Enter</kbd>
- Set the code card editor's language mode based on selected language
    - set the CodeMirror mode based on the code card payload language
        - add a basic map of language short codes to their respective CodeMirror modes
    - observe `mode` property in `{{gh-cm-editor}}` so that the mode is properly set when it's changed after initial render
2019-04-30 16:46:29 +02:00

127 lines
3.6 KiB
JavaScript

/* global CodeMirror */
import Component from '@ember/component';
import boundOneWay from 'ghost-admin/utils/bound-one-way';
import {assign} from '@ember/polyfills';
import {bind, once, scheduleOnce} from '@ember/runloop';
import {inject as service} from '@ember/service';
import {task} from 'ember-concurrency';
const CmEditorComponent = Component.extend({
lazyLoader: service(),
classNameBindings: ['isFocused:focus'],
textareaClass: '',
isFocused: false,
// options for the editor
autofocus: false,
indentUnit: 4,
lineNumbers: true,
lineWrapping: false,
mode: 'htmlmixed',
theme: 'xq-light',
_editor: null, // reference to CodeMirror editor
// Allowed actions
'focus-in': () => {},
update: () => {},
_value: boundOneWay('value'), // make sure a value exists
didReceiveAttrs() {
if (this._value === null || undefined) {
this.set('_value', '');
}
if (this.mode !== this._lastMode && this._editor) {
this._editor.setOption('mode', this.mode);
}
this._lastMode = this.mode;
},
didInsertElement() {
this._super(...arguments);
this.initCodeMirror.perform();
},
willDestroyElement() {
this._super(...arguments);
// Ensure the editor exists before trying to destroy it. This fixes
// an error that occurs if codemirror hasn't finished loading before
// the component is destroyed.
if (this._editor) {
let editor = this._editor.getWrapperElement();
editor.parentNode.removeChild(editor);
this._editor = null;
}
},
actions: {
updateFromTextarea(value) {
this.update(value);
}
},
initCodeMirror: task(function* () {
let loader = this.lazyLoader;
yield loader.loadScript('codemirror', 'assets/codemirror/codemirror.js');
scheduleOnce('afterRender', this, this._initCodeMirror);
}),
_initCodeMirror() {
let options = this.getProperties('lineNumbers', 'lineWrapping', 'indentUnit', 'mode', 'theme', 'autofocus');
assign(options, {value: this._value});
let textarea = this.element.querySelector('textarea');
if (textarea && textarea === document.activeElement) {
options.autofocus = true;
}
this._editor = new CodeMirror.fromTextArea(textarea, options);
// by default CodeMirror will place the cursor at the beginning of the
// content, it makes more sense for the cursor to be at the end
if (options.autofocus) {
this._editor.setCursor(this._editor.lineCount(), 0);
}
// events
this._setupCodeMirrorEventHandler('focus', this, this._focus);
this._setupCodeMirrorEventHandler('blur', this, this._blur);
this._setupCodeMirrorEventHandler('change', this, this._update);
},
_setupCodeMirrorEventHandler(event, target, method) {
let callback = bind(target, method);
this._editor.on(event, callback);
this.one('willDestroyElement', this, function () {
this._editor.off(event, callback);
});
},
_update(codeMirror, changeObj) {
once(this, this.update, codeMirror.getValue(), codeMirror, changeObj);
},
_focus(codeMirror, event) {
this.set('isFocused', true);
once(this, this['focus-in'], codeMirror.getValue(), codeMirror, event);
},
_blur(/* codeMirror, event */) {
this.set('isFocused', false);
}
});
CmEditorComponent.reopenClass({
positionalParams: ['value']
});
export default CmEditorComponent;