@ckeditor/ckeditor5-ui 48.8.1-alpha.4 → 49.0.0-alpha.1

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 (273) hide show
  1. package/LICENSE.md +1 -1
  2. package/dist/arialiveannouncer.d.ts +89 -90
  3. package/dist/augmentation.d.ts +86 -86
  4. package/dist/autocomplete/autocompleteview.d.ts +69 -70
  5. package/dist/badge/badge.d.ts +119 -121
  6. package/dist/bindings/addkeyboardhandlingforgrid.d.ts +22 -22
  7. package/dist/bindings/clickoutsidehandler.d.ts +24 -26
  8. package/dist/bindings/csstransitiondisablermixin.d.ts +47 -36
  9. package/dist/bindings/draggableviewmixin.d.ts +45 -37
  10. package/dist/bindings/preventdefault.d.ts +30 -30
  11. package/dist/bindings/submithandler.d.ts +49 -49
  12. package/dist/button/button.d.ts +167 -167
  13. package/dist/button/buttonlabel.d.ts +28 -28
  14. package/dist/button/buttonlabelview.d.ts +26 -26
  15. package/dist/button/buttonview.d.ts +191 -192
  16. package/dist/button/filedialogbuttonview.d.ts +107 -99
  17. package/dist/button/listitembuttonview.d.ts +72 -73
  18. package/dist/button/switchbuttonview.d.ts +39 -40
  19. package/dist/collapsible/collapsibleview.d.ts +62 -63
  20. package/dist/colorgrid/colorgridview.d.ts +116 -117
  21. package/dist/colorgrid/colors.d.ts +28 -0
  22. package/dist/colorgrid/colortileview.d.ts +21 -21
  23. package/dist/colorgrid/utils.d.ts +47 -35
  24. package/dist/colorpicker/colorpickerview.d.ts +154 -157
  25. package/dist/colorpicker/utils.d.ts +37 -37
  26. package/dist/colorselector/colorgridsfragmentview.d.ts +191 -191
  27. package/dist/colorselector/colorpickerfragmentview.d.ts +129 -129
  28. package/dist/colorselector/colorselectorview.d.ts +226 -229
  29. package/dist/colorselector/documentcolorcollection.d.ts +52 -59
  30. package/dist/componentfactory.d.ts +76 -76
  31. package/dist/dialog/dialog.d.ts +311 -288
  32. package/dist/dialog/dialogactionsview.d.ts +61 -62
  33. package/dist/dialog/dialogcontentview.d.ts +22 -22
  34. package/dist/dialog/dialogview.d.ts +254 -251
  35. package/dist/dropdown/button/dropdownbutton.d.ts +17 -17
  36. package/dist/dropdown/button/dropdownbuttonview.d.ts +41 -41
  37. package/dist/dropdown/button/splitbuttonview.d.ts +154 -155
  38. package/dist/dropdown/dropdownpanelfocusable.d.ts +16 -16
  39. package/dist/dropdown/dropdownpanelview.d.ts +56 -56
  40. package/dist/dropdown/dropdownview.d.ts +337 -326
  41. package/dist/dropdown/menu/dropdownmenubehaviors.d.ts +43 -43
  42. package/dist/dropdown/menu/dropdownmenubuttonview.d.ts +28 -29
  43. package/dist/dropdown/menu/dropdownmenulistitembuttonview.d.ts +11 -12
  44. package/dist/dropdown/menu/dropdownmenulistitemview.d.ts +16 -17
  45. package/dist/dropdown/menu/dropdownmenulistview.d.ts +19 -19
  46. package/dist/dropdown/menu/dropdownmenunestedmenupanelview.d.ts +27 -28
  47. package/dist/dropdown/menu/dropdownmenunestedmenuview.d.ts +125 -126
  48. package/dist/dropdown/menu/dropdownmenurootlistview.d.ts +132 -132
  49. package/dist/dropdown/menu/utils.d.ts +112 -112
  50. package/dist/dropdown/utils.d.ts +270 -272
  51. package/dist/editableui/editableuiview.d.ts +78 -67
  52. package/dist/editableui/inline/inlineeditableuiview.d.ts +38 -36
  53. package/dist/editorui/accessibilityhelp/accessibilityhelp.d.ts +49 -50
  54. package/dist/editorui/accessibilityhelp/accessibilityhelpcontentview.d.ts +30 -30
  55. package/dist/editorui/bodycollection.d.ts +167 -86
  56. package/dist/editorui/boxed/boxededitoruiview.d.ts +35 -35
  57. package/dist/editorui/editorui.d.ts +382 -351
  58. package/dist/editorui/editoruiview.d.ts +48 -53
  59. package/dist/editorui/evaluationbadge.d.ts +28 -28
  60. package/dist/editorui/poweredby.d.ts +25 -25
  61. package/dist/focuscycler.d.ts +265 -270
  62. package/dist/formheader/formheaderview.d.ts +52 -53
  63. package/dist/formrow/formrowview.d.ts +51 -52
  64. package/dist/highlightedtext/buttonlabelwithhighlightview.d.ts +25 -25
  65. package/dist/highlightedtext/highlightedtextview.d.ts +30 -34
  66. package/dist/highlightedtext/labelwithhighlightview.d.ts +21 -21
  67. package/dist/icon/iconview.d.ts +82 -83
  68. package/dist/iframe/iframeview.d.ts +42 -42
  69. package/dist/index-content.css +3 -0
  70. package/dist/index-content.css.map +1 -0
  71. package/dist/index-editor.css +3241 -2329
  72. package/dist/index-editor.css.map +1 -0
  73. package/dist/index.css +2940 -2032
  74. package/dist/index.css.map +1 -1
  75. package/dist/index.d.ts +144 -136
  76. package/dist/index.js +17821 -17732
  77. package/dist/index.js.map +1 -1
  78. package/dist/input/inputbase.d.ts +114 -114
  79. package/dist/input/inputview.d.ts +27 -28
  80. package/dist/inputnumber/inputnumberview.d.ts +44 -44
  81. package/dist/inputtext/inputtextview.d.ts +13 -13
  82. package/dist/label/labelview.d.ts +30 -31
  83. package/dist/labeledfield/labeledfieldview.d.ts +179 -180
  84. package/dist/labeledfield/utils.d.ts +112 -112
  85. package/dist/labeledinput/labeledinputview.d.ts +119 -120
  86. package/dist/legacyerrors.d.ts +0 -4
  87. package/dist/list/listitemgroupview.d.ts +54 -54
  88. package/dist/list/listitemview.d.ts +31 -31
  89. package/dist/list/listseparatorview.d.ts +13 -13
  90. package/dist/list/listview.d.ts +118 -119
  91. package/dist/menubar/menubarmenubuttonview.d.ts +27 -28
  92. package/dist/menubar/menubarmenulistitembuttonview.d.ts +15 -16
  93. package/dist/menubar/menubarmenulistitemfiledialogbuttonview.d.ts +17 -18
  94. package/dist/menubar/menubarmenulistitemview.d.ts +19 -20
  95. package/dist/menubar/menubarmenulistview.d.ts +24 -24
  96. package/dist/menubar/menubarmenupanelview.d.ts +46 -47
  97. package/dist/menubar/menubarmenuview.d.ts +112 -113
  98. package/dist/menubar/menubarview.d.ts +144 -145
  99. package/dist/menubar/utils.d.ts +455 -455
  100. package/dist/model.d.ts +19 -18
  101. package/dist/notification/notification.d.ts +200 -200
  102. package/dist/overlayhost.d.ts +210 -0
  103. package/dist/panel/balloon/balloonpanelview.d.ts +700 -692
  104. package/dist/panel/balloon/contextualballoon.d.ts +296 -298
  105. package/dist/panel/sticky/stickypanelview.d.ts +162 -151
  106. package/dist/search/filteredview.d.ts +23 -23
  107. package/dist/search/filtergroupanditemnames.d.ts +11 -11
  108. package/dist/search/searchinfoview.d.ts +39 -39
  109. package/dist/search/searchresultsview.d.ts +49 -49
  110. package/dist/search/text/searchtextqueryview.d.ts +63 -63
  111. package/dist/search/text/searchtextview.d.ts +202 -203
  112. package/dist/spinner/spinnerview.d.ts +19 -20
  113. package/dist/tabs/tabbuttonview.d.ts +53 -0
  114. package/dist/tabs/tabpanelview.d.ts +45 -0
  115. package/dist/template.d.ts +897 -902
  116. package/dist/textarea/textareaview.d.ts +100 -96
  117. package/dist/toolbar/balloon/balloontoolbar.d.ts +122 -122
  118. package/dist/toolbar/block/blockbuttonview.d.ts +29 -30
  119. package/dist/toolbar/block/blocktoolbar.d.ts +166 -166
  120. package/dist/toolbar/normalizetoolbarconfig.d.ts +35 -35
  121. package/dist/toolbar/toolbarlinebreakview.d.ts +13 -13
  122. package/dist/toolbar/toolbarseparatorview.d.ts +13 -13
  123. package/dist/toolbar/toolbarview.d.ts +270 -271
  124. package/dist/tooltipmanager.d.ts +317 -193
  125. package/dist/translations/af.js +1 -1
  126. package/dist/translations/af.umd.js +5 -3
  127. package/dist/translations/ar.js +1 -1
  128. package/dist/translations/ar.umd.js +5 -3
  129. package/dist/translations/ast.js +1 -1
  130. package/dist/translations/ast.umd.js +5 -3
  131. package/dist/translations/az.js +1 -1
  132. package/dist/translations/az.umd.js +5 -3
  133. package/dist/translations/be.js +1 -1
  134. package/dist/translations/be.umd.js +5 -3
  135. package/dist/translations/bg.js +1 -1
  136. package/dist/translations/bg.umd.js +5 -3
  137. package/dist/translations/bn.js +1 -1
  138. package/dist/translations/bn.umd.js +5 -3
  139. package/dist/translations/bs.js +1 -1
  140. package/dist/translations/bs.umd.js +5 -3
  141. package/dist/translations/ca.js +1 -1
  142. package/dist/translations/ca.umd.js +5 -3
  143. package/dist/translations/cs.js +1 -1
  144. package/dist/translations/cs.umd.js +5 -3
  145. package/dist/translations/da.js +1 -1
  146. package/dist/translations/da.umd.js +5 -3
  147. package/dist/translations/de-ch.js +1 -1
  148. package/dist/translations/de-ch.umd.js +5 -3
  149. package/dist/translations/de.js +1 -1
  150. package/dist/translations/de.umd.js +5 -3
  151. package/dist/translations/el.js +1 -1
  152. package/dist/translations/el.umd.js +5 -3
  153. package/dist/translations/en-au.js +1 -1
  154. package/dist/translations/en-au.umd.js +5 -3
  155. package/dist/translations/en-gb.js +1 -1
  156. package/dist/translations/en-gb.umd.js +5 -3
  157. package/dist/translations/en.js +1 -1
  158. package/dist/translations/en.umd.js +5 -3
  159. package/dist/translations/eo.js +1 -1
  160. package/dist/translations/eo.umd.js +5 -3
  161. package/dist/translations/es-co.js +1 -1
  162. package/dist/translations/es-co.umd.js +5 -3
  163. package/dist/translations/es.js +1 -1
  164. package/dist/translations/es.umd.js +5 -3
  165. package/dist/translations/et.js +1 -1
  166. package/dist/translations/et.umd.js +5 -3
  167. package/dist/translations/eu.js +1 -1
  168. package/dist/translations/eu.umd.js +5 -3
  169. package/dist/translations/fa.js +1 -1
  170. package/dist/translations/fa.umd.js +5 -3
  171. package/dist/translations/fi.js +1 -1
  172. package/dist/translations/fi.umd.js +5 -3
  173. package/dist/translations/fr.js +1 -1
  174. package/dist/translations/fr.umd.js +5 -3
  175. package/dist/translations/gl.js +1 -1
  176. package/dist/translations/gl.umd.js +5 -3
  177. package/dist/translations/gu.js +1 -1
  178. package/dist/translations/gu.umd.js +5 -3
  179. package/dist/translations/he.js +1 -1
  180. package/dist/translations/he.umd.js +5 -3
  181. package/dist/translations/hi.js +1 -1
  182. package/dist/translations/hi.umd.js +5 -3
  183. package/dist/translations/hr.js +1 -1
  184. package/dist/translations/hr.umd.js +5 -3
  185. package/dist/translations/hu.js +1 -1
  186. package/dist/translations/hu.umd.js +5 -3
  187. package/dist/translations/hy.js +1 -1
  188. package/dist/translations/hy.umd.js +5 -3
  189. package/dist/translations/id.js +1 -1
  190. package/dist/translations/id.umd.js +5 -3
  191. package/dist/translations/it.js +1 -1
  192. package/dist/translations/it.umd.js +5 -3
  193. package/dist/translations/ja.js +1 -1
  194. package/dist/translations/ja.umd.js +5 -3
  195. package/dist/translations/jv.js +1 -1
  196. package/dist/translations/jv.umd.js +5 -3
  197. package/dist/translations/kk.js +1 -1
  198. package/dist/translations/kk.umd.js +5 -3
  199. package/dist/translations/km.js +1 -1
  200. package/dist/translations/km.umd.js +5 -3
  201. package/dist/translations/kn.js +1 -1
  202. package/dist/translations/kn.umd.js +5 -3
  203. package/dist/translations/ko.js +1 -1
  204. package/dist/translations/ko.umd.js +5 -3
  205. package/dist/translations/ku.js +1 -1
  206. package/dist/translations/ku.umd.js +5 -3
  207. package/dist/translations/lt.js +1 -1
  208. package/dist/translations/lt.umd.js +5 -3
  209. package/dist/translations/lv.js +1 -1
  210. package/dist/translations/lv.umd.js +5 -3
  211. package/dist/translations/ms.js +1 -1
  212. package/dist/translations/ms.umd.js +5 -3
  213. package/dist/translations/nb.js +1 -1
  214. package/dist/translations/nb.umd.js +5 -3
  215. package/dist/translations/ne.js +1 -1
  216. package/dist/translations/ne.umd.js +5 -3
  217. package/dist/translations/nl.js +1 -1
  218. package/dist/translations/nl.umd.js +5 -3
  219. package/dist/translations/no.js +1 -1
  220. package/dist/translations/no.umd.js +5 -3
  221. package/dist/translations/oc.js +1 -1
  222. package/dist/translations/oc.umd.js +5 -3
  223. package/dist/translations/pl.js +1 -1
  224. package/dist/translations/pl.umd.js +5 -3
  225. package/dist/translations/pt-br.js +1 -1
  226. package/dist/translations/pt-br.umd.js +5 -3
  227. package/dist/translations/pt.js +1 -1
  228. package/dist/translations/pt.umd.js +5 -3
  229. package/dist/translations/ro.js +1 -1
  230. package/dist/translations/ro.umd.js +5 -3
  231. package/dist/translations/ru.js +1 -1
  232. package/dist/translations/ru.umd.js +5 -3
  233. package/dist/translations/si.js +1 -1
  234. package/dist/translations/si.umd.js +5 -3
  235. package/dist/translations/sk.js +1 -1
  236. package/dist/translations/sk.umd.js +5 -3
  237. package/dist/translations/sl.js +1 -1
  238. package/dist/translations/sl.umd.js +5 -3
  239. package/dist/translations/sq.js +1 -1
  240. package/dist/translations/sq.umd.js +5 -3
  241. package/dist/translations/sr-latn.js +1 -1
  242. package/dist/translations/sr-latn.umd.js +5 -3
  243. package/dist/translations/sr.js +1 -1
  244. package/dist/translations/sr.umd.js +5 -3
  245. package/dist/translations/sv.js +1 -1
  246. package/dist/translations/sv.umd.js +5 -3
  247. package/dist/translations/th.js +1 -1
  248. package/dist/translations/th.umd.js +5 -3
  249. package/dist/translations/ti.js +1 -1
  250. package/dist/translations/ti.umd.js +5 -3
  251. package/dist/translations/tk.js +1 -1
  252. package/dist/translations/tk.umd.js +5 -3
  253. package/dist/translations/tr.js +1 -1
  254. package/dist/translations/tr.umd.js +5 -3
  255. package/dist/translations/tt.js +1 -1
  256. package/dist/translations/tt.umd.js +5 -3
  257. package/dist/translations/ug.js +1 -1
  258. package/dist/translations/ug.umd.js +5 -3
  259. package/dist/translations/uk.js +1 -1
  260. package/dist/translations/uk.umd.js +5 -3
  261. package/dist/translations/ur.js +1 -1
  262. package/dist/translations/ur.umd.js +5 -3
  263. package/dist/translations/uz.js +1 -1
  264. package/dist/translations/uz.umd.js +5 -3
  265. package/dist/translations/vi.js +1 -1
  266. package/dist/translations/vi.umd.js +5 -3
  267. package/dist/translations/zh-cn.js +1 -1
  268. package/dist/translations/zh-cn.umd.js +5 -3
  269. package/dist/translations/zh.js +1 -1
  270. package/dist/translations/zh.umd.js +5 -3
  271. package/dist/view.d.ts +384 -388
  272. package/dist/viewcollection.d.ts +134 -134
  273. package/package.json +8 -7
