@ckeditor/ckeditor5-engine 41.3.0-alpha.4 → 41.3.1

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.
Files changed (132) hide show
  1. package/package.json +2 -3
  2. package/src/model/node.d.ts +1 -0
  3. package/src/model/node.js +2 -0
  4. package/src/model/position.d.ts +1 -0
  5. package/src/model/position.js +2 -0
  6. package/src/view/node.d.ts +1 -0
  7. package/src/view/node.js +2 -0
  8. package/src/view/position.d.ts +1 -0
  9. package/src/view/position.js +2 -0
  10. package/dist/content-index.css +0 -4
  11. package/dist/editor-index.css +0 -23
  12. package/dist/index.css +0 -49
  13. package/dist/index.css.map +0 -1
  14. package/dist/types/controller/datacontroller.d.ts +0 -339
  15. package/dist/types/controller/editingcontroller.d.ts +0 -102
  16. package/dist/types/conversion/conversion.d.ts +0 -482
  17. package/dist/types/conversion/conversionhelpers.d.ts +0 -30
  18. package/dist/types/conversion/downcastdispatcher.d.ts +0 -566
  19. package/dist/types/conversion/downcasthelpers.d.ts +0 -1194
  20. package/dist/types/conversion/mapper.d.ts +0 -507
  21. package/dist/types/conversion/modelconsumable.d.ts +0 -205
  22. package/dist/types/conversion/upcastdispatcher.d.ts +0 -496
  23. package/dist/types/conversion/upcasthelpers.d.ts +0 -503
  24. package/dist/types/conversion/viewconsumable.d.ts +0 -373
  25. package/dist/types/dataprocessor/basichtmlwriter.d.ts +0 -22
  26. package/dist/types/dataprocessor/dataprocessor.d.ts +0 -65
  27. package/dist/types/dataprocessor/htmldataprocessor.d.ts +0 -80
  28. package/dist/types/dataprocessor/htmlwriter.d.ts +0 -20
  29. package/dist/types/dataprocessor/xmldataprocessor.d.ts +0 -94
  30. package/dist/types/dev-utils/model.d.ts +0 -128
  31. package/dist/types/dev-utils/operationreplayer.d.ts +0 -55
  32. package/dist/types/dev-utils/utils.d.ts +0 -41
  33. package/dist/types/dev-utils/view.d.ts +0 -323
  34. package/dist/types/index.d.ts +0 -117
  35. package/dist/types/model/batch.d.ts +0 -110
  36. package/dist/types/model/differ.d.ts +0 -419
  37. package/dist/types/model/document.d.ts +0 -278
  38. package/dist/types/model/documentfragment.d.ts +0 -204
  39. package/dist/types/model/documentselection.d.ts +0 -424
  40. package/dist/types/model/element.d.ts +0 -169
  41. package/dist/types/model/history.d.ts +0 -118
  42. package/dist/types/model/item.d.ts +0 -18
  43. package/dist/types/model/liveposition.d.ts +0 -81
  44. package/dist/types/model/liverange.d.ts +0 -106
  45. package/dist/types/model/markercollection.d.ts +0 -339
  46. package/dist/types/model/model.d.ts +0 -923
  47. package/dist/types/model/node.d.ts +0 -259
  48. package/dist/types/model/nodelist.d.ts +0 -95
  49. package/dist/types/model/operation/attributeoperation.d.ts +0 -107
  50. package/dist/types/model/operation/detachoperation.d.ts +0 -64
  51. package/dist/types/model/operation/insertoperation.d.ts +0 -94
  52. package/dist/types/model/operation/markeroperation.d.ts +0 -95
  53. package/dist/types/model/operation/mergeoperation.d.ts +0 -104
  54. package/dist/types/model/operation/moveoperation.d.ts +0 -100
  55. package/dist/types/model/operation/nooperation.d.ts +0 -42
  56. package/dist/types/model/operation/operation.d.ts +0 -100
  57. package/dist/types/model/operation/operationfactory.d.ts +0 -22
  58. package/dist/types/model/operation/renameoperation.d.ts +0 -87
  59. package/dist/types/model/operation/rootattributeoperation.d.ts +0 -102
  60. package/dist/types/model/operation/rootoperation.d.ts +0 -80
  61. package/dist/types/model/operation/splitoperation.d.ts +0 -113
  62. package/dist/types/model/operation/transform.d.ts +0 -104
  63. package/dist/types/model/operation/utils.d.ts +0 -75
  64. package/dist/types/model/position.d.ts +0 -542
  65. package/dist/types/model/range.d.ts +0 -462
  66. package/dist/types/model/rootelement.d.ts +0 -64
  67. package/dist/types/model/schema.d.ts +0 -1210
  68. package/dist/types/model/selection.d.ts +0 -486
  69. package/dist/types/model/text.d.ts +0 -70
  70. package/dist/types/model/textproxy.d.ts +0 -148
  71. package/dist/types/model/treewalker.d.ts +0 -190
  72. package/dist/types/model/typecheckable.d.ts +0 -289
  73. package/dist/types/model/utils/autoparagraphing.d.ts +0 -41
  74. package/dist/types/model/utils/deletecontent.d.ts +0 -62
  75. package/dist/types/model/utils/getselectedcontent.d.ts +0 -34
  76. package/dist/types/model/utils/insertcontent.d.ts +0 -50
  77. package/dist/types/model/utils/insertobject.d.ts +0 -51
  78. package/dist/types/model/utils/modifyselection.d.ts +0 -52
  79. package/dist/types/model/utils/selection-post-fixer.d.ts +0 -78
  80. package/dist/types/model/writer.d.ts +0 -855
  81. package/dist/types/view/attributeelement.d.ts +0 -112
  82. package/dist/types/view/containerelement.d.ts +0 -53
  83. package/dist/types/view/datatransfer.d.ts +0 -83
  84. package/dist/types/view/document.d.ts +0 -188
  85. package/dist/types/view/documentfragment.d.ts +0 -157
  86. package/dist/types/view/documentselection.d.ts +0 -310
  87. package/dist/types/view/domconverter.d.ts +0 -656
  88. package/dist/types/view/downcastwriter.d.ts +0 -1000
  89. package/dist/types/view/editableelement.d.ts +0 -66
  90. package/dist/types/view/element.d.ts +0 -472
  91. package/dist/types/view/elementdefinition.d.ts +0 -91
  92. package/dist/types/view/emptyelement.d.ts +0 -45
  93. package/dist/types/view/filler.d.ts +0 -115
  94. package/dist/types/view/item.d.ts +0 -18
  95. package/dist/types/view/matcher.d.ts +0 -490
  96. package/dist/types/view/node.d.ts +0 -166
  97. package/dist/types/view/observer/arrowkeysobserver.d.ts +0 -49
  98. package/dist/types/view/observer/bubblingemittermixin.d.ts +0 -170
  99. package/dist/types/view/observer/bubblingeventinfo.d.ts +0 -51
  100. package/dist/types/view/observer/clickobserver.d.ts +0 -47
  101. package/dist/types/view/observer/compositionobserver.d.ts +0 -86
  102. package/dist/types/view/observer/domeventdata.d.ts +0 -54
  103. package/dist/types/view/observer/domeventobserver.d.ts +0 -77
  104. package/dist/types/view/observer/fakeselectionobserver.d.ts +0 -51
  105. package/dist/types/view/observer/focusobserver.d.ts +0 -86
  106. package/dist/types/view/observer/inputobserver.d.ts +0 -90
  107. package/dist/types/view/observer/keyobserver.d.ts +0 -70
  108. package/dist/types/view/observer/mouseobserver.d.ts +0 -93
  109. package/dist/types/view/observer/mutationobserver.d.ts +0 -90
  110. package/dist/types/view/observer/observer.d.ts +0 -93
  111. package/dist/types/view/observer/selectionobserver.d.ts +0 -152
  112. package/dist/types/view/observer/tabobserver.d.ts +0 -50
  113. package/dist/types/view/placeholder.d.ts +0 -100
  114. package/dist/types/view/position.d.ts +0 -192
  115. package/dist/types/view/range.d.ts +0 -283
  116. package/dist/types/view/rawelement.d.ts +0 -77
  117. package/dist/types/view/renderer.d.ts +0 -269
  118. package/dist/types/view/rooteditableelement.d.ts +0 -45
  119. package/dist/types/view/selection.d.ts +0 -379
  120. package/dist/types/view/styles/background.d.ts +0 -37
  121. package/dist/types/view/styles/border.d.ts +0 -47
  122. package/dist/types/view/styles/margin.d.ts +0 -33
  123. package/dist/types/view/styles/padding.d.ts +0 -33
  124. package/dist/types/view/styles/utils.d.ts +0 -97
  125. package/dist/types/view/stylesmap.d.ts +0 -677
  126. package/dist/types/view/text.d.ts +0 -78
  127. package/dist/types/view/textproxy.d.ts +0 -101
  128. package/dist/types/view/treewalker.d.ts +0 -199
  129. package/dist/types/view/typecheckable.d.ts +0 -452
  130. package/dist/types/view/uielement.d.ts +0 -100
  131. package/dist/types/view/upcastwriter.d.ts +0 -421
  132. package/dist/types/view/view.d.ts +0 -491
