import { BaseEditor, Editor, Element, Node, Path, Point, Range, Scrubber, Transforms, } from 'slate' import { TextDiff } from '../utils/diff-text' import { DOMElement, DOMNode, DOMPoint, DOMRange, DOMSelection, DOMStaticRange, DOMText, getSelection, hasShadowRoot, isAfter, isBefore, isDOMElement, isDOMNode, isDOMSelection, normalizeDOMPoint, } from '../utils/dom' import { IS_ANDROID, IS_CHROME, IS_FIREFOX } from '../utils/environment' import { Key } from '../utils/key' import { EDITOR_TO_ELEMENT, EDITOR_TO_KEY_TO_ELEMENT, EDITOR_TO_PENDING_DIFFS, EDITOR_TO_SCHEDULE_FLUSH, EDITOR_TO_WINDOW, ELEMENT_TO_NODE, IS_COMPOSING, IS_FOCUSED, IS_READ_ONLY, NODE_TO_INDEX, NODE_TO_KEY, NODE_TO_PARENT, } from '../utils/weak-maps' /** * A DOM-specific version of the `Editor` interface. */ export interface DOMEditor extends BaseEditor { hasEditableTarget: ( editor: DOMEditor, target: EventTarget | null ) => target is DOMNode hasRange: (editor: DOMEditor, range: Range) => boolean hasSelectableTarget: ( editor: DOMEditor, target: EventTarget | null ) => boolean hasTarget: ( editor: DOMEditor, target: EventTarget | null ) => target is DOMNode insertData: (data: DataTransfer) => void insertFragmentData: (data: DataTransfer) => boolean insertTextData: (data: DataTransfer) => boolean isTargetInsideNonReadonlyVoid: ( editor: DOMEditor, target: EventTarget | null ) => boolean setFragmentData: ( data: DataTransfer, originEvent?: 'drag' | 'copy' | 'cut' ) => void } export interface DOMEditorInterface { /** * Experimental and android specific: Get pending diffs */ androidPendingDiffs: (editor: Editor) => TextDiff[] | undefined /** * Experimental and android specific: Flush all pending diffs and cancel composition at the next possible time. */ androidScheduleFlush: (editor: Editor) => void /** * Blur the editor. */ blur: (editor: DOMEditor) => void /** * Deselect the editor. */ deselect: (editor: DOMEditor) => void /** * Find the DOM node that implements DocumentOrShadowRoot for the editor. */ findDocumentOrShadowRoot: (editor: DOMEditor) => Document | ShadowRoot /** * Get the target range from a DOM `event`. */ findEventRange: (editor: DOMEditor, event: any) => Range /** * Find a key for a Slate node. */ findKey: (editor: DOMEditor, node: Node) => Key /** * Find the path of Slate node. */ findPath: (editor: DOMEditor, node: Node) => Path /** * Focus the editor. */ focus: (editor: DOMEditor, options?: { retries: number }) => void /** * Return the host window of the current editor. */ getWindow: (editor: DOMEditor) => Window /** * Check if a DOM node is within the editor. */ hasDOMNode: ( editor: DOMEditor, target: DOMNode, options?: { editable?: boolean } ) => boolean /** * Check if the target is editable and in the editor. */ hasEditableTarget: ( editor: DOMEditor, target: EventTarget | null ) => target is DOMNode /** * */ hasRange: (editor: DOMEditor, range: Range) => boolean /** * Check if the target can be selectable */ hasSelectableTarget: ( editor: DOMEditor, target: EventTarget | null ) => boolean /** * Check if the target is in the editor. */ hasTarget: ( editor: DOMEditor, target: EventTarget | null ) => target is DOMNode /** * Insert data from a `DataTransfer` into the editor. */ insertData: (editor: DOMEditor, data: DataTransfer) => void /** * Insert fragment data from a `DataTransfer` into the editor. */ insertFragmentData: (editor: DOMEditor, data: DataTransfer) => boolean /** * Insert text data from a `DataTransfer` into the editor. */ insertTextData: (editor: DOMEditor, data: DataTransfer) => boolean /** * Check if the user is currently composing inside the editor. */ isComposing: (editor: DOMEditor) => boolean /** * Check if the editor is focused. */ isFocused: (editor: DOMEditor) => boolean /** * Check if the editor is in read-only mode. */ isReadOnly: (editor: DOMEditor) => boolean /** * Check if the target is inside void and in an non-readonly editor. */ isTargetInsideNonReadonlyVoid: ( editor: DOMEditor, target: EventTarget | null ) => boolean /** * Sets data from the currently selected fragment on a `DataTransfer`. */ setFragmentData: ( editor: DOMEditor, data: DataTransfer, originEvent?: 'drag' | 'copy' | 'cut' ) => void /** * Find the native DOM element from a Slate node. */ toDOMNode: (editor: DOMEditor, node: Node) => HTMLElement /** * Find a native DOM selection point from a Slate point. */ toDOMPoint: (editor: DOMEditor, point: Point) => DOMPoint /** * Find a native DOM range from a Slate `range`. * * Notice: the returned range will always be ordinal regardless of the direction of Slate `range` due to DOM API limit. * * there is no way to create a reverse DOM Range using Range.setStart/setEnd * according to https://dom.spec.whatwg.org/#concept-range-bp-set. */ toDOMRange: (editor: DOMEditor, range: Range) => DOMRange /** * Find a Slate node from a native DOM `element`. */ toSlateNode: (editor: DOMEditor, domNode: DOMNode) => Node /** * Find a Slate point from a DOM selection's `domNode` and `domOffset`. */ toSlatePoint: ( editor: DOMEditor, domPoint: DOMPoint, options: { exactMatch: boolean suppressThrow: T /** * The direction to search for Slate leaf nodes if `domPoint` is * non-editable and non-void. */ searchDirection?: 'forward' | 'backward' } ) => T extends true ? Point | null : Point /** * Find a Slate range from a DOM range or selection. */ toSlateRange: ( editor: DOMEditor, domRange: DOMRange | DOMStaticRange | DOMSelection, options: { exactMatch: boolean suppressThrow: T } ) => T extends true ? Range | null : Range } // eslint-disable-next-line no-redeclare export const DOMEditor: DOMEditorInterface = { androidPendingDiffs: editor => EDITOR_TO_PENDING_DIFFS.get(editor), androidScheduleFlush: editor => { EDITOR_TO_SCHEDULE_FLUSH.get(editor)?.() }, blur: editor => { const el = DOMEditor.toDOMNode(editor, editor) const root = DOMEditor.findDocumentOrShadowRoot(editor) IS_FOCUSED.set(editor, false) if (root.activeElement === el) { el.blur() } }, deselect: editor => { const { selection } = editor const root = DOMEditor.findDocumentOrShadowRoot(editor) const domSelection = getSelection(root) if (domSelection && domSelection.rangeCount > 0) { domSelection.removeAllRanges() } if (selection) { Transforms.deselect(editor) } }, findDocumentOrShadowRoot: editor => { const el = DOMEditor.toDOMNode(editor, editor) const root = el.getRootNode() if (root instanceof Document || root instanceof ShadowRoot) { return root } return el.ownerDocument }, findEventRange: (editor, event) => { if ('nativeEvent' in event) { event = event.nativeEvent } const { clientX: x, clientY: y, target } = event if (x == null || y == null) { throw new Error(`Cannot resolve a Slate range from a DOM event: ${event}`) } const node = DOMEditor.toSlateNode(editor, event.target) const path = DOMEditor.findPath(editor, node) // If the drop target is inside a void node, move it into either the // next or previous node, depending on which side the `x` and `y` // coordinates are closest to. if (Element.isElement(node) && Editor.isVoid(editor, node)) { const rect = target.getBoundingClientRect() const isPrev = editor.isInline(node) ? x - rect.left < rect.left + rect.width - x : y - rect.top < rect.top + rect.height - y const edge = Editor.point(editor, path, { edge: isPrev ? 'start' : 'end', }) const point = isPrev ? Editor.before(editor, edge) : Editor.after(editor, edge) if (point) { const range = Editor.range(editor, point) return range } } // Else resolve a range from the caret position where the drop occured. let domRange const { document } = DOMEditor.getWindow(editor) // COMPAT: In Firefox, `caretRangeFromPoint` doesn't exist. (2016/07/25) if (document.caretRangeFromPoint) { domRange = document.caretRangeFromPoint(x, y) } else { const position = document.caretPositionFromPoint(x, y) if (position) { domRange = document.createRange() domRange.setStart(position.offsetNode, position.offset) domRange.setEnd(position.offsetNode, position.offset) } } if (!domRange) { throw new Error(`Cannot resolve a Slate range from a DOM event: ${event}`) } // Resolve a Slate range from the DOM range. const range = DOMEditor.toSlateRange(editor, domRange, { exactMatch: false, suppressThrow: false, }) return range }, findKey: (editor, node) => { let key = NODE_TO_KEY.get(node) if (!key) { key = new Key() NODE_TO_KEY.set(node, key) } return key }, findPath: (editor, node) => { const path: Path = [] let child = node while (true) { const parent = NODE_TO_PARENT.get(child) if (parent == null) { if (Editor.isEditor(child)) { return path } else { break } } const i = NODE_TO_INDEX.get(child) if (i == null) { break } path.unshift(i) child = parent } throw new Error( `Unable to find the path for Slate node: ${Scrubber.stringify(node)}` ) }, focus: (editor, options = { retries: 5 }) => { // Return if already focused if (IS_FOCUSED.get(editor)) { return } // Return if no dom node is associated with the editor, which means the editor is not yet mounted // or has been unmounted. This can happen especially, while retrying to focus the editor. if (!EDITOR_TO_ELEMENT.get(editor)) { return } // Retry setting focus if the editor has pending operations. // The DOM (selection) is unstable while changes are applied. // Retry until retries are exhausted or editor is focused. if (options.retries <= 0) { throw new Error( 'Could not set focus, editor seems stuck with pending operations' ) } if (editor.operations.length > 0) { setTimeout(() => { DOMEditor.focus(editor, { retries: options.retries - 1 }) }, 10) return } const el = DOMEditor.toDOMNode(editor, editor) const root = DOMEditor.findDocumentOrShadowRoot(editor) if (root.activeElement !== el) { // Ensure that the DOM selection state is set to the editor's selection if (editor.selection && root instanceof Document) { const domSelection = getSelection(root) const domRange = DOMEditor.toDOMRange(editor, editor.selection) domSelection?.removeAllRanges() domSelection?.addRange(domRange) } // Create a new selection in the top of the document if missing if (!editor.selection) { Transforms.select(editor, Editor.start(editor, [])) } // IS_FOCUSED should be set before calling el.focus() to ensure that // FocusedContext is updated to the correct value IS_FOCUSED.set(editor, true) el.focus({ preventScroll: true }) } }, getWindow: editor => { const window = EDITOR_TO_WINDOW.get(editor) if (!window) { throw new Error('Unable to find a host window element for this editor') } return window }, hasDOMNode: (editor, target, options = {}) => { const { editable = false } = options const editorEl = DOMEditor.toDOMNode(editor, editor) let targetEl // COMPAT: In Firefox, reading `target.nodeType` will throw an error if // target is originating from an internal "restricted" element (e.g. a // stepper arrow on a number input). (2018/05/04) // https://github.com/ianstormtaylor/slate/issues/1819 try { targetEl = ( isDOMElement(target) ? target : target.parentElement ) as HTMLElement } catch (err) { if ( err instanceof Error && !err.message.includes('Permission denied to access property "nodeType"') ) { throw err } } if (!targetEl) { return false } return ( targetEl.closest(`[data-slate-editor]`) === editorEl && (!editable || targetEl.isContentEditable ? true : (typeof targetEl.isContentEditable === 'boolean' && // isContentEditable exists only on HTMLElement, and on other nodes it will be undefined // this is the core logic that lets you know you got the right editor.selection instead of null when editor is contenteditable="false"(readOnly) targetEl.closest('[contenteditable="false"]') === editorEl) || !!targetEl.getAttribute('data-slate-zero-width')) ) }, hasEditableTarget: (editor, target): target is DOMNode => isDOMNode(target) && DOMEditor.hasDOMNode(editor, target, { editable: true }), hasRange: (editor, range) => { const { anchor, focus } = range return ( Editor.hasPath(editor, anchor.path) && Editor.hasPath(editor, focus.path) ) }, hasSelectableTarget: (editor, target) => DOMEditor.hasEditableTarget(editor, target) || DOMEditor.isTargetInsideNonReadonlyVoid(editor, target), hasTarget: (editor, target): target is DOMNode => isDOMNode(target) && DOMEditor.hasDOMNode(editor, target), insertData: (editor, data) => { editor.insertData(data) }, insertFragmentData: (editor, data) => editor.insertFragmentData(data), insertTextData: (editor, data) => editor.insertTextData(data), isComposing: editor => { return !!IS_COMPOSING.get(editor) }, isFocused: editor => !!IS_FOCUSED.get(editor), isReadOnly: editor => !!IS_READ_ONLY.get(editor), isTargetInsideNonReadonlyVoid: (editor, target) => { if (IS_READ_ONLY.get(editor)) return false const slateNode = DOMEditor.hasTarget(editor, target) && DOMEditor.toSlateNode(editor, target) return Element.isElement(slateNode) && Editor.isVoid(editor, slateNode) }, setFragmentData: (editor, data, originEvent) => editor.setFragmentData(data, originEvent), toDOMNode: (editor, node) => { const KEY_TO_ELEMENT = EDITOR_TO_KEY_TO_ELEMENT.get(editor) const domNode = Editor.isEditor(node) ? EDITOR_TO_ELEMENT.get(editor) : KEY_TO_ELEMENT?.get(DOMEditor.findKey(editor, node)) if (!domNode) { throw new Error( `Cannot resolve a DOM node from Slate node: ${Scrubber.stringify(node)}` ) } return domNode }, toDOMPoint: (editor, point) => { const [node] = Editor.node(editor, point.path) const el = DOMEditor.toDOMNode(editor, node) let domPoint: DOMPoint | undefined // If we're inside a void node, force the offset to 0, otherwise the zero // width spacing character will result in an incorrect offset of 1 if (Editor.void(editor, { at: point })) { point = { path: point.path, offset: 0 } } // For each leaf, we need to isolate its content, which means filtering // to its direct text and zero-width spans. (We have to filter out any // other siblings that may have been rendered alongside them.) const selector = `[data-slate-string], [data-slate-zero-width]` const texts = Array.from(el.querySelectorAll(selector)) let start = 0 for (let i = 0; i < texts.length; i++) { const text = texts[i] const domNode = text.childNodes[0] as HTMLElement if (domNode == null || domNode.textContent == null) { continue } const { length } = domNode.textContent const attr = text.getAttribute('data-slate-length') const trueLength = attr == null ? length : parseInt(attr, 10) const end = start + trueLength // Prefer putting the selection inside the mark placeholder to ensure // composed text is displayed with the correct marks. const nextText = texts[i + 1] if ( point.offset === end && nextText?.hasAttribute('data-slate-mark-placeholder') ) { const domText = nextText.childNodes[0] domPoint = [ // COMPAT: If we don't explicity set the dom point to be on the actual // dom text element, chrome will put the selection behind the actual dom // text element, causing domRange.getBoundingClientRect() calls on a collapsed // selection to return incorrect zero values (https://bugs.chromium.org/p/chromium/issues/detail?id=435438) // which will cause issues when scrolling to it. domText instanceof DOMText ? domText : nextText, nextText.textContent?.startsWith('\uFEFF') ? 1 : 0, ] break } if (point.offset <= end) { const offset = Math.min(length, Math.max(0, point.offset - start)) domPoint = [domNode, offset] break } start = end } if (!domPoint) { throw new Error( `Cannot resolve a DOM point from Slate point: ${Scrubber.stringify( point )}` ) } return domPoint }, toDOMRange: (editor, range) => { const { anchor, focus } = range const isBackward = Range.isBackward(range) const domAnchor = DOMEditor.toDOMPoint(editor, anchor) const domFocus = Range.isCollapsed(range) ? domAnchor : DOMEditor.toDOMPoint(editor, focus) const window = DOMEditor.getWindow(editor) const domRange = window.document.createRange() const [startNode, startOffset] = isBackward ? domFocus : domAnchor const [endNode, endOffset] = isBackward ? domAnchor : domFocus // A slate Point at zero-width Leaf always has an offset of 0 but a native DOM selection at // zero-width node has an offset of 1 so we have to check if we are in a zero-width node and // adjust the offset accordingly. const startEl = ( isDOMElement(startNode) ? startNode : startNode.parentElement ) as HTMLElement const isStartAtZeroWidth = !!startEl.getAttribute('data-slate-zero-width') const endEl = ( isDOMElement(endNode) ? endNode : endNode.parentElement ) as HTMLElement const isEndAtZeroWidth = !!endEl.getAttribute('data-slate-zero-width') domRange.setStart(startNode, isStartAtZeroWidth ? 1 : startOffset) domRange.setEnd(endNode, isEndAtZeroWidth ? 1 : endOffset) return domRange }, toSlateNode: (editor, domNode) => { let domEl = isDOMElement(domNode) ? domNode : domNode.parentElement if (domEl && !domEl.hasAttribute('data-slate-node')) { domEl = domEl.closest(`[data-slate-node]`) } const node = domEl ? ELEMENT_TO_NODE.get(domEl as HTMLElement) : null if (!node) { throw new Error(`Cannot resolve a Slate node from DOM node: ${domEl}`) } return node }, toSlatePoint: ( editor: DOMEditor, domPoint: DOMPoint, options: { exactMatch: boolean suppressThrow: T searchDirection?: 'forward' | 'backward' } ): T extends true ? Point | null : Point => { const { exactMatch, suppressThrow, searchDirection = 'backward' } = options const [nearestNode, nearestOffset] = exactMatch ? domPoint : normalizeDOMPoint(domPoint) const parentNode = nearestNode.parentNode as DOMElement let textNode: DOMElement | null = null let offset = 0 if (parentNode) { const editorEl = DOMEditor.toDOMNode(editor, editor) const potentialVoidNode = parentNode.closest('[data-slate-void="true"]') // Need to ensure that the closest void node is actually a void node // within this editor, and not a void node within some parent editor. This can happen // if this editor is within a void node of another editor ("nested editors", like in // the "Editable Voids" example on the docs site). const voidNode = potentialVoidNode && editorEl.contains(potentialVoidNode) ? potentialVoidNode : null const potentialNonEditableNode = parentNode.closest( '[contenteditable="false"]' ) const nonEditableNode = potentialNonEditableNode && editorEl.contains(potentialNonEditableNode) ? potentialNonEditableNode : null let leafNode = parentNode.closest('[data-slate-leaf]') let domNode: DOMElement | null = null // Calculate how far into the text node the `nearestNode` is, so that we // can determine what the offset relative to the text node is. if (leafNode) { textNode = leafNode.closest('[data-slate-node="text"]') if (textNode) { const window = DOMEditor.getWindow(editor) const range = window.document.createRange() range.setStart(textNode, 0) range.setEnd(nearestNode, nearestOffset) const contents = range.cloneContents() const removals = [ ...Array.prototype.slice.call( contents.querySelectorAll('[data-slate-zero-width]') ), ...Array.prototype.slice.call( contents.querySelectorAll('[contenteditable=false]') ), ] removals.forEach(el => { // COMPAT: While composing at the start of a text node, some keyboards put // the text content inside the zero width space. if ( IS_ANDROID && !exactMatch && el.hasAttribute('data-slate-zero-width') && el.textContent.length > 0 && el.textContext !== '\uFEFF' ) { if (el.textContent.startsWith('\uFEFF')) { el.textContent = el.textContent.slice(1) } return } el!.parentNode!.removeChild(el) }) // COMPAT: Edge has a bug where Range.prototype.toString() will // convert \n into \r\n. The bug causes a loop when slate-dom // attempts to reposition its cursor to match the native position. Use // textContent.length instead. // https://developer.microsoft.com/en-us/microsoft-edge/platform/issues/10291116/ offset = contents.textContent!.length domNode = textNode } } else if (voidNode) { // For void nodes, the element with the offset key will be a cousin, not an // ancestor, so find it by going down from the nearest void parent and taking the // first one that isn't inside a nested editor. const leafNodes = voidNode.querySelectorAll('[data-slate-leaf]') for (let index = 0; index < leafNodes.length; index++) { const current = leafNodes[index] if (DOMEditor.hasDOMNode(editor, current)) { leafNode = current break } } // COMPAT: In read-only editors the leaf is not rendered. if (!leafNode) { offset = 1 } else { textNode = leafNode.closest('[data-slate-node="text"]')! domNode = leafNode offset = domNode.textContent!.length domNode.querySelectorAll('[data-slate-zero-width]').forEach(el => { offset -= el.textContent!.length }) } } else if (nonEditableNode) { // Find the edge of the nearest leaf in `searchDirection` const getLeafNodes = (node: DOMElement | null | undefined) => node ? node.querySelectorAll( // Exclude leaf nodes in nested editors '[data-slate-leaf]:not(:scope [data-slate-editor] [data-slate-leaf])' ) : [] const elementNode = nonEditableNode.closest( '[data-slate-node="element"]' ) if (searchDirection === 'forward') { const leafNodes = [ ...getLeafNodes(elementNode), ...getLeafNodes(elementNode?.nextElementSibling), ] leafNode = leafNodes.find(leaf => isAfter(nonEditableNode, leaf)) ?? null } else { const leafNodes = [ ...getLeafNodes(elementNode?.previousElementSibling), ...getLeafNodes(elementNode), ] leafNode = leafNodes.findLast(leaf => isBefore(nonEditableNode, leaf)) ?? null } if (leafNode) { textNode = leafNode.closest('[data-slate-node="text"]')! domNode = leafNode if (searchDirection === 'forward') { offset = 0 } else { offset = domNode.textContent!.length domNode.querySelectorAll('[data-slate-zero-width]').forEach(el => { offset -= el.textContent!.length }) } } } if ( domNode && offset === domNode.textContent!.length && // COMPAT: Android IMEs might remove the zero width space while composing, // and we don't add it for line-breaks. IS_ANDROID && domNode.getAttribute('data-slate-zero-width') === 'z' && domNode.textContent?.startsWith('\uFEFF') && // COMPAT: If the parent node is a Slate zero-width space, editor is // because the text node should have no characters. However, during IME // composition the ASCII characters will be prepended to the zero-width // space, so subtract 1 from the offset to account for the zero-width // space character. (parentNode.hasAttribute('data-slate-zero-width') || // COMPAT: In Firefox, `range.cloneContents()` returns an extra trailing '\n' // when the document ends with a new-line character. This results in the offset // length being off by one, so we need to subtract one to account for this. (IS_FIREFOX && domNode.textContent?.endsWith('\n\n'))) ) { offset-- } } if (IS_ANDROID && !textNode && !exactMatch) { const node = parentNode.hasAttribute('data-slate-node') ? parentNode : parentNode.closest('[data-slate-node]') if (node && DOMEditor.hasDOMNode(editor, node, { editable: true })) { const slateNode = DOMEditor.toSlateNode(editor, node) let { path, offset } = Editor.start( editor, DOMEditor.findPath(editor, slateNode) ) if (!node.querySelector('[data-slate-leaf]')) { offset = nearestOffset } return { path, offset } as T extends true ? Point | null : Point } } if (!textNode) { if (suppressThrow) { return null as T extends true ? Point | null : Point } throw new Error( `Cannot resolve a Slate point from DOM point: ${domPoint}` ) } // COMPAT: If someone is clicking from one Slate editor into another, // the select event fires twice, once for the old editor's `element` // first, and then afterwards for the correct `element`. (2017/03/03) const slateNode = DOMEditor.toSlateNode(editor, textNode!) const path = DOMEditor.findPath(editor, slateNode) return { path, offset } as T extends true ? Point | null : Point }, toSlateRange: ( editor: DOMEditor, domRange: DOMRange | DOMStaticRange | DOMSelection, options: { exactMatch: boolean suppressThrow: T } ): T extends true ? Range | null : Range => { const { exactMatch, suppressThrow } = options const el = isDOMSelection(domRange) ? domRange.anchorNode : domRange.startContainer let anchorNode let anchorOffset let focusNode let focusOffset let isCollapsed if (el) { if (isDOMSelection(domRange)) { // COMPAT: In firefox the normal seletion way does not work // (https://github.com/ianstormtaylor/slate/pull/5486#issue-1820720223) if (IS_FIREFOX && domRange.rangeCount > 1) { focusNode = domRange.focusNode // Focus node works fine const firstRange = domRange.getRangeAt(0) const lastRange = domRange.getRangeAt(domRange.rangeCount - 1) // Here we are in the contenteditable mode of a table in firefox if ( focusNode instanceof HTMLTableRowElement && firstRange.startContainer instanceof HTMLTableRowElement && lastRange.startContainer instanceof HTMLTableRowElement ) { // HTMLElement, becouse Element is a slate element function getLastChildren(element: HTMLElement): HTMLElement { if (element.childElementCount > 0) { return getLastChildren(element.children[0]) } else { return element } } const firstNodeRow = firstRange.startContainer const lastNodeRow = lastRange.startContainer // This should never fail as "The HTMLElement interface represents any HTML element." const firstNode = getLastChildren( firstNodeRow.children[firstRange.startOffset] ) const lastNode = getLastChildren( lastNodeRow.children[lastRange.startOffset] ) // Zero, as we allways take the right one as the anchor point focusOffset = 0 if (lastNode.childNodes.length > 0) { anchorNode = lastNode.childNodes[0] } else { anchorNode = lastNode } if (firstNode.childNodes.length > 0) { focusNode = firstNode.childNodes[0] } else { focusNode = firstNode } if (lastNode instanceof HTMLElement) { anchorOffset = (lastNode).innerHTML.length } else { // Fallback option anchorOffset = 0 } } else { // This is the read only mode of a firefox table // Right to left if (firstRange.startContainer === focusNode) { anchorNode = lastRange.endContainer anchorOffset = lastRange.endOffset focusOffset = firstRange.startOffset } else { // Left to right anchorNode = firstRange.startContainer anchorOffset = firstRange.endOffset focusOffset = lastRange.startOffset } } } else { anchorNode = domRange.anchorNode anchorOffset = domRange.anchorOffset focusNode = domRange.focusNode focusOffset = domRange.focusOffset } // COMPAT: There's a bug in chrome that always returns `true` for // `isCollapsed` for a Selection that comes from a ShadowRoot. // (2020/08/08) // https://bugs.chromium.org/p/chromium/issues/detail?id=447523 // IsCollapsed might not work in firefox, but this will if ((IS_CHROME && hasShadowRoot(anchorNode)) || IS_FIREFOX) { isCollapsed = domRange.anchorNode === domRange.focusNode && domRange.anchorOffset === domRange.focusOffset } else { isCollapsed = domRange.isCollapsed } } else { anchorNode = domRange.startContainer anchorOffset = domRange.startOffset focusNode = domRange.endContainer focusOffset = domRange.endOffset isCollapsed = domRange.collapsed } } if ( anchorNode == null || focusNode == null || anchorOffset == null || focusOffset == null ) { throw new Error( `Cannot resolve a Slate range from DOM range: ${domRange}` ) } // COMPAT: Firefox sometimes includes an extra \n (rendered by TextString // when isTrailing is true) in the focusOffset, resulting in an invalid // Slate point. (2023/11/01) if ( IS_FIREFOX && focusNode.textContent?.endsWith('\n\n') && focusOffset === focusNode.textContent.length ) { focusOffset-- } const anchor = DOMEditor.toSlatePoint(editor, [anchorNode, anchorOffset], { exactMatch, suppressThrow, }) if (!anchor) { return null as T extends true ? Range | null : Range } const focusBeforeAnchor = isBefore(anchorNode, focusNode) || (anchorNode === focusNode && focusOffset < anchorOffset) const focus = isCollapsed ? anchor : DOMEditor.toSlatePoint(editor, [focusNode, focusOffset], { exactMatch, suppressThrow, searchDirection: focusBeforeAnchor ? 'forward' : 'backward', }) if (!focus) { return null as T extends true ? Range | null : Range } let range: Range = { anchor: anchor as Point, focus: focus as Point } // if the selection is a hanging range that ends in a void // and the DOM focus is an Element // (meaning that the selection ends before the element) // unhang the range to avoid mistakenly including the void if ( Range.isExpanded(range) && Range.isForward(range) && isDOMElement(focusNode) && Editor.void(editor, { at: range.focus, mode: 'highest' }) ) { range = Editor.unhangRange(editor, range, { voids: true }) } return range as unknown as T extends true ? Range | null : Range }, }