yomichan/ext/js/dom/popup-menu.js
toasted-nutbread 63d37c872b
Popup positioning improvements (#2135)
* Rename elementRect to sourceRect

* Add getRects function to TextSourceElement and TextSourceRange

* Add jsdocs

* Remove unnecessary valid parameter

* Remove default parameter

* Make optionsContext optional

* Remove unnecessary checks

* Update sourceRect to use left/right rather than x/y

* Update the return type of Popup*.getFrameRect

* Rename some unrelated rect vars for disambiguation

* Disambiguate between Popup.Rect and Popup.ValidRect

* Move sourceRect destructuring

* Pass multiple source rects

* Simplify

* Change Rect to use right/bottom rather than width/height

* Update how popup offset is applied

* Simplify frame offset

* Remove _applyFrameOffset

* Use right/bottom rather than width/height

* Simplify some positioning settings

* Update parameter names for clarity

* Fix typos

* Refactor data type for _getPosition* functions

* Support using multiple source rects

* Combine _getPosition functions

* Refactor

* Expose after dataset value

* Consistently use this's property

* Add jsdoc
2022-05-16 21:45:22 -04:00

225 lines
6.9 KiB
JavaScript

/*
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
class PopupMenu extends EventDispatcher {
constructor(sourceElement, containerNode) {
super();
this._sourceElement = sourceElement;
this._containerNode = containerNode;
this._node = containerNode.querySelector('.popup-menu');
this._bodyNode = containerNode.querySelector('.popup-menu-body');
this._isClosed = false;
this._eventListeners = new EventListenerCollection();
this._itemEventListeners = new EventListenerCollection();
}
get sourceElement() {
return this._sourceElement;
}
get containerNode() {
return this._containerNode;
}
get node() {
return this._node;
}
get bodyNode() {
return this._bodyNode;
}
get isClosed() {
return this._isClosed;
}
prepare() {
this._setPosition();
this._containerNode.focus();
this._eventListeners.addEventListener(window, 'resize', this._onWindowResize.bind(this), false);
this._eventListeners.addEventListener(this._containerNode, 'click', this._onMenuContainerClick.bind(this), false);
this.updateMenuItems();
PopupMenu.openMenus.add(this);
this._sourceElement.dispatchEvent(new CustomEvent('menuOpen', {
bubbles: false,
cancelable: false,
detail: {menu: this}
}));
}
close(cancelable=true) {
return this._close(null, 'close', cancelable, {});
}
updateMenuItems() {
this._itemEventListeners.removeAllEventListeners();
const items = this._bodyNode.querySelectorAll('.popup-menu-item');
const onMenuItemClick = this._onMenuItemClick.bind(this);
for (const item of items) {
this._itemEventListeners.addEventListener(item, 'click', onMenuItemClick, false);
}
}
updatePosition() {
this._setPosition();
}
// Private
_onMenuContainerClick(e) {
if (e.currentTarget !== e.target) { return; }
if (this._close(null, 'outside', true, e)) {
e.stopPropagation();
e.preventDefault();
}
}
_onMenuItemClick(e) {
const item = e.currentTarget;
if (item.disabled) { return; }
if (this._close(item, 'item', true, e)) {
e.stopPropagation();
e.preventDefault();
}
}
_onWindowResize() {
this._close(null, 'resize', true, {});
}
_setPosition() {
// Get flags
let horizontal = 1;
let vertical = 1;
let horizontalCover = 1;
let verticalCover = 1;
const positionInfo = this._sourceElement.dataset.menuPosition;
if (typeof positionInfo === 'string') {
const positionInfoSet = new Set(positionInfo.split(' '));
if (positionInfoSet.has('left')) {
horizontal = -1;
} else if (positionInfoSet.has('right')) {
horizontal = 1;
} else if (positionInfoSet.has('h-center')) {
horizontal = 0;
}
if (positionInfoSet.has('above')) {
vertical = -1;
} else if (positionInfoSet.has('below')) {
vertical = 1;
} else if (positionInfoSet.has('v-center')) {
vertical = 0;
}
if (positionInfoSet.has('cover')) {
horizontalCover = 1;
verticalCover = 1;
} else if (positionInfoSet.has('no-cover')) {
horizontalCover = -1;
verticalCover = -1;
}
if (positionInfoSet.has('h-cover')) {
horizontalCover = 1;
} else if (positionInfoSet.has('no-h-cover')) {
horizontalCover = -1;
}
if (positionInfoSet.has('v-cover')) {
verticalCover = 1;
} else if (positionInfoSet.has('no-v-cover')) {
verticalCover = -1;
}
}
// Position
const menu = this._node;
const containerNodeRect = this._containerNode.getBoundingClientRect();
const sourceElementRect = this._sourceElement.getBoundingClientRect();
const menuRect = menu.getBoundingClientRect();
let top = menuRect.top;
let bottom = menuRect.bottom;
if (verticalCover === 1) {
const bodyRect = this._bodyNode.getBoundingClientRect();
top = bodyRect.top;
bottom = bodyRect.bottom;
}
let x = (
sourceElementRect.left +
sourceElementRect.width * ((-horizontal * horizontalCover + 1) * 0.5) +
menuRect.width * ((-horizontal + 1) * -0.5)
);
let y = (
sourceElementRect.top +
(menuRect.top - top) +
sourceElementRect.height * ((-vertical * verticalCover + 1) * 0.5) +
(bottom - top) * ((-vertical + 1) * -0.5)
);
x = Math.max(0.0, Math.min(containerNodeRect.width - menuRect.width, x));
y = Math.max(0.0, Math.min(containerNodeRect.height - menuRect.height, y));
menu.style.left = `${x}px`;
menu.style.top = `${y}px`;
}
_close(item, cause, cancelable, originalEvent) {
if (this._isClosed) { return true; }
const action = (item !== null ? item.dataset.menuAction : null);
const {altKey=false, ctrlKey=false, metaKey=false, shiftKey=false} = originalEvent;
const detail = {
menu: this,
item,
action,
cause,
altKey,
ctrlKey,
metaKey,
shiftKey
};
const result = this._sourceElement.dispatchEvent(new CustomEvent('menuClose', {bubbles: false, cancelable, detail}));
if (cancelable && !result) { return false; }
PopupMenu.openMenus.delete(this);
this._isClosed = true;
this._eventListeners.removeAllEventListeners();
this._itemEventListeners.removeAllEventListeners();
if (this._containerNode.parentNode !== null) {
this._containerNode.parentNode.removeChild(this._containerNode);
}
this.trigger('close', detail);
return true;
}
}
Object.defineProperty(PopupMenu, 'openMenus', {
configurable: false,
enumerable: true,
writable: false,
value: new Set()
});