@ckeditor/ckeditor5-ui 48.2.0-alpha.7 → 48.3.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (117) hide show
  1. package/dist/arialiveannouncer.d.ts +90 -90
  2. package/dist/augmentation.d.ts +86 -86
  3. package/dist/autocomplete/autocompleteview.d.ts +70 -70
  4. package/dist/badge/badge.d.ts +119 -121
  5. package/dist/bindings/addkeyboardhandlingforgrid.d.ts +22 -22
  6. package/dist/bindings/clickoutsidehandler.d.ts +25 -25
  7. package/dist/bindings/csstransitiondisablermixin.d.ts +47 -36
  8. package/dist/bindings/draggableviewmixin.d.ts +45 -37
  9. package/dist/bindings/preventdefault.d.ts +30 -30
  10. package/dist/bindings/submithandler.d.ts +49 -49
  11. package/dist/button/button.d.ts +167 -167
  12. package/dist/button/buttonlabel.d.ts +28 -28
  13. package/dist/button/buttonlabelview.d.ts +26 -26
  14. package/dist/button/buttonview.d.ts +192 -192
  15. package/dist/button/filedialogbuttonview.d.ts +107 -99
  16. package/dist/button/listitembuttonview.d.ts +73 -73
  17. package/dist/button/switchbuttonview.d.ts +40 -40
  18. package/dist/collapsible/collapsibleview.d.ts +63 -63
  19. package/dist/colorgrid/colorgridview.d.ts +117 -117
  20. package/dist/colorgrid/colortileview.d.ts +21 -21
  21. package/dist/colorgrid/utils.d.ts +35 -35
  22. package/dist/colorpicker/colorpickerview.d.ts +155 -157
  23. package/dist/colorpicker/utils.d.ts +37 -37
  24. package/dist/colorselector/colorgridsfragmentview.d.ts +191 -191
  25. package/dist/colorselector/colorpickerfragmentview.d.ts +129 -129
  26. package/dist/colorselector/colorselectorview.d.ts +227 -229
  27. package/dist/colorselector/documentcolorcollection.d.ts +52 -59
  28. package/dist/componentfactory.d.ts +76 -76
  29. package/dist/dialog/dialog.d.ts +311 -288
  30. package/dist/dialog/dialogactionsview.d.ts +62 -62
  31. package/dist/dialog/dialogcontentview.d.ts +22 -22
  32. package/dist/dialog/dialogview.d.ts +255 -251
  33. package/dist/dropdown/button/dropdownbutton.d.ts +17 -17
  34. package/dist/dropdown/button/dropdownbuttonview.d.ts +41 -41
  35. package/dist/dropdown/button/splitbuttonview.d.ts +155 -155
  36. package/dist/dropdown/dropdownpanelfocusable.d.ts +16 -16
  37. package/dist/dropdown/dropdownpanelview.d.ts +56 -56
  38. package/dist/dropdown/dropdownview.d.ts +326 -326
  39. package/dist/dropdown/menu/dropdownmenubehaviors.d.ts +43 -43
  40. package/dist/dropdown/menu/dropdownmenubuttonview.d.ts +29 -29
  41. package/dist/dropdown/menu/dropdownmenulistitembuttonview.d.ts +12 -12
  42. package/dist/dropdown/menu/dropdownmenulistitemview.d.ts +17 -17
  43. package/dist/dropdown/menu/dropdownmenulistview.d.ts +19 -19
  44. package/dist/dropdown/menu/dropdownmenunestedmenupanelview.d.ts +28 -28
  45. package/dist/dropdown/menu/dropdownmenunestedmenuview.d.ts +126 -126
  46. package/dist/dropdown/menu/dropdownmenurootlistview.d.ts +132 -132
  47. package/dist/dropdown/menu/utils.d.ts +112 -112
  48. package/dist/dropdown/utils.d.ts +272 -272
  49. package/dist/editableui/editableuiview.d.ts +78 -78
  50. package/dist/editableui/inline/inlineeditableuiview.d.ts +38 -38
  51. package/dist/editorui/accessibilityhelp/accessibilityhelp.d.ts +50 -50
  52. package/dist/editorui/accessibilityhelp/accessibilityhelpcontentview.d.ts +30 -30
  53. package/dist/editorui/bodycollection.d.ts +86 -86
  54. package/dist/editorui/boxed/boxededitoruiview.d.ts +35 -35
  55. package/dist/editorui/editorui.d.ts +348 -351
  56. package/dist/editorui/editoruiview.d.ts +53 -53
  57. package/dist/editorui/evaluationbadge.d.ts +28 -28
  58. package/dist/editorui/poweredby.d.ts +25 -25
  59. package/dist/focuscycler.d.ts +265 -270
  60. package/dist/formheader/formheaderview.d.ts +53 -53
  61. package/dist/formrow/formrowview.d.ts +52 -52
  62. package/dist/highlightedtext/buttonlabelwithhighlightview.d.ts +25 -25
  63. package/dist/highlightedtext/highlightedtextview.d.ts +33 -33
  64. package/dist/highlightedtext/labelwithhighlightview.d.ts +21 -21
  65. package/dist/icon/iconview.d.ts +83 -83
  66. package/dist/iframe/iframeview.d.ts +42 -42
  67. package/dist/index.css.map +1 -1
  68. package/dist/index.d.ts +136 -136
  69. package/dist/index.js +16467 -17751
  70. package/dist/index.js.map +1 -1
  71. package/dist/input/inputbase.d.ts +114 -114
  72. package/dist/input/inputview.d.ts +28 -28
  73. package/dist/inputnumber/inputnumberview.d.ts +44 -44
  74. package/dist/inputtext/inputtextview.d.ts +13 -13
  75. package/dist/label/labelview.d.ts +31 -31
  76. package/dist/labeledfield/labeledfieldview.d.ts +180 -180
  77. package/dist/labeledfield/utils.d.ts +112 -112
  78. package/dist/labeledinput/labeledinputview.d.ts +120 -120
  79. package/dist/legacyerrors.d.ts +0 -4
  80. package/dist/list/listitemgroupview.d.ts +54 -54
  81. package/dist/list/listitemview.d.ts +31 -31
  82. package/dist/list/listseparatorview.d.ts +13 -13
  83. package/dist/list/listview.d.ts +119 -119
  84. package/dist/menubar/menubarmenubuttonview.d.ts +28 -28
  85. package/dist/menubar/menubarmenulistitembuttonview.d.ts +16 -16
  86. package/dist/menubar/menubarmenulistitemfiledialogbuttonview.d.ts +18 -18
  87. package/dist/menubar/menubarmenulistitemview.d.ts +20 -20
  88. package/dist/menubar/menubarmenulistview.d.ts +24 -24
  89. package/dist/menubar/menubarmenupanelview.d.ts +47 -47
  90. package/dist/menubar/menubarmenuview.d.ts +113 -113
  91. package/dist/menubar/menubarview.d.ts +145 -145
  92. package/dist/menubar/utils.d.ts +455 -455
  93. package/dist/model.d.ts +19 -18
  94. package/dist/notification/notification.d.ts +200 -200
  95. package/dist/panel/balloon/balloonpanelview.d.ts +692 -692
  96. package/dist/panel/balloon/contextualballoon.d.ts +298 -298
  97. package/dist/panel/sticky/stickypanelview.d.ts +151 -151
  98. package/dist/search/filteredview.d.ts +23 -23
  99. package/dist/search/filtergroupanditemnames.d.ts +11 -11
  100. package/dist/search/searchinfoview.d.ts +39 -39
  101. package/dist/search/searchresultsview.d.ts +49 -49
  102. package/dist/search/text/searchtextqueryview.d.ts +63 -63
  103. package/dist/search/text/searchtextview.d.ts +203 -203
  104. package/dist/spinner/spinnerview.d.ts +20 -20
  105. package/dist/template.d.ts +897 -902
  106. package/dist/textarea/textareaview.d.ts +96 -96
  107. package/dist/toolbar/balloon/balloontoolbar.d.ts +122 -122
  108. package/dist/toolbar/block/blockbuttonview.d.ts +30 -30
  109. package/dist/toolbar/block/blocktoolbar.d.ts +166 -166
  110. package/dist/toolbar/normalizetoolbarconfig.d.ts +35 -35
  111. package/dist/toolbar/toolbarlinebreakview.d.ts +13 -13
  112. package/dist/toolbar/toolbarseparatorview.d.ts +13 -13
  113. package/dist/toolbar/toolbarview.d.ts +271 -271
  114. package/dist/tooltipmanager.d.ts +190 -193
  115. package/dist/view.d.ts +385 -388
  116. package/dist/viewcollection.d.ts +134 -134
  117. package/package.json +6 -6
