@ckeditor/ckeditor5-ui 40.0.0 → 40.2.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.
Files changed (171) hide show
  1. package/CHANGELOG.md +26 -26
  2. package/LICENSE.md +3 -3
  3. package/lang/translations/gl.po +4 -4
  4. package/lang/translations/pt-br.po +1 -1
  5. package/lang/translations/sr-latn.po +6 -6
  6. package/lang/translations/ug.po +26 -26
  7. package/package.json +3 -3
  8. package/src/arialiveannouncer.d.ts +94 -0
  9. package/src/arialiveannouncer.js +113 -0
  10. package/src/augmentation.d.ts +86 -86
  11. package/src/augmentation.js +5 -5
  12. package/src/autocomplete/autocompleteview.d.ts +81 -81
  13. package/src/autocomplete/autocompleteview.js +153 -146
  14. package/src/bindings/addkeyboardhandlingforgrid.d.ts +27 -27
  15. package/src/bindings/addkeyboardhandlingforgrid.js +107 -107
  16. package/src/bindings/clickoutsidehandler.d.ts +28 -28
  17. package/src/bindings/clickoutsidehandler.js +36 -36
  18. package/src/bindings/csstransitiondisablermixin.d.ts +40 -40
  19. package/src/bindings/csstransitiondisablermixin.js +55 -55
  20. package/src/bindings/injectcsstransitiondisabler.d.ts +59 -59
  21. package/src/bindings/injectcsstransitiondisabler.js +71 -71
  22. package/src/bindings/preventdefault.d.ts +33 -33
  23. package/src/bindings/preventdefault.js +34 -34
  24. package/src/bindings/submithandler.d.ts +57 -57
  25. package/src/bindings/submithandler.js +47 -47
  26. package/src/button/button.d.ts +172 -178
  27. package/src/button/button.js +5 -5
  28. package/src/button/buttonlabel.d.ts +34 -34
  29. package/src/button/buttonlabel.js +5 -5
  30. package/src/button/buttonlabelview.d.ts +31 -31
  31. package/src/button/buttonlabelview.js +42 -42
  32. package/src/button/buttonview.d.ts +181 -185
  33. package/src/button/buttonview.js +217 -219
  34. package/src/button/switchbuttonview.d.ts +45 -45
  35. package/src/button/switchbuttonview.js +75 -75
  36. package/src/collapsible/collapsibleview.d.ts +69 -0
  37. package/src/collapsible/collapsibleview.js +95 -0
  38. package/src/colorgrid/colorgridview.d.ts +132 -132
  39. package/src/colorgrid/colorgridview.js +124 -124
  40. package/src/colorgrid/colortileview.d.ts +28 -28
  41. package/src/colorgrid/colortileview.js +40 -40
  42. package/src/colorgrid/utils.d.ts +47 -47
  43. package/src/colorgrid/utils.js +84 -84
  44. package/src/colorpicker/colorpickerview.d.ts +137 -137
  45. package/src/colorpicker/colorpickerview.js +270 -270
  46. package/src/colorpicker/utils.d.ts +43 -43
  47. package/src/colorpicker/utils.js +99 -99
  48. package/src/colorselector/colorgridsfragmentview.d.ts +194 -194
  49. package/src/colorselector/colorgridsfragmentview.js +289 -289
  50. package/src/colorselector/colorpickerfragmentview.d.ts +128 -128
  51. package/src/colorselector/colorpickerfragmentview.js +205 -205
  52. package/src/colorselector/colorselectorview.d.ts +242 -242
  53. package/src/colorselector/colorselectorview.js +256 -256
  54. package/src/colorselector/documentcolorcollection.d.ts +70 -70
  55. package/src/colorselector/documentcolorcollection.js +42 -42
  56. package/src/componentfactory.d.ts +81 -81
  57. package/src/componentfactory.js +104 -104
  58. package/src/dropdown/button/dropdownbutton.d.ts +25 -25
  59. package/src/dropdown/button/dropdownbutton.js +5 -5
  60. package/src/dropdown/button/dropdownbuttonview.d.ts +48 -48
  61. package/src/dropdown/button/dropdownbuttonview.js +66 -66
  62. package/src/dropdown/button/splitbuttonview.d.ts +162 -161
  63. package/src/dropdown/button/splitbuttonview.js +154 -152
  64. package/src/dropdown/dropdownpanelfocusable.d.ts +21 -21
  65. package/src/dropdown/dropdownpanelfocusable.js +5 -5
  66. package/src/dropdown/dropdownpanelview.d.ts +62 -62
  67. package/src/dropdown/dropdownpanelview.js +97 -97
  68. package/src/dropdown/dropdownview.d.ts +315 -315
  69. package/src/dropdown/dropdownview.js +379 -379
  70. package/src/dropdown/utils.d.ts +235 -235
  71. package/src/dropdown/utils.js +463 -458
  72. package/src/editableui/editableuiview.d.ts +72 -72
  73. package/src/editableui/editableuiview.js +112 -112
  74. package/src/editableui/inline/inlineeditableuiview.d.ts +40 -40
  75. package/src/editableui/inline/inlineeditableuiview.js +48 -48
  76. package/src/editorui/bodycollection.d.ts +55 -55
  77. package/src/editorui/bodycollection.js +84 -84
  78. package/src/editorui/boxed/boxededitoruiview.d.ts +40 -40
  79. package/src/editorui/boxed/boxededitoruiview.js +81 -81
  80. package/src/editorui/editorui.d.ts +288 -282
  81. package/src/editorui/editorui.js +412 -410
  82. package/src/editorui/editoruiview.d.ts +39 -39
  83. package/src/editorui/editoruiview.js +38 -38
  84. package/src/editorui/poweredby.d.ts +71 -71
  85. package/src/editorui/poweredby.js +276 -276
  86. package/src/focuscycler.d.ts +226 -226
  87. package/src/focuscycler.js +245 -245
  88. package/src/formheader/formheaderview.d.ts +59 -59
  89. package/src/formheader/formheaderview.js +69 -69
  90. package/src/highlightedtext/highlightedtextview.d.ts +38 -38
  91. package/src/highlightedtext/highlightedtextview.js +102 -102
  92. package/src/icon/iconview.d.ts +85 -85
  93. package/src/icon/iconview.js +114 -114
  94. package/src/iframe/iframeview.d.ts +50 -50
  95. package/src/iframe/iframeview.js +63 -63
  96. package/src/index.d.ts +74 -73
  97. package/src/index.js +71 -70
  98. package/src/input/inputbase.d.ts +107 -107
  99. package/src/input/inputbase.js +110 -110
  100. package/src/input/inputview.d.ts +36 -36
  101. package/src/input/inputview.js +24 -24
  102. package/src/inputnumber/inputnumberview.d.ts +49 -49
  103. package/src/inputnumber/inputnumberview.js +40 -40
  104. package/src/inputtext/inputtextview.d.ts +18 -18
  105. package/src/inputtext/inputtextview.js +27 -27
  106. package/src/label/labelview.d.ts +36 -36
  107. package/src/label/labelview.js +41 -41
  108. package/src/labeledfield/labeledfieldview.d.ts +187 -187
  109. package/src/labeledfield/labeledfieldview.js +157 -157
  110. package/src/labeledfield/utils.d.ts +123 -123
  111. package/src/labeledfield/utils.js +176 -176
  112. package/src/labeledinput/labeledinputview.d.ts +125 -125
  113. package/src/labeledinput/labeledinputview.js +125 -125
  114. package/src/list/listitemgroupview.d.ts +59 -51
  115. package/src/list/listitemgroupview.js +67 -75
  116. package/src/list/listitemview.d.ts +36 -36
  117. package/src/list/listitemview.js +42 -42
  118. package/src/list/listseparatorview.d.ts +18 -18
  119. package/src/list/listseparatorview.js +28 -28
  120. package/src/list/listview.d.ts +123 -122
  121. package/src/list/listview.js +188 -187
  122. package/src/model.d.ts +22 -22
  123. package/src/model.js +31 -31
  124. package/src/notification/notification.d.ts +211 -211
  125. package/src/notification/notification.js +187 -187
  126. package/src/panel/balloon/balloonpanelview.d.ts +685 -685
  127. package/src/panel/balloon/balloonpanelview.js +1010 -1010
  128. package/src/panel/balloon/contextualballoon.d.ts +299 -299
  129. package/src/panel/balloon/contextualballoon.js +572 -572
  130. package/src/panel/sticky/stickypanelview.d.ts +156 -156
  131. package/src/panel/sticky/stickypanelview.js +234 -234
  132. package/src/search/filteredview.d.ts +31 -31
  133. package/src/search/filteredview.js +5 -5
  134. package/src/search/searchinfoview.d.ts +45 -45
  135. package/src/search/searchinfoview.js +59 -59
  136. package/src/search/searchresultsview.d.ts +54 -54
  137. package/src/search/searchresultsview.js +65 -65
  138. package/src/search/text/searchtextqueryview.d.ts +76 -76
  139. package/src/search/text/searchtextqueryview.js +75 -75
  140. package/src/search/text/searchtextview.d.ts +219 -219
  141. package/src/search/text/searchtextview.js +201 -201
  142. package/src/spinner/spinnerview.d.ts +25 -25
  143. package/src/spinner/spinnerview.js +38 -38
  144. package/src/template.d.ts +942 -942
  145. package/src/template.js +1294 -1294
  146. package/src/textarea/textareaview.d.ts +88 -88
  147. package/src/textarea/textareaview.js +142 -140
  148. package/src/toolbar/balloon/balloontoolbar.d.ts +122 -122
  149. package/src/toolbar/balloon/balloontoolbar.js +300 -300
  150. package/src/toolbar/block/blockbuttonview.d.ts +35 -35
  151. package/src/toolbar/block/blockbuttonview.js +41 -41
  152. package/src/toolbar/block/blocktoolbar.d.ts +161 -161
  153. package/src/toolbar/block/blocktoolbar.js +395 -395
  154. package/src/toolbar/normalizetoolbarconfig.d.ts +40 -40
  155. package/src/toolbar/normalizetoolbarconfig.js +52 -51
  156. package/src/toolbar/toolbarlinebreakview.d.ts +18 -18
  157. package/src/toolbar/toolbarlinebreakview.js +28 -28
  158. package/src/toolbar/toolbarseparatorview.d.ts +18 -18
  159. package/src/toolbar/toolbarseparatorview.js +28 -28
  160. package/src/toolbar/toolbarview.d.ts +266 -266
  161. package/src/toolbar/toolbarview.js +719 -719
  162. package/src/tooltipmanager.d.ts +180 -180
  163. package/src/tooltipmanager.js +353 -353
  164. package/src/view.d.ts +422 -422
  165. package/src/view.js +396 -396
  166. package/src/viewcollection.d.ts +139 -139
  167. package/src/viewcollection.js +206 -206
  168. package/theme/components/arialiveannouncer/arialiveannouncer.css +10 -0
  169. package/theme/components/button/button.css +9 -1
  170. package/theme/components/collapsible/collapsible.css +10 -0
  171. package/theme/components/formheader/formheader.css +0 -4
