@ckeditor/ckeditor5-ui 41.2.0 → 41.3.0-alpha.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 (98) hide show
  1. package/dist/content-index.css +4 -0
  2. package/dist/editor-index.css +451 -0
  3. package/dist/index.css +856 -0
  4. package/dist/index.css.map +1 -0
  5. package/dist/index.js +13857 -0
  6. package/dist/index.js.map +1 -0
  7. package/dist/types/arialiveannouncer.d.ts +98 -0
  8. package/dist/types/augmentation.d.ts +88 -0
  9. package/dist/types/autocomplete/autocompleteview.d.ts +81 -0
  10. package/dist/types/bindings/addkeyboardhandlingforgrid.d.ts +27 -0
  11. package/dist/types/bindings/clickoutsidehandler.d.ts +28 -0
  12. package/dist/types/bindings/csstransitiondisablermixin.d.ts +40 -0
  13. package/dist/types/bindings/draggableviewmixin.d.ts +46 -0
  14. package/dist/types/bindings/injectcsstransitiondisabler.d.ts +59 -0
  15. package/dist/types/bindings/preventdefault.d.ts +33 -0
  16. package/dist/types/bindings/submithandler.d.ts +57 -0
  17. package/dist/types/button/button.d.ts +175 -0
  18. package/dist/types/button/buttonlabel.d.ts +34 -0
  19. package/dist/types/button/buttonlabelview.d.ts +31 -0
  20. package/dist/types/button/buttonview.d.ts +181 -0
  21. package/dist/types/button/switchbuttonview.d.ts +45 -0
  22. package/dist/types/collapsible/collapsibleview.d.ts +70 -0
  23. package/dist/types/colorgrid/colorgridview.d.ts +132 -0
  24. package/dist/types/colorgrid/colortileview.d.ts +28 -0
  25. package/dist/types/colorgrid/utils.d.ts +47 -0
  26. package/dist/types/colorpicker/colorpickerview.d.ts +142 -0
  27. package/dist/types/colorpicker/utils.d.ts +48 -0
  28. package/dist/types/colorselector/colorgridsfragmentview.d.ts +195 -0
  29. package/dist/types/colorselector/colorpickerfragmentview.d.ts +129 -0
  30. package/dist/types/colorselector/colorselectorview.d.ts +242 -0
  31. package/dist/types/colorselector/documentcolorcollection.d.ts +70 -0
  32. package/dist/types/componentfactory.d.ts +81 -0
  33. package/dist/types/dialog/dialog.d.ts +273 -0
  34. package/dist/types/dialog/dialogactionsview.d.ts +69 -0
  35. package/dist/types/dialog/dialogcontentview.d.ts +27 -0
  36. package/dist/types/dialog/dialogview.d.ts +256 -0
  37. package/dist/types/dropdown/button/dropdownbutton.d.ts +25 -0
  38. package/dist/types/dropdown/button/dropdownbuttonview.d.ts +48 -0
  39. package/dist/types/dropdown/button/splitbuttonview.d.ts +162 -0
  40. package/dist/types/dropdown/dropdownpanelfocusable.d.ts +21 -0
  41. package/dist/types/dropdown/dropdownpanelview.d.ts +62 -0
  42. package/dist/types/dropdown/dropdownview.d.ts +315 -0
  43. package/dist/types/dropdown/utils.d.ts +235 -0
  44. package/dist/types/editableui/editableuiview.d.ts +72 -0
  45. package/dist/types/editableui/inline/inlineeditableuiview.d.ts +40 -0
  46. package/dist/types/editorui/accessibilityhelp/accessibilityhelp.d.ts +47 -0
  47. package/dist/types/editorui/accessibilityhelp/accessibilityhelpcontentview.d.ts +35 -0
  48. package/dist/types/editorui/bodycollection.d.ts +55 -0
  49. package/dist/types/editorui/boxed/boxededitoruiview.d.ts +40 -0
  50. package/dist/types/editorui/editorui.d.ts +288 -0
  51. package/dist/types/editorui/editoruiview.d.ts +39 -0
  52. package/dist/types/editorui/poweredby.d.ts +71 -0
  53. package/dist/types/focuscycler.d.ts +245 -0
  54. package/dist/types/formheader/formheaderview.d.ts +59 -0
  55. package/dist/types/highlightedtext/highlightedtextview.d.ts +38 -0
  56. package/dist/types/icon/iconview.d.ts +88 -0
  57. package/dist/types/iframe/iframeview.d.ts +50 -0
  58. package/dist/types/index.d.ts +74 -0
  59. package/dist/types/input/inputbase.d.ts +107 -0
  60. package/dist/types/input/inputview.d.ts +36 -0
  61. package/dist/types/inputnumber/inputnumberview.d.ts +49 -0
  62. package/dist/types/inputtext/inputtextview.d.ts +18 -0
  63. package/dist/types/label/labelview.d.ts +36 -0
  64. package/dist/types/labeledfield/labeledfieldview.d.ts +187 -0
  65. package/dist/types/labeledfield/utils.d.ts +123 -0
  66. package/dist/types/labeledinput/labeledinputview.d.ts +125 -0
  67. package/dist/types/list/listitemgroupview.d.ts +59 -0
  68. package/dist/types/list/listitemview.d.ts +36 -0
  69. package/dist/types/list/listseparatorview.d.ts +18 -0
  70. package/dist/types/list/listview.d.ts +124 -0
  71. package/dist/types/model.d.ts +22 -0
  72. package/dist/types/notification/notification.d.ts +211 -0
  73. package/dist/types/panel/balloon/balloonpanelview.d.ts +685 -0
  74. package/dist/types/panel/balloon/contextualballoon.d.ts +299 -0
  75. package/dist/types/panel/sticky/stickypanelview.d.ts +156 -0
  76. package/dist/types/search/filteredview.d.ts +31 -0
  77. package/dist/types/search/searchinfoview.d.ts +45 -0
  78. package/dist/types/search/searchresultsview.d.ts +54 -0
  79. package/dist/types/search/text/searchtextqueryview.d.ts +76 -0
  80. package/dist/types/search/text/searchtextview.d.ts +219 -0
  81. package/dist/types/spinner/spinnerview.d.ts +25 -0
  82. package/dist/types/template.d.ts +942 -0
  83. package/dist/types/textarea/textareaview.d.ts +104 -0
  84. package/dist/types/toolbar/balloon/balloontoolbar.d.ts +117 -0
  85. package/dist/types/toolbar/block/blockbuttonview.d.ts +35 -0
  86. package/dist/types/toolbar/block/blocktoolbar.d.ts +153 -0
  87. package/dist/types/toolbar/normalizetoolbarconfig.d.ts +40 -0
  88. package/dist/types/toolbar/toolbarlinebreakview.d.ts +18 -0
  89. package/dist/types/toolbar/toolbarseparatorview.d.ts +18 -0
  90. package/dist/types/toolbar/toolbarview.d.ts +267 -0
  91. package/dist/types/tooltipmanager.d.ts +184 -0
  92. package/dist/types/view.d.ts +422 -0
  93. package/dist/types/viewcollection.d.ts +139 -0
  94. package/package.json +4 -3
  95. package/src/colorpicker/colorpickerview.js +0 -1
  96. package/src/index.d.ts +2 -2
  97. package/src/index.js +2 -1
  98. package/src/toolbar/toolbarview.js +2 -3