@@ -1,58 +1,58 @@
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/formheader/formheaderview
7
- */
8
- import { View } from '../view.js';
9
- import { type ViewCollection } from '../viewcollection.js';
10
- import { IconView } from '../icon/iconview.js';
11
- import type { Locale } from '@ckeditor/ckeditor5-utils';
12
- import '../../theme/components/formheader/formheader.css';
6
+ * @module ui/formheader/formheaderview
7
+ */
8
+ import { View } from "../view.js";
9
+ import { type ViewCollection } from "../viewcollection.js";
10
+ import { IconView } from "../icon/iconview.js";
11
+ import type { Locale } from "@ckeditor/ckeditor5-utils";
12
+ import "../../theme/components/formheader/formheader.css";
13
13
  /**
14
- * The class component representing a form header view. It should be used in more advanced forms to
15
- * describe the main purpose of the form.
16
- *
17
- * By default the component contains a bolded label view that has to be set. The label is usually a short (at most 3-word) string.
18
- * The component can also be extended by any other elements, like: icons, dropdowns, etc.
19
- *
20
- * It is used i.a.
21
- * by {@link module:table/tablecellproperties/ui/tablecellpropertiesview~TableCellPropertiesView}.
22
- *
23
- * The latter is an example, where the component has been extended by {@link module:ui/dropdown/dropdownview~DropdownView} view.
24
- */
14
+ * The class component representing a form header view. It should be used in more advanced forms to
15
+ * describe the main purpose of the form.
16
+ *
17
+ * By default the component contains a bolded label view that has to be set. The label is usually a short (at most 3-word) string.
18
+ * The component can also be extended by any other elements, like: icons, dropdowns, etc.
19
+ *
20
+ * It is used i.a.
21
+ * by {@link module:table/tablecellproperties/ui/tablecellpropertiesview~TableCellPropertiesView}.
22
+ *
23
+ * The latter is an example, where the component has been extended by {@link module:ui/dropdown/dropdownview~DropdownView} view.
24
+ */
25
25
  export declare class FormHeaderView extends View {
26
- /**
27
- * A collection of header items.
28
- */
29
- readonly children: ViewCollection;
30
- /**
31
- * The label of the header.
32
- *
33
- * @observable
34
- */
35
- label: string;
36
- /**
37
- * An additional CSS class added to the {@link #element}.
38
- *
39
- * @observable
40
- */
41
- class: string | null;
42
- /**
43
- * The icon view instance. Defined only if icon was passed in the constructor's options.
44
- */
45
- readonly iconView?: IconView;
46
- /**
47
- * Creates an instance of the form header class.
48
- *
49
- * @param locale The locale instance.
50
- * @param options.label A label.
51
- * @param options.class An additional class.
52
- */
53
- constructor(locale: Locale | undefined, options?: {
54
- label?: string | null;
55
- class?: string | null;
56
- icon?: string | null;
57
- });
26
+ /**
27
+ * A collection of header items.
28
+ */
29
+ readonly children: ViewCollection;
30
+ /**
31
+ * The label of the header.
32
+ *
33
+ * @observable
34
+ */
35
+ label: string;
36
+ /**
37
+ * An additional CSS class added to the {@link #element}.
38
+ *
39
+ * @observable
40
+ */
41
+ class: string | null;
42
+ /**
43
+ * The icon view instance. Defined only if icon was passed in the constructor's options.
44
+ */
45
+ readonly iconView?: IconView;
46
+ /**
47
+ * Creates an instance of the form header class.
48
+ *
49
+ * @param locale The locale instance.
50
+ * @param options.label A label.
51
+ * @param options.class An additional class.
52
+ */
53
+ constructor(locale: Locale | undefined, options?: {
54
+ label?: string | null;
55
+ class?: string | null;
56
+ icon?: string | null;
57
+ });
58
58
  }