@@ -1,77 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
8
- */
9
- /**
10
- * @module engine/view/observer/domeventobserver
11
- */
12
- import Observer from './observer.js';
13
- import type { EventInfo } from '@ckeditor/ckeditor5-utils';
14
- /**
15
- * Base class for DOM event observers. This class handles
16
- * {@link module:engine/view/observer/observer~Observer#observe adding} listeners to DOM elements,
17
- * {@link module:engine/view/observer/observer~Observer#disable disabling} and
18
- * {@link module:engine/view/observer/observer~Observer#enable re-enabling} events.
19
- * Child class needs to define
20
- * {@link module:engine/view/observer/domeventobserver~DomEventObserver#domEventType DOM event type} and
21
- * {@link module:engine/view/observer/domeventobserver~DomEventObserver#onDomEvent callback}.
22
- *
23
- * For instance:
24
- *
25
- * ```ts
26
- * class ClickObserver extends DomEventObserver<'click'> {
27
- * // It can also be defined as a normal property in the constructor.
28
- * get domEventType(): 'click' {
29
- * return 'click';
30
- * }
31
- *
32
- * onDomEvent( domEvent: MouseEvent ): void {
33
- * this.fire( 'click', domEvent );
34
- * }
35
- * }
36
- * ```
37
- *
38
- * @typeParam EventType DOM Event type name or an union of those.
39
- * @typeParam AdditionalData Additional data passed along with the event.
40
- */
41
- export default abstract class DomEventObserver<EventType extends keyof HTMLElementEventMap, AdditionalData extends object = object> extends Observer {
42
- /**
43
- * Type of the DOM event the observer should listen to. Array of types can be defined
44
- * if the observer should listen to multiple DOM events.
45
- */
46
- abstract get domEventType(): EventType | ReadonlyArray<EventType>;
47
- /**
48
- * If set to `true` DOM events will be listened on the capturing phase.
49
- * Default value is `false`.
50
- */
51
- useCapture: boolean;
52
- /**
53
- * Callback which should be called when the DOM event occurred. Note that the callback will not be called if
54
- * observer {@link #isEnabled is not enabled}.
55
- *
56
- * @see #domEventType
57
- */
58
- abstract onDomEvent(event: HTMLElementEventMap[EventType]): void;
59
- /**
60
- * @inheritDoc
61
- */
62
- observe(domElement: HTMLElement): void;
63
- /**
64
- * @inheritDoc
65
- */
66
- stopObserving(domElement: HTMLElement): void;
67
- /**
68
- * Calls `Document#fire()` if observer {@link #isEnabled is enabled}.
69
- *
70
- * @see module:utils/emittermixin~Emitter#fire
71
- * @param eventType The event type (name).
72
- * @param domEvent The DOM event.
73
- * @param additionalData The additional data which should extend the
74
- * {@link module:engine/view/observer/domeventdata~DomEventData event data} object.
75
- */
76
- fire(eventType: string | EventInfo, domEvent: Event, additionalData?: AdditionalData): void;
77
- }
@@ -1,51 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
8
- */
9
- /**
10
- * @module engine/view/observer/fakeselectionobserver
11
- */
12
- import Observer from './observer.js';
13
- import type View from '../view.js';
14
- /**
15
- * Fake selection observer class. If view selection is fake it is placed in dummy DOM container. This observer listens
16
- * on {@link module:engine/view/document~Document#event:keydown keydown} events and handles moving fake view selection to the correct place
17
- * if arrow keys are pressed.
18
- * Fires {@link module:engine/view/document~Document#event:selectionChange selectionChange event} simulating natural behaviour of
19
- * {@link module:engine/view/observer/selectionobserver~SelectionObserver SelectionObserver}.
20
- */
21
- export default class FakeSelectionObserver extends Observer {
22
- /**
23
- * Fires debounced event `selectionChangeDone`. It uses `lodash#debounce` method to delay function call.
24
- */
25
- private readonly _fireSelectionChangeDoneDebounced;
26
- /**
27
- * Creates new FakeSelectionObserver instance.
28
- */
29
- constructor(view: View);
30
- /**
31
- * @inheritDoc
32
- */
33
- observe(): void;
34
- /**
35
- * @inheritDoc
36
- */
37
- stopObserving(): void;
38
- /**
39
- * @inheritDoc
40
- */
41
- destroy(): void;
42
- /**
43
- * Handles collapsing view selection according to given key code. If left or up key is provided - new selection will be
44
- * collapsed to left. If right or down key is pressed - new selection will be collapsed to right.
45
- *
46
- * This method fires {@link module:engine/view/document~Document#event:selectionChange} and
47
- * {@link module:engine/view/document~Document#event:selectionChangeDone} events imitating behaviour of
48
- * {@link module:engine/view/observer/selectionobserver~SelectionObserver}.
49
- */
50
- private _handleSelectionMove;
51
- }
@@ -1,86 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
8
- */
9
- /**
10
- * @module engine/view/observer/focusobserver
11
- */
12
- import DomEventObserver from './domeventobserver.js';
13
- import type DomEventData from './domeventdata.js';
14
- import type View from '../view.js';
15
- /**
16
- * {@link module:engine/view/document~Document#event:focus Focus}
17
- * and {@link module:engine/view/document~Document#event:blur blur} events observer.
18
- * Focus observer handle also {@link module:engine/view/rooteditableelement~RootEditableElement#isFocused isFocused} property of the
19
- * {@link module:engine/view/rooteditableelement~RootEditableElement root elements}.
20
- *
21
- * Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default.
22
- */
23
- export default class FocusObserver extends DomEventObserver<'focus' | 'blur'> {
24
- /**
25
- * Identifier of the timeout currently used by focus listener to delay rendering execution.
26
- */
27
- private _renderTimeoutId;
28
- /**
29
- * Set to `true` if the document is in the process of setting the focus.
30
- *
31
- * The flag is used to indicate that setting the focus is in progress.
32
- */
33
- private _isFocusChanging;
34
- /**
35
- * @inheritDoc
36
- */
37
- readonly domEventType: readonly ["focus", "blur"];
38
- /**
39
- * @inheritDoc
40
- */
41
- constructor(view: View);
42
- /**
43
- * Finishes setting the document focus state.
44
- */
45
- flush(): void;
46
- /**
47
- * @inheritDoc
48
- */
49
- onDomEvent(domEvent: FocusEvent): void;
50
- /**
51
- * @inheritDoc
52
- */
53
- destroy(): void;
54
- }
55
- /**
56
- * Fired when one of the editables gets focus.
57
- *
58
- * Introduced by {@link module:engine/view/observer/focusobserver~FocusObserver}.
59
- *
60
- * Note that because {@link module:engine/view/observer/focusobserver~FocusObserver} is attached by the
61
- * {@link module:engine/view/view~View} this event is available by default.
62
- *
63
- * @see module:engine/view/observer/focusobserver~FocusObserver
64
- * @eventName module:engine/view/document~Document#focus
65
- * @param data Event data.
66
- */
67
- export type ViewDocumentFocusEvent = {
68
- name: 'focus';
69
- args: [data: DomEventData<FocusEvent>];
70
- };
71
- /**
72
- * Fired when one of the editables loses focus.
73
- *
74
- * Introduced by {@link module:engine/view/observer/focusobserver~FocusObserver}.
75
- *
76
- * Note that because {@link module:engine/view/observer/focusobserver~FocusObserver} is attached by the
77
- * {@link module:engine/view/view~View} this event is available by default.
78
- *
79
- * @see module:engine/view/observer/focusobserver~FocusObserver
80
- * @eventName module:engine/view/document~Document#blur
81
- * @param data Event data.
82
- */
83
- export type ViewDocumentBlurEvent = {
84
- name: 'blur';
85
- args: [data: DomEventData<FocusEvent>];
86
- };
@@ -1,90 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
8
- */
9
- /**
10
- * @module engine/view/observer/inputobserver
11
- */
12
- import DomEventObserver from './domeventobserver.js';
13
- import type DomEventData from './domeventdata.js';
14
- import type ViewRange from '../range.js';
15
- import DataTransfer from '../datatransfer.js';
16
- /**
17
- * Observer for events connected with data input.
18
- *
19
- * **Note**: This observer is attached by {@link module:engine/view/view~View} and available by default in all
20
- * editor instances.
21
- */
22
- export default class InputObserver extends DomEventObserver<'beforeinput'> {
23
- /**
24
- * @inheritDoc
25
- */
26
- readonly domEventType: "beforeinput";
27
- /**
28
- * @inheritDoc
29
- */
30
- onDomEvent(domEvent: InputEvent): void;
31
- }
32
- /**
33
- * Fired before the web browser inputs, deletes, or formats some data.
34
- *
35
- * This event is introduced by {@link module:engine/view/observer/inputobserver~InputObserver} and available
36
- * by default in all editor instances (attached by {@link module:engine/view/view~View}).
37
- *
38
- * @see module:engine/view/observer/inputobserver~InputObserver
39
- * @eventName module:engine/view/document~Document#beforeinput
40
- * @param data Event data containing detailed information about the event.
41
- */
42
- export type ViewDocumentInputEvent = {
43
- name: 'beforeinput';
44
- args: [data: InputEventData];
45
- };
46
- /**
47
- * The value of the {@link ~ViewDocumentInputEvent} event.
48
- */
49
- export interface InputEventData extends DomEventData<InputEvent> {
50
- /**
51
- * The type of the input event (e.g. "insertText" or "deleteWordBackward"). Corresponds to native `InputEvent#inputType`.
52
- */
53
- readonly inputType: string;
54
- /**
55
- * A unified text data passed along with the input event. Depending on:
56
- *
57
- * * the web browser and input events implementation (for instance [Level 1](https://www.w3.org/TR/input-events-1/) or
58
- * [Level 2](https://www.w3.org/TR/input-events-2/)),
59
- * * {@link module:engine/view/observer/inputobserver~InputEventData#inputType input type}
60
- *
61
- * text data is sometimes passed in the `data` and sometimes in the `dataTransfer` property.
62
- *
63
- * * If `InputEvent#data` was set, this property reflects its value.
64
- * * If `InputEvent#data` is unavailable, this property contains the `'text/plain'` data from
65
- * {@link module:engine/view/observer/inputobserver~InputEventData#dataTransfer}.
66
- * * If the event ({@link module:engine/view/observer/inputobserver~InputEventData#inputType input type})
67
- * provides no data whatsoever, this property is `null`.
68
- */
69
- readonly data: string | null;
70
- /**
71
- * The data transfer instance of the input event. Corresponds to native `InputEvent#dataTransfer`.
72
- *
73
- * The value is `null` when no `dataTransfer` was passed along with the input event.
74
- */
75
- readonly dataTransfer: DataTransfer;
76
- /**
77
- * A flag indicating that the `beforeinput` event was fired during composition.
78
- *
79
- * Corresponds to the
80
- * {@link module:engine/view/document~Document#event:compositionstart},
81
- * {@link module:engine/view/document~Document#event:compositionupdate},
82
- * and {@link module:engine/view/document~Document#event:compositionend } trio.
83
- */
84
- readonly isComposing: boolean;
85
- /**
86
- * Editing {@link module:engine/view/range~Range view ranges} corresponding to DOM ranges provided by the web browser
87
- * (as returned by `InputEvent#getTargetRanges()`).
88
- */
89
- readonly targetRanges: Array<ViewRange>;
90
- }
@@ -1,70 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
8
- */
9
- /**
10
- * @module engine/view/observer/keyobserver
11
- */
12
- import DomEventObserver from './domeventobserver.js';
13
- import type DomEventData from './domeventdata.js';
14
- import { type KeystrokeInfo } from '@ckeditor/ckeditor5-utils';
15
- /**
16
- * Observer for events connected with pressing keyboard keys.
17
- *
18
- * Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default.
19
- */
20
- export default class KeyObserver extends DomEventObserver<'keydown' | 'keyup', KeystrokeInfo & {
21
- keystroke: number;
22
- }> {
23
- /**
24
- * @inheritDoc
25
- */
26
- readonly domEventType: readonly ["keydown", "keyup"];
27
- /**
28
- * @inheritDoc
29
- */
30
- onDomEvent(domEvt: KeyboardEvent): void;
31
- }
32
- /**
33
- * Fired when a key has been pressed.
34
- *
35
- * Introduced by {@link module:engine/view/observer/keyobserver~KeyObserver}.
36
- *
37
- * Note that because {@link module:engine/view/observer/keyobserver~KeyObserver} is attached by the
38
- * {@link module:engine/view/view~View} this event is available by default.
39
- *
40
- * @see module:engine/view/observer/keyobserver~KeyObserver
41
- * @eventName module:engine/view/document~Document#keydown
42
- */
43
- export type ViewDocumentKeyDownEvent = {
44
- name: 'keydown';
45
- args: [data: KeyEventData];
46
- };
47
- /**
48
- * Fired when a key has been released.
49
- *
50
- * Introduced by {@link module:engine/view/observer/keyobserver~KeyObserver}.
51
- *
52
- * Note that because {@link module:engine/view/observer/keyobserver~KeyObserver} is attached by the
53
- * {@link module:engine/view/view~View} this event is available by default.
54
- *
55
- * @see module:engine/view/observer/keyobserver~KeyObserver
56
- * @eventName module:engine/view/document~Document#keyup
57
- */
58
- export type ViewDocumentKeyUpEvent = {
59
- name: 'keyup';
60
- args: [data: KeyEventData];
61
- };
62
- /**
63
- * The value of both events - {@link ~ViewDocumentKeyDownEvent} and {@link ~ViewDocumentKeyUpEvent}.
64
- */
65
- export interface KeyEventData extends DomEventData<KeyboardEvent>, KeystrokeInfo {
66
- /**
67
- * Code of the whole keystroke. See {@link module:utils/keyboard~getCode}.
68
- */
69
- keystroke: number;
70
- }
@@ -1,93 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
8
- */
9
- /**
10
- * @module engine/view/observer/mouseobserver
11
- */
12
- import DomEventObserver from './domeventobserver.js';
13
- import type DomEventData from './domeventdata.js';
14
- /**
15
- * Mouse events observer.
16
- *
17
- * Note that this observer is not available by default. To make it available it needs to be added to
18
- * {@link module:engine/view/view~View} by {@link module:engine/view/view~View#addObserver} method.
19
- */
20
- export default class MouseObserver extends DomEventObserver<'mousedown' | 'mouseup' | 'mouseover' | 'mouseout'> {
21
- /**
22
- * @inheritDoc
23
- */
24
- readonly domEventType: readonly ["mousedown", "mouseup", "mouseover", "mouseout"];
25
- /**
26
- * @inheritDoc
27
- */
28
- onDomEvent(domEvent: MouseEvent): void;
29
- }
30
- /**
31
- * Fired when the mouse button is pressed down on one of the editing roots of the editor.
32
- *
33
- * Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
34
- *
35
- * Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
36
- * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
37
- *
38
- * @see module:engine/view/observer/mouseobserver~MouseObserver
39
- * @eventName module:engine/view/document~Document#mousedown
40
- * @param data The event data.
41
- */
42
- export type ViewDocumentMouseDownEvent = {
43
- name: 'mousedown';
44
- args: [data: DomEventData<MouseEvent>];
45
- };
46
- /**
47
- * Fired when the mouse button is released over one of the editing roots of the editor.
48
- *
49
- * Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
50
- *
51
- * Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
52
- * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
53
- *
54
- * @see module:engine/view/observer/mouseobserver~MouseObserver
55
- * @eventName module:engine/view/document~Document#mouseup
56
- * @param data The event data.
57
- */
58
- export type ViewDocumentMouseUpEvent = {
59
- name: 'mouseup';
60
- args: [data: DomEventData<MouseEvent>];
61
- };
62
- /**
63
- * Fired when the mouse is over one of the editing roots of the editor.
64
- *
65
- * Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
66
- *
67
- * Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
68
- * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
69
- *
70
- * @see module:engine/view/observer/mouseobserver~MouseObserver
71
- * @eventName module:engine/view/document~Document#mouseover
72
- * @param data The event data.
73
- */
74
- export type ViewDocumentMouseOverEvent = {
75
- name: 'mouseover';
76
- args: [data: DomEventData<MouseEvent>];
77
- };
78
- /**
79
- * Fired when the mouse is moved out of the one of the editing roots of the editor.
80
- *
81
- * Introduced by {@link module:engine/view/observer/mouseobserver~MouseObserver}.
82
- *
83
- * Note that this event is not available by default. To make it available, {@link module:engine/view/observer/mouseobserver~MouseObserver}
84
- * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
85
- *
86
- * @see module:engine/view/observer/mouseobserver~MouseObserver
87
- * @eventName module:engine/view/document~Document#mouseout
88
- * @param data The event data.
89
- */
90
- export type ViewDocumentMouseOutEvent = {
91
- name: 'mouseout';
92
- args: [data: DomEventData<MouseEvent>];
93
- };
@@ -1,90 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
8
- */
9
- /**
10
- * @module engine/view/observer/mutationobserver
11
- */
12
- import Observer from './observer.js';
13
- import type DomConverter from '../domconverter.js';
14
- import type Renderer from '../renderer.js';
15
- import type View from '../view.js';
16
- /**
17
- * Mutation observer's role is to watch for any DOM changes inside the editor that weren't
18
- * done by the editor's {@link module:engine/view/renderer~Renderer} itself and reverting these changes.
19
- *
20
- * It does this by observing all mutations in the DOM, marking related view elements as changed and calling
21
- * {@link module:engine/view/renderer~Renderer#render}. Because all mutated nodes are marked as
22
- * "to be rendered" and the {@link module:engine/view/renderer~Renderer#render `render()`} method is called,
23
- * all changes are reverted in the DOM (the DOM is synced with the editor's view structure).
24
- *
25
- * Note that this observer is attached by the {@link module:engine/view/view~View} and is available by default.
26
- */
27
- export default class MutationObserver extends Observer {
28
- /**
29
- * Reference to the {@link module:engine/view/view~View#domConverter}.
30
- */
31
- readonly domConverter: DomConverter;
32
- /**
33
- * Reference to the {@link module:engine/view/view~View#_renderer}.
34
- */
35
- readonly renderer: Renderer;
36
- /**
37
- * Native mutation observer config.
38
- */
39
- private readonly _config;
40
- /**
41
- * Observed DOM elements.
42
- */
43
- private readonly _domElements;
44
- /**
45
- * Native mutation observer.
46
- */
47
- private _mutationObserver;
48
- /**
49
- * @inheritDoc
50
- */
51
- constructor(view: View);
52
- /**
53
- * Synchronously handles mutations and empties the queue.
54
- */
55
- flush(): void;
56
- /**
57
- * @inheritDoc
58
- */
59
- observe(domElement: HTMLElement): void;
60
- /**
61
- * @inheritDoc
62
- */
63
- stopObserving(domElement: HTMLElement): void;
64
- /**
65
- * @inheritDoc
66
- */
67
- enable(): void;
68
- /**
69
- * @inheritDoc
70
- */
71
- disable(): void;
72
- /**
73
- * @inheritDoc
74
- */
75
- destroy(): void;
76
- /**
77
- * Handles mutations. Mark view elements to sync and call render.
78
- *
79
- * @param domMutations Array of native mutations.
80
- */
81
- private _onMutations;
82
- /**
83
- * Checks if mutation was generated by the browser inserting bogus br on the end of the block element.
84
- * Such mutations are generated while pressing space or performing native spellchecker correction
85
- * on the end of the block element in Firefox browser.
86
- *
87
- * @param mutation Native mutation object.
88
- */
89
- private _isBogusBrMutation;
90
- }
@@ -1,93 +0,0 @@
1
- /**
2
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
8
- */
9
- import type Document from '../document.js';
10
- import type View from '../view.js';
11
- declare const Observer_base: {
12
- new (): import("@ckeditor/ckeditor5-utils").DomEmitter;
13
- prototype: import("@ckeditor/ckeditor5-utils").DomEmitter;
14
- };
15
- /**
16
- * Abstract base observer class. Observers are classes which listen to DOM events, do the preliminary
17
- * processing and fire events on the {@link module:engine/view/document~Document} objects.
18
- * Observers can also add features to the view, for instance by updating its status or marking elements
19
- * which need a refresh on DOM events.
20
- */
21
- export default abstract class Observer extends Observer_base {
22
- /**
23
- * An instance of the view controller.
24
- */
25
- readonly view: View;
26
- /**
27
- * A reference to the {@link module:engine/view/document~Document} object.
28
- */
29
- readonly document: Document;
30
- /**
31
- * The state of the observer. If it is disabled, no events will be fired.
32
- */
33
- private _isEnabled;
34
- /**
35
- * Creates an instance of the observer.
36
- */
37
- constructor(view: View);
38
- /**
39
- * The state of the observer. If it is disabled, no events will be fired.
40
- */
41
- get isEnabled(): boolean;
42
- /**
43
- * Enables the observer. This method is called when the observer is registered to the
44
- * {@link module:engine/view/view~View} and after {@link module:engine/view/view~View#forceRender rendering}
45
- * (all observers are {@link #disable disabled} before rendering).
46
- *
47
- * A typical use case for disabling observers is that mutation observers need to be disabled for the rendering.
48
- * However, a child class may not need to be disabled, so it can implement an empty method.
49
- *
50
- * @see module:engine/view/observer/observer~Observer#disable
51
- */
52
- enable(): void;
53
- /**
54
- * Disables the observer. This method is called before
55
- * {@link module:engine/view/view~View#forceRender rendering} to prevent firing events during rendering.
56
- *
57
- * @see module:engine/view/observer/observer~Observer#enable
58
- */
59
- disable(): void;
60
- /**
61
- * Disables and destroys the observer, among others removes event listeners created by the observer.
62
- */
63
- destroy(): void;
64
- /**
65
- * Checks whether a given DOM event should be ignored (should not be turned into a synthetic view document event).
66
- *
67
- * Currently, an event will be ignored only if its target or any of its ancestors has the `data-cke-ignore-events` attribute.
68
- * This attribute can be used inside the structures generated by
69
- * {@link module:engine/view/downcastwriter~DowncastWriter#createUIElement `DowncastWriter#createUIElement()`} to ignore events
70
- * fired within a UI that should be excluded from CKEditor 5's realms.
71
- *
72
- * @param domTarget The DOM event target to check (usually an element, sometimes a text node and
73
- * potentially sometimes a document, too).
74
- * @returns Whether this event should be ignored by the observer.
75
- */
76
- checkShouldIgnoreEventFromTarget(domTarget: Node | null): boolean;
77
- /**
78
- * Starts observing given DOM element.
79
- *
80
- * @param domElement DOM element to observe.
81
- * @param name The name of the related root element.
82
- */
83
- abstract observe(domElement: HTMLElement, name: string): void;
84
- /**
85
- * Stops observing given DOM element.
86
- */
87
- abstract stopObserving(domElement: HTMLElement): void;
88
- }
89
- /**
90
- * The constructor of {@link ~Observer} subclass.
91
- */
92
- export type ObserverConstructor = new (view: View) => Observer;
93
- export {};