@@ -1,471 +1,471 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
5
- import { type MenuBarMenuView } from './menubarmenuview.js';
6
- import type { MenuBarView, MenuBarConfig, MenuBarConfigObject, MenuBarConfigAddedGroup, MenuBarConfigAddedMenu, NormalizedMenuBarConfigObject, MenuBarConfigAddedItem } from './menubarview.js';
7
- import { type ComponentFactory } from '../componentfactory.js';
8
- import { type Locale, type PositioningFunction } from '@ckeditor/ckeditor5-utils';
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
+ import { type MenuBarMenuView } from "./menubarmenuview.js";
6
+ import type { MenuBarView, MenuBarConfig, MenuBarConfigObject, MenuBarConfigAddedGroup, MenuBarConfigAddedMenu, NormalizedMenuBarConfigObject, MenuBarConfigAddedItem } from "./menubarview.js";
7
+ import { type ComponentFactory } from "../componentfactory.js";
8
+ import { type Locale, type PositioningFunction } from "@ckeditor/ckeditor5-utils";
9
9
  /**
10
- * Behaviors of the {@link module:ui/menubar/menubarview~MenuBarView} component.
11
- * @internal
12
- */
10
+ * Behaviors of the {@link module:ui/menubar/menubarview~MenuBarView} component.
11
+ * @internal
12
+ */
13
13
  export declare const MenuBarBehaviors: {
14
- /**
15
- * When the bar is already open:
16
- * * Opens the menu when the user hovers over its button.
17
- * * Closes open menu when another menu's button gets hovered.
18
- */
19
- toggleMenusAndFocusItemsOnHover(menuBarView: MenuBarView): void;
20
- /**
21
- * Moves between top-level menus using the arrow left and right keys.
22
- *
23
- * If the menubar has already been open, the arrow keys move focus between top-level menu buttons and open them.
24
- * If the menubar is closed, the arrow keys only move focus between top-level menu buttons.
25
- */
26
- focusCycleMenusOnArrows(menuBarView: MenuBarView): void;
27
- /**
28
- * Closes the entire sub-menu structure when the bar is closed. This prevents sub-menus from being open if the user
29
- * closes the entire bar, and then re-opens some top-level menu.
30
- */
31
- closeMenusWhenTheBarCloses(menuBarView: MenuBarView): void;
32
- /**
33
- * Handles the following case:
34
- * 1. Hover to open a sub-menu (A). The button has focus.
35
- * 2. Press arrow up/down to move focus to another sub-menu (B) button.
36
- * 3. Press arrow right to open the sub-menu (B).
37
- * 4. The sub-menu (A) should close as it would with `toggleMenusAndFocusItemsOnHover()`.
38
- */
39
- closeMenuWhenAnotherOnTheSameLevelOpens(menuBarView: MenuBarView): void;
40
- /**
41
- * Closes the bar when the user clicked outside of it (page body, editor root, etc.).
42
- */
43
- closeOnClickOutside(menuBarView: MenuBarView): void;
44
- /**
45
- * Tracks the keyboard focus interaction on the menu bar view. It is used to determine if the nested items
46
- * of the menu bar should render focus rings after first interaction with the keyboard.
47
- */
48
- enableFocusHighlightOnInteraction(menuBarView: MenuBarView): void;
14
+ /**
15
+ * When the bar is already open:
16
+ * * Opens the menu when the user hovers over its button.
17
+ * * Closes open menu when another menu's button gets hovered.
18
+ */
19
+ toggleMenusAndFocusItemsOnHover(menuBarView: MenuBarView): void;
20
+ /**
21
+ * Moves between top-level menus using the arrow left and right keys.
22
+ *
23
+ * If the menubar has already been open, the arrow keys move focus between top-level menu buttons and open them.
24
+ * If the menubar is closed, the arrow keys only move focus between top-level menu buttons.
25
+ */
26
+ focusCycleMenusOnArrows(menuBarView: MenuBarView): void;
27
+ /**
28
+ * Closes the entire sub-menu structure when the bar is closed. This prevents sub-menus from being open if the user
29
+ * closes the entire bar, and then re-opens some top-level menu.
30
+ */
31
+ closeMenusWhenTheBarCloses(menuBarView: MenuBarView): void;
32
+ /**
33
+ * Handles the following case:
34
+ * 1. Hover to open a sub-menu (A). The button has focus.
35
+ * 2. Press arrow up/down to move focus to another sub-menu (B) button.
36
+ * 3. Press arrow right to open the sub-menu (B).
37
+ * 4. The sub-menu (A) should close as it would with `toggleMenusAndFocusItemsOnHover()`.
38
+ */
39
+ closeMenuWhenAnotherOnTheSameLevelOpens(menuBarView: MenuBarView): void;
40
+ /**
41
+ * Closes the bar when the user clicked outside of it (page body, editor root, etc.).
42
+ */
43
+ closeOnClickOutside(menuBarView: MenuBarView): void;
44
+ /**
45
+ * Tracks the keyboard focus interaction on the menu bar view. It is used to determine if the nested items
46
+ * of the menu bar should render focus rings after first interaction with the keyboard.
47
+ */
48
+ enableFocusHighlightOnInteraction(menuBarView: MenuBarView): void;
49
49
  };
