@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,25 +1,25 @@
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 Locale } from '@ckeditor/ckeditor5-utils';
6
- import { ButtonView } from '../button/buttonview.js';
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 Locale } from "@ckeditor/ckeditor5-utils";
6
+ import { ButtonView } from "../button/buttonview.js";
7
7
  /**
8
- * This class represents a single color tile in the {@link module:ui/colorgrid/colorgridview~ColorGridView}.
9
- */
8
+ * This class represents a single color tile in the {@link module:ui/colorgrid/colorgridview~ColorGridView}.
9
+ */
10
10
  export declare class ColorTileView extends ButtonView {
11
- /**
12
- * String representing a color shown as tile's background.
13
- */
14
- color: string | undefined;
15
- /**
16
- * A flag that toggles a special CSS class responsible for displaying
17
- * a border around the button.
18
- */
19
- hasBorder: boolean;
20
- constructor(locale?: Locale);
21
- /**
22
- * @inheritDoc
23
- */
24
- render(): void;
11
+ /**
12
+ * String representing a color shown as tile's background.
13
+ */
14
+ color: string | undefined;
15
+ /**
16
+ * A flag that toggles a special CSS class responsible for displaying
17
+ * a border around the button.
18
+ */
19
+ hasBorder: boolean;
20
+ constructor(locale?: Locale);
21
+ /**
22
+ * @inheritDoc
23
+ */
24
+ override render(): void;
25
25
  }
@@ -1,47 +1,59 @@
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/colorgrid/utils
7
- */
8
- import type { Locale } from '@ckeditor/ckeditor5-utils';
6
+ * @module ui/colorgrid/utils
7
+ */
8
+ import type { Locale } from "@ckeditor/ckeditor5-utils";
9
9
  export type ColorOption = string | {
10
- color: string;
11
- label?: string;
12
- hasBorder?: boolean;
10
+ color: string;
11
+ label?: string;
12
+ hasBorder?: boolean;
13
13
  };
14
14
  export interface NormalizedColorOption {
15
- model: string;
16
- label: string;
17
- hasBorder: boolean;
18
- view: {
19
- name: string;
20
- styles: {
21
- color: string;
22
- };
23
- };
15
+ model: string;
16
+ label: string;
17
+ hasBorder: boolean;
18
+ view: {
19
+ name: string;
20
+ styles: {
21
+ color: string;
22
+ };
23
+ };
24
24
  }
