-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
mouseeventsobserver.ts
72 lines (66 loc) · 2.44 KB
/
mouseeventsobserver.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
/**
* @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module table/tablemouse/mouseeventsobserver
*/
import { DomEventObserver, type DomEventData } from 'ckeditor5/src/engine.js';
/**
* The mouse selection event observer.
*
* It registers listeners for the following DOM events:
*
* - `'mousemove'`
* - `'mouseleave'`
*
* Note that this observer is disabled by default. To enable this observer, it needs to be added to
* {@link module:engine/view/view~View} using the {@link module:engine/view/view~View#addObserver} method.
*
* The observer is registered by the {@link module:table/tableselection~TableSelection} plugin.
*/
export default class MouseEventsObserver extends DomEventObserver<'mousemove' | 'mouseleave'> {
public readonly domEventType = [
'mousemove', 'mouseleave'
] as const;
/**
* @inheritDoc
*/
public onDomEvent( domEvent: MouseEvent ): void {
this.fire( domEvent.type, domEvent );
}
}
/**
* Fired when the mouse is moved over one of the editables.
*
* Introduced by {@link module:table/tablemouse/mouseeventsobserver~MouseEventsObserver}.
*
* Note that this event is not available by default. To make it available,
* {@link module:table/tablemouse/mouseeventsobserver~MouseEventsObserver} needs to be added
* to {@link module:engine/view/view~View} using the {@link module:engine/view/view~View#addObserver} method.
*
* @see module:table/tablemouse/mouseeventsobserver~MouseEventsObserver
* @eventName module:engine/view/document~Document#mousemove
* @param data Event data.
*/
export type ViewDocumentMouseMoveEvent = {
name: 'mousemove';
args: [ data: DomEventData<MouseEvent> ];
};
/**
* Fired when the mouse is moved out of one of the editables.
*
* Introduced by {@link module:table/tablemouse/mouseeventsobserver~MouseEventsObserver}.
*
* Note that this event is not available by default. To make it available,
* {@link module:table/tablemouse/mouseeventsobserver~MouseEventsObserver} needs to be added
* to {@link module:engine/view/view~View} using the {@link module:engine/view/view~View#addObserver} method.
*
* @see module:table/tablemouse/mouseeventsobserver~MouseEventsObserver
* @eventName module:engine/view/document~Document#mouseleave
* @param data Event data.
*/
export type ViewDocumentMouseLeaveEvent = {
name: 'mouseleave';
args: [ data: DomEventData<MouseEvent> ];
};