mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-11-28 22:43:30 +03:00
5fae14fa74
closes https://github.com/TryGhost/Ghost/issues/8863 - Spellcheck shortcut: <kbd>Ctrl-Alt-S</kbd> - Render preview shortcut: <kbd>Ctrl-Alt-R</kbd> - Side-by-side preview shortcut: <kbd>Ctrl-Alt-P</kbd> - fix "Hemmingway" typo - update simplemde fork to add a bypass of the Ctrl->⌘ transformation in toolbar button tooltips
620 lines
21 KiB
JavaScript
620 lines
21 KiB
JavaScript
import Component from '@ember/component';
|
|
import ShortcutsMixin from 'ghost-admin/mixins/shortcuts';
|
|
import ctrlOrCmd from 'ghost-admin/utils/ctrl-or-cmd';
|
|
import formatMarkdown from 'ghost-admin/utils/format-markdown';
|
|
import {assign} from '@ember/polyfills';
|
|
import {computed} from '@ember/object';
|
|
import {copy} from '@ember/object/internals';
|
|
import {htmlSafe} from '@ember/string';
|
|
import {inject as injectService} from '@ember/service';
|
|
import {isEmpty, typeOf} from '@ember/utils';
|
|
import {run} from '@ember/runloop';
|
|
|
|
const MOBILEDOC_VERSION = '0.3.1';
|
|
|
|
export const BLANK_DOC = {
|
|
version: MOBILEDOC_VERSION,
|
|
markups: [],
|
|
atoms: [],
|
|
cards: [
|
|
['card-markdown', {
|
|
cardName: 'card-markdown',
|
|
markdown: ''
|
|
}]
|
|
],
|
|
sections: [[10, 0]]
|
|
};
|
|
|
|
export default Component.extend(ShortcutsMixin, {
|
|
|
|
config: injectService(),
|
|
notifications: injectService(),
|
|
settings: injectService(),
|
|
|
|
classNames: ['gh-markdown-editor'],
|
|
classNameBindings: [
|
|
'_isFullScreen:gh-markdown-editor-full-screen',
|
|
'_isSplitScreen:gh-markdown-editor-side-by-side'
|
|
],
|
|
|
|
// Public attributes
|
|
autofocus: false,
|
|
imageMimeTypes: null,
|
|
isFullScreen: false,
|
|
mobiledoc: null,
|
|
options: null,
|
|
placeholder: '',
|
|
uploadedImageUrls: null,
|
|
|
|
// Closure actions
|
|
onChange() {},
|
|
onFullScreenToggle() {},
|
|
onImageFilesSelected() {},
|
|
onPreviewToggle() {},
|
|
onSplitScreenToggle() {},
|
|
showMarkdownHelp() {},
|
|
|
|
// Internal attributes
|
|
markdown: null,
|
|
|
|
// Private
|
|
_editor: null,
|
|
_editorFocused: false,
|
|
_isFullScreen: false,
|
|
_isSplitScreen: false,
|
|
_isHemingwayMode: false,
|
|
_isUploading: false,
|
|
_showUnsplash: false,
|
|
_statusbar: null,
|
|
_toolbar: null,
|
|
_uploadedImageUrls: null,
|
|
|
|
simpleMDEOptions: computed('options', function () {
|
|
let options = this.get('options') || {};
|
|
let defaultOptions = {
|
|
// use our Showdown config with sanitization for previews
|
|
previewRender(markdown) {
|
|
return formatMarkdown(markdown);
|
|
},
|
|
|
|
// Ghost-specific SimpleMDE toolbar config - allows us to create a
|
|
// bridge between SimpleMDE buttons and Ember actions
|
|
toolbar: [
|
|
'bold', 'italic', 'heading', '|',
|
|
'quote', 'unordered-list', 'ordered-list', '|',
|
|
'link',
|
|
{
|
|
name: 'image',
|
|
action: () => {
|
|
this._openImageFileDialog();
|
|
},
|
|
className: 'fa fa-picture-o',
|
|
title: 'Upload Image(s)'
|
|
},
|
|
'|',
|
|
{
|
|
name: 'preview',
|
|
action: () => {
|
|
this._togglePreview();
|
|
},
|
|
className: 'fa fa-eye no-disable',
|
|
title: 'Render Preview (Ctrl-Alt-R)',
|
|
useCtrlOnMac: true
|
|
},
|
|
{
|
|
name: 'side-by-side',
|
|
action: () => {
|
|
this.send('toggleSplitScreen');
|
|
},
|
|
className: 'fa fa-columns no-disable no-mobile',
|
|
title: 'Side-by-side Preview (Ctrl-Alt-P)',
|
|
useCtrlOnMac: true
|
|
},
|
|
'|',
|
|
{
|
|
name: 'spellcheck',
|
|
action: () => {
|
|
this._toggleSpellcheck();
|
|
},
|
|
className: 'fa fa-check',
|
|
title: 'Spellcheck (Ctrl-Alt-S)',
|
|
useCtrlOnMac: true
|
|
},
|
|
{
|
|
name: 'hemingway',
|
|
action: () => {
|
|
this._toggleHemingway();
|
|
},
|
|
className: 'fa fa-h-square',
|
|
title: 'Hemingway Mode (Ctrl-Alt-H)',
|
|
useCtrlOnMac: true
|
|
},
|
|
{
|
|
name: 'guide',
|
|
action: () => {
|
|
this.showMarkdownHelp();
|
|
},
|
|
className: 'fa fa-question-circle',
|
|
title: 'Markdown Guide'
|
|
}
|
|
],
|
|
|
|
// disable shortcuts for side-by-side and fullscreen because they
|
|
// trigger interal SimpleMDE methods that will result in broken
|
|
// layouts
|
|
shortcuts: {
|
|
toggleFullScreen: null,
|
|
togglePreview: null,
|
|
toggleSideBySide: null,
|
|
drawImage: null
|
|
},
|
|
|
|
// only include the number of words in the status bar
|
|
status: ['words']
|
|
};
|
|
|
|
if (this.get('settings.unsplash.isActive')) {
|
|
let image = defaultOptions.toolbar.findBy('name', 'image');
|
|
let index = defaultOptions.toolbar.indexOf(image) + 1;
|
|
|
|
defaultOptions.toolbar.splice(index, 0, {
|
|
name: 'unsplash',
|
|
action: () => {
|
|
this.send('toggleUnsplash');
|
|
},
|
|
className: 'fa fa-camera',
|
|
title: 'Add Image from Unsplash'
|
|
});
|
|
}
|
|
|
|
return assign(defaultOptions, options);
|
|
}),
|
|
|
|
shortcuts: {},
|
|
|
|
init() {
|
|
this._super(...arguments);
|
|
let shortcuts = this.get('shortcuts');
|
|
|
|
shortcuts[`${ctrlOrCmd}+shift+i`] = {action: 'openImageFileDialog'};
|
|
shortcuts['ctrl+alt+r'] = {action: 'togglePreview'};
|
|
shortcuts['ctrl+alt+p'] = {action: 'toggleSplitScreen'};
|
|
shortcuts['ctrl+alt+s'] = {action: 'toggleSpellcheck'};
|
|
shortcuts['ctrl+alt+h'] = {action: 'toggleHemingway'};
|
|
},
|
|
|
|
// extract markdown content from single markdown card
|
|
didReceiveAttrs() {
|
|
this._super(...arguments);
|
|
let mobiledoc = this.get('mobiledoc') || copy(BLANK_DOC, true);
|
|
|
|
let uploadedImageUrls = this.get('uploadedImageUrls');
|
|
if (!isEmpty(uploadedImageUrls) && uploadedImageUrls !== this._uploadedImageUrls) {
|
|
this._uploadedImageUrls = uploadedImageUrls;
|
|
|
|
// must be done afterRender to avoid double modify of mobiledoc in
|
|
// a single render
|
|
run.scheduleOnce('afterRender', this, () => {
|
|
this._insertImages(uploadedImageUrls);
|
|
// reset the file input so the same file can be selected again
|
|
this.$('input[type=file]').val('');
|
|
});
|
|
}
|
|
|
|
// eslint-disable-next-line ember-suave/prefer-destructuring
|
|
let markdown = mobiledoc.cards[0][1].markdown;
|
|
this.set('markdown', markdown);
|
|
|
|
// use internal values to avoid updating bound values
|
|
if (!isEmpty(this.get('isFullScreen'))) {
|
|
this.set('_isFullScreen', this.get('isFullScreen'));
|
|
}
|
|
if (!isEmpty(this.get('isSplitScreen'))) {
|
|
this.set('_isSplitScreen', this.get('isSplitScreen'));
|
|
}
|
|
|
|
this._updateButtonState();
|
|
},
|
|
|
|
didInsertElement() {
|
|
this._super(...arguments);
|
|
this.registerShortcuts();
|
|
},
|
|
|
|
_insertImages(urls) {
|
|
let cm = this._editor.codemirror;
|
|
|
|
// loop through urls and generate image markdown
|
|
let images = urls.map((url) => {
|
|
// plain url string, so extract filename from path
|
|
if (typeOf(url) === 'string') {
|
|
let filename = url.split('/').pop();
|
|
let alt = filename;
|
|
|
|
// if we have a normal filename.ext, set alt to filename -ext
|
|
if (filename.lastIndexOf('.') > 0) {
|
|
alt = filename.slice(0, filename.lastIndexOf('.'));
|
|
}
|
|
|
|
return ``;
|
|
|
|
// full url object, use attrs we're given
|
|
} else {
|
|
let image = ``;
|
|
|
|
if (url.credit) {
|
|
image += `\n${url.credit}`;
|
|
}
|
|
|
|
return image;
|
|
}
|
|
});
|
|
let text = images.join('\n\n');
|
|
|
|
// clicking the image toolbar button will lose the selection so we use
|
|
// the captured selection to re-select here
|
|
if (this._imageInsertSelection) {
|
|
// we want to focus but not re-position
|
|
this.send('focusEditor', null);
|
|
|
|
// re-select and clear the captured selection so drag/drop still
|
|
// inserts at the correct place
|
|
cm.setSelection(
|
|
this._imageInsertSelection.anchor,
|
|
this._imageInsertSelection.head
|
|
);
|
|
this._imageInsertSelection = null;
|
|
}
|
|
|
|
// focus editor and place cursor at end if not already focused
|
|
if (!cm.hasFocus()) {
|
|
this.send('focusEditor');
|
|
text = `\n\n${text}\n\n`;
|
|
}
|
|
|
|
// insert at cursor or replace selection then position cursor at end
|
|
// of inserted text
|
|
cm.replaceSelection(text, 'end');
|
|
},
|
|
|
|
// mark the split-pane/full-screen/spellcheck buttons active when they're active
|
|
_updateButtonState() {
|
|
if (this._editor) {
|
|
let sideBySideButton = this._editor.toolbarElements['side-by-side'];
|
|
let spellcheckButton = this._editor.toolbarElements.spellcheck;
|
|
let hemingwayButton = this._editor.toolbarElements.hemingway;
|
|
|
|
if (sideBySideButton) {
|
|
if (this.get('_isSplitScreen')) {
|
|
sideBySideButton.classList.add('active');
|
|
} else {
|
|
sideBySideButton.classList.remove('active');
|
|
}
|
|
}
|
|
|
|
if (spellcheckButton) {
|
|
if (this._editor.codemirror.getOption('mode') === 'spell-checker') {
|
|
spellcheckButton.classList.add('active');
|
|
} else {
|
|
spellcheckButton.classList.remove('active');
|
|
}
|
|
}
|
|
|
|
if (hemingwayButton) {
|
|
if (this._isHemingwayMode) {
|
|
hemingwayButton.classList.add('active');
|
|
} else {
|
|
hemingwayButton.classList.remove('active');
|
|
}
|
|
}
|
|
}
|
|
},
|
|
|
|
// set up the preview auto-update and scroll sync
|
|
_connectSplitPreview() {
|
|
let cm = this._editor.codemirror;
|
|
let editor = this._editor;
|
|
/* eslint-disable ember-suave/prefer-destructuring */
|
|
let editorPane = this.$('.gh-markdown-editor-pane')[0];
|
|
let previewPane = this.$('.gh-markdown-editor-preview')[0];
|
|
let previewContent = this.$('.gh-markdown-editor-preview-content')[0];
|
|
/* eslint-enable ember-suave/prefer-destructuring */
|
|
|
|
this._editorPane = editorPane;
|
|
this._previewPane = previewPane;
|
|
this._previewContent = previewContent;
|
|
|
|
// from SimpleMDE -------
|
|
let sideBySideRenderingFunction = function() {
|
|
previewContent.innerHTML = editor.options.previewRender(
|
|
editor.value(),
|
|
previewContent
|
|
);
|
|
};
|
|
|
|
cm.sideBySideRenderingFunction = sideBySideRenderingFunction;
|
|
|
|
sideBySideRenderingFunction();
|
|
cm.on('update', cm.sideBySideRenderingFunction);
|
|
|
|
// Refresh to fix selection being off (#309)
|
|
cm.refresh();
|
|
// ----------------------
|
|
|
|
this._onEditorPaneScroll = this._scrollHandler.bind(this);
|
|
editorPane.addEventListener('scroll', this._onEditorPaneScroll, false);
|
|
this._scrollSync();
|
|
},
|
|
|
|
_scrollHandler() {
|
|
if (!this._scrollSyncTicking) {
|
|
requestAnimationFrame(this._scrollSync.bind(this));
|
|
}
|
|
this._scrollSyncTicking = true;
|
|
},
|
|
|
|
_scrollSync() {
|
|
let editorPane = this._editorPane;
|
|
let previewPane = this._previewPane;
|
|
let height = editorPane.scrollHeight - editorPane.clientHeight;
|
|
let ratio = parseFloat(editorPane.scrollTop) / height;
|
|
let move = (previewPane.scrollHeight - previewPane.clientHeight) * ratio;
|
|
|
|
previewPane.scrollTop = move;
|
|
this._scrollSyncTicking = false;
|
|
},
|
|
|
|
_disconnectSplitPreview() {
|
|
let cm = this._editor.codemirror;
|
|
|
|
cm.off('update', cm.sideBySideRenderingFunction);
|
|
cm.refresh();
|
|
|
|
this._editorPane.removeEventListener('scroll', this._onEditorPaneScroll, false);
|
|
delete this._previewPane;
|
|
delete this._previewPaneContent;
|
|
delete this._onEditorPaneScroll;
|
|
},
|
|
|
|
_openImageFileDialog({captureSelection = true} = {}) {
|
|
if (captureSelection) {
|
|
// capture the current selection before it's lost by clicking the
|
|
// file input button
|
|
this._imageInsertSelection = {
|
|
anchor: this._editor.codemirror.getCursor('anchor'),
|
|
head: this._editor.codemirror.getCursor('head')
|
|
};
|
|
}
|
|
|
|
// trigger the dialog via gh-file-input, when a file is selected it will
|
|
// trigger the onImageFilesSelected closure action
|
|
this.$('input[type="file"]').click();
|
|
},
|
|
|
|
// wrap SimpleMDE's built-in preview toggle so that we can trigger a closure
|
|
// action that can apply our own classes higher up in the DOM
|
|
_togglePreview() {
|
|
this.onPreviewToggle(!this._editor.isPreviewActive());
|
|
this._editor.togglePreview();
|
|
},
|
|
|
|
_toggleSpellcheck() {
|
|
let cm = this._editor.codemirror;
|
|
|
|
if (cm.getOption('mode') === 'spell-checker') {
|
|
cm.setOption('mode', 'gfm');
|
|
} else {
|
|
cm.setOption('mode', 'spell-checker');
|
|
}
|
|
|
|
this._updateButtonState();
|
|
},
|
|
|
|
_toggleHemingway() {
|
|
let cm = this._editor.codemirror;
|
|
let extraKeys = cm.getOption('extraKeys');
|
|
let notificationText = '';
|
|
|
|
this._isHemingwayMode = !this._isHemingwayMode;
|
|
|
|
if (this._isHemingwayMode) {
|
|
notificationText = '<span class="gh-notification-title">Hemingway Mode On:</span> Write now; edit later. Backspace disabled.';
|
|
extraKeys.Backspace = function () {};
|
|
} else {
|
|
notificationText = '<span class="gh-notification-title">Hemingway Mode Off:</span> Normal editing restored.';
|
|
delete extraKeys.Backspace;
|
|
}
|
|
|
|
cm.setOption('extraKeys', extraKeys);
|
|
this._updateButtonState();
|
|
|
|
cm.focus();
|
|
|
|
this.get('notifications').showNotification(
|
|
htmlSafe(notificationText),
|
|
{key: 'editor.hemingwaymode'}
|
|
);
|
|
},
|
|
|
|
willDestroyElement() {
|
|
if (this.get('_isSplitScreen')) {
|
|
this._disconnectSplitPreview();
|
|
}
|
|
|
|
this.removeShortcuts();
|
|
|
|
this._super(...arguments);
|
|
},
|
|
|
|
actions: {
|
|
// put the markdown into a new mobiledoc card, trigger external update
|
|
updateMarkdown(markdown) {
|
|
let mobiledoc = copy(BLANK_DOC, true);
|
|
mobiledoc.cards[0][1].markdown = markdown;
|
|
this.onChange(mobiledoc);
|
|
},
|
|
|
|
// store a reference to the simplemde editor so that we can handle
|
|
// focusing and image uploads
|
|
setEditor(editor) {
|
|
this._editor = editor;
|
|
|
|
// disable CodeMirror's drag/drop handling as we want to handle that
|
|
// in the parent gh-editor component
|
|
this._editor.codemirror.setOption('dragDrop', false);
|
|
|
|
// default to spellchecker being off
|
|
this._editor.codemirror.setOption('mode', 'gfm');
|
|
|
|
// HACK: move the toolbar & status bar elements outside of the
|
|
// editor container so that they can be aligned in fixed positions
|
|
let container = this.$().closest('.gh-editor').find('.gh-editor-footer');
|
|
this._toolbar = this.$('.editor-toolbar');
|
|
this._statusbar = this.$('.editor-statusbar');
|
|
this._toolbar.appendTo(container);
|
|
this._statusbar.appendTo(container);
|
|
|
|
this._updateButtonState();
|
|
},
|
|
|
|
// used by the title input when the TAB or ENTER keys are pressed
|
|
focusEditor(position = 'bottom') {
|
|
this._editor.codemirror.focus();
|
|
|
|
if (position === 'bottom') {
|
|
this._editor.codemirror.execCommand('goDocEnd');
|
|
} else if (position === 'top') {
|
|
this._editor.codemirror.execCommand('goDocStart');
|
|
}
|
|
|
|
return false;
|
|
},
|
|
|
|
// HACK FIXME (PLEASE):
|
|
// - clicking toolbar buttons will cause the editor to lose focus
|
|
// - this is painful because we often want to know if the editor has focus
|
|
// so that we can insert images and so on in the correct place
|
|
// - the blur event will always fire before the button action is triggered 😞
|
|
// - to work around this we track focus state manually and set it to false
|
|
// after an arbitrary period that's long enough to allow the button action
|
|
// to trigger first
|
|
// - this _may_ well have unknown issues due to browser differences,
|
|
// variations in performance, moon cycles, sun spots, or cosmic rays
|
|
// - here be 🐲
|
|
// - (please let it work 🙏)
|
|
updateFocusState(focused) {
|
|
if (focused) {
|
|
this._editorFocused = true;
|
|
} else {
|
|
run.later(this, function () {
|
|
this._editorFocused = false;
|
|
}, 100);
|
|
}
|
|
},
|
|
|
|
openImageFileDialog() {
|
|
let captureSelection = this._editor.codemirror.hasFocus();
|
|
this._openImageFileDialog({captureSelection});
|
|
},
|
|
|
|
toggleUnsplash() {
|
|
if (this.get('_showUnsplash')) {
|
|
return this.toggleProperty('_showUnsplash');
|
|
}
|
|
|
|
// capture current selection before it's lost by clicking toolbar btn
|
|
if (this._editorFocused) {
|
|
this._imageInsertSelection = {
|
|
anchor: this._editor.codemirror.getCursor('anchor'),
|
|
head: this._editor.codemirror.getCursor('head')
|
|
};
|
|
}
|
|
|
|
this.toggleProperty('_showUnsplash');
|
|
},
|
|
|
|
insertUnsplashPhoto(photo) {
|
|
let image = {
|
|
alt: photo.description || '',
|
|
url: photo.urls.regular,
|
|
credit: `<small>Photo by [${photo.user.name}](${photo.user.links.html}?utm_source=ghost&utm_medium=referral&utm_campaign=api-credit) / [Unsplash](https://unsplash.com/?utm_source=ghost&utm_medium=referral&utm_campaign=api-credit)</small>`
|
|
};
|
|
|
|
this._insertImages([image]);
|
|
},
|
|
|
|
togglePreview() {
|
|
this._togglePreview();
|
|
},
|
|
|
|
toggleFullScreen() {
|
|
let isFullScreen = !this.get('_isFullScreen');
|
|
|
|
this.set('_isFullScreen', isFullScreen);
|
|
this._updateButtonState();
|
|
this.onFullScreenToggle(isFullScreen);
|
|
|
|
// leave split screen when exiting full screen mode
|
|
if (!isFullScreen && this.get('_isSplitScreen')) {
|
|
this.send('toggleSplitScreen');
|
|
}
|
|
},
|
|
|
|
toggleSplitScreen() {
|
|
let isSplitScreen = !this.get('_isSplitScreen');
|
|
let previewButton = this._editor.toolbarElements.preview;
|
|
|
|
this.set('_isSplitScreen', isSplitScreen);
|
|
this._updateButtonState();
|
|
|
|
// set up the preview rendering and scroll sync
|
|
// afterRender is needed so that necessary components have been
|
|
// added/removed and editor pane length has settled
|
|
if (isSplitScreen) {
|
|
// disable the normal SimpleMDE preview if it's active
|
|
if (this._editor.isPreviewActive()) {
|
|
let preview = this._editor.toolbar.find((button) => {
|
|
return button.name === 'preview';
|
|
});
|
|
|
|
preview.action(this._editor);
|
|
}
|
|
|
|
if (previewButton) {
|
|
previewButton.classList.add('disabled');
|
|
}
|
|
|
|
run.scheduleOnce('afterRender', this, this._connectSplitPreview);
|
|
} else {
|
|
if (previewButton) {
|
|
previewButton.classList.remove('disabled');
|
|
}
|
|
|
|
run.scheduleOnce('afterRender', this, this._disconnectSplitPreview);
|
|
}
|
|
|
|
this.onSplitScreenToggle(isSplitScreen);
|
|
|
|
// go fullscreen when entering split screen mode
|
|
this.send('toggleFullScreen');
|
|
},
|
|
|
|
toggleSpellcheck() {
|
|
this._toggleSpellcheck();
|
|
},
|
|
|
|
toggleHemingway() {
|
|
this._toggleHemingway();
|
|
},
|
|
|
|
// put the toolbar/statusbar elements back so that SimpleMDE doesn't throw
|
|
// errors when it tries to remove them
|
|
destroyEditor() {
|
|
let container = this.$('.gh-markdown-editor-pane');
|
|
this._toolbar.appendTo(container);
|
|
this._statusbar.appendTo(container);
|
|
this._editor = null;
|
|
}
|
|
}
|
|
});
|