50
50
  /**
51
- * Behaviors of the {@link module:ui/menubar/menubarmenuview~MenuBarMenuView} component.
52
- * @internal
53
- */
51
+ * Behaviors of the {@link module:ui/menubar/menubarmenuview~MenuBarMenuView} component.
52
+ * @internal
53
+ */
54
54
  export declare const MenuBarMenuBehaviors: {
55
- /**
56
- * If the button of the menu is focused, pressing the arrow down key should open the panel and focus it.
57
- * This is analogous to the {@link module:ui/dropdown/dropdownview~DropdownView}.
58
- */
59
- openAndFocusPanelOnArrowDownKey(menuView: MenuBarMenuView): void;
60
- /**
61
- * Open the menu on the right arrow key press. This allows for navigating to sub-menus using the keyboard.
62
- */
63
- openOnArrowRightKey(menuView: MenuBarMenuView): void;
64
- /**
65
- * Opens the menu on its button click. Note that this behavior only opens but never closes the menu (unlike
66
- * {@link module:ui/dropdown/dropdownview~DropdownView}).
67
- */
68
- openOnButtonClick(menuView: MenuBarMenuView): void;
69
- /**
70
- * Toggles the menu on its button click. This behavior is analogous to {@link module:ui/dropdown/dropdownview~DropdownView}.
71
- */
72
- toggleOnButtonClick(menuView: MenuBarMenuView): void;
73
- /**
74
- * Opens the menu and focuses the panel content upon pressing the Enter key.
75
- */
76
- openAndFocusOnEnterKeyPress(menuView: MenuBarMenuView): void;
77
- /**
78
- * Closes the menu on the right left key press. This allows for navigating to sub-menus using the keyboard.
79
- */
80
- closeOnArrowLeftKey(menuView: MenuBarMenuView): void;
81
- /**
82
- * Closes the menu on the esc key press. This allows for navigating to sub-menus using the keyboard.
83
- */
84
- closeOnEscKey(menuView: MenuBarMenuView): void;
85
- /**
86
- * Closes the menu when its parent menu also closed. This prevents from orphaned open menus when the parent menu re-opens.
87
- */
88
- closeOnParentClose(menuView: MenuBarMenuView): void;
55
+ /**
56
+ * If the button of the menu is focused, pressing the arrow down key should open the panel and focus it.
57
+ * This is analogous to the {@link module:ui/dropdown/dropdownview~DropdownView}.
58
+ */
59
+ openAndFocusPanelOnArrowDownKey(menuView: MenuBarMenuView): void;
60
+ /**
61
+ * Open the menu on the right arrow key press. This allows for navigating to sub-menus using the keyboard.
62
+ */
63
+ openOnArrowRightKey(menuView: MenuBarMenuView): void;
64
+ /**
65
+ * Opens the menu on its button click. Note that this behavior only opens but never closes the menu (unlike
66
+ * {@link module:ui/dropdown/dropdownview~DropdownView}).
67
+ */
68
+ openOnButtonClick(menuView: MenuBarMenuView): void;
69
+ /**
70
+ * Toggles the menu on its button click. This behavior is analogous to {@link module:ui/dropdown/dropdownview~DropdownView}.
71
+ */
72
+ toggleOnButtonClick(menuView: MenuBarMenuView): void;
73
+ /**
74
+ * Opens the menu and focuses the panel content upon pressing the Enter key.
75
+ */
76
+ openAndFocusOnEnterKeyPress(menuView: MenuBarMenuView): void;
77
+ /**
78
+ * Closes the menu on the right left key press. This allows for navigating to sub-menus using the keyboard.
79
+ */
80
+ closeOnArrowLeftKey(menuView: MenuBarMenuView): void;
81
+ /**
82
+ * Closes the menu on the esc key press. This allows for navigating to sub-menus using the keyboard.
83
+ */
84
+ closeOnEscKey(menuView: MenuBarMenuView): void;
85
+ /**
86
+ * Closes the menu when its parent menu also closed. This prevents from orphaned open menus when the parent menu re-opens.
87
+ */
88
+ closeOnParentClose(menuView: MenuBarMenuView): void;
89
89
  };
