@ckeditor/ckeditor5-ui 48.8.1-alpha.4 → 49.0.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 (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 +3240 -2329
  72. package/dist/index-editor.css.map +1 -0
  73. package/dist/index.css +2939 -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,73 +1,73 @@
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 { ButtonView } from '../../button/buttonview.js';
6
- import { IconView } from '../../icon/iconview.js';
7
- import { LabeledFieldView, type LabeledFieldViewCreator } from '../../labeledfield/labeledfieldview.js';
8
- import { type InputBase } from '../../input/inputbase.js';
9
- import type { Locale } 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 { ButtonView } from "../../button/buttonview.js";
6
+ import { IconView } from "../../icon/iconview.js";
7
+ import { LabeledFieldView, type LabeledFieldViewCreator } from "../../labeledfield/labeledfieldview.js";
8
+ import { type InputBase } from "../../input/inputbase.js";
9
+ import type { Locale } from "@ckeditor/ckeditor5-utils";
10
10
  /**
11
- * A search input field for the {@link module:ui/search/text/searchtextview~SearchTextView} component.
12
- *
13
- * @internal
14
- * @extends module:ui/labeledfield/labeledfieldview~LabeledFieldView
15
- */
11
+ * A search input field for the {@link module:ui/search/text/searchtextview~SearchTextView} component.
12
+ *
13
+ * @internal
14
+ * @extends module:ui/labeledfield/labeledfieldview~LabeledFieldView
15
+ */
16
16
  export declare class SearchTextQueryView<TQueryFieldView extends InputBase<HTMLInputElement | HTMLTextAreaElement>> extends LabeledFieldView<TQueryFieldView> {
17
- /**
18
- * The loupe icon displayed next to the {@link #fieldView}.
19
- */
20
- iconView?: IconView;
21
- /**
22
- * The button that clears and focuses the {@link #fieldView}.
23
- */
24
- resetButtonView?: ButtonView;
25
- /**
26
- * A reference to the view configuration.
27
- */
28
- private readonly _viewConfig;
29
- /**
30
- * @inheritDoc
31
- */
32
- constructor(locale: Locale, config: SearchTextQueryViewConfig<TQueryFieldView>);
33
- /**
34
- * Resets the search field to its default state.
35
- */
36
- reset(): void;
17
+ /**
18
+ * The loupe icon displayed next to the {@link #fieldView}.
19
+ */
20
+ iconView?: IconView;
21
+ /**
22
+ * The button that clears and focuses the {@link #fieldView}.
23
+ */
24
+ resetButtonView?: ButtonView;
25
+ /**
26
+ * A reference to the view configuration.
27
+ */
28
+ private readonly _viewConfig;
29
+ /**
30
+ * @inheritDoc
31
+ */
32
+ constructor(locale: Locale, config: SearchTextQueryViewConfig<TQueryFieldView>);
33
+ /**
34
+ * Resets the search field to its default state.
35
+ */
36
+ reset(): void;
37
37
  }
38
38
  /**
39
- * An event fired when the field is reset using the
40
- * {@link module:ui/search/text/searchtextqueryview~SearchTextQueryView#resetButtonView}.
41
- *
42
- * @eventName ~SearchTextQueryView#reset
43
- */
39
+ * An event fired when the field is reset using the
40
+ * {@link module:ui/search/text/searchtextqueryview~SearchTextQueryView#resetButtonView}.
41
+ *
42
+ * @eventName ~SearchTextQueryView#reset
43
+ */
44
44
  export type SearchTextQueryViewResetEvent = {
45
- name: 'reset';
46
- args: [];
45
+ name: "reset";
46
+ args: [];
47
47
  };
48
48
  /**
49
- * The configuration of the {@link module:ui/search/text/searchtextqueryview~SearchTextQueryView} view.
50
- */
49
+ * The configuration of the {@link module:ui/search/text/searchtextqueryview~SearchTextQueryView} view.
50
+ */
51
51
  export interface SearchTextQueryViewConfig<TConfigSearchField extends InputBase<HTMLInputElement | HTMLTextAreaElement>> {
52
- /**
53
- * The human-readable label of the search field.
54
- */
55
- label: string;
56
- /**
57
- * Determines whether the button that resets the search should be visible.
58
- *
59
- * @default true
60
- */
61
- showResetButton?: boolean;
62
- /**
63
- * Determines whether the loupe icon should be visible.
64
- *
65
- * @default true
66
- */
67
- showIcon?: boolean;
68
- /**
69
- * The function that creates the search field input view. By default, a plain
70
- * {@link module:ui/inputtext/inputtextview~InputTextView} is used for this purpose.
71
- */
72
- creator?: LabeledFieldViewCreator<TConfigSearchField>;
52
+ /**
53
+ * The human-readable label of the search field.
54
+ */
55
+ label: string;
56
+ /**
57
+ * Determines whether the button that resets the search should be visible.
58
+ *
59
+ * @default true
60
+ */
61
+ showResetButton?: boolean;
62
+ /**
63
+ * Determines whether the loupe icon should be visible.
64
+ *
65
+ * @default true
66
+ */
67
+ showIcon?: boolean;
68
+ /**
69
+ * The function that creates the search field input view. By default, a plain
70
+ * {@link module:ui/inputtext/inputtextview~InputTextView} is used for this purpose.
71
+ */
72
+ creator?: LabeledFieldViewCreator<TConfigSearchField>;
73
73
  }
@@ -1,219 +1,218 @@
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/search/text/searchtextview
6
+ * @module ui/search/text/searchtextview
7
7
  */
8
- import { FocusTracker, KeystrokeHandler, type Locale } from '@ckeditor/ckeditor5-utils';
9
- import { View } from '../../view.js';
10
- import { SearchTextQueryView, type SearchTextQueryViewConfig } from './searchtextqueryview.js';
11
- import { SearchResultsView } from '../searchresultsview.js';
12
- import { FocusCycler, type FocusableView } from '../../focuscycler.js';
13
- import { type FilteredView } from '../filteredview.js';
14
- import { type ViewCollection } from '../../viewcollection.js';
15
- import { type InputBase } from '../../input/inputbase.js';
16
- import { type InputTextView } from '../../inputtext/inputtextview.js';
17
- import '../../../theme/components/search/search.css';
8
+ import { FocusTracker, KeystrokeHandler, type Locale } from "@ckeditor/ckeditor5-utils";
9
+ import { View } from "../../view.js";
10
+ import { SearchTextQueryView, type SearchTextQueryViewConfig } from "./searchtextqueryview.js";
11
+ import { SearchResultsView } from "../searchresultsview.js";
12
+ import { FocusCycler, type FocusableView } from "../../focuscycler.js";
13
+ import { type FilteredView } from "../filteredview.js";
14
+ import { type ViewCollection } from "../../viewcollection.js";
15
+ import { type InputBase } from "../../input/inputbase.js";
16
+ import { type InputTextView } from "../../inputtext/inputtextview.js";
18
17
  /**
19
- * A search component that allows filtering of an arbitrary view based on a search query
20
- * specified by the user in a text field.
21
- *
22
- *```ts
23
- * // This view must specify the `filter()` and `focus()` methods.
24
- * const filteredView = ...;
25
- *
26
- * const searchView = new SearchTextView( locale, {
27
- * searchFieldLabel: 'Search list items',
28
- * filteredView
29
- * } );
30
- *
31
- * view.render();
32
- *
33
- * document.body.append( view.element );
34
- * ```
35
- */
18
+ * A search component that allows filtering of an arbitrary view based on a search query
19
+ * specified by the user in a text field.
20
+ *
21
+ *```ts
22
+ * // This view must specify the `filter()` and `focus()` methods.
23
+ * const filteredView = ...;
24
+ *
25
+ * const searchView = new SearchTextView( locale, {
26
+ * searchFieldLabel: 'Search list items',
27
+ * filteredView
28
+ * } );
29
+ *
30
+ * view.render();
31
+ *
32
+ * document.body.append( view.element );
33
+ * ```
34
+ */
36
35
  export declare class SearchTextView<TQueryFieldView extends InputBase<HTMLInputElement | HTMLTextAreaElement> = InputTextView> extends View {
37
- /**
38
- * Tracks information about the DOM focus in the view.
39
- *
40
- * @readonly
41
- */
42
- focusTracker: FocusTracker;
43
- /**
44
- * An instance of the keystroke handler managing user interaction and accessibility.
45
- *
46
- * @readonly
47
- */
48
- keystrokes: KeystrokeHandler;
49
- /**
50
- * A view hosting the {@link #filteredView} passed in the configuration and the {@link #infoView}.
51
- */
52
- resultsView: SearchResultsView;
53
- /**
54
- * The view that is filtered by the search query.
55
- */
56
- filteredView: FilteredView;
57
- /**
58
- * The view that displays the information about the search results.
59
- */
60
- infoView: FocusableView | undefined;
61
- /**
62
- * The view that allows the user to enter the search query.
63
- */
64
- queryView: SearchTextQueryView<TQueryFieldView>;
65
- /**
66
- * Controls whether the component is in read-only mode.
67
- *
68
- * @default true
69
- * @observable
70
- */
71
- isEnabled: boolean;
72
- /**
73
- * The number of results found for the current search query. Updated upon the {@link #search} event.
74
- *
75
- * @default 0
76
- * @observable
77
- */
78
- resultsCount: number;
79
- /**
80
- * The number of the items that can be searched in the {@link #filteredView}. Updated upon the {@link #search} event.
81
- *
82
- * @default 0
83
- * @observable
84
- */
85
- totalItemsCount: number;
86
- /**
87
- * The collection of children of the view.
88
- *
89
- * @readonly
90
- */
91
- readonly children: ViewCollection;
92
- /**
93
- * The collection of focusable children of the view. Used by the focus management logic.
94
- *
95
- * @readonly
96
- */
97
- readonly focusableChildren: ViewCollection<FocusableView>;
98
- locale: Locale;
99
- /**
100
- * Provides the focus management (keyboard navigation) between {@link #queryView} and {@link #filteredView}.
101
- *
102
- * @readonly
103
- */
104
- focusCycler: FocusCycler;
105
- /**
106
- * The cached configuration object.
107
- *
108
- * @internal
109
- */
110
- protected _config: SearchTextViewConfig<TQueryFieldView>;
111
- /**
112
- * Creates an instance of the {@link module:ui/search/text/searchtextview~SearchTextView} class.
113
- *
114
- * @param locale The localization services instance.
115
- * @param config Configuration of the view.
116
- */
117
- constructor(locale: Locale, config: SearchTextViewConfig<TQueryFieldView>);
118
- /**
119
- * @inheritDoc
120
- */
121
- render(): void;
122
- /**
123
- * Focuses the {@link #queryView}.
124
- */
125
- focus(): void;
126
- /**
127
- * Resets the component to its initial state.
128
- */
129
- reset(): void;
130
- /**
131
- * Searches the {@link #filteredView} for the given query.
132
- *
133
- * @internal
134
- * @param query The search query string.
135
- */
136
- search(query: string): void;
137
- /**
138
- * Creates a search field view based on configured creator..
139
- */
140
- private _createSearchTextQueryView;
141
- /**
142
- * Initializes the default {@link #infoView} behavior with default text labels when no custom info view
143
- * was specified in the view config.
144
- */
145
- private _enableDefaultInfoViewBehavior;
36
+ /**
37
+ * Tracks information about the DOM focus in the view.
38
+ *
39
+ * @readonly
40
+ */
41
+ focusTracker: FocusTracker;
42
+ /**
43
+ * An instance of the keystroke handler managing user interaction and accessibility.
44
+ *
45
+ * @readonly
46
+ */
47
+ keystrokes: KeystrokeHandler;
48
+ /**
49
+ * A view hosting the {@link #filteredView} passed in the configuration and the {@link #infoView}.
50
+ */
51
+ resultsView: SearchResultsView;
52
+ /**
53
+ * The view that is filtered by the search query.
54
+ */
55
+ filteredView: FilteredView;
56
+ /**
57
+ * The view that displays the information about the search results.
58
+ */
59
+ infoView: FocusableView | undefined;
60
+ /**
61
+ * The view that allows the user to enter the search query.
62
+ */
63
+ queryView: SearchTextQueryView<TQueryFieldView>;
64
+ /**
65
+ * Controls whether the component is in read-only mode.
66
+ *
67
+ * @default true
68
+ * @observable
69
+ */
70
+ isEnabled: boolean;
71
+ /**
72
+ * The number of results found for the current search query. Updated upon the {@link #search} event.
73
+ *
74
+ * @default 0
75
+ * @observable
76
+ */
77
+ resultsCount: number;
78
+ /**
79
+ * The number of the items that can be searched in the {@link #filteredView}. Updated upon the {@link #search} event.
80
+ *
81
+ * @default 0
82
+ * @observable
83
+ */
84
+ totalItemsCount: number;
85
+ /**
86
+ * The collection of children of the view.
87
+ *
88
+ * @readonly
89
+ */
90
+ readonly children: ViewCollection;
91
+ /**
92
+ * The collection of focusable children of the view. Used by the focus management logic.
93
+ *
94
+ * @readonly
95
+ */
96
+ readonly focusableChildren: ViewCollection<FocusableView>;
97
+ locale: Locale;
98
+ /**
99
+ * Provides the focus management (keyboard navigation) between {@link #queryView} and {@link #filteredView}.
100
+ *
101
+ * @readonly
102
+ */
103
+ focusCycler: FocusCycler;
104
+ /**
105
+ * The cached configuration object.
106
+ *
107
+ * @internal
108
+ */
109
+ protected _config: SearchTextViewConfig<TQueryFieldView>;
110
+ /**
111
+ * Creates an instance of the {@link module:ui/search/text/searchtextview~SearchTextView} class.
112
+ *
113
+ * @param locale The localization services instance.
114
+ * @param config Configuration of the view.
115
+ */
116
+ constructor(locale: Locale, config: SearchTextViewConfig<TQueryFieldView>);
117
+ /**
118
+ * @inheritDoc
119
+ */
120
+ override render(): void;
121
+ /**
122
+ * Focuses the {@link #queryView}.
123
+ */
124
+ focus(): void;
125
+ /**
126
+ * Resets the component to its initial state.
127
+ */
128
+ reset(): void;
129
+ /**
130
+ * Searches the {@link #filteredView} for the given query.
131
+ *
132
+ * @internal
133
+ * @param query The search query string.
134
+ */
135
+ search(query: string): void;
136
+ /**
137
+ * Creates a search field view based on configured creator..
138
+ */
139
+ private _createSearchTextQueryView;
140
+ /**
141
+ * Initializes the default {@link #infoView} behavior with default text labels when no custom info view
142
+ * was specified in the view config.
143
+ */
144
+ private _enableDefaultInfoViewBehavior;
146
145
  }
147
146
  /**
148
- * The configuration of the {@link module:ui/search/text/searchtextview~SearchTextView} class.
149
- */
147
+ * The configuration of the {@link module:ui/search/text/searchtextview~SearchTextView} class.
148
+ */
150
149
  export interface SearchTextViewConfig<TConfigSearchField extends InputBase<HTMLInputElement | HTMLTextAreaElement>> {
151
- /**
152
- * The configuration of the view's query field.
153
- */
154
- queryView: SearchTextQueryViewConfig<TConfigSearchField>;
155
- /**
156
- * The view that is filtered by the search query.
157
- */
158
- filteredView: FilteredView;
159
- /**
160
- * The view that displays the information about the search results.
161
- */
162
- infoView?: {
163
- /**
164
- * The view that displays the information about the search results. If not specified,
165
- * {@link module:ui/search/searchinfoview~SearchInfoView} is used.
166
- */
167
- instance?: FocusableView;
168
- /**
169
- * The configuration of text labels displayed in the {@link #infoView} in different states
170
- * of the search component.
171
- *
172
- * **Note**: This configuration is only used when the {@link #infoView} is **not** specified.
173
- * In other cases, please use the {@link module:ui/search/searchview~SearchTextViewSearchEvent} to bring about
174
- * your own info text logic.
175
- */
176
- text?: {
177
- notFound?: {
178
- primary: SearchTextViewDefaultInfoText;
179
- secondary?: SearchTextViewDefaultInfoText;
180
- };
181
- noSearchableItems?: {
182
- primary: SearchTextViewDefaultInfoText;
183
- secondary?: SearchTextViewDefaultInfoText;
184
- };
185
- };
186
- };
187
- /**
188
- * The custom CSS class name to be added to the search view element.
189
- */
190
- class?: string;
150
+ /**
151
+ * The configuration of the view's query field.
152
+ */
153
+ queryView: SearchTextQueryViewConfig<TConfigSearchField>;
154
+ /**
155
+ * The view that is filtered by the search query.
156
+ */
157
+ filteredView: FilteredView;
158
+ /**
159
+ * The view that displays the information about the search results.
160
+ */
161
+ infoView?: {
162
+ /**
163
+ * The view that displays the information about the search results. If not specified,
164
+ * {@link module:ui/search/searchinfoview~SearchInfoView} is used.
165
+ */
166
+ instance?: FocusableView;
167
+ /**
168
+ * The configuration of text labels displayed in the {@link #infoView} in different states
169
+ * of the search component.
170
+ *
171
+ * **Note**: This configuration is only used when the {@link #infoView} is **not** specified.
172
+ * In other cases, please use the {@link module:ui/search/searchview~SearchTextViewSearchEvent} to bring about
173
+ * your own info text logic.
174
+ */
175
+ text?: {
176
+ notFound?: {
177
+ primary: SearchTextViewDefaultInfoText;
178
+ secondary?: SearchTextViewDefaultInfoText;
179
+ };
180
+ noSearchableItems?: {
181
+ primary: SearchTextViewDefaultInfoText;
182
+ secondary?: SearchTextViewDefaultInfoText;
183
+ };
184
+ };
185
+ };
186
+ /**
187
+ * The custom CSS class name to be added to the search view element.
188
+ */
189
+ class?: string;
191
190
  }
192
191
  /**
193
- * Describes value of a info text configuration in {@link module:ui/search/text/searchtextview~SearchTextViewConfig}.
194
- * A string or a function that returns a string with the information about the search results.
195
- */
192
+ * Describes value of a info text configuration in {@link module:ui/search/text/searchtextview~SearchTextViewConfig}.
193
+ * A string or a function that returns a string with the information about the search results.
194
+ */
196
195
  export type SearchTextViewDefaultInfoText = string | ((query: string, resultsCount: number, totalItemsCount: number) => string);
197
196
  /**
198
- * An event fired when the search query changes fired by {@link module:ui/search/text/searchtextview~SearchTextView#search}.
199
- *
200
- * @eventName ~SearchTextView#search
201
- */
197
+ * An event fired when the search query changes fired by {@link module:ui/search/text/searchtextview~SearchTextView#search}.
198
+ *
199
+ * @eventName ~SearchTextView#search
200
+ */
202
201
  export type SearchTextViewSearchEvent = {
203
- name: 'search';
204
- args: [SearchTextViewSearchEventData];
202
+ name: "search";
203
+ args: [SearchTextViewSearchEventData];
205
204
  };
206
205
  export type SearchTextViewSearchEventData = {
207
- /**
208
- * The search query string.
209
- */
210
- query: string;
211
- /**
212
- * The number of results found for the current search query.
213
- */
214
- resultsCount: number;
215
- /**
216
- * The number of the items that can be searched.
217
- */
218
- totalItemsCount: number;
206
+ /**
207
+ * The search query string.
208
+ */
209
+ query: string;
210
+ /**
211
+ * The number of results found for the current search query.
212
+ */
213
+ resultsCount: number;
214
+ /**
215
+ * The number of the items that can be searched.
216
+ */
217
+ totalItemsCount: number;
219
218
  };
@@ -1,25 +1,24 @@
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/spinner/spinnerview
7
- */
8
- import { View } from '../view.js';
9
- import '../../theme/components/spinner/spinner.css';
6
+ * @module ui/spinner/spinnerview
7
+ */
8
+ import { View } from "../view.js";
10
9
  /**
11
- * The spinner view class.
12
- */
10
+ * The spinner view class.
11
+ */
13
12
  export declare class SpinnerView extends View {
14
- /**
15
- * Controls whether the spinner is visible.
16
- *
17
- * @observable
18
- * @default false
19
- */
20
- isVisible: boolean;
21
- /**
22
- * @inheritDoc
23
- */
24
- constructor();
13
+ /**
14
+ * Controls whether the spinner is visible.
15
+ *
16
+ * @observable
17
+ * @default false
18
+ */
19
+ isVisible: boolean;
20
+ /**
21
+ * @inheritDoc
22
+ */
23
+ constructor();
25
24
  }
@@ -0,0 +1,53 @@
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
+ /**
6
+ * @module ui/tabs/tabbuttonview
7
+ */
8
+ import { type ArrayOrItem, type Locale } from "@ckeditor/ckeditor5-utils";
9
+ import { ButtonView } from "../button/buttonview.js";
10
+ /**
11
+ * The available positions of the tabs (and their buttons) within a tabs view.
12
+ */
13
+ export declare const TAB_POSITIONS: readonly ["top", "left", "right"];
14
+ /**
15
+ * A single position of the tabs within a tabs view.
16
+ */
17
+ export type TabPosition = typeof TAB_POSITIONS[number];
18
+ /**
19
+ * A button that toggles the visibility of a tab in a tabs view component.
20
+ */
21
+ export declare class TabButtonView extends ButtonView {
22
+ /**
23
+ * The position of the tab button.
24
+ *
25
+ * @observable
26
+ */
27
+ side: TabPosition;
28
+ /**
29
+ * @inheritDoc
30
+ */
31
+ constructor(locale?: Locale, options?: TabButtonViewOptions);
32
+ /**
33
+ * Shows the tab button.
34
+ */
35
+ show(): void;
36
+ /**
37
+ * Hides the tab button.
38
+ */
39
+ hide(): void;
40
+ }
41
+ /**
42
+ * The options for the {@link module:ui/tabs/tabbuttonview~TabButtonView} class.
43
+ */
44
+ export type TabButtonViewOptions = {
45
+ /**
46
+ * An additional CSS class added to the {@link module:ui/tabs/tabbuttonview~TabButtonView#element}.
47
+ */
48
+ class?: ArrayOrItem<string>;
49
+ /**
50
+ * The position of the tab button.
51
+ */
52
+ side?: TabPosition;
53
+ };