@@ -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/formrow/formrowview
7
- */
8
- import { View } from '../view.js';
9
- import { type ViewCollection } from '../viewcollection.js';
10
- import { type LabelView } from '../label/labelview.js';
11
- import { type ArrayOrItem, type Locale } from '@ckeditor/ckeditor5-utils';
12
- import '../../theme/components/formrow/formrow.css';
6
+ * @module ui/formrow/formrowview
7
+ */
8
+ import { View } from "../view.js";
9
+ import { type ViewCollection } from "../viewcollection.js";
10
+ import { type LabelView } from "../label/labelview.js";
11
+ import { type ArrayOrItem, type Locale } from "@ckeditor/ckeditor5-utils";
12
+ import "../../theme/components/formrow/formrow.css";
13
13
  /**
14
- * The class representing a single row in a form,
15
- */
14
+ * The class representing a single row in a form,
15
+ */
16
16
  export declare class FormRowView extends View {
17
- /**
18
- * An additional CSS class added to the {@link #element}.
19
- *
20
- * @observable
21
- */
22
- class: Array<string>;
23
- /**
24
- * A collection of row items (buttons, dropdowns, etc.).
25
- */
26
- readonly children: ViewCollection;
27
- /**
28
- * The role property reflected by the `role` DOM attribute of the {@link #element}.
29
- *
30
- * **Note**: Used only when a `labelView` is passed to constructor `options`.
31
- *
32
- * @observable
33
- * @internal
34
- */
35
- _role: string | null;
36
- /**
37
- * The ARIA property reflected by the `aria-labelledby` DOM attribute of the {@link #element}.
38
- *
39
- * **Note**: Used only when a `labelView` is passed to constructor `options`.
40
- *
41
- * @observable
42
- * @internal
43
- */
44
- _ariaLabelledBy: string | null;
45
- /**
46
- * Creates an instance of the form row class.
47
- *
48
- * @param locale The locale instance.
49
- * @param options.labelView When passed, the row gets the `group` and `aria-labelledby`
50
- * DOM attributes and gets described by the label.
51
- */
52
- constructor(locale: Locale, options?: {
53
- children?: Array<View>;
54
- class?: ArrayOrItem<string>;
55
- labelView?: LabelView;
56
- });
17
+ /**
18
+ * An additional CSS class added to the {@link #element}.
19
+ *
20
+ * @observable
21
+ */
22
+ class: Array<string>;
23
+ /**
24
+ * A collection of row items (buttons, dropdowns, etc.).
25
+ */
26
+ readonly children: ViewCollection;
27
+ /**
28
+ * The role property reflected by the `role` DOM attribute of the {@link #element}.
29
+ *
30
+ * **Note**: Used only when a `labelView` is passed to constructor `options`.
31
+ *
32
+ * @observable
33
+ * @internal
34
+ */
35
+ _role: string | null;
36
+ /**
37
+ * The ARIA property reflected by the `aria-labelledby` DOM attribute of the {@link #element}.
38
+ *
39
+ * **Note**: Used only when a `labelView` is passed to constructor `options`.
40
+ *
41
+ * @observable
42
+ * @internal
43
+ */
44
+ _ariaLabelledBy: string | null;
45
+ /**
46
+ * Creates an instance of the form row class.
47
+ *
48
+ * @param locale The locale instance.
49
+ * @param options.labelView When passed, the row gets the `group` and `aria-labelledby`
50
+ * DOM attributes and gets described by the label.
51
+ */
52
+ constructor(locale: Locale, options?: {
53
+ children?: Array<View>;
54
+ class?: ArrayOrItem<string>;
55
+ labelView?: LabelView;
56
+ });
57
57
  }
