|
| 1 | +import { Editor, type EditorOptions } from '@tiptap/core' |
| 2 | +import Document from '@tiptap/extension-document' |
| 3 | +import HardBreak from '@tiptap/extension-hard-break' |
| 4 | +import Paragraph from '@tiptap/extension-paragraph' |
| 5 | +import Text from '@tiptap/extension-text' |
| 6 | +import { afterEach, describe, expect, it, vi } from 'vite-plus/test' |
| 7 | + |
| 8 | +import { handleMobileEnter } from './handleMobileEnter.js' |
| 9 | + |
| 10 | +vi.hoisted(() => { |
| 11 | + Object.defineProperty(navigator, 'userAgent', { |
| 12 | + configurable: true, |
| 13 | + value: 'Mozilla/5.0 (Linux; Android 14) Chrome/140.0.0.0', |
| 14 | + }) |
| 15 | +}) |
| 16 | + |
| 17 | +describe('handleMobileEnter', () => { |
| 18 | + let editor: Editor |
| 19 | + |
| 20 | + function createEditor(options: Partial<EditorOptions> = {}) { |
| 21 | + vi.stubGlobal('navigator', { platform: 'Android', userAgent: 'Android 14' }) |
| 22 | + editor = new Editor({ |
| 23 | + extensions: [ |
| 24 | + Document, |
| 25 | + Paragraph.extend({ |
| 26 | + addNodeView() { |
| 27 | + return () => { |
| 28 | + const dom = document.createElement('p') |
| 29 | + |
| 30 | + dom.dataset.nodeViewContentReact = '' |
| 31 | + return { |
| 32 | + dom, |
| 33 | + contentDOM: dom, |
| 34 | + ignoreMutation: mutation => mutation.type === 'attributes', |
| 35 | + } |
| 36 | + } |
| 37 | + }, |
| 38 | + }), |
| 39 | + Text, |
| 40 | + HardBreak, |
| 41 | + ], |
| 42 | + content: '<p>Hello</p>', |
| 43 | + ...options, |
| 44 | + }) |
| 45 | + document.body.append(editor.view.dom) |
| 46 | + const contentDOM = editor.view.dom.firstElementChild as HTMLElement |
| 47 | + |
| 48 | + editor.commands.setTextSelection(6) |
| 49 | + editor.view.focus() |
| 50 | + |
| 51 | + return contentDOM |
| 52 | + } |
| 53 | + |
| 54 | + function beforeInput(options: InputEventInit = {}) { |
| 55 | + const event = new InputEvent('beforeinput', { |
| 56 | + inputType: 'insertParagraph', |
| 57 | + cancelable: true, |
| 58 | + ...options, |
| 59 | + }) |
| 60 | + |
| 61 | + handleMobileEnter(editor, event) |
| 62 | + return event |
| 63 | + } |
| 64 | + |
| 65 | + afterEach(() => { |
| 66 | + editor?.destroy() |
| 67 | + document.body.replaceChildren() |
| 68 | + vi.restoreAllMocks() |
| 69 | + vi.unstubAllGlobals() |
| 70 | + }) |
| 71 | + |
| 72 | + function queueSelectionChange(contentDOM: HTMLElement) { |
| 73 | + const view = editor.view as typeof editor.view & { |
| 74 | + domObserver: { flush: () => void; onSelectionChange: () => void } |
| 75 | + } |
| 76 | + |
| 77 | + view.domObserver.flush() |
| 78 | + // Keep happy-dom's synchronous selectionchange pending until beforeinput. |
| 79 | + document.removeEventListener('selectionchange', view.domObserver.onSelectionChange) |
| 80 | + document.getSelection()!.collapse(contentDOM.firstChild!, 3) |
| 81 | + view.dispatchEvent(new KeyboardEvent('keydown', { key: 'Enter', keyCode: 13 })) |
| 82 | + } |
| 83 | + |
| 84 | + it.each([ |
| 85 | + ['insertParagraph', '<p>Hel</p><p>lo</p>', 6], |
| 86 | + ['insertLineBreak', '<p>Hel<br>lo</p>', 5], |
| 87 | + ])('handles %s once at the pending DOM caret', (inputType, html, position) => { |
| 88 | + const contentDOM = createEditor() |
| 89 | + |
| 90 | + queueSelectionChange(contentDOM) |
| 91 | + |
| 92 | + expect(editor.state.selection.from).toBe(6) |
| 93 | + expect(beforeInput({ inputType }).defaultPrevented).toBe(true) |
| 94 | + expect(editor.getHTML()).toBe(html) |
| 95 | + expect(editor.state.selection.from).toBe(position) |
| 96 | + }) |
| 97 | + |
| 98 | + it('calls custom Enter handlers once with the updated selection', () => { |
| 99 | + const handleKeyDown = vi.fn(view => { |
| 100 | + expect(view.state.selection.from).toBe(4) |
| 101 | + return true |
| 102 | + }) |
| 103 | + const contentDOM = createEditor({ editorProps: { handleKeyDown } }) |
| 104 | + |
| 105 | + queueSelectionChange(contentDOM) |
| 106 | + |
| 107 | + expect(beforeInput().defaultPrevented).toBe(true) |
| 108 | + expect(handleKeyDown).toHaveBeenCalledTimes(1) |
| 109 | + }) |
| 110 | + |
| 111 | + it('preserves native Enter detection when no handler accepts it', () => { |
| 112 | + const contentDOM = createEditor({ enableCoreExtensions: { keymap: false } }) |
| 113 | + const view = editor.view as typeof editor.view & { input: { lastKeyCode: number | null } } |
| 114 | + |
| 115 | + queueSelectionChange(contentDOM) |
| 116 | + |
| 117 | + expect(beforeInput().defaultPrevented).toBe(false) |
| 118 | + expect(view.input.lastKeyCode).toBe(13) |
| 119 | + expect(editor.state.selection.from).toBe(4) |
| 120 | + expect(editor.getHTML()).toBe('<p>Hello</p>') |
| 121 | + }) |
| 122 | + |
| 123 | + it('commits pending DOM text and selection before splitting', () => { |
| 124 | + const contentDOM = createEditor() |
| 125 | + const text = contentDOM.firstChild! |
| 126 | + |
| 127 | + text.textContent = 'Hello world' |
| 128 | + document.getSelection()!.collapse(text, 11) |
| 129 | + |
| 130 | + expect(beforeInput().defaultPrevented).toBe(true) |
| 131 | + expect(editor.getHTML()).toBe('<p>Hello world</p><p></p>') |
| 132 | + expect(editor.state.selection.from).toBe(14) |
| 133 | + }) |
| 134 | + |
| 135 | + it('preserves pending composition text when Enter arrives before compositionend', () => { |
| 136 | + const contentDOM = createEditor() |
| 137 | + const text = contentDOM.firstChild! |
| 138 | + |
| 139 | + editor.view.dispatchEvent(new CompositionEvent('compositionstart')) |
| 140 | + text.textContent = 'Hello world' |
| 141 | + document.getSelection()!.collapse(text, 11) |
| 142 | + |
| 143 | + expect(beforeInput({ isComposing: true }).defaultPrevented).toBe(true) |
| 144 | + editor.view.dispatchEvent(new CompositionEvent('compositionend', { data: 'world' })) |
| 145 | + editor.commands.insertContent('Next') |
| 146 | + |
| 147 | + expect(editor.getHTML()).toBe('<p>Hello world</p><p>Next</p>') |
| 148 | + expect(editor.state.selection.from).toBe(18) |
| 149 | + }) |
| 150 | + |
| 151 | + it.each([ |
| 152 | + ['insertParagraph', false], |
| 153 | + ['insertLineBreak', true], |
| 154 | + ])('uses custom keyboard handlers for %s', (inputType, shiftKey) => { |
| 155 | + const handleKeyDown = vi.fn(() => true) |
| 156 | + |
| 157 | + createEditor({ editorProps: { handleKeyDown } }) |
| 158 | + |
| 159 | + expect(beforeInput({ inputType }).defaultPrevented).toBe(true) |
| 160 | + expect(handleKeyDown).toHaveBeenCalledWith( |
| 161 | + editor.view, |
| 162 | + expect.objectContaining({ key: 'Enter', keyCode: 13, shiftKey }), |
| 163 | + ) |
| 164 | + expect(editor.getHTML()).toBe('<p>Hello</p>') |
| 165 | + }) |
| 166 | + |
| 167 | + it('allows native input when no keyboard handler accepts Enter', () => { |
| 168 | + createEditor({ enableCoreExtensions: { keymap: false } }) |
| 169 | + |
| 170 | + expect(beforeInput().defaultPrevented).toBe(false) |
| 171 | + expect(editor.getHTML()).toBe('<p>Hello</p>') |
| 172 | + }) |
| 173 | + |
| 174 | + it.each([{ cancelable: false }, { inputType: 'insertText' }])( |
| 175 | + 'leaves unrelated or noncancelable input alone: %j', |
| 176 | + options => { |
| 177 | + createEditor() |
| 178 | + |
| 179 | + expect(beforeInput(options).defaultPrevented).toBe(false) |
| 180 | + expect(editor.getHTML()).toBe('<p>Hello</p>') |
| 181 | + }, |
| 182 | + ) |
| 183 | + |
| 184 | + it('respects an already handled event', () => { |
| 185 | + createEditor() |
| 186 | + const event = new InputEvent('beforeinput', { inputType: 'insertParagraph', cancelable: true }) |
| 187 | + |
| 188 | + event.preventDefault() |
| 189 | + handleMobileEnter(editor, event) |
| 190 | + |
| 191 | + expect(editor.getHTML()).toBe('<p>Hello</p>') |
| 192 | + }) |
| 193 | + |
| 194 | + it('leaves desktop input alone', () => { |
| 195 | + createEditor() |
| 196 | + vi.stubGlobal('navigator', { platform: 'Linux', userAgent: 'Linux' }) |
| 197 | + |
| 198 | + expect(beforeInput().defaultPrevented).toBe(false) |
| 199 | + expect(editor.getHTML()).toBe('<p>Hello</p>') |
| 200 | + }) |
| 201 | + |
| 202 | + it('leaves ordinary paragraphs alone', () => { |
| 203 | + const contentDOM = createEditor() |
| 204 | + |
| 205 | + delete contentDOM.dataset.nodeViewContentReact |
| 206 | + |
| 207 | + expect(beforeInput().defaultPrevented).toBe(false) |
| 208 | + expect(editor.getHTML()).toBe('<p>Hello</p>') |
| 209 | + }) |
| 210 | + |
| 211 | + it('leaves read-only editors alone', () => { |
| 212 | + createEditor() |
| 213 | + editor.setEditable(false) |
| 214 | + |
| 215 | + expect(beforeInput().defaultPrevented).toBe(false) |
| 216 | + expect(editor.getHTML()).toBe('<p>Hello</p>') |
| 217 | + }) |
| 218 | +}) |
0 commit comments