@@ -1,395 +1,395 @@
1
- /**
2
- * @license Copyright (c) 2003-2023, 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
- * @module ui/toolbar/block/blocktoolbar
7
- */
8
- /* global window */
9
- import { Plugin } from '@ckeditor/ckeditor5-core';
10
- import { Rect, ResizeObserver, toUnit } from '@ckeditor/ckeditor5-utils';
11
- import BlockButtonView from './blockbuttonview';
12
- import BalloonPanelView from '../../panel/balloon/balloonpanelview';
13
- import ToolbarView, { NESTED_TOOLBAR_ICONS } from '../toolbarview';
14
- import clickOutsideHandler from '../../bindings/clickoutsidehandler';
15
- import normalizeToolbarConfig from '../normalizetoolbarconfig';
16
- const toPx = toUnit('px');
17
- /**
18
- * The block toolbar plugin.
19
- *
20
- * This plugin provides a button positioned next to the block of content where the selection is anchored.
21
- * Upon clicking the button, a dropdown providing access to editor features shows up, as configured in
22
- * {@link module:core/editor/editorconfig~EditorConfig#blockToolbar}.
23
- *
24
- * By default, the button is displayed next to all elements marked in {@link module:engine/model/schema~Schema}
25
- * as `$block` for which the toolbar provides at least one option.
26
- *
27
- * By default, the button is attached so its right boundary is touching the
28
- * {@link module:engine/view/editableelement~EditableElement}:
29
- *
30
- * ```
31
- * __ |
32
- * | || This is a block of content that the
33
- * ¯¯ | button is attached to. This is a
34
- * | block of content that the button is
35
- * | attached to.
36
- * ```
37
- *
38
- * The position of the button can be adjusted using the CSS `transform` property:
39
- *
40
- * ```css
41
- * .ck-block-toolbar-button {
42
- * transform: translateX( -10px );
43
- * }
44
- * ```
45
- *
46
- * ```
47
- * __ |
48
- * | | | This is a block of content that the
49
- * ¯¯ | button is attached to. This is a
50
- * | block of content that the button is
51
- * | attached to.
52
- * ```
53
- *
54
- * **Note**: If you plan to run the editor in a right–to–left (RTL) language, keep in mind the button
55
- * will be attached to the **right** boundary of the editable area. In that case, make sure the
56
- * CSS position adjustment works properly by adding the following styles:
57
- *
58
- * ```css
59
- * .ck[dir="rtl"] .ck-block-toolbar-button {
60
- * transform: translateX( 10px );
61
- * }
62
- * ```
63
- */
64
- export default class BlockToolbar extends Plugin {
65
- /**
66
- * @inheritDoc
67
- */
68
- static get pluginName() {
69
- return 'BlockToolbar';
70
- }
71
- /**
72
- * @inheritDoc
73
- */
74
- constructor(editor) {
75
- super(editor);
76
- /**
77
- * An instance of the resize observer that allows to respond to changes in editable's geometry
78
- * so the toolbar can stay within its boundaries (and group toolbar items that do not fit).
79
- *
80
- * **Note**: Used only when `shouldNotGroupWhenFull` was **not** set in the
81
- * {@link module:core/editor/editorconfig~EditorConfig#blockToolbar configuration}.
82
- *
83
- * **Note:** Created in {@link #afterInit}.
84
- */
85
- this._resizeObserver = null;
86
- this._blockToolbarConfig = normalizeToolbarConfig(this.editor.config.get('blockToolbar'));
87
- this.toolbarView = this._createToolbarView();
88
- this.panelView = this._createPanelView();
89
- this.buttonView = this._createButtonView();
90
- // Close the #panelView upon clicking outside of the plugin UI.
91
- clickOutsideHandler({
92
- emitter: this.panelView,
93
- contextElements: [this.panelView.element, this.buttonView.element],
94
- activator: () => this.panelView.isVisible,
95
- callback: () => this._hidePanel()
96
- });
97
- }
98
- /**
99
- * @inheritDoc
100
- */
101
- init() {
102
- const editor = this.editor;
103
- const t = editor.t;
104
- const editBlockText = t('Click to edit block');
105
- const dragToMoveText = t('Drag to move');
106
- const editBlockLabel = t('Edit block');
107
- const isDragDropBlockToolbarPluginLoaded = editor.plugins.has('DragDropBlockToolbar');
108
- const label = isDragDropBlockToolbarPluginLoaded ? `${editBlockText}\n${dragToMoveText}` : editBlockLabel;
109
- this.buttonView.label = label;
110
- if (isDragDropBlockToolbarPluginLoaded) {
111
- this.buttonView.element.dataset.ckeTooltipClass = 'ck-tooltip_multi-line';
112
- }
113
- // Hides panel on a direct selection change.
114
- this.listenTo(editor.model.document.selection, 'change:range', (evt, data) => {
115
- if (data.directChange) {
116
- this._hidePanel();
117
- }
118
- });
119
- this.listenTo(editor.ui, 'update', () => this._updateButton());
120
- // `low` priority is used because of https://github.com/ckeditor/ckeditor5-core/issues/133.
121
- this.listenTo(editor, 'change:isReadOnly', () => this._updateButton(), { priority: 'low' });
122
- this.listenTo(editor.ui.focusTracker, 'change:isFocused', () => this._updateButton());
123
- // Reposition button on resize.
124
- this.listenTo(this.buttonView, 'change:isVisible', (evt, name, isVisible) => {
125
- if (isVisible) {
126
- // Keep correct position of button and panel on window#resize.
127
- this.buttonView.listenTo(window, 'resize', () => this._updateButton());
128
- }
129
- else {
130
- // Stop repositioning button when is hidden.
131
- this.buttonView.stopListening(window, 'resize');
132
- // Hide the panel when the button disappears.
133
- this._hidePanel();
134
- }
135
- });
136
- // Register the toolbar so it becomes available for Alt+F10 and Esc navigation.
137
- editor.ui.addToolbar(this.toolbarView, {
138
- beforeFocus: () => this._showPanel(),
139
- afterBlur: () => this._hidePanel()
140
- });
141
- }
142
- /**
143
- * Fills the toolbar with its items based on the configuration.
144
- *
145
- * **Note:** This needs to be done after all plugins are ready.
146
- */
147
- afterInit() {
148
- this.toolbarView.fillFromConfig(this._blockToolbarConfig, this.editor.ui.componentFactory);
149
- // Hide panel before executing each button in the panel.
150
- for (const item of this.toolbarView.items) {
151
- item.on('execute', () => this._hidePanel(true), { priority: 'high' });
152
- }
153
- }
154
- /**
155
- * @inheritDoc
156
- */
157
- destroy() {
158
- super.destroy();
159
- // Destroy created UI components as they are not automatically destroyed (see ckeditor5#1341).
160
- this.panelView.destroy();
161
- this.buttonView.destroy();
162
- this.toolbarView.destroy();
163
- if (this._resizeObserver) {
164
- this._resizeObserver.destroy();
165
- }
166
- }
167
- /**
168
- * Creates the {@link #toolbarView}.
169
- */
170
- _createToolbarView() {
171
- const t = this.editor.locale.t;
172
- const shouldGroupWhenFull = !this._blockToolbarConfig.shouldNotGroupWhenFull;
173
- const toolbarView = new ToolbarView(this.editor.locale, {
174
- shouldGroupWhenFull,
175
- isFloating: true
176
- });
177
- toolbarView.ariaLabel = t('Editor block content toolbar');
178
- return toolbarView;
179
- }
180
- /**
181
- * Creates the {@link #panelView}.
182
- */
183
- _createPanelView() {
184
- const editor = this.editor;
185
- const panelView = new BalloonPanelView(editor.locale);
186
- panelView.content.add(this.toolbarView);
187
- panelView.class = 'ck-toolbar-container';
188
- editor.ui.view.body.add(panelView);
189
- editor.ui.focusTracker.add(panelView.element);
190
- // Close #panelView on `Esc` press.
191
- this.toolbarView.keystrokes.set('Esc', (evt, cancel) => {
192
- this._hidePanel(true);
193
- cancel();
194
- });
195
- return panelView;
196
- }
197
- /**
198
- * Creates the {@link #buttonView}.
199
- */
200
- _createButtonView() {
201
- const editor = this.editor;
202
- const t = editor.t;
203
- const buttonView = new BlockButtonView(editor.locale);
204
- const iconFromConfig = this._blockToolbarConfig.icon;
205
- const icon = NESTED_TOOLBAR_ICONS[iconFromConfig] || iconFromConfig || NESTED_TOOLBAR_ICONS.dragIndicator;
206
- buttonView.set({
207
- label: t('Edit block'),
208
- icon,
209
- withText: false
210
- });
211
- // Bind the panelView observable properties to the buttonView.
212
- buttonView.bind('isOn').to(this.panelView, 'isVisible');
213
- buttonView.bind('tooltip').to(this.panelView, 'isVisible', isVisible => !isVisible);
214
- // Toggle the panelView upon buttonView#execute.
215
- this.listenTo(buttonView, 'execute', () => {
216
- if (!this.panelView.isVisible) {
217
- this._showPanel();
218
- }
219
- else {
220
- this._hidePanel(true);
221
- }
222
- });
223
- editor.ui.view.body.add(buttonView);
224
- editor.ui.focusTracker.add(buttonView.element);
225
- return buttonView;
226
- }
227
- /**
228
- * Shows or hides the button.
229
- * When all the conditions for displaying the button are matched, it shows the button. Hides otherwise.
230
- */
231
- _updateButton() {
232
- const editor = this.editor;
233
- const model = editor.model;
234
- const view = editor.editing.view;
235
- // Hides the button when the editor is not focused.
236
- if (!editor.ui.focusTracker.isFocused) {
237
- this._hideButton();
238
- return;
239
- }
240
- // Hides the button when the selection is in non-editable place.
241
- if (!editor.model.canEditAt(editor.model.document.selection)) {
242
- this._hideButton();
243
- return;
244
- }
245
- // Get the first selected block, button will be attached to this element.
246
- const modelTarget = Array.from(model.document.selection.getSelectedBlocks())[0];
247
- // Hides the button when there is no enabled item in toolbar for the current block element.
248
- if (!modelTarget || Array.from(this.toolbarView.items).every((item) => !item.isEnabled)) {
249
- this._hideButton();
250
- return;
251
- }
252
- // Get DOM target element.
253
- const domTarget = view.domConverter.mapViewToDom(editor.editing.mapper.toViewElement(modelTarget));
254
- // Show block button.
255
- this.buttonView.isVisible = true;
256
- // Make sure that the block toolbar panel is resized properly.
257
- this._setupToolbarResize();
258
- // Attach block button to target DOM element.
259
- this._attachButtonToElement(domTarget);
260
- // When panel is opened then refresh it position to be properly aligned with block button.
261
- if (this.panelView.isVisible) {
262
- this._showPanel();
263
- }
264
- }
265
- /**
266
- * Hides the button.
267
- */
268
- _hideButton() {
269
- this.buttonView.isVisible = false;
270
- }
271
- /**
272
- * Shows the {@link #toolbarView} attached to the {@link #buttonView}.
273
- * If the toolbar is already visible, then it simply repositions it.
274
- */
275
- _showPanel() {
276
- // Usually, the only way to show the toolbar is by pressing the block button. It makes it impossible for
277
- // the toolbar to show up when the button is invisible (feature does not make sense for the selection then).
278
- // The toolbar navigation using Alt+F10 does not access the button but shows the panel directly using this method.
279
- // So we need to check whether this is possible first.
280
- if (!this.buttonView.isVisible) {
281
- return;
282
- }
283
- const wasVisible = this.panelView.isVisible;
284
- // So here's the thing: If there was no initial panelView#show() or these two were in different order, the toolbar
285
- // positioning will break in RTL editors. Weird, right? What you show know is that the toolbar
286
- // grouping works thanks to:
287
- //
288
- // * the ResizeObserver, which kicks in as soon as the toolbar shows up in DOM (becomes visible again).
289
- // * the observable ToolbarView#maxWidth, which triggers re-grouping when changed.
290
- //
291
- // Here are the possible scenarios:
292
- //
293
- // 1. (WRONG ❌) If the #maxWidth is set when the toolbar is invisible, it won't affect item grouping (no DOMRects, no grouping).
294
- // Then, when panelView.pin() is called, the position of the toolbar will be calculated for the old
295
- // items grouping state, and when finally ResizeObserver kicks in (hey, the toolbar is visible now, right?)
296
- // it will group/ungroup some items and the length of the toolbar will change. But since in RTL the toolbar
297
- // is attached on the right side and the positioning uses CSS "left", it will result in the toolbar shifting
298
- // to the left and being displayed in the wrong place.
299
- // 2. (WRONG ❌) If the panelView.pin() is called first and #maxWidth set next, then basically the story repeats. The balloon
300
- // calculates the position for the old toolbar grouping state, then the toolbar re-groups items and because
301
- // it is positioned using CSS "left" it will move.
302
- // 3. (RIGHT ✅) We show the panel first (the toolbar does re-grouping but it does not matter), then the #maxWidth
303
- // is set allowing the toolbar to re-group again and finally panelView.pin() does the positioning when the
304
- // items grouping state is stable and final.
305
- //
306
- // https://github.com/ckeditor/ckeditor5/issues/6449, https://github.com/ckeditor/ckeditor5/issues/6575
307
- this.panelView.show();
308
- const editableElement = this._getSelectedEditableElement();
309
- this.toolbarView.maxWidth = this._getToolbarMaxWidth(editableElement);
310
- this.panelView.pin({
311
- target: this.buttonView.element,
312
- limiter: editableElement
313
- });
314
- if (!wasVisible) {
315
- this.toolbarView.items.get(0).focus();
316
- }
317
- }
318
- /**
319
- * Returns currently selected editable, based on the model selection.
320
- */
321
- _getSelectedEditableElement() {
322
- const selectedModelRootName = this.editor.model.document.selection.getFirstRange().root.rootName;
323
- return this.editor.ui.getEditableElement(selectedModelRootName);
324
- }
325
- /**
326
- * Hides the {@link #toolbarView}.
327
- *
328
- * @param focusEditable When `true`, the editable will be focused after hiding the panel.
329
- */
330
- _hidePanel(focusEditable) {
331
- this.panelView.isVisible = false;
332
- if (focusEditable) {
333
- this.editor.editing.view.focus();
334
- }
335
- }
336
- /**
337
- * Attaches the {@link #buttonView} to the target block of content.
338
- *
339
- * @param targetElement Target element.
340
- */
341
- _attachButtonToElement(targetElement) {
342
- const contentStyles = window.getComputedStyle(targetElement);
343
- const editableRect = new Rect(this._getSelectedEditableElement());
344
- const contentPaddingTop = parseInt(contentStyles.paddingTop, 10);
345
- // When line height is not an integer then treat it as "normal".
346
- // MDN says that 'normal' == ~1.2 on desktop browsers.
347
- const contentLineHeight = parseInt(contentStyles.lineHeight, 10) || parseInt(contentStyles.fontSize, 10) * 1.2;
348
- const buttonRect = new Rect(this.buttonView.element);
349
- const contentRect = new Rect(targetElement);
350
- let positionLeft;
351
- if (this.editor.locale.uiLanguageDirection === 'ltr') {
352
- positionLeft = editableRect.left - buttonRect.width;
353
- }
354
- else {
355
- positionLeft = editableRect.right;
356
- }
357
- const positionTop = contentRect.top + contentPaddingTop + (contentLineHeight - buttonRect.height) / 2;
358
- buttonRect.moveTo(positionLeft, positionTop);
359
- const absoluteButtonRect = buttonRect.toAbsoluteRect();
360
- this.buttonView.top = absoluteButtonRect.top;
361
- this.buttonView.left = absoluteButtonRect.left;
362
- }
363
- /**
364
- * Creates a resize observer that observes selected editable and resizes the toolbar panel accordingly.
365
- */
366
- _setupToolbarResize() {
367
- const editableElement = this._getSelectedEditableElement();
368
- // Do this only if the automatic grouping is turned on.
369
- if (!this._blockToolbarConfig.shouldNotGroupWhenFull) {
370
- // If resize observer is attached to a different editable than currently selected editable, re-attach it.
371
- if (this._resizeObserver && this._resizeObserver.element !== editableElement) {
372
- this._resizeObserver.destroy();
373
- this._resizeObserver = null;
374
- }
375
- if (!this._resizeObserver) {
376
- this._resizeObserver = new ResizeObserver(editableElement, () => {
377
- this.toolbarView.maxWidth = this._getToolbarMaxWidth(editableElement);
378
- });
379
- }
380
- }
381
- }
382
- /**
383
- * Gets the {@link #toolbarView} max-width, based on given `editableElement` width plus the distance between the farthest
384
- * edge of the {@link #buttonView} and the editable.
385
- *
386
- * @returns A maximum width that toolbar can have, in pixels.
387
- */
388
- _getToolbarMaxWidth(editableElement) {
389
- const editableRect = new Rect(editableElement);
390
- const buttonRect = new Rect(this.buttonView.element);
391
- const isRTL = this.editor.locale.uiLanguageDirection === 'rtl';
392
- const offset = isRTL ? (buttonRect.left - editableRect.right) + buttonRect.width : editableRect.left - buttonRect.left;
393
- return toPx(editableRect.width + offset);
394
- }
395
- }
1
+ /**
2
+ * @license Copyright (c) 2003-2023, 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
+ * @module ui/toolbar/block/blocktoolbar
7
+ */
8
+ /* global window */
9
+ import { Plugin } from '@ckeditor/ckeditor5-core';
10
+ import { Rect, ResizeObserver, toUnit } from '@ckeditor/ckeditor5-utils';
11
+ import BlockButtonView from './blockbuttonview';
12
+ import BalloonPanelView from '../../panel/balloon/balloonpanelview';
13
+ import ToolbarView, { NESTED_TOOLBAR_ICONS } from '../toolbarview';
14
+ import clickOutsideHandler from '../../bindings/clickoutsidehandler';
15
+ import normalizeToolbarConfig from '../normalizetoolbarconfig';
16
+ const toPx = toUnit('px');
17
+ /**
18
+ * The block toolbar plugin.
19
+ *
20
+ * This plugin provides a button positioned next to the block of content where the selection is anchored.
21
+ * Upon clicking the button, a dropdown providing access to editor features shows up, as configured in
22
+ * {@link module:core/editor/editorconfig~EditorConfig#blockToolbar}.
23
+ *
24
+ * By default, the button is displayed next to all elements marked in {@link module:engine/model/schema~Schema}
25
+ * as `$block` for which the toolbar provides at least one option.
26
+ *
27
+ * By default, the button is attached so its right boundary is touching the
28
+ * {@link module:engine/view/editableelement~EditableElement}:
29
+ *
30
+ * ```
31
+ * __ |
32
+ * | || This is a block of content that the
33
+ * ¯¯ | button is attached to. This is a
34
+ * | block of content that the button is
35
+ * | attached to.
36
+ * ```
37
+ *
38
+ * The position of the button can be adjusted using the CSS `transform` property:
39
+ *
40
+ * ```css
41
+ * .ck-block-toolbar-button {
42
+ * transform: translateX( -10px );
43
+ * }
44
+ * ```
45
+ *
46
+ * ```
47
+ * __ |
48
+ * | | | This is a block of content that the
49
+ * ¯¯ | button is attached to. This is a
50
+ * | block of content that the button is
51
+ * | attached to.
52
+ * ```
53
+ *
54
+ * **Note**: If you plan to run the editor in a right–to–left (RTL) language, keep in mind the button
55
+ * will be attached to the **right** boundary of the editable area. In that case, make sure the
56
+ * CSS position adjustment works properly by adding the following styles:
57
+ *
58
+ * ```css
59
+ * .ck[dir="rtl"] .ck-block-toolbar-button {
60
+ * transform: translateX( 10px );
61
+ * }
62
+ * ```
63
+ */
64
+ export default class BlockToolbar extends Plugin {
65
+ /**
66
+ * @inheritDoc
67
+ */
68
+ static get pluginName() {
69
+ return 'BlockToolbar';
70
+ }
71
+ /**
72
+ * @inheritDoc
73
+ */
74
+ constructor(editor) {
75
+ super(editor);
76
+ /**
77
+ * An instance of the resize observer that allows to respond to changes in editable's geometry
78
+ * so the toolbar can stay within its boundaries (and group toolbar items that do not fit).
79
+ *
80
+ * **Note**: Used only when `shouldNotGroupWhenFull` was **not** set in the
81
+ * {@link module:core/editor/editorconfig~EditorConfig#blockToolbar configuration}.
82
+ *
83
+ * **Note:** Created in {@link #afterInit}.
84
+ */
85
+ this._resizeObserver = null;
86
+ this._blockToolbarConfig = normalizeToolbarConfig(this.editor.config.get('blockToolbar'));
87
+ this.toolbarView = this._createToolbarView();
88
+ this.panelView = this._createPanelView();
89
+ this.buttonView = this._createButtonView();
90
+ // Close the #panelView upon clicking outside of the plugin UI.
91
+ clickOutsideHandler({
92
+ emitter: this.panelView,
93
+ contextElements: [this.panelView.element, this.buttonView.element],
94
+ activator: () => this.panelView.isVisible,
95
+ callback: () => this._hidePanel()
96
+ });
97
+ }
98
+ /**
99
+ * @inheritDoc
100
+ */
101
+ init() {
102
+ const editor = this.editor;
103
+ const t = editor.t;
104
+ const editBlockText = t('Click to edit block');
105
+ const dragToMoveText = t('Drag to move');
106
+ const editBlockLabel = t('Edit block');
107
+ const isDragDropBlockToolbarPluginLoaded = editor.plugins.has('DragDropBlockToolbar');
108
+ const label = isDragDropBlockToolbarPluginLoaded ? `${editBlockText}\n${dragToMoveText}` : editBlockLabel;
109
+ this.buttonView.label = label;
110
+ if (isDragDropBlockToolbarPluginLoaded) {
111
+ this.buttonView.element.dataset.ckeTooltipClass = 'ck-tooltip_multi-line';
112
+ }
113
+ // Hides panel on a direct selection change.
114
+ this.listenTo(editor.model.document.selection, 'change:range', (evt, data) => {
115
+ if (data.directChange) {
116
+ this._hidePanel();
117
+ }
118
+ });
119
+ this.listenTo(editor.ui, 'update', () => this._updateButton());
120
+ // `low` priority is used because of https://github.com/ckeditor/ckeditor5-core/issues/133.
121
+ this.listenTo(editor, 'change:isReadOnly', () => this._updateButton(), { priority: 'low' });
122
+ this.listenTo(editor.ui.focusTracker, 'change:isFocused', () => this._updateButton());
123
+ // Reposition button on resize.
124
+ this.listenTo(this.buttonView, 'change:isVisible', (evt, name, isVisible) => {
125
+ if (isVisible) {
126
+ // Keep correct position of button and panel on window#resize.
127
+ this.buttonView.listenTo(window, 'resize', () => this._updateButton());
128
+ }
129
+ else {
130
+ // Stop repositioning button when is hidden.
131
+ this.buttonView.stopListening(window, 'resize');
132
+ // Hide the panel when the button disappears.
133
+ this._hidePanel();
134
+ }
135
+ });
136
+ // Register the toolbar so it becomes available for Alt+F10 and Esc navigation.
137
+ editor.ui.addToolbar(this.toolbarView, {
138
+ beforeFocus: () => this._showPanel(),
139
+ afterBlur: () => this._hidePanel()
140
+ });
141
+ }
142
+ /**
143
+ * Fills the toolbar with its items based on the configuration.
144
+ *
145
+ * **Note:** This needs to be done after all plugins are ready.
146
+ */
147
+ afterInit() {
148
+ this.toolbarView.fillFromConfig(this._blockToolbarConfig, this.editor.ui.componentFactory);
149
+ // Hide panel before executing each button in the panel.
150
+ for (const item of this.toolbarView.items) {
151
+ item.on('execute', () => this._hidePanel(true), { priority: 'high' });
152
+ }
153
+ }
154
+ /**
155
+ * @inheritDoc
156
+ */
157
+ destroy() {
158
+ super.destroy();
159
+ // Destroy created UI components as they are not automatically destroyed (see ckeditor5#1341).
160
+ this.panelView.destroy();
161
+ this.buttonView.destroy();
162
+ this.toolbarView.destroy();
163
+ if (this._resizeObserver) {
164
+ this._resizeObserver.destroy();
165
+ }
166
+ }
167
+ /**
168
+ * Creates the {@link #toolbarView}.
169
+ */
170
+ _createToolbarView() {
171
+ const t = this.editor.locale.t;
172
+ const shouldGroupWhenFull = !this._blockToolbarConfig.shouldNotGroupWhenFull;
173
+ const toolbarView = new ToolbarView(this.editor.locale, {
174
+ shouldGroupWhenFull,
175
+ isFloating: true
176
+ });
177
+ toolbarView.ariaLabel = t('Editor block content toolbar');
178
+ return toolbarView;
179
+ }
180
+ /**
181
+ * Creates the {@link #panelView}.
182
+ */
183
+ _createPanelView() {
184
+ const editor = this.editor;
185
+ const panelView = new BalloonPanelView(editor.locale);
186
+ panelView.content.add(this.toolbarView);
187
+ panelView.class = 'ck-toolbar-container';
188
+ editor.ui.view.body.add(panelView);
189
+ editor.ui.focusTracker.add(panelView.element);
190
+ // Close #panelView on `Esc` press.
191
+ this.toolbarView.keystrokes.set('Esc', (evt, cancel) => {
192
+ this._hidePanel(true);
193
+ cancel();
194
+ });
195
+ return panelView;
196
+ }
197
+ /**
198
+ * Creates the {@link #buttonView}.
199
+ */
200
+ _createButtonView() {
201
+ const editor = this.editor;
202
+ const t = editor.t;
203
+ const buttonView = new BlockButtonView(editor.locale);
204
+ const iconFromConfig = this._blockToolbarConfig.icon;
205
+ const icon = NESTED_TOOLBAR_ICONS[iconFromConfig] || iconFromConfig || NESTED_TOOLBAR_ICONS.dragIndicator;
206
+ buttonView.set({
207
+ label: t('Edit block'),
208
+ icon,
209
+ withText: false
210
+ });
211
+ // Bind the panelView observable properties to the buttonView.
212
+ buttonView.bind('isOn').to(this.panelView, 'isVisible');
213
+ buttonView.bind('tooltip').to(this.panelView, 'isVisible', isVisible => !isVisible);
214
+ // Toggle the panelView upon buttonView#execute.
215
+ this.listenTo(buttonView, 'execute', () => {
216
+ if (!this.panelView.isVisible) {
217
+ this._showPanel();
218
+ }
219
+ else {
220
+ this._hidePanel(true);
221
+ }
222
+ });
223
+ editor.ui.view.body.add(buttonView);
224
+ editor.ui.focusTracker.add(buttonView.element);
225
+ return buttonView;
226
+ }
227
+ /**
228
+ * Shows or hides the button.
229
+ * When all the conditions for displaying the button are matched, it shows the button. Hides otherwise.
230
+ */
231
+ _updateButton() {
232
+ const editor = this.editor;
233
+ const model = editor.model;
234
+ const view = editor.editing.view;
235
+ // Hides the button when the editor is not focused.
236
+ if (!editor.ui.focusTracker.isFocused) {
237
+ this._hideButton();
238
+ return;
239
+ }
240
+ // Hides the button when the selection is in non-editable place.
241
+ if (!editor.model.canEditAt(editor.model.document.selection)) {
242
+ this._hideButton();
243
+ return;
244
+ }
245
+ // Get the first selected block, button will be attached to this element.
246
+ const modelTarget = Array.from(model.document.selection.getSelectedBlocks())[0];
247
+ // Hides the button when there is no enabled item in toolbar for the current block element.
248
+ if (!modelTarget || Array.from(this.toolbarView.items).every((item) => !item.isEnabled)) {
249
+ this._hideButton();
250
+ return;
251
+ }
252
+ // Get DOM target element.
253
+ const domTarget = view.domConverter.mapViewToDom(editor.editing.mapper.toViewElement(modelTarget));
254
+ // Show block button.
255
+ this.buttonView.isVisible = true;
256
+ // Make sure that the block toolbar panel is resized properly.
257
+ this._setupToolbarResize();
258
+ // Attach block button to target DOM element.
259
+ this._attachButtonToElement(domTarget);
260
+ // When panel is opened then refresh it position to be properly aligned with block button.
261
+ if (this.panelView.isVisible) {
262
+ this._showPanel();
263
+ }
264
+ }
265
+ /**
266
+ * Hides the button.
267
+ */
268
+ _hideButton() {
269
+ this.buttonView.isVisible = false;
270
+ }
271
+ /**
272
+ * Shows the {@link #toolbarView} attached to the {@link #buttonView}.
273
+ * If the toolbar is already visible, then it simply repositions it.
274
+ */
275
+ _showPanel() {
276
+ // Usually, the only way to show the toolbar is by pressing the block button. It makes it impossible for
277
+ // the toolbar to show up when the button is invisible (feature does not make sense for the selection then).
278
+ // The toolbar navigation using Alt+F10 does not access the button but shows the panel directly using this method.
279
+ // So we need to check whether this is possible first.
280
+ if (!this.buttonView.isVisible) {
281
+ return;
282
+ }
283
+ const wasVisible = this.panelView.isVisible;
284
+ // So here's the thing: If there was no initial panelView#show() or these two were in different order, the toolbar
285
+ // positioning will break in RTL editors. Weird, right? What you show know is that the toolbar
286
+ // grouping works thanks to:
287
+ //
288
+ // * the ResizeObserver, which kicks in as soon as the toolbar shows up in DOM (becomes visible again).
289
+ // * the observable ToolbarView#maxWidth, which triggers re-grouping when changed.
290
+ //
291
+ // Here are the possible scenarios:
292
+ //
293
+ // 1. (WRONG ❌) If the #maxWidth is set when the toolbar is invisible, it won't affect item grouping (no DOMRects, no grouping).
294
+ // Then, when panelView.pin() is called, the position of the toolbar will be calculated for the old
295
+ // items grouping state, and when finally ResizeObserver kicks in (hey, the toolbar is visible now, right?)
296
+ // it will group/ungroup some items and the length of the toolbar will change. But since in RTL the toolbar
297
+ // is attached on the right side and the positioning uses CSS "left", it will result in the toolbar shifting
298
+ // to the left and being displayed in the wrong place.
299
+ // 2. (WRONG ❌) If the panelView.pin() is called first and #maxWidth set next, then basically the story repeats. The balloon
300
+ // calculates the position for the old toolbar grouping state, then the toolbar re-groups items and because
301
+ // it is positioned using CSS "left" it will move.
302
+ // 3. (RIGHT ✅) We show the panel first (the toolbar does re-grouping but it does not matter), then the #maxWidth
303
+ // is set allowing the toolbar to re-group again and finally panelView.pin() does the positioning when the
304
+ // items grouping state is stable and final.
305
+ //
306
+ // https://github.com/ckeditor/ckeditor5/issues/6449, https://github.com/ckeditor/ckeditor5/issues/6575
307
+ this.panelView.show();
308
+ const editableElement = this._getSelectedEditableElement();
309
+ this.toolbarView.maxWidth = this._getToolbarMaxWidth(editableElement);
310
+ this.panelView.pin({
311
+ target: this.buttonView.element,
312
+ limiter: editableElement
313
+ });
314
+ if (!wasVisible) {
315
+ this.toolbarView.items.get(0).focus();
316
+ }
317
+ }
318
+ /**
319
+ * Returns currently selected editable, based on the model selection.
320
+ */
321
+ _getSelectedEditableElement() {
322
+ const selectedModelRootName = this.editor.model.document.selection.getFirstRange().root.rootName;
323
+ return this.editor.ui.getEditableElement(selectedModelRootName);
324
+ }
325
+ /**
326
+ * Hides the {@link #toolbarView}.
327
+ *
328
+ * @param focusEditable When `true`, the editable will be focused after hiding the panel.
329
+ */
330
+ _hidePanel(focusEditable) {
331
+ this.panelView.isVisible = false;
332
+ if (focusEditable) {
333
+ this.editor.editing.view.focus();
334
+ }
335
+ }
336
+ /**
337
+ * Attaches the {@link #buttonView} to the target block of content.
338
+ *
339
+ * @param targetElement Target element.
340
+ */
341
+ _attachButtonToElement(targetElement) {
342
+ const contentStyles = window.getComputedStyle(targetElement);
343
+ const editableRect = new Rect(this._getSelectedEditableElement());
344
+ const contentPaddingTop = parseInt(contentStyles.paddingTop, 10);
345
+ // When line height is not an integer then treat it as "normal".
346
+ // MDN says that 'normal' == ~1.2 on desktop browsers.
347
+ const contentLineHeight = parseInt(contentStyles.lineHeight, 10) || parseInt(contentStyles.fontSize, 10) * 1.2;
348
+ const buttonRect = new Rect(this.buttonView.element);
349
+ const contentRect = new Rect(targetElement);
350
+ let positionLeft;
351
+ if (this.editor.locale.uiLanguageDirection === 'ltr') {
352
+ positionLeft = editableRect.left - buttonRect.width;
353
+ }
354
+ else {
355
+ positionLeft = editableRect.right;
356
+ }
357
+ const positionTop = contentRect.top + contentPaddingTop + (contentLineHeight - buttonRect.height) / 2;
358
+ buttonRect.moveTo(positionLeft, positionTop);
359
+ const absoluteButtonRect = buttonRect.toAbsoluteRect();
360
+ this.buttonView.top = absoluteButtonRect.top;
361
+ this.buttonView.left = absoluteButtonRect.left;
362
+ }
363
+ /**
364
+ * Creates a resize observer that observes selected editable and resizes the toolbar panel accordingly.
365
+ */
366
+ _setupToolbarResize() {
367
+ const editableElement = this._getSelectedEditableElement();
368
+ // Do this only if the automatic grouping is turned on.
369
+ if (!this._blockToolbarConfig.shouldNotGroupWhenFull) {
370
+ // If resize observer is attached to a different editable than currently selected editable, re-attach it.
371
+ if (this._resizeObserver && this._resizeObserver.element !== editableElement) {
372
+ this._resizeObserver.destroy();
373
+ this._resizeObserver = null;
374
+ }
375
+ if (!this._resizeObserver) {
376
+ this._resizeObserver = new ResizeObserver(editableElement, () => {
377
+ this.toolbarView.maxWidth = this._getToolbarMaxWidth(editableElement);
378
+ });
379
+ }
380
+ }
381
+ }
382
+ /**
383
+ * Gets the {@link #toolbarView} max-width, based on given `editableElement` width plus the distance between the farthest
384
+ * edge of the {@link #buttonView} and the editable.
385
+ *
386
+ * @returns A maximum width that toolbar can have, in pixels.
387
+ */
388
+ _getToolbarMaxWidth(editableElement) {
389
+ const editableRect = new Rect(editableElement);
390
+ const buttonRect = new Rect(this.buttonView.element);
391
+ const isRTL = this.editor.locale.uiLanguageDirection === 'rtl';
392
+ const offset = isRTL ? (buttonRect.left - editableRect.right) + buttonRect.width : editableRect.left - buttonRect.left;
393
+ return toPx(editableRect.width + offset);
394
+ }
395
+ }