-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
clickobserver.ts
50 lines (45 loc) · 1.63 KB
/
clickobserver.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
/**
* @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 engine/view/observer/clickobserver
*/
import DomEventObserver from './domeventobserver.js';
import type DomEventData from './domeventdata.js';
import type { BubblingEvent } from './bubblingemittermixin.js';
/**
* {@link module:engine/view/document~Document#event:click Click} event observer.
*
* Note that this observer is not available by default. To make it available it needs to be added to
* {@link module:engine/view/view~View view controller} by a {@link module:engine/view/view~View#addObserver} method.
*/
export default class ClickObserver extends DomEventObserver<'click'> {
/**
* @inheritDoc
*/
public readonly domEventType = 'click' as const;
/**
* @inheritDoc
*/
public onDomEvent( domEvent: MouseEvent ): void {
this.fire( domEvent.type, domEvent );
}
}
/**
* Fired when one of the editables has been clicked.
*
* Introduced by {@link module:engine/view/observer/clickobserver~ClickObserver}.
*
* Note that this event is not available by default. To make it available
* {@link module:engine/view/observer/clickobserver~ClickObserver} needs to be added
* to {@link module:engine/view/view~View} by a {@link module:engine/view/view~View#addObserver} method.
*
* @see module:engine/view/observer/clickobserver~ClickObserver
* @eventName module:engine/view/document~Document#click
* @param data Event data.
*/
export type ViewDocumentClickEvent = BubblingEvent<{
name: 'click';
args: [ data: DomEventData<MouseEvent> ];
}>;