@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,57 +1,57 @@
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
- */
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
5
  /**
6
- * @module ui/bindings/submithandler
7
- */
8
- import { type View } from '../view.js';
6
+ * @module ui/bindings/submithandler
7
+ */
8
+ import { type View } from "../view.js";
9
9
  /**
10
- * A handler useful for {@link module:ui/view~View views} working as HTML forms. It intercepts a native DOM
11
- * `submit` event, prevents the default web browser behavior (navigation and page reload) and
12
- * fires the `submit` event on a view instead. Such a custom event can be then used by any
13
- * {@link module:utils/dom/emittermixin~DomEmitter emitter}, e.g. to serialize the form data.
14
- *
15
- * ```ts
16
- * import { submitHandler } from '@ckeditor/ckeditor5-ui/src/bindings/submithandler';
17
- *
18
- * // ...
19
- *
20
- * class AnyFormView extends View {
21
- * constructor() {
22
- * super();
23
- *
24
- * // ...
25
- *
26
- * submitHandler( {
27
- * view: this
28
- * } );
29
- * }
30
- * }
31
- *
32
- * // ...
33
- *
34
- * const view = new AnyFormView();
35
- *
36
- * // A sample listener attached by an emitter working with the view.
37
- * this.listenTo( view, 'submit', () => {
38
- * saveTheFormData();
39
- * hideTheForm();
40
- * } );
41
- * ```
42
- *
43
- * @param options Configuration options.
44
- * @param options.view The view which DOM `submit` events should be handled.
45
- */
10
+ * A handler useful for {@link module:ui/view~View views} working as HTML forms. It intercepts a native DOM
11
+ * `submit` event, prevents the default web browser behavior (navigation and page reload) and
12
+ * fires the `submit` event on a view instead. Such a custom event can be then used by any
13
+ * {@link module:utils/dom/emittermixin~DomEmitter emitter}, e.g. to serialize the form data.
14
+ *
15
+ * ```ts
16
+ * import { submitHandler } from '@ckeditor/ckeditor5-ui/src/bindings/submithandler';
17
+ *
18
+ * // ...
19
+ *
20
+ * class AnyFormView extends View {
21
+ * constructor() {
22
+ * super();
23
+ *
24
+ * // ...
25
+ *
26
+ * submitHandler( {
27
+ * view: this
28
+ * } );
29
+ * }
30
+ * }
31
+ *
32
+ * // ...
33
+ *
34
+ * const view = new AnyFormView();
35
+ *
36
+ * // A sample listener attached by an emitter working with the view.
37
+ * this.listenTo( view, 'submit', () => {
38
+ * saveTheFormData();
39
+ * hideTheForm();
40
+ * } );
41
+ * ```
42
+ *
43
+ * @param options Configuration options.
44
+ * @param options.view The view which DOM `submit` events should be handled.
45
+ */
46
46
  export declare function submitHandler({ view }: {
47
- view: View;
47
+ view: View;
48
48
  }): void;
49
49
  /**
50
- * Fired by {@link module:ui/bindings/submithandler~submitHandler} helper.
51
- *
52
- * @eventName module:ui/view~View#submit
53
- */
50
+ * Fired by {@link module:ui/bindings/submithandler~submitHandler} helper.
51
+ *
52
+ * @eventName module:ui/view~View#submit
53
+ */
54
54
  export type SubmitHandlerEvent = {
55
- name: 'submit';
56
- args: [];
55
+ name: "submit";
56
+ args: [];
57
57
  };