@@ -1,30 +1,30 @@
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/highlightedtext/buttonlabelwithhighlightview
7
- */
8
- import { type ButtonLabel } from '../button/buttonlabel.js';
9
- import { HighlightedTextView } from './highlightedtextview.js';
6
+ * @module ui/highlightedtext/buttonlabelwithhighlightview
7
+ */
8
+ import { type ButtonLabel } from "../button/buttonlabel.js";
9
+ import { HighlightedTextView } from "./highlightedtextview.js";
10
10
  /**
11
- * A button label view that can highlight a text fragment.
12
- */
11
+ * A button label view that can highlight a text fragment.
12
+ */
13
13
  export declare class ButtonLabelWithHighlightView extends HighlightedTextView implements ButtonLabel {
14
- /**
15
- * @inheritDoc
16
- */
17
- style: string | undefined;
18
- /**
19
- * @inheritDoc
20
- */
21
- text: string | undefined;
22
- /**
23
- * @inheritDoc
24
- */
25
- id: string | undefined;
26
- /**
27
- * @inheritDoc
28
- */
29
- constructor();
14
+ /**
15
+ * @inheritDoc
16
+ */
17
+ style: string | undefined;
18
+ /**
19
+ * @inheritDoc
20
+ */
21
+ text: string | undefined;
22
+ /**
23
+ * @inheritDoc
24
+ */
25
+ id: string | undefined;
26
+ /**
27
+ * @inheritDoc
28
+ */
29
+ constructor();
30
30
  }