@@ -0,0 +1,422 @@
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
+ * @module ui/view
7
+ */
8
+ import ViewCollection from './viewcollection.js';
9
+ import Template, { type BindChain, type TemplateDefinition } from './template.js';
10
+ import { Collection, type DecoratedMethodEvent, type Locale, type LocaleTranslate } from '@ckeditor/ckeditor5-utils';
11
+ import '../theme/globals/globals.css';
12
+ declare const View_base: import("@ckeditor/ckeditor5-utils").Mixed<{
13
+ new (): import("@ckeditor/ckeditor5-utils").Observable;
14
+ prototype: import("@ckeditor/ckeditor5-utils").Observable;
15
+ }, import("@ckeditor/ckeditor5-utils").DomEmitter>;
16
+ /**
17
+ * The basic view class, which represents an HTML element created out of a
18
+ * {@link module:ui/view~View#template}. Views are building blocks of the user interface and handle
19
+ * interaction
20
+ *
21
+ * Views {@link module:ui/view~View#registerChild aggregate} children in
22
+ * {@link module:ui/view~View#createCollection collections} and manage the life cycle of DOM
23
+ * listeners e.g. by handling rendering and destruction.
24
+ *
25
+ * See the {@link module:ui/template~TemplateDefinition} syntax to learn more about shaping view
26
+ * elements, attributes and listeners.
27
+ *
28
+ * ```ts
29
+ * class SampleView extends View {
30
+ * constructor( locale ) {
31
+ * super( locale );
32
+ *
33
+ * const bind = this.bindTemplate;
34
+ *
35
+ * // Views define their interface (state) using observable attributes.
36
+ * this.set( 'elementClass', 'bar' );
37
+ *
38
+ * this.setTemplate( {
39
+ * tag: 'p',
40
+ *
41
+ * // The element of the view can be defined with its children.
42
+ * children: [
43
+ * 'Hello',
44
+ * {
45
+ * tag: 'b',
46
+ * children: [ 'world!' ]
47
+ * }
48
+ * ],
49
+ * attributes: {
50
+ * class: [
51
+ * 'foo',
52
+ *
53
+ * // Observable attributes control the state of the view in DOM.
54
+ * bind.to( 'elementClass' )
55
+ * ]
56
+ * },
57
+ * on: {
58
+ * // Views listen to DOM events and propagate them.
59
+ * click: bind.to( 'clicked' )
60
+ * }
61
+ * } );
62
+ * }
63
+ * }
64
+ *
65
+ * const view = new SampleView( locale );
66
+ *
67
+ * view.render();
68
+ *
69
+ * // Append <p class="foo bar">Hello<b>world</b></p> to the <body>
70
+ * document.body.appendChild( view.element );
71
+ *
72
+ * // Change the class attribute to <p class="foo baz">Hello<b>world</b></p>
73
+ * view.elementClass = 'baz';
74
+ *
75
+ * // Respond to the "click" event in DOM by executing a custom action.
76
+ * view.on( 'clicked', () => {
77
+ * console.log( 'The view has been clicked!' );
78
+ * } );
79
+ * ```
80
+ */
81
+ export default class View<TElement extends HTMLElement = HTMLElement> extends View_base {
82
+ /**
83
+ * An HTML element of the view. `null` until {@link #render rendered}
84
+ * from the {@link #template}.
85
+ *
86
+ * ```ts
87
+ * class SampleView extends View {
88
+ * constructor() {
89
+ * super();
90
+ *
91
+ * // A template instance the #element will be created from.
92
+ * this.setTemplate( {
93
+ * tag: 'p'
94
+ *
95
+ * // ...
96
+ * } );
97
+ * }
98
+ * }
99
+ *
100
+ * const view = new SampleView();
101
+ *
102
+ * // Renders the #template.
103
+ * view.render();
104
+ *
105
+ * // Append the HTML element of the view to <body>.
106
+ * document.body.appendChild( view.element );
107
+ * ```
108
+ *
109
+ * **Note**: The element of the view can also be assigned directly:
110
+ *
111
+ * ```ts
112
+ * view.element = document.querySelector( '#my-container' );
113
+ * ```
114
+ */
115
+ element: TElement | null;
116
+ /**
117
+ * Set `true` when the view has already been {@link module:ui/view~View#render rendered}.
118
+ *
119
+ * @readonly
120
+ */
121
+ isRendered: boolean;
122
+ /**
123
+ * A set of tools to localize the user interface.
124
+ *
125
+ * Also see {@link module:core/editor/editor~Editor#locale}.
126
+ *
127
+ * @readonly
128
+ */
129
+ locale: Locale | undefined;
130
+ /**
131
+ * Shorthand for {@link module:utils/locale~Locale#t}.
132
+ *
133
+ * Note: If {@link #locale} instance hasn't been passed to the view this method may not
134
+ * be available.
135
+ *
136
+ * @see module:utils/locale~Locale#t
137
+ */
138
+ t: LocaleTranslate | undefined;
139
+ /**
140
+ * Template of this view. It provides the {@link #element} representing
141
+ * the view in DOM, which is {@link #render rendered}.
142
+ */
143
+ template?: Template;
144
+ viewUid?: string;
145
+ /**
146
+ * Collections registered with {@link #createCollection}.
147
+ */
148
+ protected _viewCollections: Collection<ViewCollection>;
149
+ /**
150
+ * A collection of view instances, which have been added directly
151
+ * into the {@link module:ui/template~Template#children}.
152
+ */
153
+ protected _unboundChildren: ViewCollection;
154
+ /**
155
+ * Cached {@link module:ui/template~BindChain bind chain} object created by the
156
+ * {@link #template}. See {@link #bindTemplate}.
157
+ */
158
+ private _bindTemplate?;
159
+ /**
160
+ * Creates an instance of the {@link module:ui/view~View} class.
161
+ *
162
+ * Also see {@link #render}.
163
+ *
164
+ * @param locale The localization services instance.
165
+ */
166
+ constructor(locale?: Locale);
167
+ /**
168
+ * Shorthand for {@link module:ui/template~Template.bind}, a binding
169
+ * {@link module:ui/template~BindChain interface} pre–configured for the view instance.
170
+ *
171
+ * It provides {@link module:ui/template~BindChain#to `to()`} and
172
+ * {@link module:ui/template~BindChain#if `if()`} methods that initialize bindings with
173
+ * observable attributes and attach DOM listeners.
174
+ *
175
+ * ```ts
176
+ * class SampleView extends View {
177
+ * constructor( locale ) {
178
+ * super( locale );
179
+ *
180
+ * const bind = this.bindTemplate;
181
+ *
182
+ * // These {@link module:utils/observablemixin~Observable observable} attributes will control
183
+ * // the state of the view in DOM.
184
+ * this.set( {
185
+ * elementClass: 'foo',
186
+ * isEnabled: true
187
+ * } );
188
+ *
189
+ * this.setTemplate( {
190
+ * tag: 'p',
191
+ *
192
+ * attributes: {
193
+ * // The class HTML attribute will follow elementClass
194
+ * // and isEnabled view attributes.
195
+ * class: [
196
+ * bind.to( 'elementClass' )
197
+ * bind.if( 'isEnabled', 'present-when-enabled' )
198
+ * ]
199
+ * },
200
+ *
201
+ * on: {
202
+ * // The view will fire the "clicked" event upon clicking <p> in DOM.
203
+ * click: bind.to( 'clicked' )
204
+ * }
205
+ * } );
206
+ * }
207
+ * }
208
+ * ```
209
+ */
210
+ get bindTemplate(): BindChain<this>;
211
+ /**
212
+ * Creates a new collection of views, which can be used as
213
+ * {@link module:ui/template~Template#children} of this view.
214
+ *
215
+ * ```ts
216
+ * class SampleView extends View {
217
+ * constructor( locale ) {
218
+ * super( locale );
219
+ *
220
+ * const child = new ChildView( locale );
221
+ * this.items = this.createCollection( [ child ] );
222
+ *
223
+ * this.setTemplate( {
224
+ * tag: 'p',
225
+ *
226
+ * // `items` collection will render here.
227
+ * children: this.items
228
+ * } );
229
+ * }
230
+ * }
231
+ *
232
+ * const view = new SampleView( locale );
233
+ * view.render();
234
+ *
235
+ * // It will append <p><child#element></p> to the <body>.
236
+ * document.body.appendChild( view.element );
237
+ * ```
238
+ *
239
+ * @param views Initial views of the collection.
240
+ * @returns A new collection of view instances.
241
+ */
242
+ createCollection<T extends View = View>(views?: Iterable<T>): ViewCollection<T>;
243
+ /**
244
+ * Registers a new child view under the view instance. Once registered, a child
245
+ * view is managed by its parent, including {@link #render rendering}
246
+ * and {@link #destroy destruction}.
247
+ *
248
+ * To revert this, use {@link #deregisterChild}.
249
+ *
250
+ * ```ts
251
+ * class SampleView extends View {
252
+ * constructor( locale ) {
253
+ * super( locale );
254
+ *
255
+ * this.childA = new SomeChildView( locale );
256
+ * this.childB = new SomeChildView( locale );
257
+ *
258
+ * this.setTemplate( { tag: 'p' } );
259
+ *
260
+ * // Register the children.
261
+ * this.registerChild( [ this.childA, this.childB ] );
262
+ * }
263
+ *
264
+ * render() {
265
+ * super.render();
266
+ *
267
+ * this.element.appendChild( this.childA.element );
268
+ * this.element.appendChild( this.childB.element );
269
+ * }
270
+ * }
271
+ *
272
+ * const view = new SampleView( locale );
273
+ *
274
+ * view.render();
275
+ *
276
+ * // Will append <p><childA#element><b></b><childB#element></p>.
277
+ * document.body.appendChild( view.element );
278
+ * ```
279
+ *
280
+ * **Note**: There's no need to add child views if they're already referenced in the
281
+ * {@link #template}:
282
+ *
283
+ * ```ts
284
+ * class SampleView extends View {
285
+ * constructor( locale ) {
286
+ * super( locale );
287
+ *
288
+ * this.childA = new SomeChildView( locale );
289
+ * this.childB = new SomeChildView( locale );
290
+ *
291
+ * this.setTemplate( {
292
+ * tag: 'p',
293
+ *
294
+ * // These children will be added automatically. There's no
295
+ * // need to call {@link #registerChild} for any of them.
296
+ * children: [ this.childA, this.childB ]
297
+ * } );
298
+ * }
299
+ *
300
+ * // ...
301
+ * }
302
+ * ```
303
+ *
304
+ * @param children Children views to be registered.
305
+ */
306
+ registerChild(children: View | Iterable<View>): void;
307
+ /**
308
+ * The opposite of {@link #registerChild}. Removes a child view from this view instance.
309
+ * Once removed, the child is no longer managed by its parent, e.g. it can safely
310
+ * become a child of another parent view.
311
+ *
312
+ * @see #registerChild
313
+ * @param children Child views to be removed.
314
+ */
315
+ deregisterChild(children: View | Iterable<View>): void;
316
+ /**
317
+ * Sets the {@link #template} of the view with with given definition.
318
+ *
319
+ * A shorthand for:
320
+ *
321
+ * ```ts
322
+ * view.setTemplate( definition );
323
+ * ```
324
+ *
325
+ * @param definition Definition of view's template.
326
+ */
327
+ setTemplate(definition: TemplateDefinition): void;
328
+ /**
329
+ * {@link module:ui/template~Template.extend Extends} the {@link #template} of the view with
330
+ * with given definition.
331
+ *
332
+ * A shorthand for:
333
+ *
334
+ * ```ts
335
+ * Template.extend( view.template, definition );
336
+ * ```
337
+ *
338
+ * **Note**: Is requires the {@link #template} to be already set. See {@link #setTemplate}.
339
+ *
340
+ * @param definition Definition which extends the {@link #template}.
341
+ */
342
+ extendTemplate(definition: Partial<TemplateDefinition>): void;
343
+ /**
344
+ * Recursively renders the view.
345
+ *
346
+ * Once the view is rendered:
347
+ * * the {@link #element} becomes an HTML element out of {@link #template},
348
+ * * the {@link #isRendered} flag is set `true`.
349
+ *
350
+ * **Note**: The children of the view:
351
+ * * defined directly in the {@link #template}
352
+ * * residing in collections created by the {@link #createCollection} method,
353
+ * * and added by {@link #registerChild}
354
+ * are also rendered in the process.
355
+ *
356
+ * In general, `render()` method is the right place to keep the code which refers to the
357
+ * {@link #element} and should be executed at the very beginning of the view's life cycle.
358
+ *
359
+ * It is possible to {@link module:ui/template~Template.extend} the {@link #template} before
360
+ * the view is rendered. To allow an early customization of the view (e.g. by its parent),
361
+ * such references should be done in `render()`.
362
+ *
363
+ * ```ts
364
+ * class SampleView extends View {
365
+ * constructor() {
366
+ * this.setTemplate( {
367
+ * // ...
368
+ * } );
369
+ * },
370
+ *
371
+ * render() {
372
+ * // View#element becomes available.
373
+ * super.render();
374
+ *
375
+ * // The "scroll" listener depends on #element.
376
+ * this.listenTo( window, 'scroll', () => {
377
+ * // A reference to #element would render the #template and make it non-extendable.
378
+ * if ( window.scrollY > 0 ) {
379
+ * this.element.scrollLeft = 100;
380
+ * } else {
381
+ * this.element.scrollLeft = 0;
382
+ * }
383
+ * } );
384
+ * }
385
+ * }
386
+ *
387
+ * const view = new SampleView();
388
+ *
389
+ * // Let's customize the view before it gets rendered.
390
+ * view.extendTemplate( {
391
+ * attributes: {
392
+ * class: [
393
+ * 'additional-class'
394
+ * ]
395
+ * }
396
+ * } );
397
+ *
398
+ * // Late rendering allows customization of the view.
399
+ * view.render();
400
+ * ```
401
+ */
402
+ render(): void;
403
+ /**
404
+ * Recursively destroys the view instance and child views added by {@link #registerChild} and
405
+ * residing in collections created by the {@link #createCollection}.
406
+ *
407
+ * Destruction disables all event listeners:
408
+ * * created on the view, e.g. `view.on( 'event', () => {} )`,
409
+ * * defined in the {@link #template} for DOM events.
410
+ */
411
+ destroy(): void;
412
+ }
413
+ /**
414
+ * Event fired by the {@link module:ui/view~View#render} method. Actual rendering is executed as a listener to
415
+ * this event with the default priority.
416
+ *
417
+ * See {@link module:utils/observablemixin~Observable#decorate} for more information and samples.
418
+ *
419
+ * @eventName ~View#render
420
+ */
421
+ export type UIViewRenderEvent = DecoratedMethodEvent<View, 'render'>;
422
+ export {};
@@ -0,0 +1,139 @@
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
+ * @module ui/viewcollection
7
+ */
8
+ import { Collection, type EmitterMixinDelegateChain } from '@ckeditor/ckeditor5-utils';
9
+ import type View from './view.js';
10
+ /**
11
+ * Collects {@link module:ui/view~View} instances.
12
+ *
13
+ * ```ts
14
+ * const parentView = new ParentView( locale );
15
+ * const collection = new ViewCollection( locale );
16
+ *
17
+ * collection.setParent( parentView.element );
18
+ *
19
+ * const viewA = new ChildView( locale );
20
+ * const viewB = new ChildView( locale );
21
+ * ```
22
+ *
23
+ * View collection renders and manages view {@link module:ui/view~View#element elements}:
24
+ *
25
+ * ```ts
26
+ * collection.add( viewA );
27
+ * collection.add( viewB );
28
+ *
29
+ * console.log( parentView.element.firsChild ); // -> viewA.element
30
+ * console.log( parentView.element.lastChild ); // -> viewB.element
31
+ * ```
32
+ *
33
+ * It {@link module:ui/viewcollection~ViewCollection#delegate propagates} DOM events too:
34
+ *
35
+ * ```ts
36
+ * // Delegate #click and #keydown events from viewA and viewB to the parentView.
37
+ * collection.delegate( 'click' ).to( parentView );
38
+ *
39
+ * parentView.on( 'click', ( evt ) => {
40
+ * console.log( `${ evt.source } has been clicked.` );
41
+ * } );
42
+ *
43
+ * // This event will be delegated to the parentView.
44
+ * viewB.fire( 'click' );
45
+ * ```
46
+ *
47
+ * **Note**: A view collection can be used directly in the {@link module:ui/template~TemplateDefinition definition}
48
+ * of a {@link module:ui/template~Template template}.
49
+ */
50
+ export default class ViewCollection<TView extends View = View> extends Collection<TView> {
51
+ id?: string;
52
+ /**
53
+ * A parent element within which child views are rendered and managed in DOM.
54
+ */
55
+ private _parentElement;
56
+ /**
57
+ * Creates a new instance of the {@link module:ui/viewcollection~ViewCollection}.
58
+ *
59
+ * @param initialItems The initial items of the collection.
60
+ */
61
+ constructor(initialItems?: Iterable<TView>);
62
+ /**
63
+ * Destroys the view collection along with child views.
64
+ * See the view {@link module:ui/view~View#destroy} method.
65
+ */
66
+ destroy(): void;
67
+ /**
68
+ * Sets the parent HTML element of this collection. When parent is set, {@link #add adding} and
69
+ * {@link #remove removing} views in the collection synchronizes their
70
+ * {@link module:ui/view~View#element elements} in the parent element.
71
+ *
72
+ * @param element A new parent element.
73
+ */
74
+ setParent(elementOrDocFragment: DocumentFragment | HTMLElement): void;
75
+ /**
76
+ * Delegates selected events coming from within views in the collection to any
77
+ * {@link module:utils/emittermixin~Emitter}.
78
+ *
79
+ * For the following views and collection:
80
+ *
81
+ * ```ts
82
+ * const viewA = new View();
83
+ * const viewB = new View();
84
+ * const viewC = new View();
85
+ *
86
+ * const views = parentView.createCollection();
87
+ *
88
+ * views.delegate( 'eventX' ).to( viewB );
89
+ * views.delegate( 'eventX', 'eventY' ).to( viewC );
90
+ *
91
+ * views.add( viewA );
92
+ * ```
93
+ *
94
+ * the `eventX` is delegated (fired by) `viewB` and `viewC` along with `customData`:
95
+ *
96
+ * ```ts
97
+ * viewA.fire( 'eventX', customData );
98
+ * ```
99
+ *
100
+ * and `eventY` is delegated (fired by) `viewC` along with `customData`:
101
+ *
102
+ * ```ts
103
+ * viewA.fire( 'eventY', customData );
104
+ * ```
105
+ *
106
+ * See {@link module:utils/emittermixin~Emitter#delegate}.
107
+ *
108
+ * @param events {@link module:ui/view~View} event names to be delegated to another
109
+ * {@link module:utils/emittermixin~Emitter}.
110
+ * @returns Object with `to` property, a function which accepts the destination
111
+ * of {@link module:utils/emittermixin~Emitter#delegate delegated} events.
112
+ */
113
+ delegate(...events: Array<string>): EmitterMixinDelegateChain;
114
+ /**
115
+ * This method {@link module:ui/view~View#render renders} a new view added to the collection.
116
+ *
117
+ * If the {@link #_parentElement parent element} of the collection is set, this method also adds
118
+ * the view's {@link module:ui/view~View#element} as a child of the parent in DOM at a specified index.
119
+ *
120
+ * **Note**: If index is not specified, the view's element is pushed as the last child
121
+ * of the parent element.
122
+ *
123
+ * @param view A new view added to the collection.
124
+ * @param index An index the view holds in the collection. When not specified,
125
+ * the view is added at the end.
126
+ */
127
+ private _renderViewIntoCollectionParent;
128
+ /**
129
+ * Removes a child view from the collection. If the {@link #setParent parent element} of the
130
+ * collection has been set, the {@link module:ui/view~View#element element} of the view is also removed
131
+ * in DOM, reflecting the order of the collection.
132
+ *
133
+ * See the {@link #add} method.
134
+ *
135
+ * @param subject The view to remove, its id or index in the collection.
136
+ * @returns The removed view.
137
+ */
138
+ remove(subject: TView | number | string): TView;
139
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ckeditor/ckeditor5-ui",
3
- "version": "41.2.0",
3
+ "version": "41.3.0-alpha.0",
4
4
  "description": "The UI framework and standard UI library of CKEditor 5.",
5
5
  "keywords": [
6
6
  "ckeditor",
@@ -12,8 +12,8 @@
12
12
  "type": "module",
13
13
  "main": "src/index.js",
14
14
  "dependencies": {
15
- "@ckeditor/ckeditor5-core": "41.2.0",
16
- "@ckeditor/ckeditor5-utils": "41.2.0",
15
+ "@ckeditor/ckeditor5-core": "41.3.0-alpha.0",
16
+ "@ckeditor/ckeditor5-utils": "41.3.0-alpha.0",
17
17
  "color-convert": "2.0.1",
18
18
  "color-parse": "1.4.2",
19
19
  "lodash-es": "4.17.21",
@@ -29,6 +29,7 @@
29
29
  "directory": "packages/ckeditor5-ui"
30
30
  },
31
31
  "files": [
32
+ "dist",
32
33
  "lang",
33
34
  "src/**/*.js",
34
35
  "src/**/*.d.ts",
@@ -12,7 +12,6 @@ import View from '../view.js';
12
12
  import LabeledFieldView from '../labeledfield/labeledfieldview.js';
13
13
  import { createLabeledInputText } from '../labeledfield/utils.js';
14
14
  // Custom export due to https://github.com/ckeditor/ckeditor5/issues/15698.
15
- // eslint-disable-next-line ckeditor5-rules/require-file-extensions-in-imports
16
15
  import { HexBase } from 'vanilla-colorful/lib/entrypoints/hex';
17
16
  import '../../theme/components/colorpicker/colorpicker.css';
18
17
  const waitingTime = 150;
package/src/index.d.ts CHANGED
@@ -5,6 +5,7 @@
5
5
  /**
6
6
  * @module ui
7
7
  */
8
+ export { default as View, type UIViewRenderEvent } from './view.js';
8
9
  export { default as clickOutsideHandler } from './bindings/clickoutsidehandler.js';
9
10
  export { default as injectCssTransitionDisabler } from './bindings/injectcsstransitiondisabler.js';
10
11
  export { default as CssTransitionDisablerMixin, type ViewWithCssTransitionDisabler } from './bindings/csstransitiondisablermixin.js';
@@ -58,7 +59,7 @@ export { default as StickyPanelView } from './panel/sticky/stickypanelview.js';
58
59
  export { default as AutocompleteView, type AutocompleteViewConfig, type AutocompleteResultsView } from './autocomplete/autocompleteview.js';
59
60
  export { default as SearchTextView, type SearchTextViewSearchEvent, type SearchTextViewConfig } from './search/text/searchtextview.js';
60
61
  export { default as SearchInfoView } from './search/searchinfoview.js';
61
- export { default as FilteredView, type FilteredViewExecuteEvent } from './search/filteredview.js';
62
+ export type { default as FilteredView, FilteredViewExecuteEvent } from './search/filteredview.js';
62
63
  export { default as HighlightedTextView } from './highlightedtext/highlightedtextview.js';
63
64
  export { default as TooltipManager } from './tooltipmanager.js';
64
65
  export { default as Template, type TemplateDefinition } from './template.js';
@@ -69,6 +70,5 @@ export { default as ToolbarSeparatorView } from './toolbar/toolbarseparatorview.
69
70
  export { default as normalizeToolbarConfig } from './toolbar/normalizetoolbarconfig.js';
70
71
  export { default as BalloonToolbar, type BalloonToolbarShowEvent } from './toolbar/balloon/balloontoolbar.js';
71
72
  export { default as BlockToolbar } from './toolbar/block/blocktoolbar.js';
72
- export { default as View, type UIViewRenderEvent } from './view.js';
73
73
  export { default as ViewCollection } from './viewcollection.js';
74
74
  import './augmentation.js';
package/src/index.js CHANGED
@@ -5,6 +5,8 @@
5
5
  /**
6
6
  * @module ui
7
7
  */
8
+ // This import must be at the top to ensure that `globals.css` is imported first
9
+ export { default as View } from './view.js';
8
10
  export { default as clickOutsideHandler } from './bindings/clickoutsidehandler.js';
9
11
  export { default as injectCssTransitionDisabler } from './bindings/injectcsstransitiondisabler.js';
10
12
  export { default as CssTransitionDisablerMixin } from './bindings/csstransitiondisablermixin.js';
@@ -65,6 +67,5 @@ export { default as ToolbarSeparatorView } from './toolbar/toolbarseparatorview.
65
67
  export { default as normalizeToolbarConfig } from './toolbar/normalizetoolbarconfig.js';
66
68
  export { default as BalloonToolbar } from './toolbar/balloon/balloontoolbar.js';
67
69
  export { default as BlockToolbar } from './toolbar/block/blocktoolbar.js';
68
- export { default as View } from './view.js';
69
70
  export { default as ViewCollection } from './viewcollection.js';
70
71
  import './augmentation.js';
@@ -16,7 +16,6 @@ import { FocusTracker, KeystrokeHandler, Rect, ResizeObserver, global, isVisible
16
16
  import { icons } from '@ckeditor/ckeditor5-core';
17
17
  import { isObject } from 'lodash-es';
18
18
  import '../../theme/components/toolbar/toolbar.css';
19
- const { threeVerticalDots } = icons;
20
19
  export const NESTED_TOOLBAR_ICONS = {
21
20
  alignLeft: icons.alignLeft,
22
21
  bold: icons.bold,
@@ -335,7 +334,7 @@ export default class ToolbarView extends View {
335
334
  // Allow disabling icon by passing false.
336
335
  if (icon !== false) {
337
336
  // A pre-defined icon picked by name, SVG string, a fallback (default) icon.
338
- dropdownView.buttonView.icon = NESTED_TOOLBAR_ICONS[icon] || icon || threeVerticalDots;
337
+ dropdownView.buttonView.icon = NESTED_TOOLBAR_ICONS[icon] || icon || icons.threeVerticalDots;
339
338
  }
340
339
  // If the icon is disabled, display the label automatically.
341
340
  else {
@@ -693,7 +692,7 @@ class DynamicGrouping {
693
692
  label: t('Show more items'),
694
693
  tooltip: true,
695
694
  tooltipPosition: locale.uiLanguageDirection === 'rtl' ? 'se' : 'sw',
696
- icon: threeVerticalDots
695
+ icon: icons.threeVerticalDots
697
696
  });
698
697
  return dropdown;
699
698
  }