425 lines
16 KiB
JavaScript
425 lines
16 KiB
JavaScript
import PointerTracker from 'pointer-tracker';
|
|
|
|
const minScaleAttr = 'min-scale';
|
|
const allowPanMinScaleAttr = 'allow-pan-min-scale';
|
|
const resetToMinScaleLimitAttr = 'reset-to-min-scale-limit';
|
|
const reachMinScaleStrategyAttr = 'reach-min-scale-strategy';
|
|
const stopPropagateHandledAttr = 'stop-propagate-handled';
|
|
const reachMinScaleStrategyDefault = 'none';
|
|
function getDistance(a, b) {
|
|
if (!b)
|
|
return 0;
|
|
return Math.sqrt((b.clientX - a.clientX) ** 2 + (b.clientY - a.clientY) ** 2);
|
|
}
|
|
function getMidpoint(a, b) {
|
|
if (!b)
|
|
return a;
|
|
return {
|
|
clientX: (a.clientX + b.clientX) / 2,
|
|
clientY: (a.clientY + b.clientY) / 2,
|
|
};
|
|
}
|
|
function getAbsoluteValue(value, max) {
|
|
if (typeof value === 'number')
|
|
return value;
|
|
if (value.trimRight().endsWith('%')) {
|
|
return max * parseFloat(value) / 100;
|
|
}
|
|
return parseFloat(value);
|
|
}
|
|
// I'd rather use DOMMatrix/DOMPoint here, but the browser support isn't good enough.
|
|
// Given that, better to use something everything supports.
|
|
let cachedSvg;
|
|
function getSVG() {
|
|
return cachedSvg || (cachedSvg = document.createElementNS('http://www.w3.org/2000/svg', 'svg'));
|
|
}
|
|
function createMatrix() {
|
|
return getSVG().createSVGMatrix();
|
|
}
|
|
function createPoint() {
|
|
return getSVG().createSVGPoint();
|
|
}
|
|
const MIN_SCALE = 0.01;
|
|
const ALLOW_PAN_MIN_SCALE = -1;
|
|
const RESET_TO_MIN_SCALE_LIMIT = -1;
|
|
const BUTTON_LEFT = 0;
|
|
const roundedCmp = (a, b) => {
|
|
return Math.round(a * 100) - Math.round(b * 100);
|
|
};
|
|
class PinchZoom extends HTMLElement {
|
|
static get observedAttributes() { return [minScaleAttr]; }
|
|
constructor() {
|
|
super();
|
|
// Current transform.
|
|
this._transform = createMatrix();
|
|
// Watch for children changes.
|
|
// Note this won't fire for initial contents,
|
|
// so _stageElChange is also called in connectedCallback.
|
|
new MutationObserver(() => this._stageElChange())
|
|
.observe(this, { childList: true });
|
|
// Watch for pointers
|
|
const pointerTracker = new PointerTracker(this, {
|
|
start: (pointer, event) => {
|
|
// We only want to track 2 pointers at most
|
|
if (pointerTracker.currentPointers.length === 2 || !this._positioningEl)
|
|
return false;
|
|
const isPan = pointerTracker.currentPointers.length + 1 === 1;
|
|
const handled = !(isPan && !this._allowPan());
|
|
if (handled) {
|
|
this._maybeStopPropagate(event);
|
|
if (!isPan) { // only cancel if something was propagated
|
|
this._maybeEmitCancel([pointer, ...pointerTracker.currentPointers]);
|
|
}
|
|
}
|
|
event.preventDefault();
|
|
return true;
|
|
},
|
|
move: (previousPointers, _, event) => {
|
|
this._onPointerMove(previousPointers, pointerTracker.currentPointers, event);
|
|
},
|
|
end: (pointer, event) => {
|
|
this._onPointerEnd(pointer, pointerTracker.currentPointers, event);
|
|
},
|
|
});
|
|
this.addEventListener('wheel', event => this._onWheel(event));
|
|
this.addEventListener('click', event => this._onClick(event, pointerTracker));
|
|
}
|
|
attributeChangedCallback(name, oldValue, newValue) {
|
|
if (name === minScaleAttr) {
|
|
if (this.scale < this.minScale) {
|
|
this.setTransform({ scale: this.minScale });
|
|
}
|
|
}
|
|
}
|
|
get minScale() {
|
|
const attrValue = this.getAttribute(minScaleAttr);
|
|
if (!attrValue)
|
|
return MIN_SCALE;
|
|
const value = parseFloat(attrValue);
|
|
if (Number.isFinite(value))
|
|
return Math.max(MIN_SCALE, value);
|
|
return MIN_SCALE;
|
|
}
|
|
set minScale(value) {
|
|
this.setAttribute(minScaleAttr, String(value));
|
|
}
|
|
get reachMinScaleStrategy() {
|
|
const attrValue = this.getAttribute(reachMinScaleStrategyAttr);
|
|
const v = attrValue;
|
|
return v || reachMinScaleStrategyDefault;
|
|
}
|
|
set reachMinScaleStrategy(value) {
|
|
this.setAttribute(reachMinScaleStrategyAttr, value);
|
|
}
|
|
get allowPanMinScale() {
|
|
const attrValue = this.getAttribute(allowPanMinScaleAttr);
|
|
if (!attrValue)
|
|
return ALLOW_PAN_MIN_SCALE;
|
|
const value = parseFloat(attrValue);
|
|
if (Number.isFinite(value))
|
|
return Math.max(ALLOW_PAN_MIN_SCALE, value);
|
|
return ALLOW_PAN_MIN_SCALE;
|
|
}
|
|
set allowPanMinScale(value) {
|
|
this.setAttribute(allowPanMinScaleAttr, String(value));
|
|
}
|
|
get resetToMinScaleLimit() {
|
|
const attrValue = this.getAttribute(resetToMinScaleLimitAttr);
|
|
if (!attrValue)
|
|
return RESET_TO_MIN_SCALE_LIMIT;
|
|
const value = parseFloat(attrValue);
|
|
if (Number.isFinite(value))
|
|
return Math.max(RESET_TO_MIN_SCALE_LIMIT, value);
|
|
return RESET_TO_MIN_SCALE_LIMIT;
|
|
}
|
|
set resetToMinScaleLimit(value) {
|
|
this.setAttribute(resetToMinScaleLimitAttr, String(value));
|
|
}
|
|
get stopPropagateHandled() {
|
|
return this.hasAttribute(stopPropagateHandledAttr);
|
|
}
|
|
set stopPropagateHandled(value) {
|
|
if (value) {
|
|
this.setAttribute(stopPropagateHandledAttr, '');
|
|
}
|
|
else {
|
|
this.removeAttribute(stopPropagateHandledAttr);
|
|
}
|
|
}
|
|
connectedCallback() {
|
|
this._stageElChange();
|
|
}
|
|
get x() {
|
|
return this._transform.e;
|
|
}
|
|
get y() {
|
|
return this._transform.f;
|
|
}
|
|
get scale() {
|
|
return this._transform.a;
|
|
}
|
|
/**
|
|
* Change the scale, adjusting x/y by a given transform origin.
|
|
*/
|
|
scaleTo(scale, opts = {}) {
|
|
let { originX = 0, originY = 0, } = opts;
|
|
const { relativeTo = 'content', allowChangeEvent = false, } = opts;
|
|
const relativeToEl = (relativeTo === 'content' ? this._positioningEl : this);
|
|
// No content element? Fall back to just setting scale
|
|
if (!relativeToEl || !this._positioningEl) {
|
|
this.setTransform({ scale, allowChangeEvent });
|
|
return;
|
|
}
|
|
const rect = relativeToEl.getBoundingClientRect();
|
|
originX = getAbsoluteValue(originX, rect.width);
|
|
originY = getAbsoluteValue(originY, rect.height);
|
|
if (relativeTo === 'content') {
|
|
originX += this.x;
|
|
originY += this.y;
|
|
}
|
|
else {
|
|
const currentRect = this._positioningEl.getBoundingClientRect();
|
|
originX -= currentRect.left;
|
|
originY -= currentRect.top;
|
|
}
|
|
this._applyChange({
|
|
allowChangeEvent,
|
|
originX,
|
|
originY,
|
|
scaleDiff: scale / this.scale,
|
|
});
|
|
}
|
|
/**
|
|
* Update the stage with a given scale/x/y.
|
|
*/
|
|
setTransform(opts = {}) {
|
|
const { scale = this.scale, allowChangeEvent = false, } = opts;
|
|
let { x = this.x, y = this.y, } = opts;
|
|
// If we don't have an element to position, just set the value as given.
|
|
// We'll check bounds later.
|
|
if (!this._positioningEl) {
|
|
this._updateTransform(scale, x, y, allowChangeEvent);
|
|
return;
|
|
}
|
|
// Get current layout
|
|
const thisBounds = this.getBoundingClientRect();
|
|
const positioningElBounds = this._positioningEl.getBoundingClientRect();
|
|
// Not displayed. May be disconnected or display:none.
|
|
// Just take the values, and we'll check bounds later.
|
|
if (!thisBounds.width || !thisBounds.height) {
|
|
this._updateTransform(scale, x, y, allowChangeEvent);
|
|
return;
|
|
}
|
|
// Create points for _positioningEl.
|
|
let topLeft = createPoint();
|
|
topLeft.x = positioningElBounds.left - thisBounds.left;
|
|
topLeft.y = positioningElBounds.top - thisBounds.top;
|
|
let bottomRight = createPoint();
|
|
bottomRight.x = positioningElBounds.width + topLeft.x;
|
|
bottomRight.y = positioningElBounds.height + topLeft.y;
|
|
// Calculate the intended position of _positioningEl.
|
|
const matrix = createMatrix()
|
|
.translate(x, y)
|
|
.scale(scale)
|
|
// Undo current transform
|
|
.multiply(this._transform.inverse());
|
|
topLeft = topLeft.matrixTransform(matrix);
|
|
bottomRight = bottomRight.matrixTransform(matrix);
|
|
// Ensure _positioningEl can't move beyond out-of-bounds.
|
|
// Correct for x
|
|
if (topLeft.x > thisBounds.width) {
|
|
x += thisBounds.width - topLeft.x;
|
|
}
|
|
else if (bottomRight.x < 0) {
|
|
x += -bottomRight.x;
|
|
}
|
|
// Correct for y
|
|
if (topLeft.y > thisBounds.height) {
|
|
y += thisBounds.height - topLeft.y;
|
|
}
|
|
else if (bottomRight.y < 0) {
|
|
y += -bottomRight.y;
|
|
}
|
|
this._updateTransform(scale, x, y, allowChangeEvent);
|
|
}
|
|
/**
|
|
* Update transform values without checking bounds. This is only called in setTransform.
|
|
*/
|
|
_updateTransform(scale, x, y, allowChangeEvent) {
|
|
// Avoid scaling to zero
|
|
if (scale < this.minScale) {
|
|
scale = this.minScale;
|
|
}
|
|
// Return if there's no change
|
|
if (scale === this.scale &&
|
|
x === this.x &&
|
|
y === this.y)
|
|
return;
|
|
this._transform.e = x;
|
|
this._transform.f = y;
|
|
this._transform.d = this._transform.a = scale;
|
|
this.style.setProperty('--x', this.x + 'px');
|
|
this.style.setProperty('--y', this.y + 'px');
|
|
this.style.setProperty('--scale', this.scale + '');
|
|
if (allowChangeEvent) {
|
|
const event = new Event('change', { bubbles: true });
|
|
this.dispatchEvent(event);
|
|
}
|
|
}
|
|
/**
|
|
* Called when the direct children of this element change.
|
|
* Until we have have shadow dom support across the board, we
|
|
* require a single element to be the child of <pinch-zoom>, and
|
|
* that's the element we pan/scale.
|
|
*/
|
|
_stageElChange() {
|
|
this._positioningEl = undefined;
|
|
if (this.children.length === 0)
|
|
return;
|
|
this._positioningEl = this.children[0];
|
|
if (this.children.length > 1) {
|
|
console.warn('<pinch-zoom> must not have more than one child.');
|
|
}
|
|
// Do a bounds check
|
|
this.setTransform({ allowChangeEvent: true });
|
|
}
|
|
_onWheel(event) {
|
|
if (!this._positioningEl)
|
|
return;
|
|
event.preventDefault();
|
|
const currentRect = this._positioningEl.getBoundingClientRect();
|
|
let { deltaY } = event;
|
|
const { ctrlKey, deltaMode } = event;
|
|
if (deltaMode === 1) { // 1 is "lines", 0 is "pixels"
|
|
// Firefox uses "lines" for some types of mouse
|
|
deltaY *= 15;
|
|
}
|
|
// ctrlKey is true when pinch-zooming on a trackpad.
|
|
const divisor = ctrlKey ? 100 : 300;
|
|
const scaleDiff = 1 - deltaY / divisor;
|
|
const isZoomOut = scaleDiff < 1;
|
|
this._applyChange({
|
|
scaleDiff,
|
|
originX: event.clientX - currentRect.left,
|
|
originY: event.clientY - currentRect.top,
|
|
allowChangeEvent: true,
|
|
});
|
|
if (isZoomOut) {
|
|
this._maybeResetScale();
|
|
}
|
|
}
|
|
_onPointerMove(previousPointers, currentPointers, event) {
|
|
if (!this._positioningEl)
|
|
return;
|
|
const isPan = previousPointers.length < 2;
|
|
if (isPan && !this._allowPan()) {
|
|
return;
|
|
}
|
|
// Combine next points with previous points
|
|
const currentRect = this._positioningEl.getBoundingClientRect();
|
|
// For calculating panning movement
|
|
const prevMidpoint = getMidpoint(previousPointers[0], previousPointers[1]);
|
|
const newMidpoint = getMidpoint(currentPointers[0], currentPointers[1]);
|
|
// Midpoint within the element
|
|
const originX = prevMidpoint.clientX - currentRect.left;
|
|
const originY = prevMidpoint.clientY - currentRect.top;
|
|
// Calculate the desired change in scale
|
|
const prevDistance = getDistance(previousPointers[0], previousPointers[1]);
|
|
const newDistance = getDistance(currentPointers[0], currentPointers[1]);
|
|
const scaleDiff = prevDistance ? newDistance / prevDistance : 1;
|
|
this._applyChange({
|
|
originX, originY, scaleDiff,
|
|
panX: newMidpoint.clientX - prevMidpoint.clientX,
|
|
panY: newMidpoint.clientY - prevMidpoint.clientY,
|
|
allowChangeEvent: true,
|
|
});
|
|
this._maybeStopPropagate(event);
|
|
}
|
|
_maybeResetScale() {
|
|
if (roundedCmp(this.scale, this.resetToMinScaleLimit) <= 0) {
|
|
this._resetToMinScale();
|
|
}
|
|
}
|
|
_onPointerEnd(pointer, currentPointers, event) {
|
|
if (!this._positioningEl)
|
|
return;
|
|
const totalPointers = 1 + currentPointers.length;
|
|
const isPinch = totalPointers >= 2;
|
|
const isPan = totalPointers == 1;
|
|
if (isPinch) {
|
|
this._maybeResetScale();
|
|
}
|
|
if (isPan && !this._allowPan()) {
|
|
return;
|
|
}
|
|
this._maybeStopPropagate(event);
|
|
}
|
|
_resetToMinScale() {
|
|
if (this.reachMinScaleStrategy === 'reset') {
|
|
this.setTransform({ scale: this.minScale, x: 0, y: 0 });
|
|
}
|
|
else {
|
|
this.setTransform({ scale: this.minScale });
|
|
}
|
|
}
|
|
/** Transform the view & fire a change event */
|
|
_applyChange(opts = {}) {
|
|
const { panX = 0, panY = 0, originX = 0, originY = 0, scaleDiff = 1, allowChangeEvent = false, } = opts;
|
|
const matrix = createMatrix()
|
|
// Translate according to panning.
|
|
.translate(panX, panY)
|
|
// Scale about the origin.
|
|
.translate(originX, originY)
|
|
// Apply current translate
|
|
.translate(this.x, this.y)
|
|
.scale(scaleDiff)
|
|
.translate(-originX, -originY)
|
|
// Apply current scale.
|
|
.scale(this.scale);
|
|
// Convert the transform into basic translate & scale.
|
|
this.setTransform({
|
|
allowChangeEvent,
|
|
scale: matrix.a,
|
|
x: matrix.e,
|
|
y: matrix.f,
|
|
});
|
|
}
|
|
_maybeStopPropagate(event) {
|
|
if (this.stopPropagateHandled) {
|
|
event.stopPropagation();
|
|
}
|
|
}
|
|
_allowPan() {
|
|
return (this.allowPanMinScale > 0
|
|
&& roundedCmp(this.scale, this.allowPanMinScale) > 0);
|
|
}
|
|
_maybeEmitCancel(pointers) {
|
|
const makeCancelEvent = (pointer) => (new PointerEvent('pointercancel', {
|
|
pointerId: pointer.id,
|
|
clientX: pointer.clientX,
|
|
clientY: pointer.clientY,
|
|
}));
|
|
if (this.stopPropagateHandled) {
|
|
pointers.forEach(p => {
|
|
if (this.parentElement && typeof this.parentElement.dispatchEvent === 'function') {
|
|
this.parentElement.dispatchEvent(makeCancelEvent(p));
|
|
}
|
|
});
|
|
}
|
|
}
|
|
_onClick(event, pointerTracker) {
|
|
// We never handle non-left-clicks
|
|
if (event.button !== BUTTON_LEFT) {
|
|
return;
|
|
}
|
|
const wasPanning = pointerTracker.currentPointers.length === 0;
|
|
const handled = !(wasPanning && !this._allowPan());
|
|
if (handled) {
|
|
this._maybeStopPropagate(event);
|
|
}
|
|
}
|
|
}
|
|
|
|
customElements.define('pinch-zoom', PinchZoom);
|
|
|
|
export { PinchZoom as default };
|