25
25
  /**
26
- * Returns color configuration options as defined in `editor.config.(fontColor|fontBackgroundColor).colors` or
27
- * `editor.config.table.(tableProperties|tableCellProperties).(background|border).colors
28
- * but processed to account for editor localization in the correct language.
29
- *
30
- * Note: The reason behind this method is that there is no way to use {@link module:utils/locale~Locale#t}
31
- * when the user configuration is defined because the editor does not exist yet.
32
- *
33
- * @param locale The {@link module:core/editor/editor~Editor#locale} instance.
34
- */
26
+ * Returns color configuration options as defined in `editor.config.(fontColor|fontBackgroundColor).colors` or
27
+ * `editor.config.table.(tableProperties|tableCellProperties).(background|border).colors
28
+ * but processed to account for editor localization in the correct language.
29
+ *
30
+ * Note: The reason behind this method is that there is no way to use {@link module:utils/locale~Locale#t}
31
+ * when the user configuration is defined because the editor does not exist yet.
32
+ *
33
+ * @param locale The {@link module:core/editor/editor~Editor#locale} instance.
34
+ */
35
35
  export declare function getLocalizedColorOptions(locale: Locale, options: Array<NormalizedColorOption>): Array<NormalizedColorOption>;
36
36
  /**
37
- * Creates a unified color definition object from color configuration options.
38
- * The object contains the information necessary to both render the UI and initialize the conversion.
39
- */
37
+ * Returns the localized name of a color, as displayed next to a color tile or in a suggestion description.
38
+ *
39
+ * Labels of shaded palettes follow the `<hue> <shade>` pattern, for instance `Blue grey 700`. Such a label is
40
+ * translated hue by hue, so a palette built of shades does not need a dictionary entry for every shade. A label
41
+ * whose hue is unknown is returned unchanged.
42
+ *
43
+ * @internal
44
+ * @param locale The {@link module:core/editor/editor~Editor#locale} instance.
45
+ * @param label The color label to translate.
46
+ */
47
+ export declare function getLocalizedColorName(locale: Locale, label: string): string;
48
+ /**
49
+ * Creates a unified color definition object from color configuration options.
50
+ * The object contains the information necessary to both render the UI and initialize the conversion.
51
+ */
40
52
  export declare function normalizeColorOptions(options: Array<ColorOption>): Array<NormalizedColorOption>;
41
53
  /**
42
- * Creates a normalized color definition from the user-defined configuration.
43
- * The "normalization" means it will create full
44
- * {@link module:ui/colorgrid/colorgridview~ColorDefinition `ColorDefinition-like`}
45
- * object for string values, and add a `view` property, for each definition.
46
- */
54
+ * Creates a normalized color definition from the user-defined configuration.
55
+ * The "normalization" means it will create full
56
+ * {@link module:ui/colorgrid/colorgridview~ColorDefinition `ColorDefinition-like`}
57
+ * object for string values, and add a `view` property, for each definition.
58
+ */
47
59
  export declare function normalizeSingleColorDefinition(color: ColorOption): NormalizedColorOption;
@@ -1,173 +1,170 @@
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/colorpicker/colorpickerview
7
- */
8
- import { type ColorPickerViewConfig } from './utils.js';
9
- import type { HexColor } from '@ckeditor/ckeditor5-core';
10
- import { type Locale } from '@ckeditor/ckeditor5-utils';
11
- import { View } from '../view.js';
12
- import { type InputTextView } from '../inputtext/inputtextview.js';
13
- import { type ViewCollection } from '../viewcollection.js';
14
- import { LabeledFieldView } from '../labeledfield/labeledfieldview.js';
15
- import { HexBase } from 'vanilla-colorful/lib/entrypoints/hex';
16
- import '../../theme/components/colorpicker/colorpicker.css';
6
+ * @module ui/colorpicker/colorpickerview
7
+ */
8
+ import { type ColorPickerViewConfig } from "./utils.js";
9
+ import type { HexColor } from "@ckeditor/ckeditor5-core";
10
+ import { type Locale } from "@ckeditor/ckeditor5-utils";
11
+ import { View } from "../view.js";
12
+ import { type InputTextView } from "../inputtext/inputtextview.js";
13
+ import { type ViewCollection } from "../viewcollection.js";
14
+ import { LabeledFieldView } from "../labeledfield/labeledfieldview.js";
15
+ import { HexBase } from "vanilla-colorful/lib/entrypoints/hex";
17
16
  declare global {
18
- interface HTMLElementTagNameMap {
19
- 'hex-color-picker': HexBase;
20
- }
17
+ interface HTMLElementTagNameMap {
18
+ "hex-color-picker": HexBase;
19
+ }
21
20
  }
22
21
  /**
23
- * A class which represents a color picker with an input field for defining custom colors.
24
- */
22
+ * A class which represents a color picker with an input field for defining custom colors.
23
+ */
25
24
  export declare class ColorPickerView extends View {
26
- /**
27
- * Element with saturation and hue sliders.
28
- */
29
- picker: HexBase;
30
- /**
31
- * Container for a `#` sign prefix and an input for displaying and defining custom colors
32
- * in HEX format.
33
- */
34
- hexInputRow: ColorPickerInputRowView;
35
- /**
36
- * Current color selected in the color picker. It can be set by the component itself
37
- * (through the palette or input) or from the outside (e.g. to reflect the current selection color).
38
- */
39
- color: string;
40
- /**
41
- * List of slider views of the color picker.
42
- */
43
- slidersView: ViewCollection<SliderView>;
44
- /**
45
- * An internal representation of a color.
46
- *
47
- * Since the picker uses a hex format, that's how we store it.
48
- *
49
- * Since this is unified color format it won't fire a change event if color is changed
50
- * from `#f00` to `#ff0000` (same value, different format).
51
- *
52
- * @observable
53
- * @private
54
- */
55
- _hexColor: string;
56
- /**
57
- * Debounced function updating the `color` property in the component
58
- * and firing the `ColorPickerColorSelectedEvent`. Executed whenever color in component
59
- * is changed by the user interaction (through the palette or input).
60
- *
61
- * @private
62
- */
63
- private _debounceColorPickerEvent;
64
- /**
65
- * A reference to the configuration of the color picker specified in the constructor.
66
- *
67
- * @private
68
- */
69
- private _config;
70
- /**
71
- * Creates a view of color picker.
72
- *
73
- * @param locale
74
- * @param config
75
- */
76
- constructor(locale: Locale | undefined, config?: ColorPickerViewConfig);
77
- /**
78
- * Renders color picker in the view.
79
- */
80
- render(): void;
81
- /**
82
- * Focuses the first pointer in color picker.
83
- *
84
- */
85
- focus(): void;
86
- /**
87
- * Creates collection of sliders in color picker.
88
- *
89
- * @private
90
- */
91
- private _createSlidersView;
92
- /**
93
- * Creates input row for defining custom colors in color picker.
94
- *
95
- * @private
96
- */
97
- private _createInputRow;
98
- /**
99
- * Creates the input where user can type or paste the color in hex format.
100
- *
101
- * @private
102
- */
103
- private _createColorInput;
104
- /**
105
- * Validates the view and returns `false` when some fields are invalid.
106
- */
107
- isValid(): boolean;
108
- /**
109
- * Cleans up the supplementary error and information text of input inside the {@link #hexInputRow}
110
- * bringing them back to the state when the form has been displayed for the first time.
111
- *
112
- * See {@link #isValid}.
113
- */
114
- resetValidationStatus(): void;
25
+ /**
26
+ * Element with saturation and hue sliders.
27
+ */
28
+ picker: HexBase;
29
+ /**
30
+ * Container for a `#` sign prefix and an input for displaying and defining custom colors
31
+ * in HEX format.
32
+ */
33
+ hexInputRow: ColorPickerInputRowView;
34
+ /**
35
+ * Current color selected in the color picker. It can be set by the component itself
36
+ * (through the palette or input) or from the outside (e.g. to reflect the current selection color).
37
+ */
38
+ color: string;
39
+ /**
40
+ * List of slider views of the color picker.
41
+ */
42
+ slidersView: ViewCollection<SliderView>;
43
+ /**
44
+ * An internal representation of a color.
45
+ *
46
+ * Since the picker uses a hex format, that's how we store it.
47
+ *
48
+ * Since this is unified color format it won't fire a change event if color is changed
49
+ * from `#f00` to `#ff0000` (same value, different format).
50
+ *
51
+ * @observable
52
+ * @private
53
+ */
54
+ _hexColor: string;
55
+ /**
56
+ * Debounced function updating the `color` property in the component
57
+ * and firing the `ColorPickerColorSelectedEvent`. Executed whenever color in component
58
+ * is changed by the user interaction (through the palette or input).
59
+ *
60
+ * @private
61
+ */
62
+ private _debounceColorPickerEvent;
63
+ /**
64
+ * A reference to the configuration of the color picker specified in the constructor.
65
+ *
66
+ * @private
67
+ */
68
+ private _config;
69
+ /**
70
+ * Creates a view of color picker.
71
+ *
72
+ * @param locale
73
+ * @param config
74
+ */
75
+ constructor(locale: Locale | undefined, config?: ColorPickerViewConfig);
76
+ /**
77
+ * Renders color picker in the view.
78
+ */
79
+ override render(): void;
80
+ /**
81
+ * Focuses the first pointer in color picker.
82
+ *
83
+ */
84
+ focus(): void;
85
+ /**
86
+ * Creates collection of sliders in color picker.
87
+ *
88
+ * @private
89
+ */
90
+ private _createSlidersView;
91
+ /**
92
+ * Creates input row for defining custom colors in color picker.
93
+ *
94
+ * @private
95
+ */
96
+ private _createInputRow;
97
+ /**
98
+ * Creates the input where user can type or paste the color in hex format.
99
+ *
100
+ * @private
101
+ */
102
+ private _createColorInput;
103
+ /**
104
+ * Validates the view and returns `false` when some fields are invalid.
105
+ */
106
+ isValid(): boolean;
107
+ /**
108
+ * Cleans up the supplementary error and information text of input inside the {@link #hexInputRow}
109
+ * bringing them back to the state when the form has been displayed for the first time.
110
+ *
111
+ * See {@link #isValid}.
112
+ */
113
+ resetValidationStatus(): void;
115
114
  }
