suneditor 2.46.2 → 3.0.0-alpha.2

package/src/core/class/selection.js

@@ -0,0 +1,508 @@
+/**
+ * @fileoverview Selection class
+ */
+
+import CoreInjector from '../../editorInjector/_core';
+import { domUtils, unicode } from '../../helper';
+
+const Selection = function (editor) {
+	CoreInjector.call(this, editor);
+
+	// members
+	this.range = null;
+	this.selectionNode = null;
+};
+
+Selection.prototype = {
+	/**
+	 * @description Get window selection obejct
+	 * @returns {Object}
+	 */
+	get() {
+		const selection = this._shadowRoot?.getSelection() || this.editor.frameContext.get('_ww').getSelection();
+		if (!selection) return null;
+		if (!this.status._range && !this.editor.frameContext.get('wysiwyg').contains(selection.focusNode)) {
+			selection.removeAllRanges();
+			selection.addRange(this._createDefaultRange());
+		}
+		return selection;
+	},
+
+	/**
+	 * @description Get current editor's range object
+	 * @returns {Object}
+	 */
+	getRange() {
+		const range = this.status._range || this._createDefaultRange();
+		const selection = this.get();
+		if (range.collapsed === selection.isCollapsed || !this.editor.frameContext.get('wysiwyg').contains(selection.focusNode)) {
+			if (this.component.is(range.startContainer)) {
+				const compInfo = this.component.get(range.startContainer);
+				const container = compInfo?.container;
+				if (!container) return range;
+				return this.setRange(container, 0, container, 1);
+			}
+
+			return range;
+		}
+
+		if (selection.rangeCount > 0) {
+			this.status._range = selection.getRangeAt(0);
+			return this.status._range;
+		} else {
+			const sc = selection.anchorNode,
+				ec = selection.focusNode,
+				so = selection.anchorOffset,
+				eo = selection.focusOffset;
+			const compareValue = domUtils.compareElements(sc, ec);
+			const rightDir = compareValue.ancestor && (compareValue.result === 0 ? so <= eo : compareValue.result > 1 ? true : false);
+			return this.setRange(rightDir ? sc : ec, rightDir ? so : eo, rightDir ? ec : sc, rightDir ? eo : so);
+		}
+	},
+
+	/**
+	 * @description Set current editor's range object and return.
+	 * @param {Node} startCon The startContainer property of the selection object.
+	 * @param {number} startOff The startOffset property of the selection object.
+	 * @param {Node} endCon The endContainer property of the selection object.
+	 * @param {number} endOff The endOffset property of the selection object.
+	 * @returns {Object} Range object.
+	 */
+	setRange(startCon, startOff, endCon, endOff) {
+		if (!startCon || !endCon) return;
+		if (startOff > startCon.textContent.length) startOff = startCon.textContent.length;
+		if (endOff > endCon.textContent.length) endOff = endCon.textContent.length;
+		if (this.format.isLine(startCon)) {
+			startCon = startCon.childNodes[startOff > 0 ? startCon.childNodes.length - 1 : 0] || startCon;
+			startOff = startOff > 0 ? (startCon.nodeType === 1 && !domUtils.isBreak(startCon) ? 1 : startCon.textContent ? startCon.textContent.length : 0) : 0;
+		}
+		if (this.format.isLine(endCon)) {
+			endCon = endCon.childNodes[endOff > 0 ? endCon.childNodes.length - 1 : 0] || endCon;
+			endOff = endOff > 0 ? (endCon.nodeType === 1 && !domUtils.isBreak(endCon) ? 1 : endCon.textContent ? endCon.textContent.length : 0) : 0;
+		}
+
+		const range = this.editor.frameContext.get('_wd').createRange();
+
+		try {
+			range.setStart(startCon, startOff);
+			range.setEnd(endCon, endOff);
+		} catch (error) {
+			console.warn('[SUNEDITOR.selection.focus.warn]', error.message);
+			this.editor._nativeFocus();
+			return;
+		}
+
+		const selection = this.get();
+
+		if (selection.removeAllRanges) {
+			selection.removeAllRanges();
+		}
+
+		selection.addRange(range);
+		this.status._range = range;
+		this._rangeInfo(range, this.get());
+
+		if (this.editor.frameOptions.get('iframe')) this.__focus();
+
+		return range;
+	},
+
+	/**
+	 * @description Remove range object and button effect
+	 */
+	removeRange() {
+		this.status._range = null;
+		this.selectionNode = null;
+		if (this.status.hasFocus) this.get().removeAllRanges();
+		this.eventManager._setKeyEffect([]);
+	},
+
+	/**
+	 * @description If the "range" object is a non-editable area, add a line at the top of the editor and update the "range" object.
+	 * Returns a new "range" or argument "range".
+	 * @param {Object} range core.getRange()
+	 * @param {Element|null} container If there is "container" argument, it creates a line in front of the container.
+	 * @returns {Object} range
+	 */
+	getRangeAndAddLine(range, container) {
+		if (this._isNone(range)) {
+			const parent = container?.parentElement || this.editor.frameContext.get('wysiwyg');
+			const op = domUtils.createElement(this.options.get('defaultLine'), null, '<br>');
+			parent.insertBefore(op, container && container !== parent ? (!container.previousElementSibling ? container : container.nextElementSibling) : parent.firstElementChild);
+			this.setRange(op.firstElementChild, 0, op.firstElementChild, 1);
+			range = this.status._range;
+		}
+		return range;
+	},
+
+	/**
+	 * @description Get current select node
+	 * @returns {Node}
+	 */
+	getNode() {
+		if (!this.editor.frameContext.get('wysiwyg').contains(this.selectionNode)) this._init();
+		if (!this.selectionNode) {
+			const selectionNode = domUtils.getEdgeChild(
+				this.editor.frameContext.get('wysiwyg').firstChild,
+				function (current) {
+					return current.childNodes.length === 0 || current.nodeType === 3;
+				},
+				false
+			);
+			if (!selectionNode) {
+				this._init();
+			} else {
+				this.selectionNode = selectionNode;
+				return selectionNode;
+			}
+		}
+		return this.selectionNode;
+	},
+
+	/**
+	 * @description  Get hte clientRects object.
+	 * @param {Range|Element|null} target Range object | Element | null
+	 * @param {"start"|"end"} position It is based on the position of the rect object to be returned in case of range selection.
+	 * @returns
+	 */
+	getRects(target, position) {
+		const targetAbs = target?.nodeType === 1 ? this._w.getComputedStyle(target).position === 'absolute' : false;
+		target = !target || target.nodeType === 3 ? this.getRange() : target;
+		const globalScroll = this.offset.getGlobalScroll();
+		let isStartPosition = position === 'start';
+		let scrollLeft = globalScroll.left;
+		let scrollTop = globalScroll.top;
+
+		let rects = target.getClientRects();
+		rects = rects[isStartPosition ? 0 : rects.length - 1];
+
+		if (!rects) {
+			const node = this.getNode();
+			if (this.format.isLine(node)) {
+				const zeroWidth = domUtils.createTextNode(unicode.zeroWidthSpace);
+				this.html.insertNode(zeroWidth, null, true);
+				this.setRange(zeroWidth, 1, zeroWidth, 1);
+				this._init();
+				rects = this.getRange().getClientRects();
+				rects = rects[isStartPosition ? 0 : rects.length - 1];
+			}
+
+			if (!rects) {
+				const nodeOffset = this.offset.get(node);
+				rects = {
+					left: nodeOffset.left,
+					top: nodeOffset.top,
+					right: nodeOffset.right,
+					bottom: nodeOffset.top + node.offsetHeight,
+					noText: true
+				};
+				scrollLeft = 0;
+				scrollTop = 0;
+			}
+
+			isStartPosition = true;
+		}
+
+		const iframeRects = /^iframe$/i.test(this.editor.frameContext.get('wysiwygFrame').nodeName) ? this.editor.frameContext.get('wysiwygFrame').getClientRects()[0] : null;
+		if (!targetAbs && iframeRects) {
+			rects = {
+				left: rects.left + iframeRects.left,
+				top: rects.top + iframeRects.top,
+				right: rects.right + iframeRects.right - iframeRects.width,
+				bottom: rects.bottom + iframeRects.bottom - iframeRects.height
+			};
+		}
+
+		return {
+			rects: rects,
+			position: isStartPosition ? 'start' : 'end',
+			scrollLeft: scrollLeft,
+			scrollTop: scrollTop
+		};
+	},
+
+	/**
+	 * @description Get the custom range object of the event.
+	 * @returns {Event} e Event object
+	 * @returns {Object} {sc: startContainer, so: startOffset, ec: endContainer, eo: endOffset}
+	 */
+	getEventLocationRange(e) {
+		let sc, so, ec, eo;
+		if (e.rangeParent) {
+			sc = e.rangeParent;
+			so = e.rangeOffset;
+			ec = e.rangeParent;
+			eo = e.rangeOffset;
+		} else if (this.editor.frameContext.get('_wd').caretRangeFromPoint) {
+			let r = this.editor.frameContext.get('_wd').caretRangeFromPoint(e.clientX, e.clientY);
+			if (!r) r = this.selection.getRange();
+			sc = r.startContainer;
+			so = r.startOffset;
+			ec = r.endContainer;
+			eo = r.endOffset;
+		} else {
+			const r = this.selection.getRange();
+			sc = r.startContainer;
+			so = r.startOffset;
+			ec = r.endContainer;
+			eo = r.endOffset;
+		}
+
+		return {
+			sc,
+			so,
+			ec,
+			eo
+		};
+	},
+
+	/**
+	 * @description Scroll to the corresponding selection or range position.
+	 * @param {Selection|Range|Node} ref selection or range object
+	 */
+	scrollTo(ref) {
+		if (ref instanceof Selection) {
+			ref = ref.getRangeAt(0);
+		} else if (ref instanceof Node) {
+			ref = this.selection.setRange(ref, 1, ref, 1);
+		} else if (typeof ref?.startContainer === 'undefined') {
+			console.warn('[SUNEDITOR.html.scrollTo.warn] "selectionRange" must be Selection or Range or Node object.', ref);
+		}
+
+		const rect = ref.getBoundingClientRect();
+		const isVisible = rect.top >= 0 && rect.bottom <= this.editor.frameContext.get('wysiwygFrame').innerHeight;
+
+		if (isVisible) return;
+
+		ref.startContainer?.scrollIntoView?.({ behavior: 'auto', block: 'nearest' });
+	},
+
+	/**
+	 * @description Returns true if there is no valid selection.
+	 * @param {Object} range selection.getRange()
+	 * @returns {boolean}
+	 */
+	_isNone(range) {
+		const comm = range.commonAncestorContainer;
+		return (
+			(domUtils.isWysiwygFrame(range.startContainer) && domUtils.isWysiwygFrame(range.endContainer)) ||
+			/FIGURE/i.test(comm.nodeName) ||
+			(this.editor._fileManager.regExp.test(comm.nodeName) && (!this.editor._fileManager.tagAttrs[comm.nodeName] || this.editor._fileManager.tagAttrs[comm.nodeName]?.every((v) => comm.hasAttribute(v)))) ||
+			this.component.is(comm)
+		);
+	},
+
+	/**
+	 * @description Return the range object of editor's first child node
+	 * @returns {Object}
+	 * @private
+	 */
+	_createDefaultRange() {
+		const wysiwyg = this.editor.frameContext.get('wysiwyg');
+		const range = this.editor.frameContext.get('_wd').createRange();
+
+		let firstFormat = wysiwyg.firstElementChild;
+		let focusEl = null;
+		if (!firstFormat) {
+			focusEl = domUtils.createElement('BR');
+			firstFormat = domUtils.createElement(this.options.get('defaultLine'), null, focusEl);
+			wysiwyg.appendChild(firstFormat);
+		} else {
+			focusEl = firstFormat.firstChild;
+			if (!focusEl) {
+				focusEl = domUtils.createElement('BR');
+				firstFormat.appendChild(focusEl);
+			}
+		}
+
+		range.setStart(focusEl, 0);
+		range.setEnd(focusEl, 0);
+
+		return range;
+	},
+
+	/**
+	 * @description Set "range" and "selection" info.
+	 * @param {Object} range range object.
+	 * @param {Object} selection selection object.
+	 */
+	_rangeInfo(range, selection) {
+		let selectionNode = null;
+		this.status._range = range;
+
+		if (range.collapsed) {
+			if (domUtils.isWysiwygFrame(range.commonAncestorContainer)) selectionNode = range.commonAncestorContainer.children[range.startOffset] || range.commonAncestorContainer;
+			else selectionNode = range.commonAncestorContainer;
+		} else {
+			selectionNode = selection.extentNode || selection.anchorNode;
+		}
+
+		this.selectionNode = selectionNode;
+	},
+
+	/**
+	 * @description Saving the range object and the currently selected node of editor
+	 * @private
+	 */
+	_init() {
+		const activeEl = this.editor.frameContext.get('_wd').activeElement;
+		if (domUtils.isInputElement(activeEl)) {
+			this.selectionNode = activeEl;
+			return activeEl;
+		}
+
+		const selection = this.get();
+
+		if (!selection) return null;
+		let range = null;
+
+		if (selection.rangeCount > 0) {
+			range = selection.getRangeAt(0);
+		} else {
+			range = this._createDefaultRange();
+		}
+
+		this._rangeInfo(range, selection);
+	},
+
+	/**
+	 * @description Focus method
+	 * @private
+	 */
+	__focus() {
+		const caption = domUtils.getParentElement(this.getNode(), 'figcaption');
+		if (caption) {
+			caption.focus();
+		} else {
+			this.editor.frameContext.get('wysiwyg').focus();
+		}
+	},
+
+	/**
+	 * @description Reset range object to text node selected status.
+	 * @returns {boolean} Returns false if there is no valid selection.
+	 * @private
+	 */
+	_resetRangeToTextNode() {
+		let rangeObj = this.getRange();
+		if (this._isNone(rangeObj)) {
+			if (!domUtils.isWysiwygFrame(rangeObj.startContainer) || !domUtils.isWysiwygFrame(rangeObj.endContainer)) return false;
+			const ww = rangeObj.startContainer;
+			rangeObj = this.setRange(ww.firstElementChild, 0, ww.lastElementChild, 1);
+		}
+
+		const range = rangeObj;
+		let startCon = range.startContainer;
+		let startOff = range.startOffset;
+		let endCon = range.endContainer;
+		let endOff = range.endOffset;
+		let tempCon, tempOffset, tempChild;
+
+		if (this.format.isLine(startCon)) {
+			if (!startCon.childNodes[startOff]) {
+				startCon = startCon.lastChild || startCon;
+				startOff = startCon.textContent.length;
+			} else {
+				startCon = startCon.childNodes[startOff] || startCon;
+				startOff = 0;
+			}
+			while (startCon?.nodeType === 1 && startCon.firstChild) {
+				startCon = startCon.firstChild || startCon;
+				startOff = 0;
+			}
+		}
+		if (this.format.isLine(endCon)) {
+			endCon = endCon.childNodes[endOff] || endCon.lastChild || endCon;
+			while (endCon?.nodeType === 1 && endCon.lastChild) {
+				endCon = endCon.lastChild;
+			}
+			endOff = endCon.textContent.length;
+		}
+
+		// startContainer
+		tempCon = domUtils.isWysiwygFrame(startCon) ? this.editor.frameContext.get('wysiwyg').firstChild : startCon;
+		tempOffset = startOff;
+
+		if (domUtils.isBreak(tempCon) || (tempCon.nodeType === 1 && tempCon.childNodes.length > 0)) {
+			const onlyBreak = domUtils.isBreak(tempCon);
+			if (!onlyBreak) {
+				const tempConCache = tempCon;
+				while (tempCon && !domUtils.isBreak(tempCon) && tempCon.nodeType === 1) {
+					tempChild = tempCon.childNodes;
+					if (tempChild.length === 0) break;
+					tempCon = tempChild[tempOffset > 0 ? tempOffset - 1 : tempOffset] || !/FIGURE/i.test(tempChild[0].nodeName) ? tempChild[0] : tempCon.previousElementSibling || tempCon.previousSibling || startCon;
+					tempOffset = tempOffset > 0 ? tempCon.textContent.length : tempOffset;
+				}
+
+				let format = this.format.getLine(tempCon, null);
+				if (format === this.format.getBlock(format, null)) {
+					tempCon = tempCon || tempConCache;
+					format = domUtils.createElement(domUtils.getParentElement(tempCon, domUtils.isTableCell) ? 'DIV' : this.options.get('defaultLine'));
+					tempCon.parentNode.insertBefore(format, tempCon);
+					if (tempCon !== tempConCache) format.appendChild(tempCon);
+				}
+			}
+
+			if (domUtils.isBreak(tempCon) || this.component.is(tempCon)) {
+				const emptyText = domUtils.createTextNode(unicode.zeroWidthSpace);
+				tempCon.parentNode.insertBefore(emptyText, tempCon);
+				tempCon = emptyText;
+				if (onlyBreak) {
+					if (startCon === endCon) {
+						endCon = tempCon;
+						endOff = 1;
+					}
+				}
+			}
+		}
+
+		// set startContainer
+		startCon = tempCon;
+		startOff = tempOffset;
+
+		// endContainer
+		tempCon = domUtils.isWysiwygFrame(endCon) ? this.editor.frameContext.get('wysiwyg').lastChild : endCon;
+		tempOffset = endOff;
+
+		if (domUtils.isBreak(tempCon) || (tempCon.nodeType === 1 && tempCon.childNodes.length > 0)) {
+			const onlyBreak = domUtils.isBreak(tempCon);
+			if (!onlyBreak) {
+				while (tempCon && !domUtils.isBreak(tempCon) && tempCon.nodeType === 1) {
+					tempChild = tempCon.childNodes;
+					if (tempChild.length === 0) break;
+					tempCon = tempChild[tempOffset > 0 ? tempOffset - 1 : tempOffset] || !/FIGURE/i.test(tempChild[0].nodeName) ? tempChild[0] : tempCon.previousElementSibling || tempCon.previousSibling || startCon;
+					tempOffset = tempOffset > 0 ? tempCon.textContent.length : tempOffset;
+				}
+
+				let format = this.format.getLine(tempCon, null);
+				if (format === this.format.getBlock(format, null)) {
+					format = domUtils.createElement(domUtils.isTableCell(format) ? 'DIV' : this.options.get('defaultLine'));
+					tempCon.parentNode.insertBefore(format, tempCon);
+					format.appendChild(tempCon);
+				}
+			}
+
+			if (domUtils.isBreak(tempCon)) {
+				const emptyText = domUtils.createTextNode(unicode.zeroWidthSpace);
+				tempCon.parentNode.insertBefore(emptyText, tempCon);
+				tempCon = emptyText;
+				tempOffset = 1;
+				if (onlyBreak && !tempCon.previousSibling) {
+					domUtils.removeItem(endCon);
+				}
+			}
+		}
+
+		// set endContainer
+		endCon = tempCon;
+		endOff = tempOffset;
+
+		// set Range
+		this.setRange(startCon, startOff, endCon, endOff);
+		return true;
+	},
+
+	constructor: Selection
+};
+
+export default Selection;

package/src/core/class/shortcuts.js

@@ -0,0 +1,38 @@
+/**
+ * @fileoverview Shortcuts class
+ */
+
+const Shortcuts = function (editor) {
+	this.editor = editor;
+	this.isDisabled = false;
+};
+
+Shortcuts.prototype = {
+	/**
+	 * @description If there is a shortcut function, run it.
+	 * @param {number} keyCode event.keyCode
+	 * @param {boolean} shift Whether to press shift key
+	 * @returns {boolean} Whether to execute shortcuts
+	 */
+	command(keyCode, shift) {
+		if (this.isDisabled) return false;
+
+		const info = this.editor.shortcutsKeyMap.get(keyCode + (shift ? 1000 : 0));
+		if (!info || (!shift && info.s)) return false;
+
+		this.editor.run(info.c, info.t, info.e);
+		return true;
+	},
+
+	disable() {
+		this.isDisabled = true;
+	},
+
+	enable() {
+		this.isDisabled = false;
+	},
+
+	constructor: Shortcuts
+};
+
+export default Shortcuts;