@ckeditor/ckeditor5-widget 41.3.1 → 41.4.0-alpha.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (125) hide show
  1. package/dist/index-content.css +4 -0
  2. package/dist/index-editor.css +144 -0
  3. package/dist/index.css +257 -0
  4. package/dist/index.css.map +1 -0
  5. package/dist/index.js +2877 -0
  6. package/dist/index.js.map +1 -0
  7. package/dist/translations/ar.d.ts +8 -0
  8. package/dist/translations/ar.js +5 -0
  9. package/dist/translations/az.d.ts +8 -0
  10. package/dist/translations/az.js +5 -0
  11. package/dist/translations/bg.d.ts +8 -0
  12. package/dist/translations/bg.js +5 -0
  13. package/dist/translations/bn.d.ts +8 -0
  14. package/dist/translations/bn.js +5 -0
  15. package/dist/translations/ca.d.ts +8 -0
  16. package/dist/translations/ca.js +5 -0
  17. package/dist/translations/cs.d.ts +8 -0
  18. package/dist/translations/cs.js +5 -0
  19. package/dist/translations/da.d.ts +8 -0
  20. package/dist/translations/da.js +5 -0
  21. package/dist/translations/de-ch.d.ts +8 -0
  22. package/dist/translations/de-ch.js +5 -0
  23. package/dist/translations/de.d.ts +8 -0
  24. package/dist/translations/de.js +5 -0
  25. package/dist/translations/el.d.ts +8 -0
  26. package/dist/translations/el.js +5 -0
  27. package/dist/translations/en-au.d.ts +8 -0
  28. package/dist/translations/en-au.js +5 -0
  29. package/dist/translations/en.d.ts +8 -0
  30. package/dist/translations/en.js +5 -0
  31. package/dist/translations/es.d.ts +8 -0
  32. package/dist/translations/es.js +5 -0
  33. package/dist/translations/et.d.ts +8 -0
  34. package/dist/translations/et.js +5 -0
  35. package/dist/translations/fa.d.ts +8 -0
  36. package/dist/translations/fa.js +5 -0
  37. package/dist/translations/fi.d.ts +8 -0
  38. package/dist/translations/fi.js +5 -0
  39. package/dist/translations/fr.d.ts +8 -0
  40. package/dist/translations/fr.js +5 -0
  41. package/dist/translations/gl.d.ts +8 -0
  42. package/dist/translations/gl.js +5 -0
  43. package/dist/translations/he.d.ts +8 -0
  44. package/dist/translations/he.js +5 -0
  45. package/dist/translations/hi.d.ts +8 -0
  46. package/dist/translations/hi.js +5 -0
  47. package/dist/translations/hr.d.ts +8 -0
  48. package/dist/translations/hr.js +5 -0
  49. package/dist/translations/hu.d.ts +8 -0
  50. package/dist/translations/hu.js +5 -0
  51. package/dist/translations/id.d.ts +8 -0
  52. package/dist/translations/id.js +5 -0
  53. package/dist/translations/it.d.ts +8 -0
  54. package/dist/translations/it.js +5 -0
  55. package/dist/translations/ja.d.ts +8 -0
  56. package/dist/translations/ja.js +5 -0
  57. package/dist/translations/ko.d.ts +8 -0
  58. package/dist/translations/ko.js +5 -0
  59. package/dist/translations/ku.d.ts +8 -0
  60. package/dist/translations/ku.js +5 -0
  61. package/dist/translations/lt.d.ts +8 -0
  62. package/dist/translations/lt.js +5 -0
  63. package/dist/translations/lv.d.ts +8 -0
  64. package/dist/translations/lv.js +5 -0
  65. package/dist/translations/ms.d.ts +8 -0
  66. package/dist/translations/ms.js +5 -0
  67. package/dist/translations/nl.d.ts +8 -0
  68. package/dist/translations/nl.js +5 -0
  69. package/dist/translations/no.d.ts +8 -0
  70. package/dist/translations/no.js +5 -0
  71. package/dist/translations/pl.d.ts +8 -0
  72. package/dist/translations/pl.js +5 -0
  73. package/dist/translations/pt-br.d.ts +8 -0
  74. package/dist/translations/pt-br.js +5 -0
  75. package/dist/translations/pt.d.ts +8 -0
  76. package/dist/translations/pt.js +5 -0
  77. package/dist/translations/ro.d.ts +8 -0
  78. package/dist/translations/ro.js +5 -0
  79. package/dist/translations/ru.d.ts +8 -0
  80. package/dist/translations/ru.js +5 -0
  81. package/dist/translations/sk.d.ts +8 -0
  82. package/dist/translations/sk.js +5 -0
  83. package/dist/translations/sq.d.ts +8 -0
  84. package/dist/translations/sq.js +5 -0
  85. package/dist/translations/sr-latn.d.ts +8 -0
  86. package/dist/translations/sr-latn.js +5 -0
  87. package/dist/translations/sr.d.ts +8 -0
  88. package/dist/translations/sr.js +5 -0
  89. package/dist/translations/sv.d.ts +8 -0
  90. package/dist/translations/sv.js +5 -0
  91. package/dist/translations/th.d.ts +8 -0
  92. package/dist/translations/th.js +5 -0
  93. package/dist/translations/tk.d.ts +8 -0
  94. package/dist/translations/tk.js +5 -0
  95. package/dist/translations/tr.d.ts +8 -0
  96. package/dist/translations/tr.js +5 -0
  97. package/dist/translations/uk.d.ts +8 -0
  98. package/dist/translations/uk.js +5 -0
  99. package/dist/translations/ur.d.ts +8 -0
  100. package/dist/translations/ur.js +5 -0
  101. package/dist/translations/uz.d.ts +8 -0
  102. package/dist/translations/uz.js +5 -0
  103. package/dist/translations/vi.d.ts +8 -0
  104. package/dist/translations/vi.js +5 -0
  105. package/dist/translations/zh-cn.d.ts +8 -0
  106. package/dist/translations/zh-cn.js +5 -0
  107. package/dist/translations/zh.d.ts +8 -0
  108. package/dist/translations/zh.js +5 -0
  109. package/dist/types/augmentation.d.ts +17 -0
  110. package/dist/types/highlightstack.d.ts +78 -0
  111. package/dist/types/index.d.ts +17 -0
  112. package/dist/types/utils.d.ts +219 -0
  113. package/dist/types/verticalnavigation.d.ts +19 -0
  114. package/dist/types/widget.d.ts +107 -0
  115. package/dist/types/widgetresize/resizer.d.ts +181 -0
  116. package/dist/types/widgetresize/resizerstate.d.ts +129 -0
  117. package/dist/types/widgetresize/sizeview.d.ts +59 -0
  118. package/dist/types/widgetresize.d.ts +129 -0
  119. package/dist/types/widgettoolbarrepository.d.ts +98 -0
  120. package/dist/types/widgettypearound/utils.d.ts +42 -0
  121. package/dist/types/widgettypearound/widgettypearound.d.ts +233 -0
  122. package/package.json +8 -7
  123. package/src/utils.d.ts +18 -1
  124. package/src/utils.js +45 -1
  125. package/src/widgetresize/resizerstate.js +2 -23