116
115
  export declare class SliderView extends View {
117
- /**
118
- * @param element HTML element of slider in color picker.
119
- */
120
- constructor(element: HTMLElement);
121
- /**
122
- * Focuses element.
123
- */
124
- focus(): void;
116
+ /**
117
+ * @param element HTML element of slider in color picker.
118
+ */
119
+ constructor(element: HTMLElement);
120
+ /**
121
+ * Focuses element.
122
+ */
123
+ focus(): void;
125
124
  }
126
125
  export declare class ColorPickerInputRowView extends View {
127
- /**
128
- * A collection of row items (buttons, dropdowns, etc.).
129
- */
130
- readonly children: ViewCollection;
131
- /**
132
- * Hex input view element.
133
- */
134
- readonly inputView: LabeledFieldView<InputTextView>;
135
- /**
136
- * Creates an instance of the form row class.
137
- *
138
- * @param locale The locale instance.
139
- * @param inputView Hex color input element.
140
- */
141
- constructor(locale: Locale, inputView: LabeledFieldView<InputTextView>);
142
- /**
143
- * Returns false if color input value is not in hex format.
144
- */
145
- getParsedColor(): HexColor | null;
126
+ /**
127
+ * A collection of row items (buttons, dropdowns, etc.).
128
+ */
129
+ readonly children: ViewCollection;
130
+ /**
131
+ * Hex input view element.
132
+ */
133
+ readonly inputView: LabeledFieldView<InputTextView>;
134
+ /**
135
+ * Creates an instance of the form row class.
136
+ *
137
+ * @param locale The locale instance.
138
+ * @param inputView Hex color input element.
139
+ */
140
+ constructor(locale: Locale, inputView: LabeledFieldView<InputTextView>);
141
+ /**
142
+ * Returns false if color input value is not in hex format.
143
+ */
144
+ getParsedColor(): HexColor | null;
146
145
  }