@@ -1,175 +1,175 @@
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
- */
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
5
  /**
6
- * @module ui/button/button
7
- */
6
+ * @module ui/button/button
7
+ */
8
8
  /**
9
- * The button interface. Implemented by, among others, {@link module:ui/button/buttonview~ButtonView},
10
- * {@link module:ui/dropdown/button/splitbuttonview~SplitButtonView} and
11
- * {@link module:ui/dropdown/button/dropdownbuttonview~DropdownButtonView}.
12
- */
9
+ * The button interface. Implemented by, among others, {@link module:ui/button/buttonview~ButtonView},
10
+ * {@link module:ui/dropdown/button/splitbuttonview~SplitButtonView} and
11
+ * {@link module:ui/dropdown/button/dropdownbuttonview~DropdownButtonView}.
12
+ */
13
13
  export interface Button {
14
- /**
15
- * The label of the button view visible to the user when {@link #withText} is `true`.
16
- * It can also be used to create a {@link #tooltip}.
17
- *
18
- * @observable
19
- */
20
- label: string | undefined;
21
- /**
22
- * (Optional) The keystroke associated with the button, i.e. <kbd>CTRL+B</kbd>,
23
- * in the string format compatible with {@link module:utils/keyboard}.
24
- *
25
- * **Note**: Use {@link module:ui/button/button~Button#withKeystroke} if you want to display
26
- * the keystroke information next to the {@link module:ui/button/button~Button#label label}.
27
- *
28
- * @observable
29
- */
30
- keystroke: string | undefined;
31
- /**
32
- * (Optional) Tooltip of the button, i.e. displayed when hovering the button with the mouse cursor.
33
- *
34
- * * If defined as a `Boolean` (e.g. `true`), then combination of `label` and `keystroke` will be set as a tooltip.
35
- * * If defined as a `String`, tooltip will equal the exact text of that `String`.
36
- * * If defined as a `Function`, `label` and `keystroke` will be passed to that function, which is to return
37
- * a string with the tooltip text.
38
- *
39
- * ```ts
40
- * const view = new ButtonView( locale );
41
- * view.tooltip = ( label, keystroke ) => `A tooltip for ${ label } and ${ keystroke }.`
42
- * ```
43
- *
44
- * @observable
45
- * @default false
46
- */
47
- tooltip: boolean | string | ((label: string, keystroke: string | undefined) => string);
48
- /**
49
- * (Optional) The position of the tooltip. See {@link module:ui/tooltipmanager~TooltipManager}
50
- * to learn more about the tooltip system.
51
- *
52
- * **Note:** It makes sense only when the {@link #tooltip `tooltip` attribute} is defined.
53
- *
54
- * @observable
55
- * @default 's'
56
- */
57
- tooltipPosition: 's' | 'n' | 'e' | 'w' | 'sw' | 'se';
58
- /**
59
- * The HTML type of the button.
60
- *
61
- * @observable
62
- * @default 'button'
63
- */
64
- type: 'button' | 'submit' | 'reset' | 'menu';
65
- /**
66
- * Controls whether the button view is "on". It makes sense when a feature it represents
67
- * is currently active, e.g. a bold button is "on" when the selection is in the bold text.
68
- *
69
- * To disable the button, use {@link #isEnabled} instead.
70
- *
71
- * @observable
72
- * @default true
73
- */
74
- isOn: boolean;
75
- /**
76
- * Controls whether the button view is enabled, i.e. it can be clicked and execute an action.
77
- *
78
- * To change the "on" state of the button, use {@link #isOn} instead.
79
- *
80
- * @observable
81
- * @default true
82
- */
83
- isEnabled: boolean;
84
- /**
85
- * Controls whether the button view is visible. Visible by default, buttons are hidden
86
- * using a CSS class.
87
- *
88
- * @observable
89
- * @default true
90
- */
91
- isVisible: boolean;
92
- /**
93
- * Controls whether the button view is a toggle button (two–state) for assistive technologies.
94
- *
95
- * @observable
96
- * @default false
97
- */
98
- isToggleable: boolean;
99
- /**
100
- * (Optional) Controls whether the label of the button is hidden (e.g. an icon–only button).
101
- *
102
- * @observable
103
- * @default false
104
- */
105
- withText: boolean;
106
- /**
107
- * (Optional) Controls whether the keystroke of the button is displayed next to its
108
- * {@link module:ui/button/button~Button#label label}.
109
- *
110
- * **Note**: This property requires a {@link module:ui/button/button~Button#keystroke keystroke}
111
- * to be defined in the first place.
112
- *
113
- * @observable
114
- * @default false
115
- */
116
- withKeystroke: boolean;
117
- /**
118
- * (Optional) An XML {@link module:ui/icon/iconview~IconView#content content} of the icon.
119
- * When defined, an `iconView` should be added to the button.
120
- *
121
- * The user must provide the entire XML string, not just the path. See the
122
- * {@glink framework/architecture/ui-library#setting-label-icon-and-tooltip UI library} guide for details.
123
- *
124
- * @observable
125
- */
126
- icon: string | undefined;
127
- /**
128
- * (Optional) Controls the `tabindex` HTML attribute of the button. By default, the button is focusable
129
- * but does not included in the <kbd>Tab</kbd> order.
130
- *
131
- * @observable
132
- * @default -1
133
- */
134
- tabindex: number;
135
- /**
136
- * (Optional) The additional CSS class set on the button.
137
- *
138
- * @observable
139
- */
140
- class: string | undefined;
141
- /**
142
- * (Optional) The ARIA property reflected by the `aria-label` DOM attribute used by assistive technologies.
143
- *
144
- * @observable
145
- */
146
- ariaLabel?: string | undefined;
147
- /**
148
- * (Optional) The ARIA property reflected by the `aria-ariaLabelledBy` DOM attribute used by assistive technologies.
149
- *
150
- * @observable
151
- */
152
- ariaLabelledBy?: string | undefined;
153
- /**
154
- * (Optional) The property reflected by the `role` DOM attribute to be used by assistive technologies.
155
- *
156
- * @observable
157
- */
158
- role?: string | undefined;
159
- /**
160
- * (Optional) The value of the `style` attribute of the label.
161
- *
162
- * @observable
163
- */
164
- labelStyle: string | undefined;
14
+ /**
15
+ * The label of the button view visible to the user when {@link #withText} is `true`.
16
+ * It can also be used to create a {@link #tooltip}.
17
+ *
18
+ * @observable
19
+ */
20
+ label: string | undefined;
21
+ /**
22
+ * (Optional) The keystroke associated with the button, i.e. <kbd>CTRL+B</kbd>,
23
+ * in the string format compatible with {@link module:utils/keyboard}.
24
+ *
25
+ * **Note**: Use {@link module:ui/button/button~Button#withKeystroke} if you want to display
26
+ * the keystroke information next to the {@link module:ui/button/button~Button#label label}.
27
+ *
28
+ * @observable
29
+ */
30
+ keystroke: string | undefined;
31
+ /**
32
+ * (Optional) Tooltip of the button, i.e. displayed when hovering the button with the mouse cursor.
33
+ *
34
+ * * If defined as a `Boolean` (e.g. `true`), then combination of `label` and `keystroke` will be set as a tooltip.
35
+ * * If defined as a `String`, tooltip will equal the exact text of that `String`.
36
+ * * If defined as a `Function`, `label` and `keystroke` will be passed to that function, which is to return
37
+ * a string with the tooltip text.
38
+ *
39
+ * ```ts
40
+ * const view = new ButtonView( locale );
41
+ * view.tooltip = ( label, keystroke ) => `A tooltip for ${ label } and ${ keystroke }.`
42
+ * ```
43
+ *
44
+ * @observable
45
+ * @default false
46
+ */
47
+ tooltip: boolean | string | ((label: string, keystroke: string | undefined) => string);
48
+ /**
49
+ * (Optional) The position of the tooltip. See {@link module:ui/tooltipmanager~TooltipManager}
50
+ * to learn more about the tooltip system.
51
+ *
52
+ * **Note:** It makes sense only when the {@link #tooltip `tooltip` attribute} is defined.
53
+ *
54
+ * @observable
55
+ * @default 's'
56
+ */
57
+ tooltipPosition: "s" | "n" | "e" | "w" | "sw" | "se";
58
+ /**
59
+ * The HTML type of the button.
60
+ *
61
+ * @observable
62
+ * @default 'button'
63
+ */
64
+ type: "button" | "submit" | "reset" | "menu";
65
+ /**
66
+ * Controls whether the button view is "on". It makes sense when a feature it represents
67
+ * is currently active, e.g. a bold button is "on" when the selection is in the bold text.
68
+ *
69
+ * To disable the button, use {@link #isEnabled} instead.
70
+ *
71
+ * @observable
72
+ * @default true
73
+ */
74
+ isOn: boolean;
75
+ /**
76
+ * Controls whether the button view is enabled, i.e. it can be clicked and execute an action.
77
+ *
78
+ * To change the "on" state of the button, use {@link #isOn} instead.
79
+ *
80
+ * @observable
81
+ * @default true
82
+ */
83
+ isEnabled: boolean;
84
+ /**
85
+ * Controls whether the button view is visible. Visible by default, buttons are hidden
86
+ * using a CSS class.
87
+ *
88
+ * @observable
89
+ * @default true
90
+ */
91
+ isVisible: boolean;
92
+ /**
93
+ * Controls whether the button view is a toggle button (two–state) for assistive technologies.
94
+ *
95
+ * @observable
96
+ * @default false
97
+ */
98
+ isToggleable: boolean;
99
+ /**
100
+ * (Optional) Controls whether the label of the button is hidden (e.g. an icon–only button).
101
+ *
102
+ * @observable
103
+ * @default false
104
+ */
105
+ withText: boolean;
106
+ /**
107
+ * (Optional) Controls whether the keystroke of the button is displayed next to its
108
+ * {@link module:ui/button/button~Button#label label}.
109
+ *
110
+ * **Note**: This property requires a {@link module:ui/button/button~Button#keystroke keystroke}
111
+ * to be defined in the first place.
112
+ *
113
+ * @observable
114
+ * @default false
115
+ */
116
+ withKeystroke: boolean;
117
+ /**
118
+ * (Optional) An XML {@link module:ui/icon/iconview~IconView#content content} of the icon.
119
+ * When defined, an `iconView` should be added to the button.
120
+ *
121
+ * The user must provide the entire XML string, not just the path. See the
122
+ * {@glink framework/architecture/ui-library#setting-label-icon-and-tooltip UI library} guide for details.
123
+ *
124
+ * @observable
125
+ */
126
+ icon: string | undefined;
127
+ /**
128
+ * (Optional) Controls the `tabindex` HTML attribute of the button. By default, the button is focusable
129
+ * but does not included in the <kbd>Tab</kbd> order.
130
+ *
131
+ * @observable
132
+ * @default -1
133
+ */
134
+ tabindex: number;
135
+ /**
136
+ * (Optional) The additional CSS class set on the button.
137
+ *
138
+ * @observable
139
+ */
140
+ class: string | undefined;
141
+ /**
142
+ * (Optional) The ARIA property reflected by the `aria-label` DOM attribute used by assistive technologies.
143
+ *
144
+ * @observable
145
+ */
146
+ ariaLabel?: string | undefined;
147
+ /**
148
+ * (Optional) The ARIA property reflected by the `aria-ariaLabelledBy` DOM attribute used by assistive technologies.
149
+ *
150
+ * @observable
151
+ */
152
+ ariaLabelledBy?: string | undefined;
153
+ /**
154
+ * (Optional) The property reflected by the `role` DOM attribute to be used by assistive technologies.
155
+ *
156
+ * @observable
157
+ */
158
+ role?: string | undefined;
159
+ /**
160
+ * (Optional) The value of the `style` attribute of the label.
161
+ *
162
+ * @observable
163
+ */
164
+ labelStyle: string | undefined;
165
165
  }
