Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 | 1x 1x 1x 152x 152x 152x 152x 152x 152x 1x 151x 151x 151x 151x 2x 151x 151x 151x 151x 1x 114x 114x 114x 114x 114x 114x 114x 114x 114x 114x 1x 144x 152x 2x 2x 2x 2x 1x 152x 2x 2x 2x 1x 1x 1x 1x 1x 152x 152x 5x 5x 4x 5x 5x 5x 2x 152x 5x 5x 5x 5x 3x 152x 3x 3x 3x 3x 3x 3x 3x 3x 3x 152x 2x 2x 2x 2x 152x 152x 1x 152x 1x 1x 1x 116x 3x 3x 152x 1x 1x 152x | import {
ChangeSource,
isCharacterValue,
isCursorMovingKey,
isNodeOfType,
} from 'roosterjs-content-model-dom';
import type {
DOMEventPluginState,
IEditor,
DOMEventRecord,
EditorOptions,
PluginWithState,
} from 'roosterjs-content-model-types';
const EventTypeMap: Record<string, 'keyDown' | 'keyUp' | 'keyPress'> = {
keydown: 'keyDown',
keyup: 'keyUp',
keypress: 'keyPress',
};
/**
* DOMEventPlugin handles customized DOM events, including:
* 1. Keyboard event
* 2. Mouse event
* 3. IME state
* 4. Drop event
* 5. Focus and blur event
* 6. Input event
* 7. Scroll event
* It contains special handling for Safari since Safari cannot get correct selection when onBlur event is triggered in editor.
*/
class DOMEventPlugin implements PluginWithState<DOMEventPluginState> {
private editor: IEditor | null = null;
private disposer: (() => void) | null = null;
private state: DOMEventPluginState;
private pointerEvent: PointerEvent | null = null;
private timer = 0;
/**
* Construct a new instance of DOMEventPlugin
* @param options The editor options
* @param contentDiv The editor content DIV
*/
constructor(options: EditorOptions, contentDiv: HTMLDivElement) {
this.state = {
isInIME: false,
scrollContainer: options.scrollContainer || contentDiv,
mouseDownX: null,
mouseDownY: null,
mouseUpEventListerAdded: false,
};
}
/**
* Get a friendly name of this plugin
*/
getName() {
return 'DOMEvent';
}
/**
* Initialize this plugin. This should only be called from Editor
* @param editor Editor instance
*/
initialize(editor: IEditor) {
this.editor = editor;
const document = this.editor.getDocument();
const eventHandlers: Partial<
{ [P in keyof HTMLElementEventMap]: DOMEventRecord<HTMLElementEventMap[P]> }
> = {
// 1. Keyboard event
keypress: this.keyboardEventHandler,
keydown: this.keyboardEventHandler,
keyup: this.keyboardEventHandler,
input: this.inputEventHandler,
// 2. Mouse event
mousedown: { beforeDispatch: this.onMouseDown },
dblclick: { beforeDispatch: (event: MouseEvent) => this.onDoubleClick(event) },
// 3. IME state management
compositionstart: { beforeDispatch: this.onCompositionStart },
compositionend: { beforeDispatch: this.onCompositionEnd },
// 4. Drag and Drop event
dragstart: { beforeDispatch: this.onDragStart },
drop: { beforeDispatch: (event: DragEvent) => this.onDrop(event) },
// 5. Pointer event
pointerdown: { beforeDispatch: (event: PointerEvent) => this.onPointerDown(event) },
};
this.disposer = this.editor.attachDomEvent(<Record<string, DOMEventRecord>>eventHandlers);
// 7. Scroll event
this.state.scrollContainer.addEventListener('scroll', this.onScroll);
document.defaultView?.addEventListener('scroll', this.onScroll);
document.defaultView?.addEventListener('resize', this.onScroll);
}
/**
* Dispose this plugin
*/
dispose() {
this.removeMouseUpEventListener();
const document = this.editor?.getDocument();
document?.defaultView?.removeEventListener('resize', this.onScroll);
document?.defaultView?.removeEventListener('scroll', this.onScroll);
this.state.scrollContainer.removeEventListener('scroll', this.onScroll);
this.disposer?.();
this.disposer = null;
this.editor = null;
this.pointerEvent = null;
Iif (this.timer) {
document?.defaultView?.clearTimeout(this.timer);
this.timer = 0;
}
}
/**
* Get plugin state object
*/
getState() {
return this.state;
}
private onDragStart = (e: Event) => {
const dragEvent = e as DragEvent;
const node = dragEvent.target as Node;
const element = isNodeOfType(node, 'ELEMENT_NODE') ? node : node.parentElement;
if (element && !element.isContentEditable) {
dragEvent.preventDefault();
}
};
private onDrop = (e: DragEvent) => {
Eif (this.editor) {
const beforeDropEvent = this.editor.triggerEvent('beforeDrop', {
rawEvent: e,
});
if (!beforeDropEvent?.rawEvent.defaultPrevented) {
const doc = this.editor.getDocument();
doc?.defaultView?.requestAnimationFrame(() => {
Eif (this.editor) {
this.editor.takeSnapshot();
this.editor.triggerEvent('contentChanged', {
source: ChangeSource.Drop,
});
}
});
}
}
};
private onScroll = (e: Event) => {
this.editor?.triggerEvent('scroll', {
rawEvent: e,
scrollContainer: this.state.scrollContainer,
});
};
private keyboardEventHandler: DOMEventRecord<KeyboardEvent> = {
beforeDispatch: event => {
const eventType = EventTypeMap[event.type];
if (isCharacterValue(event) || isCursorMovingKey(event)) {
// Stop propagation for Character keys and Up/Down/Left/Right/Home/End/PageUp/PageDown
// since editor already handles these keys and no need to propagate to parents
event.stopPropagation();
}
const isAndroid = this.editor?.getEnvironment()?.isAndroid ?? false;
const isComposing = !isAndroid && (event.isComposing || this.state.isInIME);
if (this.editor && eventType && !isComposing) {
this.editor.triggerEvent(eventType, {
rawEvent: event,
});
}
},
};
private inputEventHandler: DOMEventRecord<Event> = {
beforeDispatch: event => {
event.stopPropagation();
const isAndroid = this.editor?.getEnvironment()?.isAndroid ?? false;
const isComposing =
!isAndroid && ((event as InputEvent).isComposing || this.state.isInIME);
if (this.editor && !isComposing) {
this.editor.triggerEvent('input', {
rawEvent: event as InputEvent,
});
}
},
};
private onMouseDown = (event: MouseEvent) => {
Eif (this.editor) {
Eif (!this.state.mouseUpEventListerAdded) {
this.editor
.getDocument()
.addEventListener('mouseup', this.onMouseUp, true /*setCapture*/);
this.state.mouseUpEventListerAdded = true;
this.state.mouseDownX = event.pageX;
this.state.mouseDownY = event.pageY;
}
this.editor.triggerEvent('mouseDown', {
rawEvent: event,
});
Iif (event.defaultPrevented) {
this.pointerEvent = null;
}
Iif (this.pointerEvent) {
this.editor.triggerEvent('pointerDown', {
rawEvent: this.pointerEvent,
originalEvent: event,
});
}
}
};
private onMouseUp = (rawEvent: MouseEvent) => {
Eif (this.editor) {
this.removeMouseUpEventListener();
this.editor.triggerEvent('mouseUp', {
rawEvent,
isClicking:
this.state.mouseDownX == rawEvent.pageX &&
this.state.mouseDownY == rawEvent.pageY,
});
}
Iif (this.pointerEvent) {
this.pointerEvent = null;
}
};
private onDoubleClick = (event: MouseEvent) => {
if (this.editor) {
this.editor.triggerEvent('doubleClick', {
rawEvent: event,
});
}
};
private onCompositionStart = () => {
this.state.isInIME = true;
};
private onCompositionEnd = (rawEvent: CompositionEvent) => {
this.state.isInIME = false;
this.editor?.triggerEvent('compositionEnd', {
rawEvent,
});
};
private removeMouseUpEventListener() {
if (this.editor && this.state.mouseUpEventListerAdded) {
this.state.mouseUpEventListerAdded = false;
this.editor.getDocument().removeEventListener('mouseup', this.onMouseUp, true);
}
}
private onPointerDown = (e: PointerEvent) => {
if (e.pointerType === 'touch' || e.pointerType === 'pen') {
this.pointerEvent = e;
}
};
}
/**
* @internal
* Create a new instance of DOMEventPlugin.
* @param option The editor option
* @param contentDiv The editor content DIV element
*/
export function createDOMEventPlugin(
option: EditorOptions,
contentDiv: HTMLDivElement
): PluginWithState<DOMEventPluginState> {
return new DOMEventPlugin(option, contentDiv);
}
|