forked from ianstormtaylor/slate
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreact-editor.ts
995 lines (854 loc) · 30 KB
/
react-editor.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
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,
hasShadowRoot,
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 React and DOM-specific version of the `Editor` interface.
*/
export interface ReactEditor extends BaseEditor {
hasEditableTarget: (
editor: ReactEditor,
target: EventTarget | null
) => target is DOMNode
hasRange: (editor: ReactEditor, range: Range) => boolean
hasSelectableTarget: (
editor: ReactEditor,
target: EventTarget | null
) => boolean
hasTarget: (
editor: ReactEditor,
target: EventTarget | null
) => target is DOMNode
insertData: (data: DataTransfer) => void
insertFragmentData: (data: DataTransfer) => boolean
insertTextData: (data: DataTransfer) => boolean
isTargetInsideNonReadonlyVoid: (
editor: ReactEditor,
target: EventTarget | null
) => boolean
setFragmentData: (
data: DataTransfer,
originEvent?: 'drag' | 'copy' | 'cut'
) => void
}
export interface ReactEditorInterface {
/**
* 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: ReactEditor) => void
/**
* Deselect the editor.
*/
deselect: (editor: ReactEditor) => void
/**
* Find the DOM node that implements DocumentOrShadowRoot for the editor.
*/
findDocumentOrShadowRoot: (editor: ReactEditor) => Document | ShadowRoot
/**
* Get the target range from a DOM `event`.
*/
findEventRange: (editor: ReactEditor, event: any) => Range
/**
* Find a key for a Slate node.
*/
findKey: (editor: ReactEditor, node: Node) => Key
/**
* Find the path of Slate node.
*/
findPath: (editor: ReactEditor, node: Node) => Path
/**
* Focus the editor.
*/
focus: (editor: ReactEditor) => void
/**
* Return the host window of the current editor.
*/
getWindow: (editor: ReactEditor) => Window
/**
* Check if a DOM node is within the editor.
*/
hasDOMNode: (
editor: ReactEditor,
target: DOMNode,
options?: { editable?: boolean }
) => boolean
/**
* Check if the target is editable and in the editor.
*/
hasEditableTarget: (
editor: ReactEditor,
target: EventTarget | null
) => target is DOMNode
/**
*
*/
hasRange: (editor: ReactEditor, range: Range) => boolean
/**
* Check if the target can be selectable
*/
hasSelectableTarget: (
editor: ReactEditor,
target: EventTarget | null
) => boolean
/**
* Check if the target is in the editor.
*/
hasTarget: (
editor: ReactEditor,
target: EventTarget | null
) => target is DOMNode
/**
* Insert data from a `DataTransfer` into the editor.
*/
insertData: (editor: ReactEditor, data: DataTransfer) => void
/**
* Insert fragment data from a `DataTransfer` into the editor.
*/
insertFragmentData: (editor: ReactEditor, data: DataTransfer) => boolean
/**
* Insert text data from a `DataTransfer` into the editor.
*/
insertTextData: (editor: ReactEditor, data: DataTransfer) => boolean
/**
* Check if the user is currently composing inside the editor.
*/
isComposing: (editor: ReactEditor) => boolean
/**
* Check if the editor is focused.
*/
isFocused: (editor: ReactEditor) => boolean
/**
* Check if the editor is in read-only mode.
*/
isReadOnly: (editor: ReactEditor) => boolean
/**
* Check if the target is inside void and in an non-readonly editor.
*/
isTargetInsideNonReadonlyVoid: (
editor: ReactEditor,
target: EventTarget | null
) => boolean
/**
* Sets data from the currently selected fragment on a `DataTransfer`.
*/
setFragmentData: (
editor: ReactEditor,
data: DataTransfer,
originEvent?: 'drag' | 'copy' | 'cut'
) => void
/**
* Find the native DOM element from a Slate node.
*/
toDOMNode: (editor: ReactEditor, node: Node) => HTMLElement
/**
* Find a native DOM selection point from a Slate point.
*/
toDOMPoint: (editor: ReactEditor, 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: ReactEditor, range: Range) => DOMRange
/**
* Find a Slate node from a native DOM `element`.
*/
toSlateNode: (editor: ReactEditor, domNode: DOMNode) => Node
/**
* Find a Slate point from a DOM selection's `domNode` and `domOffset`.
*/
toSlatePoint: <T extends boolean>(
editor: ReactEditor,
domPoint: DOMPoint,
options: {
exactMatch: boolean
suppressThrow: T
}
) => T extends true ? Point | null : Point
/**
* Find a Slate range from a DOM range or selection.
*/
toSlateRange: <T extends boolean>(
editor: ReactEditor,
domRange: DOMRange | DOMStaticRange | DOMSelection,
options: {
exactMatch: boolean
suppressThrow: T
}
) => T extends true ? Range | null : Range
}
// eslint-disable-next-line no-redeclare
export const ReactEditor: ReactEditorInterface = {
androidPendingDiffs: editor => EDITOR_TO_PENDING_DIFFS.get(editor),
androidScheduleFlush: editor => {
EDITOR_TO_SCHEDULE_FLUSH.get(editor)?.()
},
blur: editor => {
const el = ReactEditor.toDOMNode(editor, editor)
const root = ReactEditor.findDocumentOrShadowRoot(editor)
IS_FOCUSED.set(editor, false)
if (root.activeElement === el) {
el.blur()
}
},
deselect: editor => {
const { selection } = editor
const root = ReactEditor.findDocumentOrShadowRoot(editor)
const domSelection = root.getSelection()
if (domSelection && domSelection.rangeCount > 0) {
domSelection.removeAllRanges()
}
if (selection) {
Transforms.deselect(editor)
}
},
findDocumentOrShadowRoot: editor => {
const el = ReactEditor.toDOMNode(editor, editor)
const root = el.getRootNode()
if (
(root instanceof Document || root instanceof ShadowRoot) &&
root.getSelection != null
) {
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 = ReactEditor.toSlateNode(editor, event.target)
const path = ReactEditor.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 } = ReactEditor.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 = ReactEditor.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 => {
const el = ReactEditor.toDOMNode(editor, editor)
const root = ReactEditor.findDocumentOrShadowRoot(editor)
IS_FOCUSED.set(editor, true)
if (root.activeElement !== el) {
if (editor.selection && root instanceof Document) {
const domSelection = root.getSelection()
const domRange = ReactEditor.toDOMRange(editor, editor.selection)
domSelection?.removeAllRanges()
domSelection?.addRange(domRange)
}
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 = ReactEditor.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.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) &&
ReactEditor.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) =>
ReactEditor.hasEditableTarget(editor, target) ||
ReactEditor.isTargetInsideNonReadonlyVoid(editor, target),
hasTarget: (editor, target): target is DOMNode =>
isDOMNode(target) && ReactEditor.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 =
ReactEditor.hasTarget(editor, target) &&
ReactEditor.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(ReactEditor.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 = ReactEditor.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 = ReactEditor.toDOMPoint(editor, anchor)
const domFocus = Range.isCollapsed(range)
? domAnchor
: ReactEditor.toDOMPoint(editor, focus)
const window = ReactEditor.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: <T extends boolean>(
editor: ReactEditor,
domPoint: DOMPoint,
options: {
exactMatch: boolean
suppressThrow: T
}
): T extends true ? Point | null : Point => {
const { exactMatch, suppressThrow } = 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 = ReactEditor.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
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 = ReactEditor.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-react
// 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 (ReactEditor.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
})
}
}
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 && ReactEditor.hasDOMNode(editor, node, { editable: true })) {
const slateNode = ReactEditor.toSlateNode(editor, node)
let { path, offset } = Editor.start(
editor,
ReactEditor.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 = ReactEditor.toSlateNode(editor, textNode!)
const path = ReactEditor.findPath(editor, slateNode)
return { path, offset } as T extends true ? Point | null : Point
},
toSlateRange: <T extends boolean>(
editor: ReactEditor,
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(<HTMLElement>element.children[0])
} else {
return element
}
}
const firstNodeRow = <HTMLTableRowElement>firstRange.startContainer
const lastNodeRow = <HTMLTableRowElement>lastRange.startContainer
// This should never fail as "The HTMLElement interface represents any HTML element."
const firstNode = getLastChildren(
<HTMLElement>firstNodeRow.children[firstRange.startOffset]
)
const lastNode = getLastChildren(
<HTMLElement>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 = (<HTMLElement>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: Triple-clicking a word in chrome will sometimes place the focus
// inside a `contenteditable="false"` DOM node following the word, which
// will cause `toSlatePoint` to throw an error. (2023/03/07)
if (
'getAttribute' in focusNode &&
(focusNode as HTMLElement).getAttribute('contenteditable') === 'false' &&
(focusNode as HTMLElement).getAttribute('data-slate-void') !== 'true'
) {
focusNode = anchorNode
focusOffset = anchorNode.textContent?.length || 0
}
const anchor = ReactEditor.toSlatePoint(
editor,
[anchorNode, anchorOffset],
{
exactMatch,
suppressThrow,
}
)
if (!anchor) {
return null as T extends true ? Range | null : Range
}
const focus = isCollapsed
? anchor
: ReactEditor.toSlatePoint(editor, [focusNode, focusOffset], {
exactMatch,
suppressThrow,
})
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
},
}