147
146
  /**
148
- * An event fired whenever the color was selected through the color picker palette
149
- * or the color picker input.
150
- *
151
- * This even fires only when the user changes the color. It does not fire when the color
152
- * is changed programmatically, e.g. via
153
- * {@link module:ui/colorpicker/colorpickerview~ColorPickerView#color}.
154
- *
155
- * @eventName ~ColorPickerView#colorSelected
156
- */
147
+ * An event fired whenever the color was selected through the color picker palette
148
+ * or the color picker input.
149
+ *
150
+ * This even fires only when the user changes the color. It does not fire when the color
151
+ * is changed programmatically, e.g. via
152
+ * {@link module:ui/colorpicker/colorpickerview~ColorPickerView#color}.
153
+ *
154
+ * @eventName ~ColorPickerView#colorSelected
155
+ */
157
156
  export type ColorPickerColorSelectedEvent = {
158
- name: 'colorSelected';
159
- args: [
160
- {
161
- color: string;
162
- }
163
- ];
157
+ name: "colorSelected";
158
+ args: [{
159
+ color: string;
160
+ }];
164
161
  };
165
162
  /**
166
- * Trim spaces from provided color and check if hex is valid.
167
- *
168
- * @param color Unsafe color string.
169
- * @returns Null if provided color is not hex value.
170
- * @export
171
- * @internal
172
- */
163
+ * Trim spaces from provided color and check if hex is valid.
164
+ *
165
+ * @param color Unsafe color string.
166
+ * @returns Null if provided color is not hex value.
167
+ * @export
168
+ * @internal
169
+ */
173
170
  export declare function tryParseHexColor<S extends string>(color: S | null | undefined): HexColor<S> | null;
@@ -1,51 +1,51 @@
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
- * Color formats handled by color converter.
7
- */
8
- export type ColorPickerOutputFormat = 'hex' | 'rgb' | 'hsl' | 'hwb' | 'lab' | 'lch';
6
+ * Color formats handled by color converter.
7
+ */
8
+ export type ColorPickerOutputFormat = "hex" | "rgb" | "hsl" | "hwb" | "lab" | "lch";
9
9
  /**
10
- * Configuration of the color picker feature.
11
- *
12
- * It can be forced to apply colors in the editor in a particular format.
13
- *
14
- * @default `{
15
- * format: 'hsl'
16
- * }`
17
- */
10
+ * Configuration of the color picker feature.
11
+ *
12
+ * It can be forced to apply colors in the editor in a particular format.
13
+ *
14
+ * @default `{
15
+ * format: 'hsl'
16
+ * }`
17
+ */
18
18
  export type ColorPickerConfig = {
19
- format?: ColorPickerOutputFormat;
19
+ format?: ColorPickerOutputFormat;
20
20
  };
21
21
  /**
22
- * Configuration of the color picker view.
23
- *
24
- * It can be used to enforce a particular color format or hide the color input.
25
- */
22
+ * Configuration of the color picker view.
23
+ *
24
+ * It can be used to enforce a particular color format or hide the color input.
25
+ */
26
26
  export type ColorPickerViewConfig = ColorPickerConfig & {
27
- hideInput?: boolean;
27
+ hideInput?: boolean;
28
28
  };
29
29
  /**
30
- * Parses and converts the color string to requested format. Handles variety of color spaces
31
- * like `hsl`, `hex` or `rgb`.
32
- *
33
- * @param color
34
- * @returns A color string.
35
- * @internal
36
- */
30
+ * Parses and converts the color string to requested format. Handles variety of color spaces
31
+ * like `hsl`, `hex` or `rgb`.
32
+ *
33
+ * @param color
34
+ * @returns A color string.
35
+ * @internal
36
+ */
37
37
  export declare function convertColor(color: string, outputFormat: ColorPickerOutputFormat): string;
38
38
  /**
39
- * Converts a color string to hex format.
40
- *
41
- * @param color
42
- * @returns A color string.
43
- * @internal
44
- */
39
+ * Converts a color string to hex format.
40
+ *
41
+ * @param color
42
+ * @returns A color string.
43
+ * @internal
44
+ */
45
45
  export declare function convertToHex(color: string): string;
46
46
  /**
47
- * Registers the custom element in the
48
- * [CustomElementsRegistry](https://developer.mozilla.org/en-US/docs/Web/API/CustomElementRegistry).
49
- * @internal
50
- */
47
+ * Registers the custom element in the
48
+ * [CustomElementsRegistry](https://developer.mozilla.org/en-US/docs/Web/API/CustomElementRegistry).
49
+ * @internal
50
+ */
51
51
  export declare function registerCustomElement(elementName: string, constructor: CustomElementConstructor): void;