90
90
  /**
91
- * Contains every positioning function used by {@link module:ui/menubar/menubarmenuview~MenuBarMenuView} that decides where the
92
- * {@link module:ui/menubar/menubarmenuview~MenuBarMenuView#panelView} should be placed.
93
- *
94
- * Top-level menu positioning functions:
95
- *
96
- * ┌──────┐
97
- * │ │
98
- * ├──────┴────────┐
99
- * │ │
100
- * │ │
101
- * │ │
102
- * │ SE │
103
- * └───────────────┘
104
- *
105
- * ┌──────┐
106
- * │ │
107
- * ┌────────┴──────┤
108
- * │ │
109
- * │ │
110
- * │ │
111
- * │ SW │
112
- * └───────────────┘
113
- *
114
- * ┌───────────────┐
115
- * │ NW │
116
- * │ │
117
- * │ │
118
- * │ │
119
- * └────────┬──────┤
120
- * │ │
121
- * └──────┘
122
- *
123
- * ┌───────────────┐
124
- * │ NE │
125
- * │ │
126
- * │ │
127
- * │ │
128
- * ├──────┬────────┘
129
- * │ │
130
- * └──────┘
131
- *
132
- * Sub-menu positioning functions:
133
- *
134
- * ┌──────┬───────────────┐
135
- * │ │ │
136
- * └──────┤ │
137
- * │ │
138
- * │ ES │
139
- * └───────────────┘
140
- *
141
- * ┌───────────────┬──────┐
142
- * │ │ │
143
- * │ ├──────┘
144
- * │ │
145
- * │ WS │
146
- * └───────────────┘
147
- *
148
- * ┌───────────────┐
149
- * │ EN │
150
- * │ │
151
- * ┌──────┤ │
152
- * │ │ │
153
- * └──────┴───────────────┘
154
- *
155
- * ┌───────────────┐
156
- * │ WN │
157
- * │ │
158
- * │ ├──────┐
159
- * │ │ │
160
- * └───────────────┴──────┘
161
- */
91
+ * Contains every positioning function used by {@link module:ui/menubar/menubarmenuview~MenuBarMenuView} that decides where the
92
+ * {@link module:ui/menubar/menubarmenuview~MenuBarMenuView#panelView} should be placed.
93
+ *
94
+ * Top-level menu positioning functions:
95
+ *
96
+ * ┌──────┐
97
+ * │ │
98
+ * ├──────┴────────┐
99
+ * │ │
100
+ * │ │
101
+ * │ │
102
+ * │ SE │
103
+ * └───────────────┘
104
+ *
105
+ * ┌──────┐
106
+ * │ │
107
+ * ┌────────┴──────┤
108
+ * │ │
109
+ * │ │
110
+ * │ │
111
+ * │ SW │
112
+ * └───────────────┘
113
+ *
114
+ * ┌───────────────┐
115
+ * │ NW │
116
+ * │ │
117
+ * │ │
118
+ * │ │
119
+ * └────────┬──────┤
120
+ * │ │
121
+ * └──────┘
122
+ *
123
+ * ┌───────────────┐
124
+ * │ NE │
125
+ * │ │
126
+ * │ │
127
+ * │ │
128
+ * ├──────┬────────┘
129
+ * │ │
130
+ * └──────┘
131
+ *
132
+ * Sub-menu positioning functions:
133
+ *
134
+ * ┌──────┬───────────────┐
135
+ * │ │ │
136
+ * └──────┤ │
137
+ * │ │
138
+ * │ ES │
139
+ * └───────────────┘
140
+ *
141
+ * ┌───────────────┬──────┐
142
+ * │ │ │
143
+ * │ ├──────┘
144
+ * │ │
145
+ * │ WS │
146
+ * └───────────────┘
147
+ *
148
+ * ┌───────────────┐
149
+ * │ EN │
150
+ * │ │
151
+ * ┌──────┤ │
152
+ * │ │ │
153
+ * └──────┴───────────────┘
154
+ *
155
+ * ┌───────────────┐
156
+ * │ WN │
157
+ * │ │
158
+ * │ ├──────┐
159
+ * │ │ │
160
+ * └───────────────┴──────┘
161
+ */
162
162
  /**
163
- * @internal
164
- */
163
+ * @internal
164
+ */
165
165
  export declare const MenuBarMenuViewPanelPositioningFunctions: Record<string, PositioningFunction>;
166
166
  /**
167
- * The default items {@link module:core/editor/editorconfig~EditorConfig#menuBar configuration} of the
168
- * {@link module:ui/menubar/menubarview~MenuBarView} component. It contains names of all menu bar components
169
- * registered in the {@link module:ui/componentfactory~ComponentFactory component factory} (available in the project).
170
- *
171
- * **Note**: Menu bar component names provided by core editor features are prefixed with `menuBar:` in order to distinguish
172
- * them from components referenced by the {@link module:core/editor/editorconfig~EditorConfig#toolbar toolbar configuration}, for instance,
173
- * `'menuBar:bold'` is a menu bar button but `'bold'` is a toolbar button.
174
- *
175
- * Below is the preset menu bar structure (the default value of `config.menuBar.items` property):
176
- *
177
- * ```ts
178
- * [
179
- * {
180
- * menuId: 'file',
181
- * label: 'File',
182
- * groups: [
183
- * {
184
- * groupId: 'export',
185
- * items: [
186
- * 'menuBar:exportPdf',
187
- * 'menuBar:exportWord'
188
- * ]
189
- * },
190
- * {
191
- * groupId: 'import',
192
- * items: [
193
- * 'menuBar:importWord'
194
- * ]
195
- * },
196
- * {
197
- * groupId: 'revisionHistory',
198
- * items: [
199
- * 'menuBar:revisionHistory'
200
- * ]
201
- * }
202
- * ]
203
- * },
204
- * {
205
- * menuId: 'edit',
206
- * label: 'Edit',
207
- * groups: [
208
- * {
209
- * groupId: 'undo',
210
- * items: [
211
- * 'menuBar:undo',
212
- * 'menuBar:redo'
213
- * ]
214
- * },
215
- * {
216
- * groupId: 'selectAll',
217
- * items: [
218
- * 'menuBar:selectAll'
219
- * ]
220
- * },
221
- * {
222
- * groupId: 'findAndReplace',
223
- * items: [
224
- * 'menuBar:findAndReplace'
225
- * ]
226
- * }
227
- * ]
228
- * },
229
- * {
230
- * menuId: 'view',
231
- * label: 'View',
232
- * groups: [
233
- * {
234
- * groupId: 'sourceEditingEnhanced',
235
- * items: [
236
- * 'menuBar:sourceEditingEnhanced'
237
- * ]
238
- * },
239
- * {
240
- * groupId: 'sourceEditing',
241
- * items: [
242
- * 'menuBar:sourceEditing'
243
- * ]
244
- * },
245
- * {
246
- * groupId: 'showBlocks',
247
- * items: [
248
- * 'menuBar:showBlocks'
249
- * ]
250
- * },
251
- * {
252
- * groupId: 'previewMergeFields',
253
- * items: [
254
- * 'menuBar:previewMergeFields'
255
- * ]
256
- * },
257
- * {
258
- * groupId: 'fullscreen',
259
- * items: [
260
- * 'menuBar:fullscreen'
261
- * ]
262
- * },
263
- * {
264
- * groupId: 'restrictedEditingException',
265
- * items: [
266
- * 'menuBar:restrictedEditingException'
267
- * ]
268
- * }
269
- * ]
270
- * },
271
- * {
272
- * menuId: 'insert',
273
- * label: 'Insert',
274
- * groups: [
275
- * {
276
- * groupId: 'insertMainWidgets',
277
- * items: [
278
- * 'menuBar:insertImage',
279
- * 'menuBar:ckbox',
280
- * 'menuBar:ckfinder',
281
- * 'menuBar:insertTable'
282
- * ]
283
- * },
284
- * {
285
- * groupId: 'insertInline',
286
- * items: [
287
- * 'menuBar:link',
288
- * 'menuBar:insertFootnote',
289
- * 'menuBar:bookmark',
290
- * 'menuBar:comment',
291
- * 'menuBar:insertMergeField',
292
- * 'menuBar:emoji'
293
- * ]
294
- * },
295
- * {
296
- * groupId: 'insertMinorWidgets',
297
- * items: [
298
- * 'menuBar:mediaEmbed',
299
- * 'menuBar:insertTemplate',
300
- * 'menuBar:blockQuote',
301
- * 'menuBar:codeBlock',
302
- * 'menuBar:htmlEmbed'
303
- * ]
304
- * },
305
- * {
306
- * groupId: 'insertStructureWidgets',
307
- * items: [
308
- * 'menuBar:horizontalLine',
309
- * 'menuBar:pageBreak',
310
- * 'menuBar:tableOfContents'
311
- * ]
312
- * },
313
- * {
314
- * groupId: 'restrictedEditing',
315
- * items: [
316
- * 'menuBar:restrictedEditing'
317
- * ]
318
- * }
319
- * ]
320
- * },
321
- * {
322
- * menuId: 'format',
323
- * label: 'Format',
324
- * groups: [
325
- * {
326
- * groupId: 'textAndFont',
327
- * items: [
328
- * {
329
- * menuId: 'text',
330
- * label: 'Text',
331
- * groups: [
332
- * {
333
- * groupId: 'basicStyles',
334
- * items: [
335
- * 'menuBar:bold',
336
- * 'menuBar:italic',
337
- * 'menuBar:underline',
338
- * 'menuBar:strikethrough',
339
- * 'menuBar:superscript',
340
- * 'menuBar:subscript',
341
- * 'menuBar:code'
342
- * ]
343
- * },
344
- * {
345
- * groupId: 'textPartLanguage',
346
- * items: [
347
- * 'menuBar:textPartLanguage'
348
- * ]
349
- * }
350
- * ]
351
- * },
352
- * {
353
- * menuId: 'font',
354
- * label: 'Font',
355
- * groups: [
356
- * {
357
- * groupId: 'fontProperties',
358
- * items: [
359
- * 'menuBar:fontSize',
360
- * 'menuBar:fontFamily'
361
- * ]
362
- * },
363
- * {
364
- * groupId: 'fontColors',
365
- * items: [
366
- * 'menuBar:fontColor',
367
- * 'menuBar:fontBackgroundColor'
368
- * ]
369
- * },
370
- * {
371
- * groupId: 'highlight',
372
- * items: [
373
- * 'menuBar:highlight'
374
- * ]
375
- * }
376
- * ]
377
- * },
378
- * 'menuBar:heading'
379
- * ]
380
- * },
381
- * {
382
- * groupId: 'list',
383
- * items: [
384
- * 'menuBar:bulletedList',
385
- * 'menuBar:numberedList',
386
- * 'menuBar:multiLevelList',
387
- * 'menuBar:todoList'
388
- * ]
389
- * },
390
- * {
391
- * groupId: 'indent',
392
- * items: [
393
- * 'menuBar:alignment',
394
- * 'menuBar:lineHeight',
395
- * 'menuBar:indent',
396
- * 'menuBar:outdent'
397
- * ]
398
- * },
399
- * {
400
- * groupId: 'caseChange',
401
- * items: [
402
- * 'menuBar:caseChange'
403
- * ]
404
- * },
405
- * {
406
- * groupId: 'removeFormat',
407
- * items: [
408
- * 'menuBar:removeFormat'
409
- * ]
410
- * }
411
- * ]
412
- * },
413
- * {
414
- * menuId: 'tools',
415
- * label: 'Tools',
416
- * groups: [
417
- * {
418
- * groupId: 'aiTools',
419
- * items: [
420
- * 'menuBar:aiAssistant',
421
- * 'menuBar:aiCommands',
422
- * 'menuBar:toggleAi',
423
- * 'menuBar:aiQuickActions'
424
- * ]
425
- * },
426
- * {
427
- * groupId: 'tools',
428
- * items: [
429
- * 'menuBar:trackChanges',
430
- * 'menuBar:commentsArchive'
431
- * ]
432
- * }
433
- * ]
434
- * },
435
- * {
436
- * menuId: 'help',
437
- * label: 'Help',
438
- * groups: [
439
- * {
440
- * groupId: 'help',
441
- * items: [
442
- * 'menuBar:accessibilityHelp'
443
- * ]
444
- * }
445
- * ]
446
- * }
447
- * ];
448
- * ```
449
- *
450
- * The menu bar can be customized using the `config.menuBar.removeItems` and `config.menuBar.addItems` properties.
451
- */
452
- export declare const DefaultMenuBarItems: MenuBarConfigObject['items'];
167
+ * The default items {@link module:core/editor/editorconfig~EditorConfig#menuBar configuration} of the
168
+ * {@link module:ui/menubar/menubarview~MenuBarView} component. It contains names of all menu bar components
169
+ * registered in the {@link module:ui/componentfactory~ComponentFactory component factory} (available in the project).
170
+ *
171
+ * **Note**: Menu bar component names provided by core editor features are prefixed with `menuBar:` in order to distinguish
172
+ * them from components referenced by the {@link module:core/editor/editorconfig~EditorConfig#toolbar toolbar configuration}, for instance,
173
+ * `'menuBar:bold'` is a menu bar button but `'bold'` is a toolbar button.
174
+ *
175
+ * Below is the preset menu bar structure (the default value of `config.menuBar.items` property):
176
+ *
177
+ * ```ts
178
+ * [
179
+ * {
180
+ * menuId: 'file',
181
+ * label: 'File',
182
+ * groups: [
183
+ * {
184
+ * groupId: 'export',
185
+ * items: [
186
+ * 'menuBar:exportPdf',
187
+ * 'menuBar:exportWord'
188
+ * ]
189
+ * },
190
+ * {
191
+ * groupId: 'import',
192
+ * items: [
193
+ * 'menuBar:importWord'
194
+ * ]
195
+ * },
196
+ * {
197
+ * groupId: 'revisionHistory',
198
+ * items: [
199
+ * 'menuBar:revisionHistory'
200
+ * ]
201
+ * }
202
+ * ]
203
+ * },
204
+ * {
205
+ * menuId: 'edit',
206
+ * label: 'Edit',
207
+ * groups: [
208
+ * {
209
+ * groupId: 'undo',
210
+ * items: [
211
+ * 'menuBar:undo',
212
+ * 'menuBar:redo'
213
+ * ]
214
+ * },
215
+ * {
216
+ * groupId: 'selectAll',
217
+ * items: [
218
+ * 'menuBar:selectAll'
219
+ * ]
220
+ * },
221
+ * {
222
+ * groupId: 'findAndReplace',
223
+ * items: [
224
+ * 'menuBar:findAndReplace'
225
+ * ]
226
+ * }
227
+ * ]
228
+ * },
229
+ * {
230
+ * menuId: 'view',
231
+ * label: 'View',
232
+ * groups: [
233
+ * {
234
+ * groupId: 'sourceEditingEnhanced',
235
+ * items: [
236
+ * 'menuBar:sourceEditingEnhanced'
237
+ * ]
238
+ * },
239
+ * {
240
+ * groupId: 'sourceEditing',
241
+ * items: [
242
+ * 'menuBar:sourceEditing'
243
+ * ]
244
+ * },
245
+ * {
246
+ * groupId: 'showBlocks',
247
+ * items: [
248
+ * 'menuBar:showBlocks'
249
+ * ]
250
+ * },
251
+ * {
252
+ * groupId: 'previewMergeFields',
253
+ * items: [
254
+ * 'menuBar:previewMergeFields'
255
+ * ]
256
+ * },
257
+ * {
258
+ * groupId: 'fullscreen',
259
+ * items: [
260
+ * 'menuBar:fullscreen'
261
+ * ]
262
+ * },
263
+ * {
264
+ * groupId: 'restrictedEditingException',
265
+ * items: [
266
+ * 'menuBar:restrictedEditingException'
267
+ * ]
268
+ * }
269
+ * ]
270
+ * },
271
+ * {
272
+ * menuId: 'insert',
273
+ * label: 'Insert',
274
+ * groups: [
275
+ * {
276
+ * groupId: 'insertMainWidgets',
277
+ * items: [
278
+ * 'menuBar:insertImage',
279
+ * 'menuBar:ckbox',
280
+ * 'menuBar:ckfinder',
281
+ * 'menuBar:insertTable'
282
+ * ]
283
+ * },
284
+ * {
285
+ * groupId: 'insertInline',
286
+ * items: [
287
+ * 'menuBar:link',
288
+ * 'menuBar:insertFootnote',
289
+ * 'menuBar:bookmark',
290
+ * 'menuBar:comment',
291
+ * 'menuBar:insertMergeField',
292
+ * 'menuBar:emoji'
293
+ * ]
294
+ * },
295
+ * {
296
+ * groupId: 'insertMinorWidgets',
297
+ * items: [
298
+ * 'menuBar:mediaEmbed',
299
+ * 'menuBar:insertTemplate',
300
+ * 'menuBar:blockQuote',
301
+ * 'menuBar:codeBlock',
302
+ * 'menuBar:htmlEmbed'
303
+ * ]
304
+ * },
305
+ * {
306
+ * groupId: 'insertStructureWidgets',
307
+ * items: [
308
+ * 'menuBar:horizontalLine',
309
+ * 'menuBar:pageBreak',
310
+ * 'menuBar:tableOfContents'
311
+ * ]
312
+ * },
313
+ * {
314
+ * groupId: 'restrictedEditing',
315
+ * items: [
316
+ * 'menuBar:restrictedEditing'
317
+ * ]
318
+ * }
319
+ * ]
320
+ * },
321
+ * {
322
+ * menuId: 'format',
323
+ * label: 'Format',
324
+ * groups: [
325
+ * {
326
+ * groupId: 'textAndFont',
327
+ * items: [
328
+ * {
329
+ * menuId: 'text',
330
+ * label: 'Text',
331
+ * groups: [
332
+ * {
333
+ * groupId: 'basicStyles',
334
+ * items: [
335
+ * 'menuBar:bold',
336
+ * 'menuBar:italic',
337
+ * 'menuBar:underline',
338
+ * 'menuBar:strikethrough',
339
+ * 'menuBar:superscript',
340
+ * 'menuBar:subscript',
341
+ * 'menuBar:code'
342
+ * ]
343
+ * },
344
+ * {
345
+ * groupId: 'textPartLanguage',
346
+ * items: [
347
+ * 'menuBar:textPartLanguage'
348
+ * ]
349
+ * }
350
+ * ]
351
+ * },
352
+ * {
353
+ * menuId: 'font',
354
+ * label: 'Font',
355
+ * groups: [
356
+ * {
357
+ * groupId: 'fontProperties',
358
+ * items: [
359
+ * 'menuBar:fontSize',
360
+ * 'menuBar:fontFamily'
361
+ * ]
362
+ * },
363
+ * {
364
+ * groupId: 'fontColors',
365
+ * items: [
366
+ * 'menuBar:fontColor',
367
+ * 'menuBar:fontBackgroundColor'
368
+ * ]
369
+ * },
370
+ * {
371
+ * groupId: 'highlight',
372
+ * items: [
373
+ * 'menuBar:highlight'
374
+ * ]
375
+ * }
376
+ * ]
377
+ * },
378
+ * 'menuBar:heading'
379
+ * ]
380
+ * },
381
+ * {
382
+ * groupId: 'list',
383
+ * items: [
384
+ * 'menuBar:bulletedList',
385
+ * 'menuBar:numberedList',
386
+ * 'menuBar:multiLevelList',
387
+ * 'menuBar:todoList'
388
+ * ]
389
+ * },
390
+ * {
391
+ * groupId: 'indent',
392
+ * items: [
393
+ * 'menuBar:alignment',
394
+ * 'menuBar:lineHeight',
395
+ * 'menuBar:indent',
396
+ * 'menuBar:outdent'
397
+ * ]
398
+ * },
399
+ * {
400
+ * groupId: 'caseChange',
401
+ * items: [
402
+ * 'menuBar:caseChange'
403
+ * ]
404
+ * },
405
+ * {
406
+ * groupId: 'removeFormat',
407
+ * items: [
408
+ * 'menuBar:removeFormat'
409
+ * ]
410
+ * }
411
+ * ]
412
+ * },
413
+ * {
414
+ * menuId: 'tools',
415
+ * label: 'Tools',
416
+ * groups: [
417
+ * {
418
+ * groupId: 'aiTools',
419
+ * items: [
420
+ * 'menuBar:aiAssistant',
421
+ * 'menuBar:aiCommands',
422
+ * 'menuBar:toggleAi',
423
+ * 'menuBar:aiQuickActions'
424
+ * ]
425
+ * },
426
+ * {
427
+ * groupId: 'tools',
428
+ * items: [
429
+ * 'menuBar:trackChanges',
430
+ * 'menuBar:commentsArchive'
431
+ * ]
432
+ * }
433
+ * ]
434
+ * },
435
+ * {
436
+ * menuId: 'help',
437
+ * label: 'Help',
438
+ * groups: [
439
+ * {
440
+ * groupId: 'help',
441
+ * items: [
442
+ * 'menuBar:accessibilityHelp'
443
+ * ]
444
+ * }
445
+ * ]
446
+ * }
447
+ * ];
448
+ * ```
449
+ *
450
+ * The menu bar can be customized using the `config.menuBar.removeItems` and `config.menuBar.addItems` properties.
451
+ */
452
+ export declare const DefaultMenuBarItems: MenuBarConfigObject["items"];
453
453
  /**
454
- * Performs a cleanup and normalization of the menu bar configuration.
455
- */
454
+ * Performs a cleanup and normalization of the menu bar configuration.
455
+ */
456
456
  export declare function normalizeMenuBarConfig(config: Readonly<MenuBarConfig>): NormalizedMenuBarConfigObject;
457
457
  /**
458
- * Processes a normalized menu bar config and returns a config clone with the following modifications:
459
- *
460
- * * Removed components that are not available in the component factory,
461
- * * Removed obsolete separators,
462
- * * Purged empty menus,
463
- * * Localized top-level menu labels.
464
- * @internal
465
- */
458
+ * Processes a normalized menu bar config and returns a config clone with the following modifications:
459
+ *
460
+ * * Removed components that are not available in the component factory,
461
+ * * Removed obsolete separators,
462
+ * * Purged empty menus,
463
+ * * Localized top-level menu labels.
464
+ * @internal
465
+ */
466
466
  export declare function processMenuBarConfig({ normalizedConfig, locale, componentFactory, extraItems }: {
467
- normalizedConfig: NormalizedMenuBarConfigObject;
468
- locale: Locale;
469
- componentFactory: ComponentFactory;
470
- extraItems: Array<MenuBarConfigAddedItem | MenuBarConfigAddedGroup | MenuBarConfigAddedMenu>;
467
+ normalizedConfig: NormalizedMenuBarConfigObject;
468
+ locale: Locale;
469
+ componentFactory: ComponentFactory;
470
+ extraItems: Array<MenuBarConfigAddedItem | MenuBarConfigAddedGroup | MenuBarConfigAddedMenu>;
471
471
  }): NormalizedMenuBarConfigObject;