166
166
  /**
167
- * Fired when the button view is clicked. It won't be fired when the button {@link module:ui/button/button~Button#isEnabled}
168
- * is `false`.
169
- *
170
- * @eventName ~Button#execute
171
- */
167
+ * Fired when the button view is clicked. It won't be fired when the button {@link module:ui/button/button~Button#isEnabled}
168
+ * is `false`.
169
+ *
170
+ * @eventName ~Button#execute
171
+ */
172
172
  export type ButtonExecuteEvent = {
173
- name: 'execute';
174
- args: [];
173
+ name: "execute";
174
+ args: [];
175
175
  };
@@ -1,34 +1,34 @@
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
- */
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
5
  /**
6
- * @module ui/button/buttonlabel
6
+ * @module ui/button/buttonlabel
7
7
  */
8
- import { type View } from '../view.js';
8
+ import { type View } from "../view.js";
9
9
  /**
10
- * The button label interface. Implemented by the {@link module:ui/button/buttonlabelview~ButtonLabelView}
11
- * and any label view that can be used with the {@link module:ui/button/buttonview~ButtonView}.
12
- */
10
+ * The button label interface. Implemented by the {@link module:ui/button/buttonlabelview~ButtonLabelView}
11
+ * and any label view that can be used with the {@link module:ui/button/buttonview~ButtonView}.
12
+ */
13
13
  export interface ButtonLabel extends View {
14
- /**
15
- * The `id` attribute of the button label. It is used for accessibility purposes
16
- * to describe the button.
17
- *
18
- * @observable
19
- */
20
- id: string | undefined;
21
- /**
22
- * The `style` attribute of the button label. It allows customizing the presentation
23
- * of the label.
24
- *
25
- * @observable
26
- */
27
- style: string | undefined;
28
- /**
29
- * The human-readable text of the label.
30
- *
31
- * @observable
32
- */
33
- text: string | undefined;
14
+ /**
15
+ * The `id` attribute of the button label. It is used for accessibility purposes
16
+ * to describe the button.
17
+ *
18
+ * @observable
19
+ */
20
+ id: string | undefined;
21
+ /**
22
+ * The `style` attribute of the button label. It allows customizing the presentation
23
+ * of the label.
24
+ *
25
+ * @observable
26
+ */
27
+ style: string | undefined;
28
+ /**
29
+ * The human-readable text of the label.
30
+ *
31
+ * @observable
32
+ */
33
+ text: string | undefined;
34
34
  }
