-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
/
utils.ts
751 lines (670 loc) · 25.9 KB
/
utils.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
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
/**
* @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/dropdown/utils
*/
import DropdownPanelView from './dropdownpanelview.js';
import DropdownView from './dropdownview.js';
import DropdownButtonView from './button/dropdownbuttonview.js';
import DropdownMenuRootListView from './menu/dropdownmenurootlistview.js';
import ToolbarView from '../toolbar/toolbarview.js';
import ListView from '../list/listview.js';
import ListItemView from '../list/listitemview.js';
import ListSeparatorView from '../list/listseparatorview.js';
import SplitButtonView from './button/splitbuttonview.js';
import SwitchButtonView from '../button/switchbuttonview.js';
import ViewCollection from '../viewcollection.js';
import clickOutsideHandler from '../bindings/clickoutsidehandler.js';
import type { default as View } from '../view.js';
import type { ButtonExecuteEvent } from '../button/button.js';
import type Model from '../model.js';
import type DropdownButton from './button/dropdownbutton.js';
import type ButtonView from '../button/buttonview.js';
import type { FocusableView } from '../focuscycler.js';
import type { FalsyValue } from '../template.js';
import type BodyCollection from '../editorui/bodycollection.js';
import {
global,
priorities,
logWarning,
type Collection,
type Locale,
type ObservableChangeEvent
} from '@ckeditor/ckeditor5-utils';
import '../../theme/components/dropdown/toolbardropdown.css';
import '../../theme/components/dropdown/listdropdown.css';
import ListItemGroupView from '../list/listitemgroupview.js';
import ListItemButtonView from '../button/listitembuttonview.js';
import type { DropdownMenuDefinition } from './menu/utils.js';
/**
* A helper for creating dropdowns. It creates an instance of a {@link module:ui/dropdown/dropdownview~DropdownView dropdown},
* with a {@link module:ui/dropdown/button/dropdownbutton~DropdownButton button},
* {@link module:ui/dropdown/dropdownpanelview~DropdownPanelView panel} and all standard dropdown's behaviors.
*
* # Creating dropdowns
*
* By default, the default {@link module:ui/dropdown/button/dropdownbuttonview~DropdownButtonView} class is used as
* definition of the button:
*
* ```ts
* const dropdown = createDropdown( model );
*
* // Configure dropdown's button properties:
* dropdown.buttonView.set( {
* label: 'A dropdown',
* withText: true
* } );
*
* dropdown.render();
*
* // Will render a dropdown labeled "A dropdown" with an empty panel.
* document.body.appendChild( dropdown.element );
* ```
*
* You can also provide other button views (they need to implement the
* {@link module:ui/dropdown/button/dropdownbutton~DropdownButton} interface). For instance, you can use
* {@link module:ui/dropdown/button/splitbuttonview~SplitButtonView} to create a dropdown with a split button.
*
* ```ts
* const dropdown = createDropdown( locale, SplitButtonView );
*
* // Configure dropdown's button properties:
* dropdown.buttonView.set( {
* label: 'A dropdown',
* withText: true
* } );
*
* dropdown.buttonView.on( 'execute', () => {
* // Add the behavior of the "action part" of the split button.
* // Split button consists of the "action part" and "arrow part".
* // The arrow opens the dropdown while the action part can have some other behavior.
* } );
*
* dropdown.render();
*
* // Will render a dropdown labeled "A dropdown" with an empty panel.
* document.body.appendChild( dropdown.element );
* ```
*
* # Adding content to the dropdown's panel
*
* The content of the panel can be inserted directly into the `dropdown.panelView.element`:
*
* ```ts
* dropdown.panelView.element.textContent = 'Content of the panel';
* ```
*
* However, most of the time you will want to add there either a {@link module:ui/list/listview~ListView list of options}
* or a list of buttons (i.e. a {@link module:ui/toolbar/toolbarview~ToolbarView toolbar}).
* To simplify the task, you can use, respectively, {@link module:ui/dropdown/utils~addListToDropdown} or
* {@link module:ui/dropdown/utils~addToolbarToDropdown} utils.
*
* @param locale The locale instance.
* @param ButtonClassOrInstance The dropdown button view class. Needs to implement the
* @param behaviorOptions Attributes for the default behavior of the dropdown.
*
* {@link module:ui/dropdown/button/dropdownbutton~DropdownButton} interface.
* @returns The dropdown view instance.
*/
export function createDropdown(
locale: Locale | undefined,
ButtonClassOrInstance:
( new ( locale?: Locale ) => DropdownButton & FocusableView ) | DropdownButton & FocusableView = DropdownButtonView
): DropdownView {
const buttonView = typeof ButtonClassOrInstance == 'function' ? new ButtonClassOrInstance( locale ) : ButtonClassOrInstance;
const panelView = new DropdownPanelView( locale );
const dropdownView = new DropdownView( locale, buttonView, panelView );
buttonView.bind( 'isEnabled' ).to( dropdownView );
if ( buttonView instanceof SplitButtonView ) {
buttonView.arrowView.bind( 'isOn' ).to( dropdownView, 'isOpen' );
} else {
buttonView.bind( 'isOn' ).to( dropdownView, 'isOpen' );
}
addDefaultBehaviors( dropdownView );
return dropdownView;
}
/**
* Adds a menu UI component to a dropdown and sets all common behaviors and interactions between the dropdown and the menu.
*
* Use this helper to create multi-level dropdown menus that are displayed in a toolbar.
*
* Internally, it creates an instance of {@link module:ui/dropdown/menu/dropdownmenurootlistview~DropdownMenuRootListView}.
*
* Example:
*
* ```ts
* const definitions = [
* {
* id: 'menu_1',
* menu: 'Menu 1',
* children: [
* {
* id: 'menu_1_a',
* label: 'Item A'
* },
* {
* id: 'menu_1_b',
* label: 'Item B'
* }
* ]
* },
* {
* id: 'top_a',
* label: 'Top Item A'
* },
* {
* id: 'top_b',
* label: 'Top Item B'
* }
* ];
*
* const dropdownView = createDropdown( editor.locale );
*
* addMenuToDropdown( dropdownView, editor.ui.view.body, definitions );
* ```
*
* After using this helper, the `dropdown` will fire {@link module:ui/dropdown/dropdownview~DropdownViewEvent `execute`} event when
* a nested menu button is pressed.
*
* The helper will make sure that the `dropdownMenuRootListView` is lazy loaded, i.e., the menu component structure will be initialized
* and rendered only after the `dropdown` is opened for the first time.
*
* @param dropdownView A dropdown instance to which the menu component will be added.
* @param body Body collection to which floating menu panels will be added.
* @param definition The menu component definition.
* @param options.ariaLabel Label used by assistive technologies to describe the top-level menu.
*/
export function addMenuToDropdown(
dropdownView: DropdownView,
body: BodyCollection,
definition: DropdownMenuDefinition,
options: {
ariaLabel?: string;
} = {} ): void {
dropdownView.menuView = new DropdownMenuRootListView( dropdownView.locale!, body, definition );
if ( dropdownView.isOpen ) {
addMenuToOpenDropdown( dropdownView, options );
} else {
// Load the UI elements only after the dropdown is opened for the first time - lazy loading.
dropdownView.once( 'change:isOpen', () => {
addMenuToOpenDropdown( dropdownView, options );
}, { priority: 'highest' } );
}
}
function addMenuToOpenDropdown(
dropdownView: DropdownView,
options: {
ariaLabel?: string;
}
): void {
const dropdownMenuRootListView = dropdownView.menuView!;
const t = dropdownView.locale!.t;
dropdownMenuRootListView.delegate( 'menu:execute' ).to( dropdownView, 'execute' );
dropdownMenuRootListView.listenTo( dropdownView, 'change:isOpen', ( evt, name, isOpen ) => {
if ( !isOpen ) {
dropdownMenuRootListView.closeMenus();
}
}, { priority: 'low' } ); // Make sure this is fired after `focusDropdownButtonOnClose` behavior.
// When `dropdownMenuRootListView` is added as a `panelView` child, it becomes rendered (`panelView` is rendered at this point).
dropdownView.panelView.children.add( dropdownMenuRootListView );
// Nested menu panels are added to body collection, so they are not children of the `dropdownView` from DOM perspective.
// Add these panels to `dropdownView` focus tracker, so they are treated like part of the `dropdownView` for focus-related purposes.
for ( const menu of dropdownMenuRootListView.menus ) {
dropdownView.focusTracker.add( menu.panelView.element! );
}
dropdownMenuRootListView.ariaLabel = options.ariaLabel || t( 'Dropdown menu' );
}
/**
* Adds an instance of {@link module:ui/toolbar/toolbarview~ToolbarView} to a dropdown.
*
* ```ts
* const buttonsCreator = () => {
* const buttons = [];
*
* // Either create a new ButtonView instance or create existing.
* buttons.push( new ButtonView() );
* buttons.push( editor.ui.componentFactory.create( 'someButton' ) );
* };
*
* const dropdown = createDropdown( locale );
*
* addToolbarToDropdown( dropdown, buttonsCreator, { isVertical: true } );
*
* // Will render a vertical button dropdown labeled "A button dropdown"
* // with a button group in the panel containing two buttons.
* // Buttons inside the dropdown will be created on first dropdown panel open.
* dropdown.render()
* document.body.appendChild( dropdown.element );
* ```
*
* **Note:** To improve the accessibility, you can tell the dropdown to focus the first active button of the toolbar when the dropdown
* {@link module:ui/dropdown/dropdownview~DropdownView#isOpen gets open}. See the documentation of `options` to learn more.
*
* **Note:** Toolbar view will be created on first open of the dropdown.
*
* See {@link module:ui/dropdown/utils~createDropdown} and {@link module:ui/toolbar/toolbarview~ToolbarView}.
*
* @param dropdownView A dropdown instance to which `ToolbarView` will be added.
* @param options.enableActiveItemFocusOnDropdownOpen When set `true`, the focus will automatically move to the first
* active {@link module:ui/toolbar/toolbarview~ToolbarView#items item} of the toolbar upon
* {@link module:ui/dropdown/dropdownview~DropdownView#isOpen opening} the dropdown. Active items are those with the `isOn` property set
* `true` (for instance {@link module:ui/button/buttonview~ButtonView buttons}). If no active items is found, the toolbar will be focused
* as a whole resulting in the focus moving to its first focusable item (default behavior of
* {@link module:ui/dropdown/dropdownview~DropdownView}).
* @param options.ariaLabel Label used by assistive technologies to describe toolbar element.
* @param options.maxWidth The maximum width of the toolbar element.
* Details: {@link module:ui/toolbar/toolbarview~ToolbarView#maxWidth}.
* @param options.class An additional CSS class added to the toolbar element.
* @param options.isCompact When set true, makes the toolbar look compact with toolbar element.
* @param options.isVertical Controls the orientation of toolbar items.
*/
export function addToolbarToDropdown(
dropdownView: DropdownView,
buttonsOrCallback: Array<View> | ViewCollection | ( () => Array<View> | ViewCollection ),
options: {
enableActiveItemFocusOnDropdownOpen?: boolean;
ariaLabel?: string;
maxWidth?: string;
class?: string;
isCompact?: boolean;
isVertical?: boolean;
} = {}
): void {
dropdownView.extendTemplate( {
attributes: {
class: [ 'ck-toolbar-dropdown' ]
}
} );
if ( dropdownView.isOpen ) {
addToolbarToOpenDropdown( dropdownView, buttonsOrCallback, options );
} else {
dropdownView.once(
'change:isOpen',
() => addToolbarToOpenDropdown( dropdownView, buttonsOrCallback, options ),
{ priority: 'highest' }
);
}
if ( options.enableActiveItemFocusOnDropdownOpen ) {
// Accessibility: Focus the first active button in the toolbar when the dropdown gets open.
focusChildOnDropdownOpen( dropdownView, () => dropdownView.toolbarView!.items.find( ( item: any ) => item.isOn ) );
}
}
/**
* Adds an instance of {@link module:ui/toolbar/toolbarview~ToolbarView} to a dropdown.
*/
function addToolbarToOpenDropdown(
dropdownView: DropdownView,
buttonsOrCallback: Array<View> | ViewCollection | ( () => Array<View> | ViewCollection ),
options: {
ariaLabel?: string;
maxWidth?: string;
class?: string;
isCompact?: boolean;
isVertical?: boolean;
}
): void {
const locale = dropdownView.locale!;
const t = locale.t;
const toolbarView = dropdownView.toolbarView = new ToolbarView( locale );
const buttons = typeof buttonsOrCallback == 'function' ? buttonsOrCallback() : buttonsOrCallback;
toolbarView.ariaLabel = options.ariaLabel || t( 'Dropdown toolbar' );
if ( options.maxWidth ) {
toolbarView.maxWidth = options.maxWidth;
}
if ( options.class ) {
toolbarView.class = options.class;
}
if ( options.isCompact ) {
toolbarView.isCompact = options.isCompact;
}
if ( options.isVertical ) {
toolbarView.isVertical = true;
}
if ( buttons instanceof ViewCollection ) {
toolbarView.items.bindTo( buttons ).using( item => item );
} else {
toolbarView.items.addMany( buttons );
}
dropdownView.panelView.children.add( toolbarView );
toolbarView.items.delegate( 'execute' ).to( dropdownView );
}
/**
* Adds an instance of {@link module:ui/list/listview~ListView} to a dropdown.
*
* ```ts
* const items = new Collection<ListDropdownItemDefinition>();
*
* items.add( {
* type: 'button',
* model: new Model( {
* withText: true,
* label: 'First item',
* labelStyle: 'color: red'
* } )
* } );
*
* items.add( {
* type: 'button',
* model: new Model( {
* withText: true,
* label: 'Second item',
* labelStyle: 'color: green',
* class: 'foo'
* } )
* } );
*
* const dropdown = createDropdown( locale );
*
* addListToDropdown( dropdown, items );
*
* // Will render a dropdown with a list in the panel containing two items.
* dropdown.render()
* document.body.appendChild( dropdown.element );
* ```
*
* The `items` collection passed to this methods controls the presence and attributes of respective
* {@link module:ui/list/listitemview~ListItemView list items}.
*
* **Note:** To improve the accessibility, when a list is added to the dropdown using this helper the dropdown will automatically attempt
* to focus the first active item (a host to a {@link module:ui/button/buttonview~ButtonView} with
* {@link module:ui/button/buttonview~ButtonView#isOn} set `true`) or the very first item when none are active.
*
* **Note:** List view will be created on first open of the dropdown.
*
* See {@link module:ui/dropdown/utils~createDropdown} and {@link module:list/list~List}.
*
* @param dropdownView A dropdown instance to which `ListVIew` will be added.
* @param itemsOrCallback A collection of the list item definitions or a callback returning a list item definitions to populate the list.
* @param options.ariaLabel Label used by assistive technologies to describe list element.
* @param options.role Will be reflected by the `role` DOM attribute in `ListVIew` and used by assistive technologies.
*/
export function addListToDropdown(
dropdownView: DropdownView,
itemsOrCallback: Collection<ListDropdownItemDefinition> | ( () => Collection<ListDropdownItemDefinition> ),
options: {
ariaLabel?: string;
role?: string;
} = {}
): void {
if ( dropdownView.isOpen ) {
addListToOpenDropdown( dropdownView, itemsOrCallback, options );
} else {
dropdownView.once(
'change:isOpen',
() => addListToOpenDropdown( dropdownView, itemsOrCallback, options ),
{ priority: 'highest' }
);
}
// Accessibility: Focus the first active button in the list when the dropdown gets open.
focusChildOnDropdownOpen( dropdownView, () => dropdownView.listView!.items.find( item => {
if ( item instanceof ListItemView ) {
return ( item.children.first as any ).isOn;
}
return false;
} ) );
}
/**
* Adds an instance of {@link module:ui/list/listview~ListView} to a dropdown.
*/
function addListToOpenDropdown(
dropdownView: DropdownView,
itemsOrCallback: Collection<ListDropdownItemDefinition> | ( () => Collection<ListDropdownItemDefinition> ),
options: {
ariaLabel?: string;
role?: string;
}
): void {
const locale = dropdownView.locale!;
const listView = dropdownView.listView = new ListView( locale );
const items = typeof itemsOrCallback == 'function' ? itemsOrCallback() : itemsOrCallback;
listView.ariaLabel = options.ariaLabel;
listView.role = options.role;
bindViewCollectionItemsToDefinitions( dropdownView, listView.items, items, locale );
dropdownView.panelView.children.add( listView );
listView.items.delegate( 'execute' ).to( dropdownView );
}
/**
* A helper to be used on an existing {@link module:ui/dropdown/dropdownview~DropdownView} that focuses
* a specific child in DOM when the dropdown {@link module:ui/dropdown/dropdownview~DropdownView#isOpen gets open}.
*
* @param dropdownView A dropdown instance to which the focus behavior will be added.
* @param childSelectorCallback A callback executed when the dropdown gets open. It should return a {@link module:ui/view~View}
* instance (child of {@link module:ui/dropdown/dropdownview~DropdownView#panelView}) that will get focused or a falsy value.
* If falsy value is returned, a default behavior of the dropdown will engage focusing the first focusable child in
* the {@link module:ui/dropdown/dropdownview~DropdownView#panelView}.
*/
export function focusChildOnDropdownOpen(
dropdownView: DropdownView,
childSelectorCallback: () => View | FalsyValue
): void {
dropdownView.on<ObservableChangeEvent>( 'change:isOpen', () => {
if ( !dropdownView.isOpen ) {
return;
}
const childToFocus: ( View & { focus?: () => void } ) | FalsyValue = childSelectorCallback();
if ( !childToFocus ) {
return;
}
if ( typeof childToFocus.focus === 'function' ) {
childToFocus.focus();
} else {
/**
* The child view of a {@link module:ui/dropdown/dropdownview~DropdownView dropdown} is missing the `focus()` method
* and could not be focused when the dropdown got {@link module:ui/dropdown/dropdownview~DropdownView#isOpen open}.
*
* Making the content of a dropdown focusable in this case greatly improves the accessibility. Please make the view instance
* implements the {@link module:ui/dropdown/dropdownpanelfocusable~DropdownPanelFocusable focusable interface} for the best user
* experience.
*
* @error ui-dropdown-focus-child-on-open-child-missing-focus
* @param {module:ui/view~View} view
*/
logWarning( 'ui-dropdown-focus-child-on-open-child-missing-focus', { view: childToFocus } );
}
// * Let the panel show up first (do not focus an invisible element).
// * Execute after focusDropdownPanelOnOpen(). See focusDropdownPanelOnOpen() to learn more.
}, { priority: priorities.low - 10 } );
}
/**
* Add a set of default behaviors to dropdown view.
*/
function addDefaultBehaviors( dropdownView: DropdownView ) {
closeDropdownOnClickOutside( dropdownView );
closeDropdownOnExecute( dropdownView );
closeDropdownOnBlur( dropdownView );
focusDropdownContentsOnArrows( dropdownView );
focusDropdownButtonOnClose( dropdownView );
focusDropdownPanelOnOpen( dropdownView );
}
/**
* Adds a behavior to a dropdownView that closes opened dropdown when user clicks outside the dropdown.
*/
function closeDropdownOnClickOutside( dropdownView: DropdownView ) {
clickOutsideHandler( {
emitter: dropdownView,
activator: () => dropdownView.isRendered && dropdownView.isOpen,
callback: () => {
dropdownView.isOpen = false;
},
contextElements: () => [
dropdownView.element!,
...dropdownView.focusTracker.elements
]
} );
}
/**
* Adds a behavior to a dropdownView that closes the dropdown view on "execute" event.
*/
function closeDropdownOnExecute( dropdownView: DropdownView ) {
// Close the dropdown when one of the list items has been executed.
dropdownView.on<ButtonExecuteEvent>( 'execute', evt => {
// Toggling a switch button view should not close the dropdown.
if ( evt.source instanceof SwitchButtonView ) {
return;
}
dropdownView.isOpen = false;
} );
}
/**
* Adds a behavior to a dropdown view that closes opened dropdown when it loses focus.
*/
function closeDropdownOnBlur( dropdownView: DropdownView ) {
dropdownView.focusTracker.on<ObservableChangeEvent<boolean>>( 'change:isFocused', ( evt, name, isFocused ) => {
if ( isFocused || !dropdownView.isOpen ) {
return;
}
dropdownView.isOpen = false;
} );
}
/**
* Adds a behavior to a dropdownView that focuses the dropdown's panel view contents on keystrokes.
*/
function focusDropdownContentsOnArrows( dropdownView: DropdownView ) {
// If the dropdown panel is already open, the arrow down key should focus the first child of the #panelView.
dropdownView.keystrokes.set( 'arrowdown', ( data, cancel ) => {
if ( dropdownView.isOpen ) {
dropdownView.panelView.focus();
cancel();
}
} );
// If the dropdown panel is already open, the arrow up key should focus the last child of the #panelView.
dropdownView.keystrokes.set( 'arrowup', ( data, cancel ) => {
if ( dropdownView.isOpen ) {
dropdownView.panelView.focusLast();
cancel();
}
} );
}
/**
* Adds a behavior that focuses the #buttonView when the dropdown was closed but focus was within the #panelView element.
* This makes sure the focus is never lost.
*/
function focusDropdownButtonOnClose( dropdownView: DropdownView ) {
dropdownView.on<ObservableChangeEvent<boolean>>( 'change:isOpen', ( evt, name, isOpen ) => {
if ( isOpen ) {
return;
}
const elements = dropdownView.focusTracker.elements;
// If the dropdown was closed, move the focus back to the button (#12125).
// Don't touch the focus, if it moved somewhere else (e.g. moved to the editing root on #execute) (#12178).
// Note: Don't use the state of the DropdownView#focusTracker here. It fires #blur with the timeout.
if ( elements.some( element => element.contains( global.document.activeElement ) ) ) {
dropdownView.buttonView.focus();
}
} );
}
/**
* Adds a behavior that focuses the #panelView when dropdown gets open (accessibility).
*/
function focusDropdownPanelOnOpen( dropdownView: DropdownView ) {
dropdownView.on<ObservableChangeEvent<boolean>>( 'change:isOpen', ( evt, name, isOpen ) => {
if ( !isOpen ) {
return;
}
// Focus the first item in the dropdown when the dropdown opened.
dropdownView.panelView.focus();
// * Let the panel show up first (do not focus an invisible element).
// * Also, execute before focusChildOnDropdownOpen() to make sure this helper does not break the
// focus of a specific child by kicking in too late and resetting the focus in the panel.
}, { priority: 'low' } );
}
/**
* This helper populates a dropdown list with items and groups according to the
* collection of item definitions. A permanent binding is created in this process allowing
* dynamic management of the dropdown list content.
*
* @param dropdownView
* @param listItems
* @param definitions
* @param locale
*/
function bindViewCollectionItemsToDefinitions(
dropdownView: DropdownView,
listItems: ViewCollection,
definitions: Collection<ListDropdownItemDefinition>,
locale: Locale
) {
// List item checkboxes have a reserved space for the check icon, so we need to know if there are any checkboxes in the list
// to adjust the layout accordingly. It'd look weird if the items on the list were not aligned horizontally.
//
// Possible theoretical performance problem if many items are added one by one, as this will be called for each item.
listItems.on( 'change', () => {
// Filter-map. Check all items, leave only these that have buttons and return the buttons.
const listItemButtons = [ ...listItems ].reduce<Array<ListItemButtonView>>( ( acc, item ) => {
if ( item instanceof ListItemView && item.children.first instanceof ListItemButtonView ) {
acc.push( item.children.first );
}
return acc;
}, [] );
const hasAnyCheckboxOnList = listItemButtons.some( button => button.isToggleable );
listItemButtons.forEach( item => {
item.hasCheckSpace = hasAnyCheckboxOnList;
} );
} );
listItems.bindTo( definitions ).using( def => {
if ( def.type === 'separator' ) {
return new ListSeparatorView( locale );
} else if ( def.type === 'group' ) {
const groupView = new ListItemGroupView( locale );
groupView.set( { label: def.label } );
bindViewCollectionItemsToDefinitions( dropdownView, groupView.items, def.items, locale );
groupView.items.delegate( 'execute' ).to( dropdownView );
return groupView;
} else if ( def.type === 'button' || def.type === 'switchbutton' ) {
const isToggleable = def.model.role === 'menuitemcheckbox' || def.model.role === 'menuitemradio';
const listItemView = new ListItemView( locale );
let buttonView: ButtonView;
if ( def.type === 'button' ) {
buttonView = new ListItemButtonView( locale );
buttonView.set( {
isToggleable
} );
} else {
buttonView = new SwitchButtonView( locale );
}
// Bind all model properties to the button view.
buttonView.bind( ...Object.keys( def.model ) as Array<keyof ButtonView> ).to( def.model );
buttonView.delegate( 'execute' ).to( listItemView );
listItemView.children.add( buttonView );
return listItemView;
}
return null;
} );
}
/**
* A definition of the list item used by the {@link module:ui/dropdown/utils~addListToDropdown}
* utility.
*/
export type ListDropdownItemDefinition = ListDropdownSeparatorDefinition | ListDropdownButtonDefinition | ListDropdownGroupDefinition;
/**
* A definition of the 'separator' list item.
*/
export type ListDropdownSeparatorDefinition = {
type: 'separator';
};
/**
* A definition of the 'button' or 'switchbutton' list item.
*/
export type ListDropdownButtonDefinition = {
type: 'button' | 'switchbutton';
/**
* Model of the item. Its properties fuel the newly created list item (or its children, depending on the `type`).
*/
model: Model;
};
/**
* A definition of the group inside the list. A group can contain one or more list items (buttons).
*/
export type ListDropdownGroupDefinition = {
type: 'group';
/**
* The visible label of the group.
*/
label: string;
/**
* The collection of the child list items inside this group.
*/
items: Collection<ListDropdownButtonDefinition>;
};