@ckeditor/ckeditor5-ui 40.0.0 → 40.2.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 (171) hide show
  1. package/CHANGELOG.md +26 -26
  2. package/LICENSE.md +3 -3
  3. package/lang/translations/gl.po +4 -4
  4. package/lang/translations/pt-br.po +1 -1
  5. package/lang/translations/sr-latn.po +6 -6
  6. package/lang/translations/ug.po +26 -26
  7. package/package.json +3 -3
  8. package/src/arialiveannouncer.d.ts +94 -0
  9. package/src/arialiveannouncer.js +113 -0
  10. package/src/augmentation.d.ts +86 -86
  11. package/src/augmentation.js +5 -5
  12. package/src/autocomplete/autocompleteview.d.ts +81 -81
  13. package/src/autocomplete/autocompleteview.js +153 -146
  14. package/src/bindings/addkeyboardhandlingforgrid.d.ts +27 -27
  15. package/src/bindings/addkeyboardhandlingforgrid.js +107 -107
  16. package/src/bindings/clickoutsidehandler.d.ts +28 -28
  17. package/src/bindings/clickoutsidehandler.js +36 -36
  18. package/src/bindings/csstransitiondisablermixin.d.ts +40 -40
  19. package/src/bindings/csstransitiondisablermixin.js +55 -55
  20. package/src/bindings/injectcsstransitiondisabler.d.ts +59 -59
  21. package/src/bindings/injectcsstransitiondisabler.js +71 -71
  22. package/src/bindings/preventdefault.d.ts +33 -33
  23. package/src/bindings/preventdefault.js +34 -34
  24. package/src/bindings/submithandler.d.ts +57 -57
  25. package/src/bindings/submithandler.js +47 -47
  26. package/src/button/button.d.ts +172 -178
  27. package/src/button/button.js +5 -5
  28. package/src/button/buttonlabel.d.ts +34 -34
  29. package/src/button/buttonlabel.js +5 -5
  30. package/src/button/buttonlabelview.d.ts +31 -31
  31. package/src/button/buttonlabelview.js +42 -42
  32. package/src/button/buttonview.d.ts +181 -185
  33. package/src/button/buttonview.js +217 -219
  34. package/src/button/switchbuttonview.d.ts +45 -45
  35. package/src/button/switchbuttonview.js +75 -75
  36. package/src/collapsible/collapsibleview.d.ts +69 -0
  37. package/src/collapsible/collapsibleview.js +95 -0
  38. package/src/colorgrid/colorgridview.d.ts +132 -132
  39. package/src/colorgrid/colorgridview.js +124 -124
  40. package/src/colorgrid/colortileview.d.ts +28 -28
  41. package/src/colorgrid/colortileview.js +40 -40
  42. package/src/colorgrid/utils.d.ts +47 -47
  43. package/src/colorgrid/utils.js +84 -84
  44. package/src/colorpicker/colorpickerview.d.ts +137 -137
  45. package/src/colorpicker/colorpickerview.js +270 -270
  46. package/src/colorpicker/utils.d.ts +43 -43
  47. package/src/colorpicker/utils.js +99 -99
  48. package/src/colorselector/colorgridsfragmentview.d.ts +194 -194
  49. package/src/colorselector/colorgridsfragmentview.js +289 -289
  50. package/src/colorselector/colorpickerfragmentview.d.ts +128 -128
  51. package/src/colorselector/colorpickerfragmentview.js +205 -205
  52. package/src/colorselector/colorselectorview.d.ts +242 -242
  53. package/src/colorselector/colorselectorview.js +256 -256
  54. package/src/colorselector/documentcolorcollection.d.ts +70 -70
  55. package/src/colorselector/documentcolorcollection.js +42 -42
  56. package/src/componentfactory.d.ts +81 -81
  57. package/src/componentfactory.js +104 -104
  58. package/src/dropdown/button/dropdownbutton.d.ts +25 -25
  59. package/src/dropdown/button/dropdownbutton.js +5 -5
  60. package/src/dropdown/button/dropdownbuttonview.d.ts +48 -48
  61. package/src/dropdown/button/dropdownbuttonview.js +66 -66
  62. package/src/dropdown/button/splitbuttonview.d.ts +162 -161
  63. package/src/dropdown/button/splitbuttonview.js +154 -152
  64. package/src/dropdown/dropdownpanelfocusable.d.ts +21 -21
  65. package/src/dropdown/dropdownpanelfocusable.js +5 -5
  66. package/src/dropdown/dropdownpanelview.d.ts +62 -62
  67. package/src/dropdown/dropdownpanelview.js +97 -97
  68. package/src/dropdown/dropdownview.d.ts +315 -315
  69. package/src/dropdown/dropdownview.js +379 -379
  70. package/src/dropdown/utils.d.ts +235 -235
  71. package/src/dropdown/utils.js +463 -458
  72. package/src/editableui/editableuiview.d.ts +72 -72
  73. package/src/editableui/editableuiview.js +112 -112
  74. package/src/editableui/inline/inlineeditableuiview.d.ts +40 -40
  75. package/src/editableui/inline/inlineeditableuiview.js +48 -48
  76. package/src/editorui/bodycollection.d.ts +55 -55
  77. package/src/editorui/bodycollection.js +84 -84
  78. package/src/editorui/boxed/boxededitoruiview.d.ts +40 -40
  79. package/src/editorui/boxed/boxededitoruiview.js +81 -81
  80. package/src/editorui/editorui.d.ts +288 -282
  81. package/src/editorui/editorui.js +412 -410
  82. package/src/editorui/editoruiview.d.ts +39 -39
  83. package/src/editorui/editoruiview.js +38 -38
  84. package/src/editorui/poweredby.d.ts +71 -71
  85. package/src/editorui/poweredby.js +276 -276
  86. package/src/focuscycler.d.ts +226 -226
  87. package/src/focuscycler.js +245 -245
  88. package/src/formheader/formheaderview.d.ts +59 -59
  89. package/src/formheader/formheaderview.js +69 -69
  90. package/src/highlightedtext/highlightedtextview.d.ts +38 -38
  91. package/src/highlightedtext/highlightedtextview.js +102 -102
  92. package/src/icon/iconview.d.ts +85 -85
  93. package/src/icon/iconview.js +114 -114
  94. package/src/iframe/iframeview.d.ts +50 -50
  95. package/src/iframe/iframeview.js +63 -63
  96. package/src/index.d.ts +74 -73
  97. package/src/index.js +71 -70
  98. package/src/input/inputbase.d.ts +107 -107
  99. package/src/input/inputbase.js +110 -110
  100. package/src/input/inputview.d.ts +36 -36
  101. package/src/input/inputview.js +24 -24
  102. package/src/inputnumber/inputnumberview.d.ts +49 -49
  103. package/src/inputnumber/inputnumberview.js +40 -40
  104. package/src/inputtext/inputtextview.d.ts +18 -18
  105. package/src/inputtext/inputtextview.js +27 -27
  106. package/src/label/labelview.d.ts +36 -36
  107. package/src/label/labelview.js +41 -41
  108. package/src/labeledfield/labeledfieldview.d.ts +187 -187
  109. package/src/labeledfield/labeledfieldview.js +157 -157
  110. package/src/labeledfield/utils.d.ts +123 -123
  111. package/src/labeledfield/utils.js +176 -176
  112. package/src/labeledinput/labeledinputview.d.ts +125 -125
  113. package/src/labeledinput/labeledinputview.js +125 -125
  114. package/src/list/listitemgroupview.d.ts +59 -51
  115. package/src/list/listitemgroupview.js +67 -75
  116. package/src/list/listitemview.d.ts +36 -36
  117. package/src/list/listitemview.js +42 -42
  118. package/src/list/listseparatorview.d.ts +18 -18
  119. package/src/list/listseparatorview.js +28 -28
  120. package/src/list/listview.d.ts +123 -122
  121. package/src/list/listview.js +188 -187
  122. package/src/model.d.ts +22 -22
  123. package/src/model.js +31 -31
  124. package/src/notification/notification.d.ts +211 -211
  125. package/src/notification/notification.js +187 -187
  126. package/src/panel/balloon/balloonpanelview.d.ts +685 -685
  127. package/src/panel/balloon/balloonpanelview.js +1010 -1010
  128. package/src/panel/balloon/contextualballoon.d.ts +299 -299
  129. package/src/panel/balloon/contextualballoon.js +572 -572
  130. package/src/panel/sticky/stickypanelview.d.ts +156 -156
  131. package/src/panel/sticky/stickypanelview.js +234 -234
  132. package/src/search/filteredview.d.ts +31 -31
  133. package/src/search/filteredview.js +5 -5
  134. package/src/search/searchinfoview.d.ts +45 -45
  135. package/src/search/searchinfoview.js +59 -59
  136. package/src/search/searchresultsview.d.ts +54 -54
  137. package/src/search/searchresultsview.js +65 -65
  138. package/src/search/text/searchtextqueryview.d.ts +76 -76
  139. package/src/search/text/searchtextqueryview.js +75 -75
  140. package/src/search/text/searchtextview.d.ts +219 -219
  141. package/src/search/text/searchtextview.js +201 -201
  142. package/src/spinner/spinnerview.d.ts +25 -25
  143. package/src/spinner/spinnerview.js +38 -38
  144. package/src/template.d.ts +942 -942
  145. package/src/template.js +1294 -1294
  146. package/src/textarea/textareaview.d.ts +88 -88
  147. package/src/textarea/textareaview.js +142 -140
  148. package/src/toolbar/balloon/balloontoolbar.d.ts +122 -122
  149. package/src/toolbar/balloon/balloontoolbar.js +300 -300
  150. package/src/toolbar/block/blockbuttonview.d.ts +35 -35
  151. package/src/toolbar/block/blockbuttonview.js +41 -41
  152. package/src/toolbar/block/blocktoolbar.d.ts +161 -161
  153. package/src/toolbar/block/blocktoolbar.js +395 -395
  154. package/src/toolbar/normalizetoolbarconfig.d.ts +40 -40
  155. package/src/toolbar/normalizetoolbarconfig.js +52 -51
  156. package/src/toolbar/toolbarlinebreakview.d.ts +18 -18
  157. package/src/toolbar/toolbarlinebreakview.js +28 -28
  158. package/src/toolbar/toolbarseparatorview.d.ts +18 -18
  159. package/src/toolbar/toolbarseparatorview.js +28 -28
  160. package/src/toolbar/toolbarview.d.ts +266 -266
  161. package/src/toolbar/toolbarview.js +719 -719
  162. package/src/tooltipmanager.d.ts +180 -180
  163. package/src/tooltipmanager.js +353 -353
  164. package/src/view.d.ts +422 -422
  165. package/src/view.js +396 -396
  166. package/src/viewcollection.d.ts +139 -139
  167. package/src/viewcollection.js +206 -206
  168. package/theme/components/arialiveannouncer/arialiveannouncer.css +10 -0
  169. package/theme/components/button/button.css +9 -1
  170. package/theme/components/collapsible/collapsible.css +10 -0
  171. package/theme/components/formheader/formheader.css +0 -4