@@ -0,0 +1,59 @@
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 widget/widgetresize/sizeview
11
+ */
12
+ import { View } from '@ckeditor/ckeditor5-ui';
13
+ import type { ResizerOptions } from '../widgetresize.js';
14
+ import type ResizeState from './resizerstate.js';
15
+ /**
16
+ * A view displaying the proposed new element size during the resizing.
17
+ */
18
+ export default class SizeView extends View {
19
+ /**
20
+ * The visibility of the view defined based on the existence of the host proposed dimensions.
21
+ *
22
+ * @internal
23
+ * @observable
24
+ * @readonly
25
+ */
26
+ _isVisible: boolean;
27
+ /**
28
+ * The text that will be displayed in the `SizeView` child.
29
+ * It can be formatted as the pixel values (e.g. 10x20) or the percentage value (e.g. 10%).
30
+ *
31
+ * @internal
32
+ * @observable
33
+ * @readonly
34
+ */
35
+ _label: string;
36
+ /**
37
+ * The position of the view defined based on the host size and active handle position.
38
+ *
39
+ * @internal
40
+ * @observable
41
+ * @readonly
42
+ */
43
+ _viewPosition: string;
44
+ constructor();
45
+ /**
46
+ * A method used for binding the `SizeView` instance properties to the `ResizeState` instance observable properties.
47
+ *
48
+ * @internal
49
+ * @param options An object defining the resizer options, used for setting the proper size label.
50
+ * @param resizeState The `ResizeState` class instance, used for keeping the `SizeView` state up to date.
51
+ */
52
+ _bindToState(options: ResizerOptions, resizeState: ResizeState): void;
53
+ /**
54
+ * A method used for cleaning up. It removes the bindings and hides the view.
55
+ *
56
+ * @internal
57
+ */
58
+ _dismiss(): void;
59
+ }
@@ -0,0 +1,129 @@
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 widget/widgetresize
11
+ */
12
+ import Resizer from './widgetresize/resizer.js';
13
+ import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
14
+ import { type Element, type ViewContainerElement } from '@ckeditor/ckeditor5-engine';
15
+ import '../theme/widgetresize.css';
16
+ /**
17
+ * The widget resize feature plugin.
18
+ *
19
+ * Use the {@link module:widget/widgetresize~WidgetResize#attachTo} method to create a resizer for the specified widget.
20
+ */
21
+ export default class WidgetResize extends Plugin {
22
+ /**
23
+ * The currently selected resizer.
24
+ *
25
+ * @observable
26
+ */
27
+ selectedResizer: Resizer | null;
28
+ /**
29
+ * References an active resizer.
30
+ *
31
+ * Active resizer means a resizer which handle is actively used by the end user.
32
+ *
33
+ * @internal
34
+ * @observable
35
+ */
36
+ _activeResizer: Resizer | null;
37
+ /**
38
+ * A map of resizers created using this plugin instance.
39
+ */
40
+ private _resizers;
41
+ private _observer;
42
+ private _redrawSelectedResizerThrottled;
43
+ /**
44
+ * @inheritDoc
45
+ */
46
+ static get pluginName(): "WidgetResize";
47
+ /**
48
+ * @inheritDoc
49
+ */
50
+ init(): void;
51
+ /**
52
+ * Redraws the selected resizer if there is any selected resizer and if it is visible.
53
+ */
54
+ redrawSelectedResizer(): void;
55
+ /**
56
+ * @inheritDoc
57
+ */
58
+ destroy(): void;
59
+ /**
60
+ * Marks resizer as selected.
61
+ */
62
+ select(resizer: Resizer): void;
63
+ /**
64
+ * Deselects currently set resizer.
65
+ */
66
+ deselect(): void;
67
+ /**
68
+ * @param options Resizer options.
69
+ */
70
+ attachTo(options: ResizerOptions): Resizer;
71
+ /**
72
+ * Returns a resizer created for a given view element (widget element).
73
+ *
74
+ * @param viewElement View element associated with the resizer.
75
+ */
76
+ getResizerByViewElement(viewElement: ViewContainerElement): Resizer | undefined;
77
+ /**
78
+ * Returns a resizer that contains a given resize handle.
79
+ */
80
+ private _getResizerByHandle;
81
+ /**
82
+ * @param domEventData Native DOM event.
83
+ */
84
+ private _mouseDownListener;
85
+ /**
86
+ * @param domEventData Native DOM event.
87
+ */
88
+ private _mouseMoveListener;
89
+ private _mouseUpListener;
90
+ }
91
+ /**
92
+ * Interface describing a resizer. It allows to specify the resizing host, custom logic for calculating aspect ratio, etc.
93
+ */
94
+ export interface ResizerOptions {
95
+ /**
96
+ * Editor instance associated with the resizer.
97
+ */
98
+ editor: Editor;
99
+ modelElement: Element;
100
+ /**
101
+ * A view of an element to be resized. Typically it's the main widget's view instance.
102
+ */
103
+ viewElement: ViewContainerElement;
104
+ unit?: 'px' | '%';
105
+ /**
106
+ * A callback to be executed once the resizing process is done.
107
+ *
108
+ * It receives a `Number` (`newValue`) as a parameter.
109
+ *
110
+ * For example, {@link module:image/imageresize~ImageResize} uses it to execute the resize image command
111
+ * which puts the new value into the model.
112
+ *
113
+ * ```ts
114
+ * {
115
+ * editor,
116
+ * modelElement: data.item,
117
+ * viewElement: widget,
118
+ *
119
+ * onCommit( newValue ) {
120
+ * editor.execute( 'resizeImage', { width: newValue } );
121
+ * }
122
+ * };
123
+ * ```
124
+ */
125
+ onCommit: (newValue: string) => void;
126
+ getResizeHost: (widgetWrapper: HTMLElement) => HTMLElement;
127
+ getHandleHost: (widgetWrapper: HTMLElement) => HTMLElement;
128
+ isCentered?: (resizer: Resizer) => boolean;
129
+ }
@@ -0,0 +1,98 @@
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 widget/widgettoolbarrepository
11
+ */
12
+ import { Plugin, type ToolbarConfigItem } from '@ckeditor/ckeditor5-core';
13
+ import type { ViewDocumentSelection, ViewElement } from '@ckeditor/ckeditor5-engine';
14
+ import { ContextualBalloon } from '@ckeditor/ckeditor5-ui';
15
+ /**
16
+ * Widget toolbar repository plugin. A central point for registering widget toolbars. This plugin handles the whole
17
+ * toolbar rendering process and exposes a concise API.
18
+ *
19
+ * To add a toolbar for your widget use the {@link ~WidgetToolbarRepository#register `WidgetToolbarRepository#register()`} method.
20
+ *
21
+ * The following example comes from the {@link module:image/imagetoolbar~ImageToolbar} plugin:
22
+ *
23
+ * ```ts
24
+ * class ImageToolbar extends Plugin {
25
+ * static get requires() {
26
+ * return [ WidgetToolbarRepository ];
27
+ * }
28
+ *
29
+ * afterInit() {
30
+ * const editor = this.editor;
31
+ * const widgetToolbarRepository = editor.plugins.get( WidgetToolbarRepository );
32
+ *
33
+ * widgetToolbarRepository.register( 'image', {
34
+ * items: editor.config.get( 'image.toolbar' ),
35
+ * getRelatedElement: getClosestSelectedImageWidget
36
+ * } );
37
+ * }
38
+ * }
39
+ * ```
40
+ */
41
+ export default class WidgetToolbarRepository extends Plugin {
42
+ /**
43
+ * A map of toolbar definitions.
44
+ */
45
+ private _toolbarDefinitions;
46
+ private _balloon;
47
+ /**
48
+ * @inheritDoc
49
+ */
50
+ static get requires(): readonly [typeof ContextualBalloon];
51
+ /**
52
+ * @inheritDoc
53
+ */
54
+ static get pluginName(): "WidgetToolbarRepository";
55
+ /**
56
+ * @inheritDoc
57
+ */
58
+ init(): void;
59
+ destroy(): void;
60
+ /**
61
+ * Registers toolbar in the WidgetToolbarRepository. It renders it in the `ContextualBalloon` based on the value of the invoked
62
+ * `getRelatedElement` function. Toolbar items are gathered from `items` array.
63
+ * The balloon's CSS class is by default `ck-toolbar-container` and may be override with the `balloonClassName` option.
64
+ *
65
+ * Note: This method should be called in the {@link module:core/plugin~PluginInterface#afterInit `Plugin#afterInit()`}
66
+ * callback (or later) to make sure that the given toolbar items were already registered by other plugins.
67
+ *
68
+ * @param toolbarId An id for the toolbar. Used to
69
+ * @param options.ariaLabel Label used by assistive technologies to describe this toolbar element.
70
+ * @param options.items Array of toolbar items.
71
+ * @param options.getRelatedElement Callback which returns an element the toolbar should be attached to.
72
+ * @param options.balloonClassName CSS class for the widget balloon.
73
+ */
74
+ register(toolbarId: string, { ariaLabel, items, getRelatedElement, balloonClassName }: {
75
+ ariaLabel?: string;
76
+ items: Array<ToolbarConfigItem>;
77
+ getRelatedElement: (selection: ViewDocumentSelection) => (ViewElement | null);
78
+ balloonClassName?: string;
79
+ }): void;
80
+ /**
81
+ * Iterates over stored toolbars and makes them visible or hidden.
82
+ */
83
+ private _updateToolbarsVisibility;
84
+ /**
85
+ * Hides the given toolbar.
86
+ */
87
+ private _hideToolbar;
88
+ /**
89
+ * Shows up the toolbar if the toolbar is not visible.
90
+ * Otherwise, repositions the toolbar's balloon when toolbar's view is the most top view in balloon stack.
91
+ *
92
+ * It might happen here that the toolbar's view is under another view. Then do nothing as the other toolbar view
93
+ * should be still visible after the {@link module:ui/editorui/editorui~EditorUI#event:update}.
94
+ */
95
+ private _showToolbar;
96
+ private _isToolbarVisible;
97
+ private _isToolbarInBalloon;
98
+ }
@@ -0,0 +1,42 @@
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 { DocumentSelection, DomConverter, Element, Schema, Selection, ViewElement } from '@ckeditor/ckeditor5-engine';
10
+ /**
11
+ * The name of the type around model selection attribute responsible for
12
+ * displaying a fake caret next to a selected widget.
13
+ */
14
+ export declare const TYPE_AROUND_SELECTION_ATTRIBUTE = "widget-type-around";
15
+ /**
16
+ * Checks if an element is a widget that qualifies to get the widget type around UI.
17
+ */
18
+ export declare function isTypeAroundWidget(viewElement: ViewElement | undefined, modelElement: Element, schema: Schema): boolean;
19
+ /**
20
+ * For the passed HTML element, this helper finds the closest widget type around button ancestor.
21
+ */
22
+ export declare function getClosestTypeAroundDomButton(domElement: HTMLElement): HTMLElement | null;
23
+ /**
24
+ * For the passed widget type around button element, this helper determines at which position
25
+ * the paragraph would be inserted into the content if, for instance, the button was
26
+ * clicked by the user.
27
+ *
28
+ * @returns The position of the button.
29
+ */
30
+ export declare function getTypeAroundButtonPosition(domElement: HTMLElement): 'before' | 'after';
31
+ /**
32
+ * For the passed HTML element, this helper returns the closest view widget ancestor.
33
+ */
34
+ export declare function getClosestWidgetViewElement(domElement: HTMLElement, domConverter: DomConverter): ViewElement;
35
+ /**
36
+ * For the passed selection instance, it returns the position of the fake caret displayed next to a widget.
37
+ *
38
+ * **Note**: If the fake caret is not currently displayed, `null` is returned.
39
+ *
40
+ * @returns The position of the fake caret or `null` when none is present.
41
+ */
42
+ export declare function getTypeAroundFakeCaretPosition(selection: Selection | DocumentSelection): 'before' | 'after' | null;
@@ -0,0 +1,233 @@
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 widget/widgettypearound/widgettypearound
11
+ */
12
+ import { Plugin } from '@ckeditor/ckeditor5-core';
13
+ import { Enter } from '@ckeditor/ckeditor5-enter';
14
+ import { Delete } from '@ckeditor/ckeditor5-typing';
15
+ import '../../theme/widgettypearound.css';
16
+ /**
17
+ * A plugin that allows users to type around widgets where normally it is impossible to place the caret due
18
+ * to limitations of web browsers. These "tight spots" occur, for instance, before (or after) a widget being
19
+ * the first (or last) child of its parent or between two block widgets.
20
+ *
21
+ * This plugin extends the {@link module:widget/widget~Widget `Widget`} plugin and injects the user interface
22
+ * with two buttons into each widget instance in the editor. Each of the buttons can be clicked by the
23
+ * user if the widget is next to the "tight spot". Once clicked, a paragraph is created with the selection anchored
24
+ * in it so that users can type (or insert content, paste, etc.) straight away.
25
+ */
26
+ export default class WidgetTypeAround extends Plugin {
27
+ /**
28
+ * A reference to the model widget element that has the fake caret active
29
+ * on either side of it. It is later used to remove CSS classes associated with the fake caret
30
+ * when the widget no longer needs it.
31
+ */
32
+ private _currentFakeCaretModelElement;
33
+ /**
34
+ * @inheritDoc
35
+ */
36
+ static get pluginName(): "WidgetTypeAround";
37
+ /**
38
+ * @inheritDoc
39
+ */
40
+ static get requires(): readonly [typeof Enter, typeof Delete];
41
+ /**
42
+ * @inheritDoc
43
+ */
44
+ init(): void;
45
+ /**
46
+ * @inheritDoc
47
+ */
48
+ destroy(): void;
49
+ /**
50
+ * Inserts a new paragraph next to a widget element with the selection anchored in it.
51
+ *
52
+ * **Note**: This method is heavily user-oriented and will both focus the editing view and scroll
53
+ * the viewport to the selection in the inserted paragraph.
54
+ *
55
+ * @param widgetModelElement The model widget element next to which a paragraph is inserted.
56
+ * @param position The position where the paragraph is inserted. Either `'before'` or `'after'` the widget.
57
+ */
58
+ private _insertParagraph;
59
+ /**
60
+ * A wrapper for the {@link module:utils/emittermixin~Emitter#listenTo} method that executes the callbacks only
61
+ * when the plugin {@link #isEnabled is enabled}.
62
+ *
63
+ * @param emitter The object that fires the event.
64
+ * @param event The name of the event.
65
+ * @param callback The function to be called on event.
66
+ * @param options Additional options.
67
+ * @param options.priority The priority of this event callback. The higher the priority value the sooner
68
+ * the callback will be fired. Events having the same priority are called in the order they were added.
69
+ */
70
+ private _listenToIfEnabled;
71
+ /**
72
+ * Similar to {@link #_insertParagraph}, this method inserts a paragraph except that it
73
+ * does not expect a position. Instead, it performs the insertion next to a selected widget
74
+ * according to the `widget-type-around` model selection attribute value (fake caret position).
75
+ *
76
+ * Because this method requires the `widget-type-around` attribute to be set,
77
+ * the insertion can only happen when the widget's fake caret is active (e.g. activated
78
+ * using the keyboard).
79
+ *
80
+ * @returns Returns `true` when the paragraph was inserted (the attribute was present) and `false` otherwise.
81
+ */
82
+ private _insertParagraphAccordingToFakeCaretPosition;
83
+ /**
84
+ * Creates a listener in the editing conversion pipeline that injects the widget type around
85
+ * UI into every single widget instance created in the editor.
86
+ *
87
+ * The UI is delivered as a {@link module:engine/view/uielement~UIElement}
88
+ * wrapper which renders DOM buttons that users can use to insert paragraphs.
89
+ */
90
+ private _enableTypeAroundUIInjection;
91
+ /**
92
+ * Brings support for the fake caret that appears when either:
93
+ *
94
+ * * the selection moves to a widget from a position next to it using arrow keys,
95
+ * * the arrow key is pressed when the widget is already selected.
96
+ *
97
+ * The fake caret lets the user know that they can start typing or just press
98
+ * <kbd>Enter</kbd> to insert a paragraph at the position next to a widget as suggested by the fake caret.
99
+ *
100
+ * The fake caret disappears when the user changes the selection or the editor
101
+ * gets blurred.
102
+ *
103
+ * The whole idea is as follows:
104
+ *
105
+ * 1. A user does one of the 2 scenarios described at the beginning.
106
+ * 2. The "keydown" listener is executed and the decision is made whether to show or hide the fake caret.
107
+ * 3. If it should show up, the `widget-type-around` model selection attribute is set indicating
108
+ * on which side of the widget it should appear.
109
+ * 4. The selection dispatcher reacts to the selection attribute and sets CSS classes responsible for the
110
+ * fake caret on the view widget.
111
+ * 5. If the fake caret should disappear, the selection attribute is removed and the dispatcher
112
+ * does the CSS class clean-up in the view.
113
+ * 6. Additionally, `change:range` and `FocusTracker#isFocused` listeners also remove the selection
114
+ * attribute (the former also removes widget CSS classes).
115
+ */
116
+ private _enableTypeAroundFakeCaretActivationUsingKeyboardArrows;
117
+ /**
118
+ * A listener executed on each "keydown" in the view document, a part of
119
+ * {@link #_enableTypeAroundFakeCaretActivationUsingKeyboardArrows}.
120
+ *
121
+ * It decides whether the arrow keypress should activate the fake caret or not (also whether it should
122
+ * be deactivated).
123
+ *
124
+ * The fake caret activation is done by setting the `widget-type-around` model selection attribute
125
+ * in this listener, and stopping and preventing the event that would normally be handled by the widget
126
+ * plugin that is responsible for the regular keyboard navigation near/across all widgets (that
127
+ * includes inline widgets, which are ignored by the widget type around plugin).
128
+ */
129
+ private _handleArrowKeyPress;
130
+ /**
131
+ * Handles the keyboard navigation on "keydown" when a widget is currently selected and activates or deactivates
132
+ * the fake caret for that widget, depending on the current value of the `widget-type-around` model
133
+ * selection attribute and the direction of the pressed arrow key.
134
+ *
135
+ * @param isForward `true` when the pressed arrow key was responsible for the forward model selection movement
136
+ * as in {@link module:utils/keyboard~isForwardArrowKeyCode}.
137
+ * @returns Returns `true` when the keypress was handled and no other keydown listener of the editor should
138
+ * process the event any further. Returns `false` otherwise.
139
+ */
140
+ private _handleArrowKeyPressOnSelectedWidget;
141
+ /**
142
+ * Handles the keyboard navigation on "keydown" when **no** widget is selected but the selection is **directly** next
143
+ * to one and upon the fake caret should become active for this widget upon arrow keypress
144
+ * (AKA entering/selecting the widget).
145
+ *
146
+ * **Note**: This code mirrors the implementation from the widget plugin but also adds the selection attribute.
147
+ * Unfortunately, there is no safe way to let the widget plugin do the selection part first and then just set the
148
+ * selection attribute here in the widget type around plugin. This is why this code must duplicate some from the widget plugin.
149
+ *
150
+ * @param isForward `true` when the pressed arrow key was responsible for the forward model selection movement
151
+ * as in {@link module:utils/keyboard~isForwardArrowKeyCode}.
152
+ * @returns Returns `true` when the keypress was handled and no other keydown listener of the editor should
153
+ * process the event any further. Returns `false` otherwise.
154
+ */
155
+ private _handleArrowKeyPressWhenSelectionNextToAWidget;
156
+ /**
157
+ * Handles the keyboard navigation on "keydown" when a widget is currently selected (together with some other content)
158
+ * and the widget is the first or last element in the selection. It activates or deactivates the fake caret for that widget.
159
+ *
160
+ * @param isForward `true` when the pressed arrow key was responsible for the forward model selection movement
161
+ * as in {@link module:utils/keyboard~isForwardArrowKeyCode}.
162
+ * @returns Returns `true` when the keypress was handled and no other keydown listener of the editor should
163
+ * process the event any further. Returns `false` otherwise.
164
+ */
165
+ private _handleArrowKeyPressWhenNonCollapsedSelection;
166
+ /**
167
+ * Registers a `mousedown` listener for the view document which intercepts events
168
+ * coming from the widget type around UI, which happens when a user clicks one of the buttons
169
+ * that insert a paragraph next to a widget.
170
+ */
171
+ private _enableInsertingParagraphsOnButtonClick;
172
+ /**
173
+ * Creates the <kbd>Enter</kbd> key listener on the view document that allows the user to insert a paragraph
174
+ * near the widget when either:
175
+ *
176
+ * * The fake caret was first activated using the arrow keys,
177
+ * * The entire widget is selected in the model.
178
+ *
179
+ * In the first case, the new paragraph is inserted according to the `widget-type-around` selection
180
+ * attribute (see {@link #_handleArrowKeyPress}).
181
+ *
182
+ * In the second case, the new paragraph is inserted based on whether a soft (<kbd>Shift</kbd>+<kbd>Enter</kbd>) keystroke
183
+ * was pressed or not.
184
+ */
185
+ private _enableInsertingParagraphsOnEnterKeypress;
186
+ /**
187
+ * Similar to the {@link #_enableInsertingParagraphsOnEnterKeypress}, it allows the user
188
+ * to insert a paragraph next to a widget when the fake caret was activated using arrow
189
+ * keys but it responds to typing instead of <kbd>Enter</kbd>.
190
+ *
191
+ * Listener enabled by this method will insert a new paragraph according to the `widget-type-around`
192
+ * model selection attribute as the user simply starts typing, which creates the impression that the fake caret
193
+ * behaves like a real one rendered by the browser (AKA your text appears where the caret was).
194
+ *
195
+ * **Note**: At the moment this listener creates 2 undo steps: one for the `insertParagraph` command
196
+ * and another one for actual typing. It is not a disaster but this may need to be fixed
197
+ * sooner or later.
198
+ */
199
+ private _enableInsertingParagraphsOnTypingKeystroke;
200
+ /**
201
+ * It creates a "delete" event listener on the view document to handle cases when the <kbd>Delete</kbd> or <kbd>Backspace</kbd>
202
+ * is pressed and the fake caret is currently active.
203
+ *
204
+ * The fake caret should create an illusion of a real browser caret so that when it appears before or after
205
+ * a widget, pressing <kbd>Delete</kbd> or <kbd>Backspace</kbd> should remove a widget or delete the content
206
+ * before or after a widget (depending on the content surrounding the widget).
207
+ */
208
+ private _enableDeleteIntegration;
209
+ /**
210
+ * Attaches the {@link module:engine/model/model~Model#event:insertContent} event listener that, for instance, allows the user to paste
211
+ * content near a widget when the fake caret is first activated using the arrow keys.
212
+ *
213
+ * The content is inserted according to the `widget-type-around` selection attribute (see {@link #_handleArrowKeyPress}).
214
+ */
215
+ private _enableInsertContentIntegration;
216
+ /**
217
+ * Attaches the {@link module:engine/model/model~Model#event:insertObject} event listener that modifies the
218
+ * `options.findOptimalPosition`parameter to position of fake caret in relation to selected element
219
+ * to reflect user's intent of desired insertion position.
220
+ *
221
+ * The object is inserted according to the `widget-type-around` selection attribute (see {@link #_handleArrowKeyPress}).
222
+ */
223
+ private _enableInsertObjectIntegration;
224
+ /**
225
+ * Attaches the {@link module:engine/model/model~Model#event:deleteContent} event listener to block the event when the fake
226
+ * caret is active.
227
+ *
228
+ * This is required for cases that trigger {@link module:engine/model/model~Model#deleteContent `model.deleteContent()`}
229
+ * before calling {@link module:engine/model/model~Model#insertContent `model.insertContent()`} like, for instance,
230
+ * plain text pasting.
231
+ */
232
+ private _enableDeleteContentIntegration;
233
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ckeditor/ckeditor5-widget",
3
- "version": "41.3.1",
3
+ "version": "41.4.0-alpha.0",
4
4
  "description": "Widget API for CKEditor 5.",
5
5
  "keywords": [
6
6
  "ckeditor",
@@ -12,12 +12,12 @@
12
12
  "type": "module",
13
13
  "main": "src/index.js",
14
14
  "dependencies": {
15
- "@ckeditor/ckeditor5-core": "41.3.1",
16
- "@ckeditor/ckeditor5-engine": "41.3.1",
17
- "@ckeditor/ckeditor5-enter": "41.3.1",
18
- "@ckeditor/ckeditor5-ui": "41.3.1",
19
- "@ckeditor/ckeditor5-utils": "41.3.1",
20
- "@ckeditor/ckeditor5-typing": "41.3.1",
15
+ "@ckeditor/ckeditor5-core": "41.4.0-alpha.0",
16
+ "@ckeditor/ckeditor5-engine": "41.4.0-alpha.0",
17
+ "@ckeditor/ckeditor5-enter": "41.4.0-alpha.0",
18
+ "@ckeditor/ckeditor5-ui": "41.4.0-alpha.0",
19
+ "@ckeditor/ckeditor5-utils": "41.4.0-alpha.0",
20
+ "@ckeditor/ckeditor5-typing": "41.4.0-alpha.0",
21
21
  "lodash-es": "4.17.21"
22
22
  },
23
23
  "author": "CKSource (http://cksource.com/)",
@@ -30,6 +30,7 @@
30
30
  "directory": "packages/ckeditor5-widget"
31
31
  },
32
32
  "files": [
33
+ "dist",
33
34
  "lang",
34
35
  "src/**/*.js",
35
36
  "src/**/*.d.ts",
package/src/utils.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
  /**
6
6
  * @module widget/utils
7
7
  */
8
- import { type GetCallback } from '@ckeditor/ckeditor5-utils';
8
+ import { Rect, type GetCallback } from '@ckeditor/ckeditor5-utils';
9
9
  import { type HighlightDescriptor, type MapperViewToModelPositionEvent, type DocumentSelection, type DowncastWriter, type Model, type Range, type Selection, type ViewEditableElement, type ViewElement, type ViewTypeCheckable } from '@ckeditor/ckeditor5-engine';
10
10
  /**
11
11
  * CSS class added to each widget element.
@@ -196,3 +196,20 @@ export declare function findOptimalInsertionRange(selection: Selection | Documen
196
196
  * should be applied to the given view element.
197
197
  */
198
198
  export declare function viewToModelPositionOutsideModelElement(model: Model, viewElementMatcher: (element: ViewElement) => boolean): GetCallback<MapperViewToModelPositionEvent>;
199
+ /**
200
+ * Starting from a DOM resize host element (an element that receives dimensions as a result of resizing),
201
+ * this helper returns the width of the found ancestor element.
202
+ *
203
+ * **Note**: This helper searches up to 5 levels of ancestors only.
204
+ *
205
+ * @param domResizeHost Resize host DOM element that receives dimensions as a result of resizing.
206
+ * @returns Width of ancestor element in pixels or 0 if no ancestor with a computed width has been found.
207
+ */
208
+ export declare function calculateResizeHostAncestorWidth(domResizeHost: HTMLElement): number;
209
+ /**
210
+ * Calculates a relative width of a `domResizeHost` compared to its ancestor in percents.
211
+ *
212
+ * @param domResizeHost Resize host DOM element.
213
+ * @returns Percentage value between 0 and 100.
214
+ */
215
+ export declare function calculateResizeHostPercentageWidth(domResizeHost: HTMLElement, resizeHostRect?: Rect): number;