Ghost/ghost/admin/lib/koenig-editor/addon/components/koenig-card.js
Kevin Ansfield 1133370568 Koenig - Deselect cards when a click happens outside of the editor canvas
refs https://github.com/TryGhost/Ghost/issues/9623
- move click handler registration from `onEnterEdit` to `onSelect`
- add guard against deselecting for clicks on the editor canvas
  - prevents card being deselected when the click would have placed the cursor in a position that selected the card
  - requires editor instance to be passed through to `{{koenig-card}}` in all card components
2018-06-14 12:21:22 +01:00

268 lines
8.1 KiB
JavaScript

import Component from '@ember/component';
import layout from '../templates/components/koenig-card';
import {computed} from '@ember/object';
import {htmlSafe} from '@ember/string';
import {run} from '@ember/runloop';
const TICK_HEIGHT = 8;
export default Component.extend({
layout,
attributeBindings: ['style'],
classNameBindings: ['selectedClass'],
// attrs
icon: null,
iconClass: 'ih5 absolute stroke-midgrey-l2 mt1 nl16 kg-icon',
toolbar: null,
isSelected: false,
isEditing: false,
hasEditMode: true,
headerOffset: 0,
showSelectedOutline: true,
// properties
showToolbar: false,
toolbarWidth: 0,
toolbarHeight: 0,
// internal properties
_lastIsEditing: false,
// closure actions
selectCard() {},
deselectCard() {},
editCard() {},
// hooks - when attached these will be fired on the individual card components
onSelect() {},
onDeselect() {},
onEnterEdit() {},
onLeaveEdit() {},
// TODO: replace with Spirit classes
style: computed(function () {
let baseStyles = 'cursor: default; caret-color: auto;';
return htmlSafe(baseStyles);
}),
toolbarStyle: computed('showToolbar', 'toolbarWidth', 'toolbarHeight', function () {
let showToolbar = this.showToolbar;
let width = this.toolbarWidth;
let height = this.toolbarHeight;
let styles = [];
styles.push(`top: -${height}px`);
styles.push(`left: calc(50% - ${width / 2}px)`);
if (!showToolbar) {
styles.push('pointer-events: none !important');
}
return htmlSafe(styles.join('; '));
}),
iconTop: computed('headerOffset', function () {
return this.headerOffset + 24;
}),
selectedClass: computed('isSelected', 'showSelectedOutline', function () {
if (this.isSelected && this.showSelectedOutline) {
return 'kg-card-selected';
}
}),
didReceiveAttrs() {
this._super(...arguments);
let isSelected = this.isSelected;
let isEditing = this.isEditing;
let hasEditMode = this.hasEditMode;
if (isSelected !== this._lastIsSelected) {
if (isSelected) {
this._fireWhenRendered(this._onSelect);
} else {
this._fireWhenRendered(this._onDeselect);
}
}
if (isEditing !== this._lastIsEditing) {
if (!hasEditMode) {
isEditing = false;
} else if (isEditing) {
this._onEnterEdit();
} else {
this._onLeaveEdit();
}
}
// show the toolbar immediately if it changes whilst the card is selected
// caters for situations such as only showing image style buttons once an
// image has been uploaded
if (isSelected && this._lastIsSelected && this.toolbar && this.toolbar !== this._lastToolbar) {
run.scheduleOnce('afterRender', this, this._showToolbar);
}
this._lastIsSelected = isSelected;
this._lastIsEditing = isEditing;
this._lastToolbar = this.toolbar;
},
didInsertElement() {
this._super(...arguments);
this._setToolbarProperties();
},
willDestroyElement() {
this._super(...arguments);
window.removeEventListener('keydown', this._onKeydownHandler);
window.removeEventListener('click', this._onClickHandler);
this._removeMousemoveHandler();
},
mouseDown(event) {
let isSelected = this.isSelected;
let isEditing = this.isEditing;
let hasEditMode = this.hasEditMode;
// if we perform an action we want to prevent the mousedown from
// triggering a cursor position change which can result in multiple
// card select calls getting the component into an odd state. We also
// manually show the toolbar so that we're not relying on mousemove
if (!isSelected && !isEditing) {
this.selectCard();
this.set('showToolbar', true);
// in most situations we want to prevent default behaviour which
// can cause an underlying cursor position change but inputs and
// textareas are different and we want the focus to move to them
// immediately when clicked
let targetTagName = event.target.tagName;
let allowedTagNames = ['INPUT', 'TEXTAREA'];
if (!allowedTagNames.includes(targetTagName)) {
event.preventDefault();
}
} else if (hasEditMode && isSelected && !isEditing) {
this.editCard();
this.set('showToolbar', true);
event.preventDefault();
}
},
doubleClick() {
if (this.hasEditMode && !this.isEditing) {
this.editCard();
this.set('showToolbar', true);
}
},
_onSelect() {
this._fireWhenRendered(this._showToolbar);
this._showToolbar();
this.onSelect();
this._onClickHandler = run.bind(this, this._handleClick);
window.addEventListener('click', this._onClickHandler);
},
_onDeselect() {
window.removeEventListener('click', this._onClickHandler);
this._hideToolbar();
this.onDeselect();
},
_onEnterEdit() {
this._onKeydownHandler = run.bind(this, this._handleKeydown);
window.addEventListener('keydown', this._onKeydownHandler);
this.onEnterEdit();
},
_onLeaveEdit() {
window.removeEventListener('keydown', this._onKeydownHandler);
this.onLeaveEdit();
},
_setToolbarProperties() {
if (this.toolbar) {
let toolbar = this.element.querySelector('[data-toolbar="true"]');
let {width, height} = toolbar.getBoundingClientRect();
this.setProperties({
toolbarWidth: width,
toolbarHeight: height + TICK_HEIGHT
});
}
},
_showToolbar() {
// only show a toolbar if we have one
if (this.toolbar) {
this._setToolbarProperties();
if (!this.showToolbar && !this._onMousemoveHandler) {
this._onMousemoveHandler = run.bind(this, this._handleMousemove);
window.addEventListener('mousemove', this._onMousemoveHandler);
}
}
},
_hideToolbar() {
this.set('showToolbar', false);
this._removeMousemoveHandler();
},
_handleKeydown(event) {
if (event.code === 'Escape' && this.isEditing) {
// run the select card routine with isEditing=false to exit edit mode
this.selectCard(false);
event.preventDefault();
}
},
// exit edit mode any time we have a click outside of the card unless it's
// a click inside one of our modals or on the plus menu
_handleClick({target, path}) {
// if the editor element is clicked then cursor placement will deselect
// or keep this card selected as necessary
if (target === this.editor.element) {
return;
}
let searchPath = function (selector) {
return element => element.closest && element.closest(selector);
};
// check if the click was in the card, on the plus menu, or on a modal
if (this.element.contains(target)
|| path.find(searchPath('[data-kg="plus-menu"]'))
|| path.find(searchPath('.liquid-destination'))) {
return;
}
this.deselectCard();
},
_handleMousemove() {
if (!this.showToolbar) {
this.set('showToolbar', true);
this._removeMousemoveHandler();
}
},
_removeMousemoveHandler() {
window.removeEventListener('mousemove', this._onMousemoveHandler);
this._onMousemoveHandler = null;
},
// convenience method for when we only want to run a method when our
// elements have been rendered
_fireWhenRendered(method) {
if (this.element) {
run.bind(this, method)();
} else {
run.scheduleOnce('afterRender', this, method);
}
}
});