@@ -1,31 +1,31 @@
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
- */
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
5
  /**
6
- * @module ui/button/buttonlabelview
7
- */
8
- import { View } from '../view.js';
9
- import { type ButtonLabel } from './buttonlabel.js';
6
+ * @module ui/button/buttonlabelview
7
+ */
8
+ import { View } from "../view.js";
9
+ import { type ButtonLabel } from "./buttonlabel.js";
10
10
  /**
11
- * A default implementation of the button view's label. It comes with a dynamic text support
12
- * via {@link module:ui/button/buttonlabelview~ButtonLabelView#text} property.
13
- */
11
+ * A default implementation of the button view's label. It comes with a dynamic text support
12
+ * via {@link module:ui/button/buttonlabelview~ButtonLabelView#text} property.
13
+ */
14
14
  export declare class ButtonLabelView extends View implements ButtonLabel {
15
- /**
16
- * @inheritDoc
17
- */
18
- id: string | undefined;
19
- /**
20
- * @inheritDoc
21
- */
22
- style: string | undefined;
23
- /**
24
- * @inheritDoc
25
- */
26
- text: string | undefined;
27
- /**
28
- * @inheritDoc
29
- */
30
- constructor();
15
+ /**
16
+ * @inheritDoc
17
+ */
18
+ id: string | undefined;
19
+ /**
20
+ * @inheritDoc
21
+ */
22
+ style: string | undefined;
23
+ /**
24
+ * @inheritDoc
25
+ */
26
+ text: string | undefined;
27
+ /**
28
+ * @inheritDoc
29
+ */
30
+ constructor();
31
31
  }