@@ -1,59 +1,59 @@
1
- /**
2
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- import View from '../view';
6
- /**
7
- * A view displaying an information text related to different states of {@link module:ui/search/text/searchtextview~SearchTextView}.
8
- *
9
- * @internal
10
- */
11
- export default class SearchInfoView extends View {
12
- /**
13
- * @inheritDoc
14
- */
15
- constructor() {
16
- super();
17
- const bind = this.bindTemplate;
18
- this.set({
19
- isVisible: false,
20
- primaryText: '',
21
- secondaryText: ''
22
- });
23
- this.setTemplate({
24
- tag: 'div',
25
- attributes: {
26
- class: [
27
- 'ck',
28
- 'ck-search__info',
29
- bind.if('isVisible', 'ck-hidden', value => !value)
30
- ],
31
- tabindex: -1
32
- },
33
- children: [
34
- {
35
- tag: 'span',
36
- children: [
37
- {
38
- text: [bind.to('primaryText')]
39
- }
40
- ]
41
- },
42
- {
43
- tag: 'span',
44
- children: [
45
- {
46
- text: [bind.to('secondaryText')]
47
- }
48
- ]
49
- }
50
- ]
51
- });
52
- }
53
- /**
54
- * Focuses the view
55
- */
56
- focus() {
57
- this.element.focus();
58
- }
59
- }
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ import View from '../view';
6
+ /**
7
+ * A view displaying an information text related to different states of {@link module:ui/search/text/searchtextview~SearchTextView}.
8
+ *
9
+ * @internal
10
+ */
11
+ export default class SearchInfoView extends View {
12
+ /**
13
+ * @inheritDoc
14
+ */
15
+ constructor() {
16
+ super();
17
+ const bind = this.bindTemplate;
18
+ this.set({
19
+ isVisible: false,
20
+ primaryText: '',
21
+ secondaryText: ''
22
+ });
23
+ this.setTemplate({
24
+ tag: 'div',
25
+ attributes: {
26
+ class: [
27
+ 'ck',
28
+ 'ck-search__info',
29
+ bind.if('isVisible', 'ck-hidden', value => !value)
30
+ ],
31
+ tabindex: -1
32
+ },
33
+ children: [
34
+ {
35
+ tag: 'span',
36
+ children: [
37
+ {
38
+ text: [bind.to('primaryText')]
39
+ }
40
+ ]
41
+ },
42
+ {
43
+ tag: 'span',
44
+ children: [
45
+ {
46
+ text: [bind.to('secondaryText')]
47
+ }
48
+ ]
49
+ }
50
+ ]
51
+ });
52
+ }
53
+ /**
54
+ * Focuses the view
55
+ */
56
+ focus() {
57
+ this.element.focus();
58
+ }
59
+ }
@@ -1,54 +1,54 @@
1
- /**
2
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @module ui/search/searchresultsview
7
- */
8
- import View from '../view';
9
- import type ViewCollection from '../viewcollection';
10
- import { FocusTracker, type Locale } from '@ckeditor/ckeditor5-utils';
11
- import { default as FocusCycler, type FocusableView } from '../focuscycler';
12
- /**
13
- * A sub-component of {@link module:ui/search/text/searchtextview~SearchTextView}. It hosts the filtered and the information views.
14
- */
15
- export default class SearchResultsView extends View implements FocusableView {
16
- /**
17
- * Tracks information about the DOM focus in the view.
18
- *
19
- * @readonly
20
- */
21
- focusTracker: FocusTracker;
22
- /**
23
- * The collection of the child views inside of the list item {@link #element}.
24
- *
25
- * @readonly
26
- */
27
- children: ViewCollection;
28
- /**
29
- * Provides the focus management (keyboard navigation) in the view.
30
- *
31
- * @readonly
32
- */
33
- protected _focusCycler: FocusCycler;
34
- /**
35
- * @inheritDoc
36
- */
37
- constructor(locale: Locale);
38
- /**
39
- * @inheritDoc
40
- */
41
- render(): void;
42
- /**
43
- * Focuses the view.
44
- */
45
- focus(): void;
46
- /**
47
- * Focuses the first child view.
48
- */
49
- focusFirst(): void;
50
- /**
51
- * Focuses the last child view.
52
- */
53
- focusLast(): void;
54
- }
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module ui/search/searchresultsview
7
+ */
8
+ import View from '../view';
9
+ import type ViewCollection from '../viewcollection';
10
+ import { FocusTracker, type Locale } from '@ckeditor/ckeditor5-utils';
11
+ import { default as FocusCycler, type FocusableView } from '../focuscycler';
12
+ /**
13
+ * A sub-component of {@link module:ui/search/text/searchtextview~SearchTextView}. It hosts the filtered and the information views.
14
+ */
15
+ export default class SearchResultsView extends View implements FocusableView {
16
+ /**
17
+ * Tracks information about the DOM focus in the view.
18
+ *
19
+ * @readonly
20
+ */
21
+ focusTracker: FocusTracker;
22
+ /**
23
+ * The collection of the child views inside of the list item {@link #element}.
24
+ *
25
+ * @readonly
26
+ */
27
+ children: ViewCollection;
28
+ /**
29
+ * Provides the focus management (keyboard navigation) in the view.
30
+ *
31
+ * @readonly
32
+ */
33
+ protected _focusCycler: FocusCycler;
34
+ /**
35
+ * @inheritDoc
36
+ */
37
+ constructor(locale: Locale);
38
+ /**
39
+ * @inheritDoc
40
+ */
41
+ render(): void;
42
+ /**
43
+ * Focuses the view.
44
+ */
45
+ focus(): void;
46
+ /**
47
+ * Focuses the first child view.
48
+ */
49
+ focusFirst(): void;
50
+ /**
51
+ * Focuses the last child view.
52
+ */
53
+ focusLast(): void;
54
+ }
@@ -1,65 +1,65 @@
1
- /**
2
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @module ui/search/searchresultsview
7
- */
8
- import View from '../view';
9
- import { FocusTracker } from '@ckeditor/ckeditor5-utils';
10
- import { default as FocusCycler } from '../focuscycler';
11
- /**
12
- * A sub-component of {@link module:ui/search/text/searchtextview~SearchTextView}. It hosts the filtered and the information views.
13
- */
14
- export default class SearchResultsView extends View {
15
- /**
16
- * @inheritDoc
17
- */
18
- constructor(locale) {
19
- super(locale);
20
- this.children = this.createCollection();
21
- this.focusTracker = new FocusTracker();
22
- this.setTemplate({
23
- tag: 'div',
24
- attributes: {
25
- class: [
26
- 'ck',
27
- 'ck-search__results'
28
- ],
29
- tabindex: -1
30
- },
31
- children: this.children
32
- });
33
- this._focusCycler = new FocusCycler({
34
- focusables: this.children,
35
- focusTracker: this.focusTracker
36
- });
37
- }
38
- /**
39
- * @inheritDoc
40
- */
41
- render() {
42
- super.render();
43
- for (const child of this.children) {
44
- this.focusTracker.add(child.element);
45
- }
46
- }
47
- /**
48
- * Focuses the view.
49
- */
50
- focus() {
51
- this._focusCycler.focusFirst();
52
- }
53
- /**
54
- * Focuses the first child view.
55
- */
56
- focusFirst() {
57
- this._focusCycler.focusFirst();
58
- }
59
- /**
60
- * Focuses the last child view.
61
- */
62
- focusLast() {
63
- this._focusCycler.focusLast();
64
- }
65
- }
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module ui/search/searchresultsview
7
+ */
8
+ import View from '../view';
9
+ import { FocusTracker } from '@ckeditor/ckeditor5-utils';
10
+ import { default as FocusCycler } from '../focuscycler';
11
+ /**
12
+ * A sub-component of {@link module:ui/search/text/searchtextview~SearchTextView}. It hosts the filtered and the information views.
13
+ */
14
+ export default class SearchResultsView extends View {
15
+ /**
16
+ * @inheritDoc
17
+ */
18
+ constructor(locale) {
19
+ super(locale);
20
+ this.children = this.createCollection();
21
+ this.focusTracker = new FocusTracker();
22
+ this.setTemplate({
23
+ tag: 'div',
24
+ attributes: {
25
+ class: [
26
+ 'ck',
27
+ 'ck-search__results'
28
+ ],
29
+ tabindex: -1
30
+ },
31
+ children: this.children
32
+ });
33
+ this._focusCycler = new FocusCycler({
34
+ focusables: this.children,
35
+ focusTracker: this.focusTracker
36
+ });
37
+ }
38
+ /**
39
+ * @inheritDoc
40
+ */
41
+ render() {
42
+ super.render();
43
+ for (const child of this.children) {
44
+ this.focusTracker.add(child.element);
45
+ }
46
+ }
47
+ /**
48
+ * Focuses the view.
49
+ */
50
+ focus() {
51
+ this._focusCycler.focusFirst();
52
+ }
53
+ /**
54
+ * Focuses the first child view.
55
+ */
56
+ focusFirst() {
57
+ this._focusCycler.focusFirst();
58
+ }
59
+ /**
60
+ * Focuses the last child view.
61
+ */
62
+ focusLast() {
63
+ this._focusCycler.focusLast();
64
+ }
65
+ }
@@ -1,76 +1,76 @@
1
- /**
2
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @module ui/search/text/searchtextqueryview
7
- */
8
- import ButtonView from '../../button/buttonview';
9
- import IconView from '../../icon/iconview';
10
- import LabeledFieldView, { type LabeledFieldViewCreator } from '../../labeledfield/labeledfieldview';
11
- import type InputBase from '../../input/inputbase';
12
- import type { Locale } from '@ckeditor/ckeditor5-utils';
13
- /**
14
- * A search input field for the {@link module:ui/search/text/searchtextview~SearchTextView} component.
15
- *
16
- * @internal
17
- * @extends module:ui/labeledfield/labeledfieldview~LabeledFieldView
18
- */
19
- export default class SearchTextQueryView<TQueryFieldView extends InputBase<HTMLInputElement | HTMLTextAreaElement>> extends LabeledFieldView<TQueryFieldView> {
20
- /**
21
- * The loupe icon displayed next to the {@link #fieldView}.
22
- */
23
- iconView?: IconView;
24
- /**
25
- * The button that clears and focuses the {@link #fieldView}.
26
- */
27
- resetButtonView?: ButtonView;
28
- /**
29
- * A reference to the view configuration.
30
- */
31
- private readonly _viewConfig;
32
- /**
33
- * @inheritDoc
34
- */
35
- constructor(locale: Locale, config: SearchTextQueryViewConfig<TQueryFieldView>);
36
- /**
37
- * Resets the search field to its default state.
38
- */
39
- reset(): void;
40
- }
41
- /**
42
- * An event fired when the field is reset using the
43
- * {@link module:ui/search/text/searchtextqueryview~SearchTextQueryView#resetButtonView}.
44
- *
45
- * @eventName ~SearchTextQueryView#reset
46
- */
47
- export type SearchTextQueryViewResetEvent = {
48
- name: 'reset';
49
- args: [];
50
- };
51
- /**
52
- * The configuration of the {@link module:ui/search/text/searchtextqueryview~SearchTextQueryView} view.
53
- */
54
- export interface SearchTextQueryViewConfig<TConfigSearchField extends InputBase<HTMLInputElement | HTMLTextAreaElement>> {
55
- /**
56
- * The human-readable label of the search field.
57
- */
58
- label: string;
59
- /**
60
- * Determines whether the button that resets the search should be visible.
61
- *
62
- * @default true
63
- */
64
- showResetButton?: boolean;
65
- /**
66
- * Determines whether the loupe icon should be visible.
67
- *
68
- * @default true
69
- */
70
- showIcon?: boolean;
71
- /**
72
- * The function that creates the search field input view. By default, a plain
73
- * {@link module:ui/inputtext/inputtextview~InputTextView} is used for this purpose.
74
- */
75
- creator?: LabeledFieldViewCreator<TConfigSearchField>;
76
- }
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module ui/search/text/searchtextqueryview
7
+ */
8
+ import ButtonView from '../../button/buttonview';
9
+ import IconView from '../../icon/iconview';
10
+ import LabeledFieldView, { type LabeledFieldViewCreator } from '../../labeledfield/labeledfieldview';
11
+ import type InputBase from '../../input/inputbase';
12
+ import type { Locale } from '@ckeditor/ckeditor5-utils';
13
+ /**
14
+ * A search input field for the {@link module:ui/search/text/searchtextview~SearchTextView} component.
15
+ *
16
+ * @internal
17
+ * @extends module:ui/labeledfield/labeledfieldview~LabeledFieldView
18
+ */
19
+ export default class SearchTextQueryView<TQueryFieldView extends InputBase<HTMLInputElement | HTMLTextAreaElement>> extends LabeledFieldView<TQueryFieldView> {
20
+ /**
21
+ * The loupe icon displayed next to the {@link #fieldView}.
22
+ */
23
+ iconView?: IconView;
24
+ /**
25
+ * The button that clears and focuses the {@link #fieldView}.
26
+ */
27
+ resetButtonView?: ButtonView;
28
+ /**
29
+ * A reference to the view configuration.
30
+ */
31
+ private readonly _viewConfig;
32
+ /**
33
+ * @inheritDoc
34
+ */
35
+ constructor(locale: Locale, config: SearchTextQueryViewConfig<TQueryFieldView>);
36
+ /**
37
+ * Resets the search field to its default state.
38
+ */
39
+ reset(): void;
40
+ }
41
+ /**
42
+ * An event fired when the field is reset using the
43
+ * {@link module:ui/search/text/searchtextqueryview~SearchTextQueryView#resetButtonView}.
44
+ *
45
+ * @eventName ~SearchTextQueryView#reset
46
+ */
47
+ export type SearchTextQueryViewResetEvent = {
48
+ name: 'reset';
49
+ args: [];
50
+ };
51
+ /**
52
+ * The configuration of the {@link module:ui/search/text/searchtextqueryview~SearchTextQueryView} view.
53
+ */
54
+ export interface SearchTextQueryViewConfig<TConfigSearchField extends InputBase<HTMLInputElement | HTMLTextAreaElement>> {
55
+ /**
56
+ * The human-readable label of the search field.
57
+ */
58
+ label: string;
59
+ /**
60
+ * Determines whether the button that resets the search should be visible.
61
+ *
62
+ * @default true
63
+ */
64
+ showResetButton?: boolean;
65
+ /**
66
+ * Determines whether the loupe icon should be visible.
67
+ *
68
+ * @default true
69
+ */
70
+ showIcon?: boolean;
71
+ /**
72
+ * The function that creates the search field input view. By default, a plain
73
+ * {@link module:ui/inputtext/inputtextview~InputTextView} is used for this purpose.
74
+ */
75
+ creator?: LabeledFieldViewCreator<TConfigSearchField>;
76
+ }
@@ -1,75 +1,75 @@
1
- /**
2
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @module ui/search/text/searchtextqueryview
7
- */
8
- import ButtonView from '../../button/buttonview';
9
- import IconView from '../../icon/iconview';
10
- import LabeledFieldView from '../../labeledfield/labeledfieldview';
11
- import { createLabeledInputText } from '../../labeledfield/utils';
12
- import { icons } from '@ckeditor/ckeditor5-core';
13
- /**
14
- * A search input field for the {@link module:ui/search/text/searchtextview~SearchTextView} component.
15
- *
16
- * @internal
17
- * @extends module:ui/labeledfield/labeledfieldview~LabeledFieldView
18
- */
19
- export default class SearchTextQueryView extends LabeledFieldView {
20
- /**
21
- * @inheritDoc
22
- */
23
- constructor(locale, config) {
24
- const t = locale.t;
25
- const viewConfig = Object.assign({}, {
26
- showResetButton: true,
27
- showIcon: true,
28
- creator: createLabeledInputText
29
- }, config);
30
- super(locale, viewConfig.creator);
31
- this.label = config.label;
32
- this._viewConfig = viewConfig;
33
- if (this._viewConfig.showIcon) {
34
- this.iconView = new IconView();
35
- this.iconView.content = icons.loupe;
36
- this.fieldWrapperChildren.add(this.iconView, 0);
37
- this.extendTemplate({
38
- attributes: {
39
- class: 'ck-search__query_with-icon'
40
- }
41
- });
42
- }
43
- if (this._viewConfig.showResetButton) {
44
- this.resetButtonView = new ButtonView(locale);
45
- this.resetButtonView.set({
46
- label: t('Clear'),
47
- icon: icons.cancel,
48
- class: 'ck-search__reset',
49
- isVisible: false,
50
- tooltip: true
51
- });
52
- this.resetButtonView.on('execute', () => {
53
- this.reset();
54
- this.focus();
55
- this.fire('reset');
56
- });
57
- this.resetButtonView.bind('isVisible').to(this.fieldView, 'isEmpty', isEmpty => !isEmpty);
58
- this.fieldWrapperChildren.add(this.resetButtonView);
59
- this.extendTemplate({
60
- attributes: {
61
- class: 'ck-search__query_with-reset'
62
- }
63
- });
64
- }
65
- }
66
- /**
67
- * Resets the search field to its default state.
68
- */
69
- reset() {
70
- this.fieldView.reset();
71
- if (this._viewConfig.showResetButton) {
72
- this.resetButtonView.isVisible = false;
73
- }
74
- }
75
- }
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module ui/search/text/searchtextqueryview
7
+ */
8
+ import ButtonView from '../../button/buttonview';
9
+ import IconView from '../../icon/iconview';
10
+ import LabeledFieldView from '../../labeledfield/labeledfieldview';
11
+ import { createLabeledInputText } from '../../labeledfield/utils';
12
+ import { icons } from '@ckeditor/ckeditor5-core';
13
+ /**
14
+ * A search input field for the {@link module:ui/search/text/searchtextview~SearchTextView} component.
15
+ *
16
+ * @internal
17
+ * @extends module:ui/labeledfield/labeledfieldview~LabeledFieldView
18
+ */
19
+ export default class SearchTextQueryView extends LabeledFieldView {
20
+ /**
21
+ * @inheritDoc
22
+ */
23
+ constructor(locale, config) {
24
+ const t = locale.t;
25
+ const viewConfig = Object.assign({}, {
26
+ showResetButton: true,
27
+ showIcon: true,
28
+ creator: createLabeledInputText
29
+ }, config);
30
+ super(locale, viewConfig.creator);
31
+ this.label = config.label;
32
+ this._viewConfig = viewConfig;
33
+ if (this._viewConfig.showIcon) {
34
+ this.iconView = new IconView();
35
+ this.iconView.content = icons.loupe;
36
+ this.fieldWrapperChildren.add(this.iconView, 0);
37
+ this.extendTemplate({
38
+ attributes: {
39
+ class: 'ck-search__query_with-icon'
40
+ }
41
+ });
42
+ }
43
+ if (this._viewConfig.showResetButton) {
44
+ this.resetButtonView = new ButtonView(locale);
45
+ this.resetButtonView.set({
46
+ label: t('Clear'),
47
+ icon: icons.cancel,
48
+ class: 'ck-search__reset',
49
+ isVisible: false,
50
+ tooltip: true
51
+ });
52
+ this.resetButtonView.on('execute', () => {
53
+ this.reset();
54
+ this.focus();
55
+ this.fire('reset');
56
+ });
57
+ this.resetButtonView.bind('isVisible').to(this.fieldView, 'isEmpty', isEmpty => !isEmpty);
58
+ this.fieldWrapperChildren.add(this.resetButtonView);
59
+ this.extendTemplate({
60
+ attributes: {
61
+ class: 'ck-search__query_with-reset'
62
+ }
63
+ });
64
+ }
65
+ }
66
+ /**
67
+ * Resets the search field to its default state.
68
+ */
69
+ reset() {
70
+ this.fieldView.reset();
71
+ if (this._viewConfig.showResetButton) {
72
+ this.resetButtonView.isVisible = false;
73
+ }
74
+ }
75
+ }