@ckeditor/ckeditor5-engine 48.2.0 → 48.3.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/controller/datacontroller.d.ts +329 -328
- package/dist/controller/editingcontroller.d.ts +95 -94
- package/dist/conversion/comparemarkers.d.ts +45 -45
- package/dist/conversion/conversion.d.ts +474 -474
- package/dist/conversion/conversionhelpers.d.ts +21 -21
- package/dist/conversion/downcastdispatcher.d.ts +539 -538
- package/dist/conversion/downcasthelpers.d.ts +1129 -1129
- package/dist/conversion/mapper.d.ts +692 -697
- package/dist/conversion/modelconsumable.d.ts +196 -196
- package/dist/conversion/upcastdispatcher.d.ts +483 -482
- package/dist/conversion/upcasthelpers.d.ts +491 -491
- package/dist/conversion/viewconsumable.d.ts +330 -330
- package/dist/dataprocessor/basichtmlwriter.d.ts +15 -15
- package/dist/dataprocessor/dataprocessor.d.ts +57 -57
- package/dist/dataprocessor/htmldataprocessor.d.ts +72 -72
- package/dist/dataprocessor/htmlwriter.d.ts +11 -11
- package/dist/dataprocessor/xmldataprocessor.d.ts +86 -86
- package/dist/dev-utils/model.d.ts +128 -123
- package/dist/dev-utils/operationreplayer.d.ts +49 -49
- package/dist/dev-utils/utils.d.ts +33 -33
- package/dist/dev-utils/view.d.ts +314 -309
- package/dist/engineconfig.d.ts +39 -39
- package/dist/index.css.map +1 -1
- package/dist/index.d.ts +150 -150
- package/dist/index.js +34026 -40107
- package/dist/index.js.map +1 -1
- package/dist/legacyerrors.d.ts +0 -4
- package/dist/model/batch.d.ts +86 -86
- package/dist/model/differ.d.ts +504 -504
- package/dist/model/document.d.ts +265 -268
- package/dist/model/documentfragment.d.ts +214 -214
- package/dist/model/documentselection.d.ts +406 -410
- package/dist/model/element.d.ts +182 -182
- package/dist/model/history.d.ts +109 -109
- package/dist/model/item.d.ts +9 -9
- package/dist/model/liveposition.d.ts +70 -69
- package/dist/model/liverange.d.ts +93 -92
- package/dist/model/markercollection.d.ts +317 -324
- package/dist/model/model.d.ts +889 -909
- package/dist/model/node.d.ts +254 -254
- package/dist/model/nodelist.d.ts +110 -110
- package/dist/model/operation/attributeoperation.d.ts +98 -98
- package/dist/model/operation/detachoperation.d.ts +57 -57
- package/dist/model/operation/insertoperation.d.ts +85 -85
- package/dist/model/operation/markeroperation.d.ts +87 -87
- package/dist/model/operation/mergeoperation.d.ts +95 -95
- package/dist/model/operation/moveoperation.d.ts +97 -97
- package/dist/model/operation/nooperation.d.ts +33 -33
- package/dist/model/operation/operation.d.ts +94 -94
- package/dist/model/operation/operationfactory.d.ts +14 -14
- package/dist/model/operation/renameoperation.d.ts +78 -78
- package/dist/model/operation/rootattributeoperation.d.ts +93 -93
- package/dist/model/operation/rootoperation.d.ts +71 -71
- package/dist/model/operation/splitoperation.d.ts +104 -104
- package/dist/model/operation/transform.d.ts +91 -91
- package/dist/model/operation/utils.d.ts +58 -58
- package/dist/model/position.d.ts +535 -535
- package/dist/model/range.d.ts +458 -453
- package/dist/model/rootelement.d.ts +55 -55
- package/dist/model/schema.d.ts +1325 -1327
- package/dist/model/selection.d.ts +452 -471
- package/dist/model/text.d.ts +62 -62
- package/dist/model/textproxy.d.ts +140 -140
- package/dist/model/treewalker.d.ts +190 -190
- package/dist/model/typecheckable.d.ts +281 -281
- package/dist/model/utils/autoparagraphing.d.ts +29 -29
- package/dist/model/utils/deletecontent.d.ts +68 -68
- package/dist/model/utils/getselectedcontent.d.ts +27 -27
- package/dist/model/utils/insertcontent.d.ts +42 -42
- package/dist/model/utils/insertobject.d.ts +41 -41
- package/dist/model/utils/modifyselection.d.ts +44 -44
- package/dist/model/utils/selection-post-fixer.d.ts +71 -71
- package/dist/model/writer.d.ts +854 -854
- package/dist/view/attributeelement.d.ts +123 -123
- package/dist/view/containerelement.d.ts +49 -49
- package/dist/view/datatransfer.d.ts +70 -70
- package/dist/view/document.d.ts +175 -177
- package/dist/view/documentfragment.d.ts +158 -157
- package/dist/view/documentselection.d.ts +308 -307
- package/dist/view/domconverter.d.ts +612 -657
- package/dist/view/downcastwriter.d.ts +1006 -1006
- package/dist/view/editableelement.d.ts +64 -63
- package/dist/view/element.d.ts +754 -754
- package/dist/view/elementdefinition.d.ts +79 -79
- package/dist/view/emptyelement.d.ts +42 -42
- package/dist/view/filler.d.ts +75 -75
- package/dist/view/item.d.ts +9 -9
- package/dist/view/matcher.d.ts +412 -487
- package/dist/view/node.d.ts +164 -163
- package/dist/view/observer/arrowkeysobserver.d.ts +37 -37
- package/dist/view/observer/bubblingemittermixin.d.ts +163 -153
- package/dist/view/observer/bubblingeventinfo.d.ts +45 -42
- package/dist/view/observer/clickobserver.d.ts +36 -36
- package/dist/view/observer/compositionobserver.d.ts +67 -67
- package/dist/view/observer/domeventdata.d.ts +46 -46
- package/dist/view/observer/domeventobserver.d.ts +77 -74
- package/dist/view/observer/fakeselectionobserver.d.ts +42 -42
- package/dist/view/observer/focusobserver.d.ts +84 -84
- package/dist/view/observer/inputobserver.d.ts +76 -76
- package/dist/view/observer/keyobserver.d.ts +53 -53
- package/dist/view/observer/mouseobserver.d.ts +73 -73
- package/dist/view/observer/mutationobserver.d.ts +101 -101
- package/dist/view/observer/observer.d.ts +84 -83
- package/dist/view/observer/pointerobserver.d.ts +63 -63
- package/dist/view/observer/selectionobserver.d.ts +136 -136
- package/dist/view/observer/tabobserver.d.ts +38 -38
- package/dist/view/observer/touchobserver.d.ts +60 -60
- package/dist/view/placeholder.d.ts +80 -80
- package/dist/view/position.d.ts +187 -187
- package/dist/view/range.d.ts +282 -282
- package/dist/view/rawelement.d.ts +72 -72
- package/dist/view/renderer.d.ts +270 -272
- package/dist/view/rooteditableelement.d.ts +43 -43
- package/dist/view/selection.d.ts +356 -369
- package/dist/view/styles/background.d.ts +15 -15
- package/dist/view/styles/border.d.ts +27 -27
- package/dist/view/styles/margin.d.ts +12 -12
- package/dist/view/styles/padding.d.ts +12 -12
- package/dist/view/styles/utils.d.ts +72 -72
- package/dist/view/stylesmap.d.ts +715 -715
- package/dist/view/text.d.ts +75 -75
- package/dist/view/textproxy.d.ts +92 -92
- package/dist/view/tokenlist.d.ts +104 -104
- package/dist/view/treewalker.d.ts +201 -201
- package/dist/view/typecheckable.d.ts +445 -445
- package/dist/view/uielement.d.ts +93 -93
- package/dist/view/upcastwriter.d.ts +412 -412
- package/dist/view/view.d.ts +466 -469
- package/package.json +2 -2
|
@@ -1,94 +1,94 @@
|
|
|
1
1
|
/**
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
|
|
4
|
+
*/
|
|
5
5
|
/**
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
import { DomEventObserver } from
|
|
9
|
-
import { type ViewDocumentDomEventData } from
|
|
10
|
-
import { type EditingView } from
|
|
6
|
+
* @module engine/view/observer/focusobserver
|
|
7
|
+
*/
|
|
8
|
+
import { DomEventObserver } from "./domeventobserver.js";
|
|
9
|
+
import { type ViewDocumentDomEventData } from "./domeventdata.js";
|
|
10
|
+
import { type EditingView } from "../view.js";
|
|
11
11
|
/**
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
export declare class FocusObserver extends DomEventObserver<
|
|
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
|
-
|
|
12
|
+
* {@link module:engine/view/document~ViewDocument#event:focus Focus}
|
|
13
|
+
* and {@link module:engine/view/document~ViewDocument#event:blur blur} events observer.
|
|
14
|
+
* Focus observer handle also {@link module:engine/view/rooteditableelement~ViewRootEditableElement#isFocused isFocused} property of the
|
|
15
|
+
* {@link module:engine/view/rooteditableelement~ViewRootEditableElement root elements}.
|
|
16
|
+
*
|
|
17
|
+
* Note that this observer is attached by the {@link module:engine/view/view~EditingView} and is available by default.
|
|
18
|
+
*/
|
|
19
|
+
export declare class FocusObserver extends DomEventObserver<"focus" | "blur"> {
|
|
20
|
+
/**
|
|
21
|
+
* Identifier of the timeout currently used by focus listener to delay rendering execution.
|
|
22
|
+
*/
|
|
23
|
+
private _renderTimeoutId;
|
|
24
|
+
/**
|
|
25
|
+
* Set to `true` if the document is in the process of setting the focus.
|
|
26
|
+
*
|
|
27
|
+
* The flag is used to indicate that setting the focus is in progress.
|
|
28
|
+
*/
|
|
29
|
+
private _isFocusChanging;
|
|
30
|
+
/**
|
|
31
|
+
* @inheritDoc
|
|
32
|
+
*/
|
|
33
|
+
readonly domEventType: readonly ["focus", "blur"];
|
|
34
|
+
/**
|
|
35
|
+
* @inheritDoc
|
|
36
|
+
*/
|
|
37
|
+
constructor(view: EditingView);
|
|
38
|
+
/**
|
|
39
|
+
* Finishes setting the document focus state.
|
|
40
|
+
*/
|
|
41
|
+
flush(): void;
|
|
42
|
+
/**
|
|
43
|
+
* @inheritDoc
|
|
44
|
+
*/
|
|
45
|
+
onDomEvent(domEvent: FocusEvent): void;
|
|
46
|
+
/**
|
|
47
|
+
* @inheritDoc
|
|
48
|
+
*/
|
|
49
|
+
override destroy(): void;
|
|
50
|
+
/**
|
|
51
|
+
* The `focus` event handler.
|
|
52
|
+
*/
|
|
53
|
+
private _handleFocus;
|
|
54
|
+
/**
|
|
55
|
+
* The `blur` event handler.
|
|
56
|
+
*/
|
|
57
|
+
private _handleBlur;
|
|
58
|
+
/**
|
|
59
|
+
* Clears timeout.
|
|
60
|
+
*/
|
|
61
|
+
private _clearTimeout;
|
|
62
62
|
}
|
|
63
63
|
/**
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
64
|
+
* Fired when one of the editables gets focus.
|
|
65
|
+
*
|
|
66
|
+
* Introduced by {@link module:engine/view/observer/focusobserver~FocusObserver}.
|
|
67
|
+
*
|
|
68
|
+
* Note that because {@link module:engine/view/observer/focusobserver~FocusObserver} is attached by the
|
|
69
|
+
* {@link module:engine/view/view~EditingView} this event is available by default.
|
|
70
|
+
*
|
|
71
|
+
* @see module:engine/view/observer/focusobserver~FocusObserver
|
|
72
|
+
* @eventName module:engine/view/document~ViewDocument#focus
|
|
73
|
+
* @param data Event data.
|
|
74
|
+
*/
|
|
75
75
|
export type ViewDocumentFocusEvent = {
|
|
76
|
-
|
|
77
|
-
|
|
76
|
+
name: "focus";
|
|
77
|
+
args: [data: ViewDocumentDomEventData<FocusEvent>];
|
|
78
78
|
};
|
|
79
79
|
/**
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
80
|
+
* Fired when one of the editables loses focus.
|
|
81
|
+
*
|
|
82
|
+
* Introduced by {@link module:engine/view/observer/focusobserver~FocusObserver}.
|
|
83
|
+
*
|
|
84
|
+
* Note that because {@link module:engine/view/observer/focusobserver~FocusObserver} is attached by the
|
|
85
|
+
* {@link module:engine/view/view~EditingView} this event is available by default.
|
|
86
|
+
*
|
|
87
|
+
* @see module:engine/view/observer/focusobserver~FocusObserver
|
|
88
|
+
* @eventName module:engine/view/document~ViewDocument#blur
|
|
89
|
+
* @param data Event data.
|
|
90
|
+
*/
|
|
91
91
|
export type ViewDocumentBlurEvent = {
|
|
92
|
-
|
|
93
|
-
|
|
92
|
+
name: "blur";
|
|
93
|
+
args: [data: ViewDocumentDomEventData<FocusEvent>];
|
|
94
94
|
};
|
|
@@ -1,86 +1,86 @@
|
|
|
1
1
|
/**
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
|
|
4
|
+
*/
|
|
5
5
|
/**
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
import { DomEventObserver } from
|
|
9
|
-
import { type ViewDocumentDomEventData } from
|
|
10
|
-
import { type ViewRange } from
|
|
11
|
-
import { ViewDataTransfer } from
|
|
6
|
+
* @module engine/view/observer/inputobserver
|
|
7
|
+
*/
|
|
8
|
+
import { DomEventObserver } from "./domeventobserver.js";
|
|
9
|
+
import { type ViewDocumentDomEventData } from "./domeventdata.js";
|
|
10
|
+
import { type ViewRange } from "../range.js";
|
|
11
|
+
import { ViewDataTransfer } from "../datatransfer.js";
|
|
12
12
|
/**
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
export declare class InputObserver extends DomEventObserver<
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
13
|
+
* Observer for events connected with data input.
|
|
14
|
+
*
|
|
15
|
+
* **Note**: This observer is attached by {@link module:engine/view/view~EditingView} and available by default in all
|
|
16
|
+
* editor instances.
|
|
17
|
+
*/
|
|
18
|
+
export declare class InputObserver extends DomEventObserver<"beforeinput"> {
|
|
19
|
+
/**
|
|
20
|
+
* @inheritDoc
|
|
21
|
+
*/
|
|
22
|
+
readonly domEventType = "beforeinput";
|
|
23
|
+
/**
|
|
24
|
+
* @inheritDoc
|
|
25
|
+
*/
|
|
26
|
+
onDomEvent(domEvent: InputEvent): void;
|
|
27
27
|
}
|
|
28
28
|
/**
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
29
|
+
* Fired before the web browser inputs, deletes, or formats some data.
|
|
30
|
+
*
|
|
31
|
+
* This event is introduced by {@link module:engine/view/observer/inputobserver~InputObserver} and available
|
|
32
|
+
* by default in all editor instances (attached by {@link module:engine/view/view~EditingView}).
|
|
33
|
+
*
|
|
34
|
+
* @see module:engine/view/observer/inputobserver~InputObserver
|
|
35
|
+
* @eventName module:engine/view/document~ViewDocument#beforeinput
|
|
36
|
+
* @param data Event data containing detailed information about the event.
|
|
37
|
+
*/
|
|
38
38
|
export type ViewDocumentInputEvent = {
|
|
39
|
-
|
|
40
|
-
|
|
39
|
+
name: "beforeinput";
|
|
40
|
+
args: [data: ViewDocumentInputEventData];
|
|
41
41
|
};
|
|
42
42
|
/**
|
|
43
|
-
|
|
44
|
-
|
|
43
|
+
* The value of the {@link ~ViewDocumentInputEvent} event.
|
|
44
|
+
*/
|
|
45
45
|
export interface ViewDocumentInputEventData extends ViewDocumentDomEventData<InputEvent> {
|
|
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
|
-
|
|
46
|
+
/**
|
|
47
|
+
* The type of the input event (e.g. "insertText" or "deleteWordBackward"). Corresponds to native `InputEvent#inputType`.
|
|
48
|
+
*/
|
|
49
|
+
readonly inputType: string;
|
|
50
|
+
/**
|
|
51
|
+
* A unified text data passed along with the input event. Depending on:
|
|
52
|
+
*
|
|
53
|
+
* * the web browser and input events implementation (for instance [Level 1](https://www.w3.org/TR/input-events-1/) or
|
|
54
|
+
* [Level 2](https://www.w3.org/TR/input-events-2/)),
|
|
55
|
+
* * {@link module:engine/view/observer/inputobserver~ViewDocumentInputEventData#inputType input type}
|
|
56
|
+
*
|
|
57
|
+
* text data is sometimes passed in the `data` and sometimes in the `dataTransfer` property.
|
|
58
|
+
*
|
|
59
|
+
* * If `InputEvent#data` was set, this property reflects its value.
|
|
60
|
+
* * If `InputEvent#data` is unavailable, this property contains the `'text/plain'` data from
|
|
61
|
+
* {@link module:engine/view/observer/inputobserver~ViewDocumentInputEventData#dataTransfer}.
|
|
62
|
+
* * If the event ({@link module:engine/view/observer/inputobserver~ViewDocumentInputEventData#inputType input type})
|
|
63
|
+
* provides no data whatsoever, this property is `null`.
|
|
64
|
+
*/
|
|
65
|
+
readonly data: string | null;
|
|
66
|
+
/**
|
|
67
|
+
* The data transfer instance of the input event. Corresponds to native `InputEvent#dataTransfer`.
|
|
68
|
+
*
|
|
69
|
+
* The value is `null` when no `dataTransfer` was passed along with the input event.
|
|
70
|
+
*/
|
|
71
|
+
readonly dataTransfer: ViewDataTransfer;
|
|
72
|
+
/**
|
|
73
|
+
* A flag indicating that the `beforeinput` event was fired during composition.
|
|
74
|
+
*
|
|
75
|
+
* Corresponds to the
|
|
76
|
+
* {@link module:engine/view/document~ViewDocument#event:compositionstart},
|
|
77
|
+
* {@link module:engine/view/document~ViewDocument#event:compositionupdate},
|
|
78
|
+
* and {@link module:engine/view/document~ViewDocument#event:compositionend } trio.
|
|
79
|
+
*/
|
|
80
|
+
readonly isComposing: boolean;
|
|
81
|
+
/**
|
|
82
|
+
* Editing {@link module:engine/view/range~ViewRange view ranges} corresponding to DOM ranges provided by the web browser
|
|
83
|
+
* (as returned by `InputEvent#getTargetRanges()`).
|
|
84
|
+
*/
|
|
85
|
+
readonly targetRanges: Array<ViewRange>;
|
|
86
86
|
}
|
|
@@ -1,67 +1,67 @@
|
|
|
1
1
|
/**
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
|
|
4
|
+
*/
|
|
5
5
|
/**
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
import { DomEventObserver } from
|
|
9
|
-
import { type ViewDocumentDomEventData } from
|
|
10
|
-
import type { BubblingEvent } from
|
|
11
|
-
import { type KeystrokeInfo } from
|
|
6
|
+
* @module engine/view/observer/keyobserver
|
|
7
|
+
*/
|
|
8
|
+
import { DomEventObserver } from "./domeventobserver.js";
|
|
9
|
+
import { type ViewDocumentDomEventData } from "./domeventdata.js";
|
|
10
|
+
import type { BubblingEvent } from "./bubblingemittermixin.js";
|
|
11
|
+
import { type KeystrokeInfo } from "@ckeditor/ckeditor5-utils";
|
|
12
12
|
/**
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
export declare class KeyObserver extends DomEventObserver<
|
|
18
|
-
|
|
13
|
+
* Observer for events connected with pressing keyboard keys.
|
|
14
|
+
*
|
|
15
|
+
* Note that this observer is attached by the {@link module:engine/view/view~EditingView} and is available by default.
|
|
16
|
+
*/
|
|
17
|
+
export declare class KeyObserver extends DomEventObserver<"keydown" | "keyup", KeystrokeInfo & {
|
|
18
|
+
keystroke: number;
|
|
19
19
|
}> {
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
20
|
+
/**
|
|
21
|
+
* @inheritDoc
|
|
22
|
+
*/
|
|
23
|
+
readonly domEventType: readonly ["keydown", "keyup"];
|
|
24
|
+
/**
|
|
25
|
+
* @inheritDoc
|
|
26
|
+
*/
|
|
27
|
+
onDomEvent(domEvt: KeyboardEvent): void;
|
|
28
28
|
}
|
|
29
29
|
/**
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
30
|
+
* Fired when a key has been pressed.
|
|
31
|
+
*
|
|
32
|
+
* Introduced by {@link module:engine/view/observer/keyobserver~KeyObserver}.
|
|
33
|
+
*
|
|
34
|
+
* Note that because {@link module:engine/view/observer/keyobserver~KeyObserver} is attached by the
|
|
35
|
+
* {@link module:engine/view/view~EditingView} this event is available by default.
|
|
36
|
+
*
|
|
37
|
+
* @see module:engine/view/observer/keyobserver~KeyObserver
|
|
38
|
+
* @eventName module:engine/view/document~ViewDocument#keydown
|
|
39
|
+
*/
|
|
40
40
|
export type ViewDocumentKeyDownEvent = BubblingEvent<{
|
|
41
|
-
|
|
42
|
-
|
|
41
|
+
name: "keydown";
|
|
42
|
+
args: [data: ViewDocumentKeyEventData];
|
|
43
43
|
}>;
|
|
44
44
|
/**
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
45
|
+
* Fired when a key has been released.
|
|
46
|
+
*
|
|
47
|
+
* Introduced by {@link module:engine/view/observer/keyobserver~KeyObserver}.
|
|
48
|
+
*
|
|
49
|
+
* Note that because {@link module:engine/view/observer/keyobserver~KeyObserver} is attached by the
|
|
50
|
+
* {@link module:engine/view/view~EditingView} this event is available by default.
|
|
51
|
+
*
|
|
52
|
+
* @see module:engine/view/observer/keyobserver~KeyObserver
|
|
53
|
+
* @eventName module:engine/view/document~ViewDocument#keyup
|
|
54
|
+
*/
|
|
55
55
|
export type ViewDocumentKeyUpEvent = BubblingEvent<{
|
|
56
|
-
|
|
57
|
-
|
|
56
|
+
name: "keyup";
|
|
57
|
+
args: [data: ViewDocumentKeyEventData];
|
|
58
58
|
}>;
|
|
59
59
|
/**
|
|
60
|
-
|
|
61
|
-
|
|
60
|
+
* The value of both events - {@link ~ViewDocumentKeyDownEvent} and {@link ~ViewDocumentKeyUpEvent}.
|
|
61
|
+
*/
|
|
62
62
|
export interface ViewDocumentKeyEventData extends ViewDocumentDomEventData<KeyboardEvent>, KeystrokeInfo {
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
63
|
+
/**
|
|
64
|
+
* Code of the whole keystroke. See {@link module:utils/keyboard~getCode}.
|
|
65
|
+
*/
|
|
66
|
+
keystroke: number;
|
|
67
67
|
}
|
|
@@ -1,89 +1,89 @@
|
|
|
1
1
|
/**
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
|
|
4
|
+
*/
|
|
5
5
|
/**
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
import { DomEventObserver } from
|
|
9
|
-
import { type ViewDocumentDomEventData } from
|
|
6
|
+
* @module engine/view/observer/mouseobserver
|
|
7
|
+
*/
|
|
8
|
+
import { DomEventObserver } from "./domeventobserver.js";
|
|
9
|
+
import { type ViewDocumentDomEventData } from "./domeventdata.js";
|
|
10
10
|
/**
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
export declare class MouseObserver extends DomEventObserver<
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
11
|
+
* Mouse events observer.
|
|
12
|
+
*
|
|
13
|
+
* Note that this observer is not available by default. To make it available it needs to be added to
|
|
14
|
+
* {@link module:engine/view/view~EditingView} by {@link module:engine/view/view~EditingView#addObserver} method.
|
|
15
|
+
*/
|
|
16
|
+
export declare class MouseObserver extends DomEventObserver<"mousedown" | "mouseup" | "mouseover" | "mouseout"> {
|
|
17
|
+
/**
|
|
18
|
+
* @inheritDoc
|
|
19
|
+
*/
|
|
20
|
+
readonly domEventType: readonly ["mousedown", "mouseup", "mouseover", "mouseout"];
|
|
21
|
+
/**
|
|
22
|
+
* @inheritDoc
|
|
23
|
+
*/
|
|
24
|
+
onDomEvent(domEvent: MouseEvent): void;
|
|
25
25
|
}
|
|
26
26
|
/**
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
27
|
+
* Fired when the mouse button is pressed down on one of the editing roots of the editor.
|
|
28
|
+
*
|
|
29
|
+
* Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
|
|
30
|
+
*
|
|
31
|
+
* Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
|
|
32
|
+
* needs to be added to {@link module:engine/view/view~EditingView} by the {@link module:engine/view/view~EditingView#addObserver} method.
|
|
33
|
+
*
|
|
34
|
+
* @see module:engine/view/observer/mouseobserver~MouseObserver
|
|
35
|
+
* @eventName module:engine/view/document~ViewDocument#mousedown
|
|
36
|
+
* @param data The event data.
|
|
37
|
+
*/
|
|
38
38
|
export type ViewDocumentMouseDownEvent = {
|
|
39
|
-
|
|
40
|
-
|
|
39
|
+
name: "mousedown";
|
|
40
|
+
args: [data: ViewDocumentDomEventData<MouseEvent>];
|
|
41
41
|
};
|
|
42
42
|
/**
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
43
|
+
* Fired when the mouse button is released over one of the editing roots of the editor.
|
|
44
|
+
*
|
|
45
|
+
* Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
|
|
46
|
+
*
|
|
47
|
+
* Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
|
|
48
|
+
* needs to be added to {@link module:engine/view/view~EditingView} by the {@link module:engine/view/view~EditingView#addObserver} method.
|
|
49
|
+
*
|
|
50
|
+
* @see module:engine/view/observer/mouseobserver~MouseObserver
|
|
51
|
+
* @eventName module:engine/view/document~ViewDocument#mouseup
|
|
52
|
+
* @param data The event data.
|
|
53
|
+
*/
|
|
54
54
|
export type ViewDocumentMouseUpEvent = {
|
|
55
|
-
|
|
56
|
-
|
|
55
|
+
name: "mouseup";
|
|
56
|
+
args: [data: ViewDocumentDomEventData<MouseEvent>];
|
|
57
57
|
};
|
|
58
58
|
/**
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
59
|
+
* Fired when the mouse is over one of the editing roots of the editor.
|
|
60
|
+
*
|
|
61
|
+
* Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
|
|
62
|
+
*
|
|
63
|
+
* Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
|
|
64
|
+
* needs to be added to {@link module:engine/view/view~EditingView} by the {@link module:engine/view/view~EditingView#addObserver} method.
|
|
65
|
+
*
|
|
66
|
+
* @see module:engine/view/observer/mouseobserver~MouseObserver
|
|
67
|
+
* @eventName module:engine/view/document~ViewDocument#mouseover
|
|
68
|
+
* @param data The event data.
|
|
69
|
+
*/
|
|
70
70
|
export type ViewDocumentMouseOverEvent = {
|
|
71
|
-
|
|
72
|
-
|
|
71
|
+
name: "mouseover";
|
|
72
|
+
args: [data: ViewDocumentDomEventData<MouseEvent>];
|
|
73
73
|
};
|
|
74
74
|
/**
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
75
|
+
* Fired when the mouse is moved out of the one of the editing roots of the editor.
|
|
76
|
+
*
|
|
77
|
+
* Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
|
|
78
|
+
*
|
|
79
|
+
* Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
|
|
80
|
+
* needs to be added to {@link module:engine/view/view~EditingView} by the {@link module:engine/view/view~EditingView#addObserver} method.
|
|
81
|
+
*
|
|
82
|
+
* @see module:engine/view/observer/mouseobserver~MouseObserver
|
|
83
|
+
* @eventName module:engine/view/document~ViewDocument#mouseout
|
|
84
|
+
* @param data The event data.
|
|
85
|
+
*/
|
|
86
86
|
export type ViewDocumentMouseOutEvent = {
|
|
87
|
-
|
|
88
|
-
|
|
87
|
+
name: "mouseout";
|
|
88
|
+
args: [data: ViewDocumentDomEventData<MouseEvent>];
|
|
89
89
|
};
|