-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
blocktoolbar.ts
499 lines (414 loc) · 16.5 KB
/
blocktoolbar.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
/**
* @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module ui/toolbar/block/blocktoolbar
*/
/* global window */
import {
Plugin,
type Editor
} from '@ckeditor/ckeditor5-core';
import {
Rect,
ResizeObserver,
toUnit,
type ObservableChangeEvent
} from '@ckeditor/ckeditor5-utils';
import type { DocumentSelectionChangeRangeEvent } from '@ckeditor/ckeditor5-engine';
import BlockButtonView from './blockbuttonview.js';
import BalloonPanelView from '../../panel/balloon/balloonpanelview.js';
import ToolbarView, { NESTED_TOOLBAR_ICONS } from '../toolbarview.js';
import clickOutsideHandler from '../../bindings/clickoutsidehandler.js';
import normalizeToolbarConfig from '../normalizetoolbarconfig.js';
import type { ButtonExecuteEvent } from '../../button/button.js';
import type { EditorUIReadyEvent, EditorUIUpdateEvent } from '../../editorui/editorui.js';
const toPx = toUnit( 'px' );
/**
* The block toolbar plugin.
*
* This plugin provides a button positioned next to the block of content where the selection is anchored.
* Upon clicking the button, a dropdown providing access to editor features shows up, as configured in
* {@link module:core/editor/editorconfig~EditorConfig#blockToolbar}.
*
* By default, the button is displayed next to all elements marked in {@link module:engine/model/schema~Schema}
* as `$block` for which the toolbar provides at least one option.
*
* By default, the button is attached so its right boundary is touching the
* {@link module:engine/view/editableelement~EditableElement}:
*
* ```
* __ |
* | || This is a block of content that the
* ¯¯ | button is attached to. This is a
* | block of content that the button is
* | attached to.
* ```
*
* The position of the button can be adjusted using the CSS `transform` property:
*
* ```css
* .ck-block-toolbar-button {
* transform: translateX( -10px );
* }
* ```
*
* ```
* __ |
* | | | This is a block of content that the
* ¯¯ | button is attached to. This is a
* | block of content that the button is
* | attached to.
* ```
*
* **Note**: If you plan to run the editor in a right–to–left (RTL) language, keep in mind the button
* will be attached to the **right** boundary of the editable area. In that case, make sure the
* CSS position adjustment works properly by adding the following styles:
*
* ```css
* .ck[dir="rtl"] .ck-block-toolbar-button {
* transform: translateX( 10px );
* }
* ```
*/
export default class BlockToolbar extends Plugin {
/**
* The toolbar view.
*/
public readonly toolbarView: ToolbarView;
/**
* The balloon panel view, containing the {@link #toolbarView}.
*/
public readonly panelView: BalloonPanelView;
/**
* The button view that opens the {@link #toolbarView}.
*/
public readonly buttonView: BlockButtonView;
/**
* An instance of the resize observer that allows to respond to changes in editable's geometry
* so the toolbar can stay within its boundaries (and group toolbar items that do not fit).
*
* **Note**: Used only when `shouldNotGroupWhenFull` was **not** set in the
* {@link module:core/editor/editorconfig~EditorConfig#blockToolbar configuration}.
*/
private _resizeObserver: ResizeObserver | null = null;
/**
* A cached and normalized `config.blockToolbar` object.
*/
private _blockToolbarConfig: ReturnType<typeof normalizeToolbarConfig>;
/**
* @inheritDoc
*/
public static get pluginName() {
return 'BlockToolbar' as const;
}
/**
* @inheritDoc
*/
constructor( editor: Editor ) {
super( editor );
this._blockToolbarConfig = normalizeToolbarConfig( this.editor.config.get( 'blockToolbar' ) );
this.toolbarView = this._createToolbarView();
this.panelView = this._createPanelView();
this.buttonView = this._createButtonView();
// Close the #panelView upon clicking outside of the plugin UI.
clickOutsideHandler( {
emitter: this.panelView,
contextElements: [ this.panelView.element!, this.buttonView.element! ],
activator: () => this.panelView.isVisible,
callback: () => this._hidePanel()
} );
}
/**
* @inheritDoc
*/
public init(): void {
const editor = this.editor;
const t = editor.t;
const editBlockText = t( 'Click to edit block' );
const dragToMoveText = t( 'Drag to move' );
const editBlockLabel = t( 'Edit block' );
const isDragDropBlockToolbarPluginLoaded = editor.plugins.has( 'DragDropBlockToolbar' );
const label = isDragDropBlockToolbarPluginLoaded ? `${ editBlockText }\n${ dragToMoveText }` : editBlockLabel;
this.buttonView.label = label;
if ( isDragDropBlockToolbarPluginLoaded ) {
this.buttonView.element!.dataset.ckeTooltipClass = 'ck-tooltip_multi-line';
}
// Hides panel on a direct selection change.
this.listenTo<DocumentSelectionChangeRangeEvent>( editor.model.document.selection, 'change:range', ( evt, data ) => {
if ( data.directChange ) {
this._hidePanel();
}
} );
this.listenTo<EditorUIUpdateEvent>( editor.ui, 'update', () => this._updateButton() );
// `low` priority is used because of https://github.com/ckeditor/ckeditor5-core/issues/133.
this.listenTo<ObservableChangeEvent>( editor, 'change:isReadOnly', () => this._updateButton(), { priority: 'low' } );
this.listenTo<ObservableChangeEvent>( editor.ui.focusTracker, 'change:isFocused', () => this._updateButton() );
// Reposition button on resize.
this.listenTo<ObservableChangeEvent<boolean>>( this.buttonView, 'change:isVisible', ( evt, name, isVisible ) => {
if ( isVisible ) {
// Keep correct position of button and panel on window#resize.
this.buttonView.listenTo( window, 'resize', () => this._updateButton() );
} else {
// Stop repositioning button when is hidden.
this.buttonView.stopListening( window, 'resize' );
// Hide the panel when the button disappears.
this._hidePanel();
}
} );
// Register the toolbar so it becomes available for Alt+F10 and Esc navigation.
editor.ui.addToolbar( this.toolbarView, {
beforeFocus: () => this._showPanel(),
afterBlur: () => this._hidePanel()
} );
// Fills the toolbar with its items based on the configuration.
// This needs to be done after all plugins are ready.
editor.ui.once<EditorUIReadyEvent>( 'ready', () => {
this.toolbarView.fillFromConfig( this._blockToolbarConfig, this.editor.ui.componentFactory );
// Hide panel before executing each button in the panel.
for ( const item of this.toolbarView.items ) {
item.on<ButtonExecuteEvent>( 'execute', () => this._hidePanel( true ), { priority: 'high' } );
}
} );
}
/**
* @inheritDoc
*/
public override destroy(): void {
super.destroy();
// Destroy created UI components as they are not automatically destroyed (see ckeditor5#1341).
this.panelView.destroy();
this.buttonView.destroy();
this.toolbarView.destroy();
if ( this._resizeObserver ) {
this._resizeObserver.destroy();
}
}
/**
* Creates the {@link #toolbarView}.
*/
private _createToolbarView(): ToolbarView {
const t = this.editor.locale.t;
const shouldGroupWhenFull = !this._blockToolbarConfig.shouldNotGroupWhenFull;
const toolbarView = new ToolbarView( this.editor.locale, {
shouldGroupWhenFull,
isFloating: true
} );
toolbarView.ariaLabel = t( 'Editor block content toolbar' );
return toolbarView;
}
/**
* Creates the {@link #panelView}.
*/
private _createPanelView(): BalloonPanelView {
const editor = this.editor;
const panelView = new BalloonPanelView( editor.locale );
panelView.content.add( this.toolbarView );
panelView.class = 'ck-toolbar-container';
editor.ui.view.body.add( panelView );
editor.ui.focusTracker.add( panelView.element! );
// Close #panelView on `Esc` press.
this.toolbarView.keystrokes.set( 'Esc', ( evt, cancel ) => {
this._hidePanel( true );
cancel();
} );
return panelView;
}
/**
* Creates the {@link #buttonView}.
*/
private _createButtonView(): BlockButtonView {
const editor = this.editor;
const t = editor.t;
const buttonView = new BlockButtonView( editor.locale );
const iconFromConfig = this._blockToolbarConfig.icon;
const icon = NESTED_TOOLBAR_ICONS[ iconFromConfig! ] || iconFromConfig || NESTED_TOOLBAR_ICONS.dragIndicator;
buttonView.set( {
label: t( 'Edit block' ),
icon,
withText: false
} );
// Bind the panelView observable properties to the buttonView.
buttonView.bind( 'isOn' ).to( this.panelView, 'isVisible' );
buttonView.bind( 'tooltip' ).to( this.panelView, 'isVisible', isVisible => !isVisible );
// Toggle the panelView upon buttonView#execute.
this.listenTo<ButtonExecuteEvent>( buttonView, 'execute', () => {
if ( !this.panelView.isVisible ) {
this._showPanel();
} else {
this._hidePanel( true );
}
} );
editor.ui.view.body.add( buttonView );
editor.ui.focusTracker.add( buttonView.element! );
return buttonView;
}
/**
* Shows or hides the button.
* When all the conditions for displaying the button are matched, it shows the button. Hides otherwise.
*/
private _updateButton() {
const editor = this.editor;
const model = editor.model;
const view = editor.editing.view;
// Hides the button when the editor is not focused.
if ( !editor.ui.focusTracker.isFocused ) {
this._hideButton();
return;
}
// Hides the button when the selection is in non-editable place.
if ( !editor.model.canEditAt( editor.model.document.selection ) ) {
this._hideButton();
return;
}
// Get the first selected block, button will be attached to this element.
const modelTarget = Array.from( model.document.selection.getSelectedBlocks() )[ 0 ];
// Hides the button when there is no enabled item in toolbar for the current block element.
if ( !modelTarget || Array.from( this.toolbarView.items ).every( ( item: any ) => !item.isEnabled ) ) {
this._hideButton();
return;
}
// Get DOM target element.
const domTarget = view.domConverter.mapViewToDom( editor.editing.mapper.toViewElement( modelTarget )! );
// Show block button.
this.buttonView.isVisible = true;
// Make sure that the block toolbar panel is resized properly.
this._setupToolbarResize();
// Attach block button to target DOM element.
this._attachButtonToElement( domTarget as any );
// When panel is opened then refresh it position to be properly aligned with block button.
if ( this.panelView.isVisible ) {
this._showPanel();
}
}
/**
* Hides the button.
*/
private _hideButton() {
this.buttonView.isVisible = false;
}
/**
* Shows the {@link #toolbarView} attached to the {@link #buttonView}.
* If the toolbar is already visible, then it simply repositions it.
*/
private _showPanel() {
// Usually, the only way to show the toolbar is by pressing the block button. It makes it impossible for
// the toolbar to show up when the button is invisible (feature does not make sense for the selection then).
// The toolbar navigation using Alt+F10 does not access the button but shows the panel directly using this method.
// So we need to check whether this is possible first.
if ( !this.buttonView.isVisible ) {
return;
}
const wasVisible = this.panelView.isVisible;
// So here's the thing: If there was no initial panelView#show() or these two were in different order, the toolbar
// positioning will break in RTL editors. Weird, right? What you show know is that the toolbar
// grouping works thanks to:
//
// * the ResizeObserver, which kicks in as soon as the toolbar shows up in DOM (becomes visible again).
// * the observable ToolbarView#maxWidth, which triggers re-grouping when changed.
//
// Here are the possible scenarios:
//
// 1. (WRONG ❌) If the #maxWidth is set when the toolbar is invisible, it won't affect item grouping (no DOMRects, no grouping).
// Then, when panelView.pin() is called, the position of the toolbar will be calculated for the old
// items grouping state, and when finally ResizeObserver kicks in (hey, the toolbar is visible now, right?)
// it will group/ungroup some items and the length of the toolbar will change. But since in RTL the toolbar
// is attached on the right side and the positioning uses CSS "left", it will result in the toolbar shifting
// to the left and being displayed in the wrong place.
// 2. (WRONG ❌) If the panelView.pin() is called first and #maxWidth set next, then basically the story repeats. The balloon
// calculates the position for the old toolbar grouping state, then the toolbar re-groups items and because
// it is positioned using CSS "left" it will move.
// 3. (RIGHT ✅) We show the panel first (the toolbar does re-grouping but it does not matter), then the #maxWidth
// is set allowing the toolbar to re-group again and finally panelView.pin() does the positioning when the
// items grouping state is stable and final.
//
// https://github.com/ckeditor/ckeditor5/issues/6449, https://github.com/ckeditor/ckeditor5/issues/6575
this.panelView.show();
const editableElement = this._getSelectedEditableElement();
this.toolbarView.maxWidth = this._getToolbarMaxWidth( editableElement );
this.panelView.pin( {
target: this.buttonView.element!,
limiter: editableElement
} );
if ( !wasVisible ) {
( this.toolbarView.items.get( 0 ) as any ).focus();
}
}
/**
* Returns currently selected editable, based on the model selection.
*/
private _getSelectedEditableElement(): HTMLElement {
const selectedModelRootName = this.editor.model.document.selection.getFirstRange()!.root.rootName!;
return this.editor.ui.getEditableElement( selectedModelRootName )!;
}
/**
* Hides the {@link #toolbarView}.
*
* @param focusEditable When `true`, the editable will be focused after hiding the panel.
*/
private _hidePanel( focusEditable?: boolean ) {
this.panelView.isVisible = false;
if ( focusEditable ) {
this.editor.editing.view.focus();
}
}
/**
* Attaches the {@link #buttonView} to the target block of content.
*
* @param targetElement Target element.
*/
private _attachButtonToElement( targetElement: HTMLElement ) {
const contentStyles = window.getComputedStyle( targetElement );
const editableRect = new Rect( this._getSelectedEditableElement() );
const contentPaddingTop = parseInt( contentStyles.paddingTop, 10 );
// When line height is not an integer then treat it as "normal".
// MDN says that 'normal' == ~1.2 on desktop browsers.
const contentLineHeight = parseInt( contentStyles.lineHeight, 10 ) || parseInt( contentStyles.fontSize, 10 ) * 1.2;
const buttonRect = new Rect( this.buttonView.element! );
const contentRect = new Rect( targetElement );
let positionLeft;
if ( this.editor.locale.uiLanguageDirection === 'ltr' ) {
positionLeft = editableRect.left - buttonRect.width;
} else {
positionLeft = editableRect.right;
}
const positionTop = contentRect.top + contentPaddingTop + ( contentLineHeight - buttonRect.height ) / 2;
buttonRect.moveTo( positionLeft, positionTop );
const absoluteButtonRect = buttonRect.toAbsoluteRect();
this.buttonView.top = absoluteButtonRect.top;
this.buttonView.left = absoluteButtonRect.left;
}
/**
* Creates a resize observer that observes selected editable and resizes the toolbar panel accordingly.
*/
private _setupToolbarResize() {
const editableElement = this._getSelectedEditableElement();
// Do this only if the automatic grouping is turned on.
if ( !this._blockToolbarConfig.shouldNotGroupWhenFull ) {
// If resize observer is attached to a different editable than currently selected editable, re-attach it.
if ( this._resizeObserver && this._resizeObserver.element !== editableElement ) {
this._resizeObserver.destroy();
this._resizeObserver = null;
}
if ( !this._resizeObserver ) {
this._resizeObserver = new ResizeObserver( editableElement, () => {
this.toolbarView.maxWidth = this._getToolbarMaxWidth( editableElement );
} );
}
}
}
/**
* Gets the {@link #toolbarView} max-width, based on given `editableElement` width plus the distance between the farthest
* edge of the {@link #buttonView} and the editable.
*
* @returns A maximum width that toolbar can have, in pixels.
*/
private _getToolbarMaxWidth( editableElement: HTMLElement ) {
const editableRect = new Rect( editableElement );
const buttonRect = new Rect( this.buttonView.element! );
const isRTL = this.editor.locale.uiLanguageDirection === 'rtl';
const offset = isRTL ? ( buttonRect.left - editableRect.right ) + buttonRect.width : editableRect.left - buttonRect.left;
return toPx( editableRect.width + offset );
}
}