@@ -1,38 +1,38 @@
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/highlightedtext/highlightedtextview
7
- */
8
- import { View } from '../view.js';
9
- import '../../theme/components/highlightedtext/highlightedtext.css';
6
+ * @module ui/highlightedtext/highlightedtextview
7
+ */
8
+ import { View } from "../view.js";
9
+ import "../../theme/components/highlightedtext/highlightedtext.css";
10
10
  /**
11
- * A class representing a view that displays a text which subset can be highlighted using the
12
- * {@link #highlightText} method.
13
- */
11
+ * A class representing a view that displays a text which subset can be highlighted using the
12
+ * {@link #highlightText} method.
13
+ */
14
14
  export declare class HighlightedTextView extends View {
15
- /**
16
- * The text that can be highlighted using the {@link #highlightText} method.
17
- *
18
- * **Note:** When this property changes, the previous highlighting is removed.
19
- *
20
- * @observable
21
- */
22
- text: string | undefined;
23
- /**
24
- * @inheritDoc
25
- */
26
- constructor();
27
- /**
28
- * Highlights view's {@link #text} according to the specified `RegExp`. If the passed RegExp is `null`, the
29
- * highlighting is removed
30
- *
31
- * @param regExp
32
- */
33
- highlightText(regExp: RegExp | null): void;
34
- /**
35
- * Updates element's `innerHTML` with the passed content.
36
- */
37
- private _updateInnerHTML;
15
+ /**
16
+ * The text that can be highlighted using the {@link #highlightText} method.
17
+ *
18
+ * **Note:** When this property changes, the previous highlighting is removed.
19
+ *
20
+ * @observable
21
+ */
22
+ text: string | undefined;
23
+ /**
24
+ * @inheritDoc
25
+ */
26
+ constructor();
27
+ /**
28
+ * Highlights view's {@link #text} according to the specified `RegExp`. If the passed RegExp is `null`, the
29
+ * highlighting is removed
30
+ *
31
+ * @param regExp
32
+ */
33
+ highlightText(regExp: RegExp | null): void;
34
+ /**
35
+ * Updates element's `innerHTML` with the passed content.
36
+ */
37
+ private _updateInnerHTML;
38
38
  }
@@ -1,26 +1,26 @@
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/highlightedtext/labelwithhighlightview
7
- */
8
- import { HighlightedTextView } from './highlightedtextview.js';
9
- import { type LabelView } from '../label/labelview.js';
6
+ * @module ui/highlightedtext/labelwithhighlightview
7
+ */
8
+ import { HighlightedTextView } from "./highlightedtextview.js";
9
+ import { type LabelView } from "../label/labelview.js";
10
10
  /**
11
- * A label view that can highlight a text fragment.
12
- */
11
+ * A label view that can highlight a text fragment.
12
+ */
13
13
  export declare class LabelWithHighlightView extends HighlightedTextView implements LabelView {
14
- /**
15
- * @inheritDoc
16
- */
17
- readonly id: string;
18
- /**
19
- * @inheritDoc
20
- */
21
- for: string | undefined;
22
- /**
23
- * @inheritDoc
24
- */
25
- constructor();
14
+ /**
15
+ * @inheritDoc
16
+ */
17
+ readonly id: string;
18
+ /**
19
+ * @inheritDoc
20
+ */
21
+ for: string | undefined;
22
+ /**
23
+ * @inheritDoc
24
+ */
25
+ constructor();
26
26
  }
@@ -1,88 +1,88 @@
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/icon/iconview
7
- */
8
- import { View } from '../view.js';
9
- import '../../theme/components/icon/icon.css';
6
+ * @module ui/icon/iconview
7
+ */
8
+ import { View } from "../view.js";
9
+ import "../../theme/components/icon/icon.css";
10
10
  /**
11
- * The icon view class.
12
- */
11
+ * The icon view class.
12
+ */
13
13
  export declare class IconView extends View {
14
- /**
15
- * The SVG source of the icon.
16
- *
17
- * The user must provide the entire XML string, not just the path. See the
18
- * {@glink framework/architecture/ui-library#setting-label-icon-and-tooltip UI library} guide for details.
19
- *
20
- * @observable
21
- */
22
- content: string | undefined;
23
- /**
24
- * This attribute specifies the boundaries to which the
25
- * icon content should stretch.
26
- *
27
- * @observable
28
- * @default '0 0 20 20'
29
- */
30
- viewBox: string;
31
- /**
32
- * The fill color of the child `path.ck-icon__fill`.
33
- *
34
- * @observable
35
- * @default ''
36
- */
37
- fillColor: string;
38
- /**
39
- * When set true (default), all parts of the icon inherit the fill color from the CSS `color` property of the
40
- * icon's DOM parent.
41
- *
42
- * This effectively makes the icon monochromatic and allows it to change its fill color dynamically, for instance,
43
- * when a {@link module:ui/button/buttonview~ButtonView} displays an icon and it switches between different states
44
- * (pushed, hovered, etc.) the icon will follow along.
45
- *
46
- * **Note**: For the monochromatic icon to render properly, it must be made up of shapes that can be filled
47
- * with color instead of, for instance, paths with strokes. Be sure to use the *outline stroke* tool
48
- * (the name could be different in your vector graphics editor) before exporting your icon. Also, remove any
49
- * excess `fill="..."` attributes that could break the color inheritance.
50
- *
51
- * **Note**: If you want to preserve the original look of your icon and disable dynamic color inheritance,
52
- * set this flag to `false`.
53
- *
54
- * @observable
55
- * @default true
56
- */
57
- isColorInherited: boolean;
58
- /**
59
- * Controls whether the icon is visible.
60
- *
61
- * @observable
62
- * @default true
63
- */
64
- isVisible: boolean;
65
- /**
66
- * A list of presentational attributes that can be set on the `<svg>` element and should be preserved
67
- * when the icon {@link module:ui/icon/iconview~IconView#content content} is loaded.
68
- *
69
- * See the [specification](https://www.w3.org/TR/SVG/styling.html#TermPresentationAttribute) to learn more.
70
- */
71
- private static presentationalAttributeNames;
72
- /**
73
- * @inheritDoc
74
- */
75
- constructor();
76
- /**
77
- * @inheritDoc
78
- */
79
- render(): void;
80
- /**
81
- * Updates the {@link #element} with the value of {@link #content}.
82
- */
83
- private _updateXMLContent;
84
- /**
85
- * Fills all child `path.ck-icon__fill` with the `#fillColor`.
86
- */
87
- private _colorFillPaths;
14
+ /**
15
+ * The SVG source of the icon.
16
+ *
17
+ * The user must provide the entire XML string, not just the path. See the
18
+ * {@glink framework/architecture/ui-library#setting-label-icon-and-tooltip UI library} guide for details.
19
+ *
20
+ * @observable
21
+ */
22
+ content: string | undefined;
23
+ /**
24
+ * This attribute specifies the boundaries to which the
25
+ * icon content should stretch.
26
+ *
27
+ * @observable
28
+ * @default '0 0 20 20'
29
+ */
30
+ viewBox: string;
31
+ /**
32
+ * The fill color of the child `path.ck-icon__fill`.
33
+ *
34
+ * @observable
35
+ * @default ''
36
+ */
37
+ fillColor: string;
38
+ /**
39
+ * When set true (default), all parts of the icon inherit the fill color from the CSS `color` property of the
40
+ * icon's DOM parent.
41
+ *
42
+ * This effectively makes the icon monochromatic and allows it to change its fill color dynamically, for instance,
43
+ * when a {@link module:ui/button/buttonview~ButtonView} displays an icon and it switches between different states
44
+ * (pushed, hovered, etc.) the icon will follow along.
45
+ *
46
+ * **Note**: For the monochromatic icon to render properly, it must be made up of shapes that can be filled
47
+ * with color instead of, for instance, paths with strokes. Be sure to use the *outline stroke* tool
48
+ * (the name could be different in your vector graphics editor) before exporting your icon. Also, remove any
49
+ * excess `fill="..."` attributes that could break the color inheritance.
50
+ *
51
+ * **Note**: If you want to preserve the original look of your icon and disable dynamic color inheritance,
52
+ * set this flag to `false`.
53
+ *
54
+ * @observable
55
+ * @default true
56
+ */
57
+ isColorInherited: boolean;
58
+ /**
59
+ * Controls whether the icon is visible.
60
+ *
61
+ * @observable
62
+ * @default true
63
+ */
64
+ isVisible: boolean;
65
+ /**
66
+ * A list of presentational attributes that can be set on the `<svg>` element and should be preserved
67
+ * when the icon {@link module:ui/icon/iconview~IconView#content content} is loaded.
68
+ *
69
+ * See the [specification](https://www.w3.org/TR/SVG/styling.html#TermPresentationAttribute) to learn more.
70
+ */
71
+ private static presentationalAttributeNames;
72
+ /**
73
+ * @inheritDoc
74
+ */
75
+ constructor();
76
+ /**
77
+ * @inheritDoc
78
+ */
79
+ override render(): void;
80
+ /**
81
+ * Updates the {@link #element} with the value of {@link #content}.
82
+ */
83
+ private _updateXMLContent;
84
+ /**
85
+ * Fills all child `path.ck-icon__fill` with the `#fillColor`.
86
+ */
87
+ private _colorFillPaths;
88
88
  }