@ckeditor/ckeditor5-ui 39.0.1 → 40.0.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 (229) hide show
  1. package/CHANGELOG.md +1 -1
  2. package/LICENSE.md +1 -1
  3. package/README.md +4 -4
  4. package/lang/contexts.json +5 -1
  5. package/lang/translations/ar.po +17 -0
  6. package/lang/translations/ast.po +17 -0
  7. package/lang/translations/az.po +17 -0
  8. package/lang/translations/bg.po +17 -0
  9. package/lang/translations/bn.po +17 -0
  10. package/lang/translations/ca.po +17 -0
  11. package/lang/translations/cs.po +17 -0
  12. package/lang/translations/da.po +17 -0
  13. package/lang/translations/de-ch.po +17 -0
  14. package/lang/translations/de.po +17 -0
  15. package/lang/translations/el.po +17 -0
  16. package/lang/translations/en-au.po +17 -0
  17. package/lang/translations/en-gb.po +17 -0
  18. package/lang/translations/en.po +17 -0
  19. package/lang/translations/eo.po +17 -0
  20. package/lang/translations/es.po +17 -0
  21. package/lang/translations/et.po +17 -0
  22. package/lang/translations/eu.po +17 -0
  23. package/lang/translations/fa.po +17 -0
  24. package/lang/translations/fi.po +17 -0
  25. package/lang/translations/fr.po +17 -0
  26. package/lang/translations/gl.po +17 -0
  27. package/lang/translations/he.po +17 -0
  28. package/lang/translations/hi.po +17 -0
  29. package/lang/translations/hr.po +17 -0
  30. package/lang/translations/hu.po +17 -0
  31. package/lang/translations/id.po +17 -0
  32. package/lang/translations/it.po +17 -0
  33. package/lang/translations/ja.po +17 -0
  34. package/lang/translations/km.po +17 -0
  35. package/lang/translations/kn.po +17 -0
  36. package/lang/translations/ko.po +17 -0
  37. package/lang/translations/ku.po +17 -0
  38. package/lang/translations/lt.po +17 -0
  39. package/lang/translations/lv.po +17 -0
  40. package/lang/translations/ms.po +17 -0
  41. package/lang/translations/nb.po +17 -0
  42. package/lang/translations/ne.po +17 -0
  43. package/lang/translations/nl.po +17 -0
  44. package/lang/translations/no.po +17 -0
  45. package/lang/translations/pl.po +17 -0
  46. package/lang/translations/pt-br.po +17 -0
  47. package/lang/translations/pt.po +17 -0
  48. package/lang/translations/ro.po +17 -0
  49. package/lang/translations/ru.po +17 -0
  50. package/lang/translations/sk.po +17 -0
  51. package/lang/translations/sl.po +17 -0
  52. package/lang/translations/sq.po +17 -0
  53. package/lang/translations/sr-latn.po +17 -0
  54. package/lang/translations/sr.po +17 -0
  55. package/lang/translations/sv.po +17 -0
  56. package/lang/translations/th.po +17 -0
  57. package/lang/translations/tk.po +17 -0
  58. package/lang/translations/tr.po +17 -0
  59. package/lang/translations/tt.po +17 -0
  60. package/lang/translations/ug.po +17 -0
  61. package/lang/translations/uk.po +17 -0
  62. package/lang/translations/ur.po +17 -0
  63. package/lang/translations/uz.po +17 -0
  64. package/lang/translations/vi.po +17 -0
  65. package/lang/translations/zh-cn.po +17 -0
  66. package/lang/translations/zh.po +17 -0
  67. package/package.json +3 -7
  68. package/src/augmentation.d.ts +86 -86
  69. package/src/augmentation.js +5 -5
  70. package/src/autocomplete/autocompleteview.d.ts +81 -0
  71. package/src/autocomplete/autocompleteview.js +146 -0
  72. package/src/bindings/addkeyboardhandlingforgrid.d.ts +27 -27
  73. package/src/bindings/addkeyboardhandlingforgrid.js +107 -107
  74. package/src/bindings/clickoutsidehandler.d.ts +28 -28
  75. package/src/bindings/clickoutsidehandler.js +36 -36
  76. package/src/bindings/csstransitiondisablermixin.d.ts +40 -40
  77. package/src/bindings/csstransitiondisablermixin.js +55 -55
  78. package/src/bindings/injectcsstransitiondisabler.d.ts +59 -59
  79. package/src/bindings/injectcsstransitiondisabler.js +71 -71
  80. package/src/bindings/preventdefault.d.ts +33 -33
  81. package/src/bindings/preventdefault.js +34 -34
  82. package/src/bindings/submithandler.d.ts +57 -57
  83. package/src/bindings/submithandler.js +47 -47
  84. package/src/button/button.d.ts +178 -178
  85. package/src/button/button.js +5 -5
  86. package/src/button/buttonlabel.d.ts +34 -0
  87. package/src/button/buttonlabel.js +5 -0
  88. package/src/button/buttonlabelview.d.ts +31 -0
  89. package/src/button/buttonlabelview.js +42 -0
  90. package/src/button/buttonview.d.ts +185 -177
  91. package/src/button/buttonview.js +219 -231
  92. package/src/button/switchbuttonview.d.ts +45 -45
  93. package/src/button/switchbuttonview.js +75 -75
  94. package/src/colorgrid/colorgridview.d.ts +132 -132
  95. package/src/colorgrid/colorgridview.js +124 -124
  96. package/src/colorgrid/colortileview.d.ts +28 -28
  97. package/src/colorgrid/colortileview.js +40 -40
  98. package/src/colorgrid/utils.d.ts +47 -47
  99. package/src/colorgrid/utils.js +84 -84
  100. package/src/colorpicker/colorpickerview.d.ts +137 -137
  101. package/src/colorpicker/colorpickerview.js +270 -270
  102. package/src/colorpicker/utils.d.ts +43 -43
  103. package/src/colorpicker/utils.js +99 -99
  104. package/src/colorselector/colorgridsfragmentview.d.ts +194 -194
  105. package/src/colorselector/colorgridsfragmentview.js +289 -289
  106. package/src/colorselector/colorpickerfragmentview.d.ts +128 -128
  107. package/src/colorselector/colorpickerfragmentview.js +205 -205
  108. package/src/colorselector/colorselectorview.d.ts +242 -242
  109. package/src/colorselector/colorselectorview.js +256 -256
  110. package/src/colorselector/documentcolorcollection.d.ts +70 -70
  111. package/src/colorselector/documentcolorcollection.js +42 -42
  112. package/src/componentfactory.d.ts +81 -81
  113. package/src/componentfactory.js +104 -104
  114. package/src/dropdown/button/dropdownbutton.d.ts +25 -25
  115. package/src/dropdown/button/dropdownbutton.js +5 -5
  116. package/src/dropdown/button/dropdownbuttonview.d.ts +48 -48
  117. package/src/dropdown/button/dropdownbuttonview.js +66 -66
  118. package/src/dropdown/button/splitbuttonview.d.ts +161 -161
  119. package/src/dropdown/button/splitbuttonview.js +152 -152
  120. package/src/dropdown/dropdownpanelfocusable.d.ts +21 -21
  121. package/src/dropdown/dropdownpanelfocusable.js +5 -5
  122. package/src/dropdown/dropdownpanelview.d.ts +62 -62
  123. package/src/dropdown/dropdownpanelview.js +97 -97
  124. package/src/dropdown/dropdownview.d.ts +315 -315
  125. package/src/dropdown/dropdownview.js +379 -378
  126. package/src/dropdown/utils.d.ts +235 -221
  127. package/src/dropdown/utils.js +458 -437
  128. package/src/editableui/editableuiview.d.ts +72 -72
  129. package/src/editableui/editableuiview.js +112 -112
  130. package/src/editableui/inline/inlineeditableuiview.d.ts +40 -40
  131. package/src/editableui/inline/inlineeditableuiview.js +48 -48
  132. package/src/editorui/bodycollection.d.ts +55 -55
  133. package/src/editorui/bodycollection.js +84 -84
  134. package/src/editorui/boxed/boxededitoruiview.d.ts +40 -40
  135. package/src/editorui/boxed/boxededitoruiview.js +81 -81
  136. package/src/editorui/editorui.d.ts +282 -282
  137. package/src/editorui/editorui.js +410 -410
  138. package/src/editorui/editoruiview.d.ts +39 -39
  139. package/src/editorui/editoruiview.js +38 -38
  140. package/src/editorui/poweredby.d.ts +71 -71
  141. package/src/editorui/poweredby.js +276 -299
  142. package/src/focuscycler.d.ts +226 -183
  143. package/src/focuscycler.js +245 -220
  144. package/src/formheader/formheaderview.d.ts +59 -53
  145. package/src/formheader/formheaderview.js +69 -63
  146. package/src/highlightedtext/highlightedtextview.d.ts +38 -0
  147. package/src/highlightedtext/highlightedtextview.js +102 -0
  148. package/src/icon/iconview.d.ts +85 -78
  149. package/src/icon/iconview.js +114 -112
  150. package/src/iframe/iframeview.d.ts +50 -50
  151. package/src/iframe/iframeview.js +63 -63
  152. package/src/index.d.ts +73 -63
  153. package/src/index.js +70 -62
  154. package/src/input/inputbase.d.ts +107 -0
  155. package/src/input/inputbase.js +110 -0
  156. package/src/input/inputview.d.ts +36 -121
  157. package/src/input/inputview.js +24 -106
  158. package/src/inputnumber/inputnumberview.d.ts +49 -49
  159. package/src/inputnumber/inputnumberview.js +40 -40
  160. package/src/inputtext/inputtextview.d.ts +18 -18
  161. package/src/inputtext/inputtextview.js +27 -27
  162. package/src/label/labelview.d.ts +36 -36
  163. package/src/label/labelview.js +41 -41
  164. package/src/labeledfield/labeledfieldview.d.ts +187 -182
  165. package/src/labeledfield/labeledfieldview.js +157 -157
  166. package/src/labeledfield/utils.d.ts +123 -93
  167. package/src/labeledfield/utils.js +176 -131
  168. package/src/labeledinput/labeledinputview.d.ts +125 -125
  169. package/src/labeledinput/labeledinputview.js +125 -125
  170. package/src/list/listitemgroupview.d.ts +51 -0
  171. package/src/list/listitemgroupview.js +75 -0
  172. package/src/list/listitemview.d.ts +36 -35
  173. package/src/list/listitemview.js +42 -40
  174. package/src/list/listseparatorview.d.ts +18 -18
  175. package/src/list/listseparatorview.js +28 -28
  176. package/src/list/listview.d.ts +122 -65
  177. package/src/list/listview.js +187 -90
  178. package/src/model.d.ts +22 -22
  179. package/src/model.js +31 -31
  180. package/src/notification/notification.d.ts +211 -211
  181. package/src/notification/notification.js +187 -187
  182. package/src/panel/balloon/balloonpanelview.d.ts +685 -685
  183. package/src/panel/balloon/balloonpanelview.js +1010 -988
  184. package/src/panel/balloon/contextualballoon.d.ts +299 -299
  185. package/src/panel/balloon/contextualballoon.js +572 -572
  186. package/src/panel/sticky/stickypanelview.d.ts +156 -158
  187. package/src/panel/sticky/stickypanelview.js +234 -231
  188. package/src/search/filteredview.d.ts +31 -0
  189. package/src/search/filteredview.js +5 -0
  190. package/src/search/searchinfoview.d.ts +45 -0
  191. package/src/search/searchinfoview.js +59 -0
  192. package/src/search/searchresultsview.d.ts +54 -0
  193. package/src/search/searchresultsview.js +65 -0
  194. package/src/search/text/searchtextqueryview.d.ts +76 -0
  195. package/src/search/text/searchtextqueryview.js +75 -0
  196. package/src/search/text/searchtextview.d.ts +219 -0
  197. package/src/search/text/searchtextview.js +201 -0
  198. package/src/spinner/spinnerview.d.ts +25 -0
  199. package/src/spinner/spinnerview.js +38 -0
  200. package/src/template.d.ts +942 -942
  201. package/src/template.js +1294 -1294
  202. package/src/textarea/textareaview.d.ts +88 -0
  203. package/src/textarea/textareaview.js +140 -0
  204. package/src/toolbar/balloon/balloontoolbar.d.ts +122 -122
  205. package/src/toolbar/balloon/balloontoolbar.js +300 -300
  206. package/src/toolbar/block/blockbuttonview.d.ts +35 -35
  207. package/src/toolbar/block/blockbuttonview.js +41 -41
  208. package/src/toolbar/block/blocktoolbar.d.ts +161 -161
  209. package/src/toolbar/block/blocktoolbar.js +395 -391
  210. package/src/toolbar/normalizetoolbarconfig.d.ts +40 -39
  211. package/src/toolbar/normalizetoolbarconfig.js +51 -51
  212. package/src/toolbar/toolbarlinebreakview.d.ts +18 -18
  213. package/src/toolbar/toolbarlinebreakview.js +28 -28
  214. package/src/toolbar/toolbarseparatorview.d.ts +18 -18
  215. package/src/toolbar/toolbarseparatorview.js +28 -28
  216. package/src/toolbar/toolbarview.d.ts +266 -265
  217. package/src/toolbar/toolbarview.js +719 -717
  218. package/src/tooltipmanager.d.ts +180 -180
  219. package/src/tooltipmanager.js +353 -353
  220. package/src/view.d.ts +422 -422
  221. package/src/view.js +396 -396
  222. package/src/viewcollection.d.ts +139 -139
  223. package/src/viewcollection.js +206 -206
  224. package/theme/components/autocomplete/autocomplete.css +22 -0
  225. package/theme/components/formheader/formheader.css +8 -0
  226. package/theme/components/highlightedtext/highlightedtext.css +12 -0
  227. package/theme/components/search/search.css +43 -0
  228. package/theme/components/spinner/spinner.css +23 -0
  229. package/theme/components/textarea/textarea.css +10 -0
@@ -1,231 +1,234 @@
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/panel/sticky/stickypanelview
7
- */
8
- import View from '../../view';
9
- import Template from '../../template';
10
- import { getElementsIntersectionRect, getScrollableAncestors, global, toUnit, Rect } from '@ckeditor/ckeditor5-utils';
11
- // @if CK_DEBUG_STICKYPANEL // const RectDrawer = require( '@ckeditor/ckeditor5-utils/tests/_utils/rectdrawer' ).default
12
- import '../../../theme/components/panel/stickypanel.css';
13
- const toPx = toUnit('px');
14
- /**
15
- * The sticky panel view class.
16
- */
17
- export default class StickyPanelView extends View {
18
- /**
19
- * @inheritDoc
20
- */
21
- constructor(locale) {
22
- super(locale);
23
- const bind = this.bindTemplate;
24
- this.set('isActive', false);
25
- this.set('isSticky', false);
26
- this.set('limiterElement', null);
27
- this.set('limiterBottomOffset', 50);
28
- this.set('viewportTopOffset', 0);
29
- this.set('_marginLeft', null);
30
- this.set('_isStickyToTheBottomOfLimiter', false);
31
- this.set('_stickyTopOffset', null);
32
- this.set('_stickyBottomOffset', null);
33
- this.content = this.createCollection();
34
- this._contentPanelPlaceholder = new Template({
35
- tag: 'div',
36
- attributes: {
37
- class: [
38
- 'ck',
39
- 'ck-sticky-panel__placeholder'
40
- ],
41
- style: {
42
- display: bind.to('isSticky', isSticky => isSticky ? 'block' : 'none'),
43
- height: bind.to('isSticky', isSticky => {
44
- return isSticky ? toPx(this._contentPanelRect.height) : null;
45
- })
46
- }
47
- }
48
- }).render();
49
- this._contentPanel = new Template({
50
- tag: 'div',
51
- attributes: {
52
- class: [
53
- 'ck',
54
- 'ck-sticky-panel__content',
55
- // Toggle class of the panel when "sticky" state changes in the view.
56
- bind.if('isSticky', 'ck-sticky-panel__content_sticky'),
57
- bind.if('_isStickyToTheBottomOfLimiter', 'ck-sticky-panel__content_sticky_bottom-limit')
58
- ],
59
- style: {
60
- width: bind.to('isSticky', isSticky => {
61
- return isSticky ? toPx(this._contentPanelPlaceholder.getBoundingClientRect().width) : null;
62
- }),
63
- top: bind.to('_stickyTopOffset', value => value ? toPx(value) : value),
64
- bottom: bind.to('_stickyBottomOffset', value => value ? toPx(value) : value),
65
- marginLeft: bind.to('_marginLeft')
66
- }
67
- },
68
- children: this.content
69
- }).render();
70
- this.setTemplate({
71
- tag: 'div',
72
- attributes: {
73
- class: [
74
- 'ck',
75
- 'ck-sticky-panel'
76
- ]
77
- },
78
- children: [
79
- this._contentPanelPlaceholder,
80
- this._contentPanel
81
- ]
82
- });
83
- }
84
- /**
85
- * @inheritDoc
86
- */
87
- render() {
88
- super.render();
89
- // Check if the panel should go into the sticky state immediately.
90
- this.checkIfShouldBeSticky();
91
- // Update sticky state of the panel as the window and ancestors are being scrolled.
92
- this.listenTo(global.document, 'scroll', (evt, data) => {
93
- this.checkIfShouldBeSticky(data.target);
94
- }, { useCapture: true });
95
- // Synchronize with `model.isActive` because sticking an inactive panel is pointless.
96
- this.listenTo(this, 'change:isActive', () => {
97
- this.checkIfShouldBeSticky();
98
- });
99
- }
100
- /**
101
- * Analyzes the environment to decide whether the panel should be sticky or not.
102
- * Then handles the positioning of the panel.
103
- *
104
- * @param [scrollTarget] The element which is being scrolled.
105
- */
106
- checkIfShouldBeSticky(scrollTarget) {
107
- // @if CK_DEBUG_STICKYPANEL // RectDrawer.clear();
108
- if (!this.limiterElement || !this.isActive) {
109
- this._unstick();
110
- return;
111
- }
112
- const scrollableAncestors = getScrollableAncestors(this.limiterElement);
113
- if (scrollTarget && !scrollableAncestors.includes(scrollTarget)) {
114
- return;
115
- }
116
- const visibleAncestorsRect = getElementsIntersectionRect(scrollableAncestors, this.viewportTopOffset);
117
- const limiterRect = new Rect(this.limiterElement);
118
- // @if CK_DEBUG_STICKYPANEL // if ( visibleAncestorsRect ) {
119
- // @if CK_DEBUG_STICKYPANEL // RectDrawer.draw( visibleAncestorsRect,
120
- // @if CK_DEBUG_STICKYPANEL // { outlineWidth: '3px', opacity: '.8', outlineColor: 'red', outlineOffset: '-3px' },
121
- // @if CK_DEBUG_STICKYPANEL // 'Visible anc'
122
- // @if CK_DEBUG_STICKYPANEL // );
123
- // @if CK_DEBUG_STICKYPANEL // }
124
- // @if CK_DEBUG_STICKYPANEL //
125
- // @if CK_DEBUG_STICKYPANEL // RectDrawer.draw( limiterRect,
126
- // @if CK_DEBUG_STICKYPANEL // { outlineWidth: '3px', opacity: '.8', outlineColor: 'green', outlineOffset: '-3px' },
127
- // @if CK_DEBUG_STICKYPANEL // 'Limiter'
128
- // @if CK_DEBUG_STICKYPANEL // );
129
- // Stick the panel only if
130
- // * the limiter's ancestors are intersecting with each other so that some of their rects are visible,
131
- // * and the limiter's top edge is above the visible ancestors' top edge.
132
- if (visibleAncestorsRect && limiterRect.top < visibleAncestorsRect.top) {
133
- const visibleLimiterRect = limiterRect.getIntersection(visibleAncestorsRect);
134
- // Sticky the panel only if the limiter's visible rect is at least partially visible in the
135
- // visible ancestors' rects intersection.
136
- if (visibleLimiterRect) {
137
- // @if CK_DEBUG_STICKYPANEL // RectDrawer.draw( visibleLimiterRect,
138
- // @if CK_DEBUG_STICKYPANEL // { outlineWidth: '3px', opacity: '.8', outlineColor: 'fuchsia', outlineOffset: '-3px',
139
- // @if CK_DEBUG_STICKYPANEL // backgroundColor: 'rgba(255, 0, 255, .3)' },
140
- // @if CK_DEBUG_STICKYPANEL // 'Visible limiter'
141
- // @if CK_DEBUG_STICKYPANEL // );
142
- const visibleAncestorsTop = visibleAncestorsRect.top;
143
- // Check if there's a change the panel can be sticky to the bottom of the limiter.
144
- if (visibleAncestorsTop + this._contentPanelRect.height + this.limiterBottomOffset > visibleLimiterRect.bottom) {
145
- const stickyBottomOffset = Math.max(limiterRect.bottom - visibleAncestorsRect.bottom, 0) + this.limiterBottomOffset;
146
- // @if CK_DEBUG_STICKYPANEL // const stickyBottomOffsetRect = new Rect( {
147
- // @if CK_DEBUG_STICKYPANEL // top: limiterRect.bottom - stickyBottomOffset, left: 0, right: 2000,
148
- // @if CK_DEBUG_STICKYPANEL // bottom: limiterRect.bottom - stickyBottomOffset, width: 2000, height: 1
149
- // @if CK_DEBUG_STICKYPANEL // } );
150
- // @if CK_DEBUG_STICKYPANEL // RectDrawer.draw( stickyBottomOffsetRect,
151
- // @if CK_DEBUG_STICKYPANEL // { outlineWidth: '1px', opacity: '.8', outlineColor: 'black' },
152
- // @if CK_DEBUG_STICKYPANEL // 'Sticky bottom offset'
153
- // @if CK_DEBUG_STICKYPANEL // );
154
- // Check if sticking the panel to the bottom of the limiter does not cause it to suddenly
155
- // move upwards if there's not enough space for it.
156
- if (limiterRect.bottom - stickyBottomOffset > limiterRect.top + this._contentPanelRect.height) {
157
- this._stickToBottomOfLimiter(stickyBottomOffset);
158
- }
159
- else {
160
- this._unstick();
161
- }
162
- }
163
- else {
164
- if (this._contentPanelRect.height + this.limiterBottomOffset < limiterRect.height) {
165
- this._stickToTopOfAncestors(visibleAncestorsTop);
166
- }
167
- else {
168
- this._unstick();
169
- }
170
- }
171
- }
172
- else {
173
- this._unstick();
174
- }
175
- }
176
- else {
177
- this._unstick();
178
- }
179
- // @if CK_DEBUG_STICKYPANEL // console.clear();
180
- // @if CK_DEBUG_STICKYPANEL // console.log( 'isSticky', this.isSticky );
181
- // @if CK_DEBUG_STICKYPANEL // console.log( '_isStickyToTheBottomOfLimiter', this._isStickyToTheBottomOfLimiter );
182
- // @if CK_DEBUG_STICKYPANEL // console.log( '_stickyTopOffset', this._stickyTopOffset );
183
- // @if CK_DEBUG_STICKYPANEL // console.log( '_stickyBottomOffset', this._stickyBottomOffset );
184
- }
185
- /**
186
- * Sticks the panel at the given CSS `top` offset.
187
- *
188
- * @private
189
- * @param topOffset
190
- */
191
- _stickToTopOfAncestors(topOffset) {
192
- this.isSticky = true;
193
- this._isStickyToTheBottomOfLimiter = false;
194
- this._stickyTopOffset = topOffset;
195
- this._stickyBottomOffset = null;
196
- this._marginLeft = toPx(-global.window.scrollX);
197
- }
198
- /**
199
- * Sticks the panel at the bottom of the limiter with a given CSS `bottom` offset.
200
- *
201
- * @private
202
- * @param stickyBottomOffset
203
- */
204
- _stickToBottomOfLimiter(stickyBottomOffset) {
205
- this.isSticky = true;
206
- this._isStickyToTheBottomOfLimiter = true;
207
- this._stickyTopOffset = null;
208
- this._stickyBottomOffset = stickyBottomOffset;
209
- this._marginLeft = toPx(-global.window.scrollX);
210
- }
211
- /**
212
- * Unsticks the panel putting it back to its original position.
213
- *
214
- * @private
215
- */
216
- _unstick() {
217
- this.isSticky = false;
218
- this._isStickyToTheBottomOfLimiter = false;
219
- this._stickyTopOffset = null;
220
- this._stickyBottomOffset = null;
221
- this._marginLeft = null;
222
- }
223
- /**
224
- * Returns the bounding rect of the {@link #_contentPanel}.
225
- *
226
- * @private
227
- */
228
- get _contentPanelRect() {
229
- return new Rect(this._contentPanel);
230
- }
231
- }
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/panel/sticky/stickypanelview
7
+ */
8
+ import View from '../../view';
9
+ import Template from '../../template';
10
+ import { global, toUnit, Rect } from '@ckeditor/ckeditor5-utils';
11
+ // @if CK_DEBUG_STICKYPANEL // const {
12
+ // @if CK_DEBUG_STICKYPANEL // default: RectDrawer,
13
+ // @if CK_DEBUG_STICKYPANEL // diagonalStylesBlack
14
+ // @if CK_DEBUG_STICKYPANEL // } = require( '@ckeditor/ckeditor5-utils/tests/_utils/rectdrawer' );
15
+ import '../../../theme/components/panel/stickypanel.css';
16
+ const toPx = toUnit('px');
17
+ /**
18
+ * The sticky panel view class.
19
+ */
20
+ export default class StickyPanelView extends View {
21
+ /**
22
+ * @inheritDoc
23
+ */
24
+ constructor(locale) {
25
+ super(locale);
26
+ const bind = this.bindTemplate;
27
+ this.set('isActive', false);
28
+ this.set('isSticky', false);
29
+ this.set('limiterElement', null);
30
+ this.set('limiterBottomOffset', 50);
31
+ this.set('viewportTopOffset', 0);
32
+ this.set('_marginLeft', null);
33
+ this.set('_isStickyToTheBottomOfLimiter', false);
34
+ this.set('_stickyTopOffset', null);
35
+ this.set('_stickyBottomOffset', null);
36
+ this.content = this.createCollection();
37
+ this._contentPanelPlaceholder = new Template({
38
+ tag: 'div',
39
+ attributes: {
40
+ class: [
41
+ 'ck',
42
+ 'ck-sticky-panel__placeholder'
43
+ ],
44
+ style: {
45
+ display: bind.to('isSticky', isSticky => isSticky ? 'block' : 'none'),
46
+ height: bind.to('isSticky', isSticky => {
47
+ return isSticky ? toPx(this._contentPanelRect.height) : null;
48
+ })
49
+ }
50
+ }
51
+ }).render();
52
+ this._contentPanel = new Template({
53
+ tag: 'div',
54
+ attributes: {
55
+ class: [
56
+ 'ck',
57
+ 'ck-sticky-panel__content',
58
+ // Toggle class of the panel when "sticky" state changes in the view.
59
+ bind.if('isSticky', 'ck-sticky-panel__content_sticky'),
60
+ bind.if('_isStickyToTheBottomOfLimiter', 'ck-sticky-panel__content_sticky_bottom-limit')
61
+ ],
62
+ style: {
63
+ width: bind.to('isSticky', isSticky => {
64
+ return isSticky ? toPx(this._contentPanelPlaceholder.getBoundingClientRect().width) : null;
65
+ }),
66
+ top: bind.to('_stickyTopOffset', value => value ? toPx(value) : value),
67
+ bottom: bind.to('_stickyBottomOffset', value => value ? toPx(value) : value),
68
+ marginLeft: bind.to('_marginLeft')
69
+ }
70
+ },
71
+ children: this.content
72
+ }).render();
73
+ this.setTemplate({
74
+ tag: 'div',
75
+ attributes: {
76
+ class: [
77
+ 'ck',
78
+ 'ck-sticky-panel'
79
+ ]
80
+ },
81
+ children: [
82
+ this._contentPanelPlaceholder,
83
+ this._contentPanel
84
+ ]
85
+ });
86
+ }
87
+ /**
88
+ * @inheritDoc
89
+ */
90
+ render() {
91
+ super.render();
92
+ // Check if the panel should go into the sticky state immediately.
93
+ this.checkIfShouldBeSticky();
94
+ // Update sticky state of the panel as the window and ancestors are being scrolled.
95
+ this.listenTo(global.document, 'scroll', () => {
96
+ this.checkIfShouldBeSticky();
97
+ }, { useCapture: true });
98
+ // Synchronize with `model.isActive` because sticking an inactive panel is pointless.
99
+ this.listenTo(this, 'change:isActive', () => {
100
+ this.checkIfShouldBeSticky();
101
+ });
102
+ }
103
+ /**
104
+ * Analyzes the environment to decide whether the panel should be sticky or not.
105
+ * Then handles the positioning of the panel.
106
+ */
107
+ checkIfShouldBeSticky() {
108
+ // @if CK_DEBUG_STICKYPANEL // RectDrawer.clear();
109
+ if (!this.limiterElement || !this.isActive) {
110
+ this._unstick();
111
+ return;
112
+ }
113
+ const limiterRect = new Rect(this.limiterElement);
114
+ let visibleLimiterRect = limiterRect.getVisible();
115
+ if (visibleLimiterRect) {
116
+ const windowRect = new Rect(global.window);
117
+ windowRect.top += this.viewportTopOffset;
118
+ windowRect.height -= this.viewportTopOffset;
119
+ visibleLimiterRect = visibleLimiterRect.getIntersection(windowRect);
120
+ }
121
+ // @if CK_DEBUG_STICKYPANEL // if ( visibleLimiterRect ) {
122
+ // @if CK_DEBUG_STICKYPANEL // RectDrawer.draw( visibleLimiterRect,
123
+ // @if CK_DEBUG_STICKYPANEL // { outlineWidth: '3px', opacity: '.8', outlineColor: 'red', outlineOffset: '-3px' },
124
+ // @if CK_DEBUG_STICKYPANEL // 'Visible anc'
125
+ // @if CK_DEBUG_STICKYPANEL // );
126
+ // @if CK_DEBUG_STICKYPANEL // }
127
+ // @if CK_DEBUG_STICKYPANEL //
128
+ // @if CK_DEBUG_STICKYPANEL // RectDrawer.draw( limiterRect,
129
+ // @if CK_DEBUG_STICKYPANEL // { outlineWidth: '3px', opacity: '.8', outlineColor: 'green', outlineOffset: '-3px' },
130
+ // @if CK_DEBUG_STICKYPANEL // 'Limiter'
131
+ // @if CK_DEBUG_STICKYPANEL // );
132
+ // Stick the panel only if
133
+ // * the limiter's ancestors are intersecting with each other so that some of their rects are visible,
134
+ // * and the limiter's top edge is above the visible ancestors' top edge.
135
+ if (visibleLimiterRect && limiterRect.top < visibleLimiterRect.top) {
136
+ // @if CK_DEBUG_STICKYPANEL // RectDrawer.draw( visibleLimiterRect,
137
+ // @if CK_DEBUG_STICKYPANEL // { outlineWidth: '3px', opacity: '.8', outlineColor: 'fuchsia', outlineOffset: '-3px',
138
+ // @if CK_DEBUG_STICKYPANEL // backgroundColor: 'rgba(255, 0, 255, .3)' },
139
+ // @if CK_DEBUG_STICKYPANEL // 'Visible limiter'
140
+ // @if CK_DEBUG_STICKYPANEL // );
141
+ const visibleLimiterTop = visibleLimiterRect.top;
142
+ // Check if there's a change the panel can be sticky to the bottom of the limiter.
143
+ if (visibleLimiterTop + this._contentPanelRect.height + this.limiterBottomOffset > visibleLimiterRect.bottom) {
144
+ const stickyBottomOffset = Math.max(limiterRect.bottom - visibleLimiterRect.bottom, 0) + this.limiterBottomOffset;
145
+ // @if CK_DEBUG_STICKYPANEL // const stickyBottomOffsetRect = new Rect( {
146
+ // @if CK_DEBUG_STICKYPANEL // top: limiterRect.bottom - stickyBottomOffset, left: 0, right: 2000,
147
+ // @if CK_DEBUG_STICKYPANEL // bottom: limiterRect.bottom - stickyBottomOffset, width: 2000, height: 1
148
+ // @if CK_DEBUG_STICKYPANEL // } );
149
+ // @if CK_DEBUG_STICKYPANEL // RectDrawer.draw( stickyBottomOffsetRect,
150
+ // @if CK_DEBUG_STICKYPANEL // { outlineWidth: '1px', opacity: '.8', outlineColor: 'black' },
151
+ // @if CK_DEBUG_STICKYPANEL // 'Sticky bottom offset'
152
+ // @if CK_DEBUG_STICKYPANEL // );
153
+ // Check if sticking the panel to the bottom of the limiter does not cause it to suddenly
154
+ // move upwards if there's not enough space for it.
155
+ if (limiterRect.bottom - stickyBottomOffset > limiterRect.top + this._contentPanelRect.height) {
156
+ this._stickToBottomOfLimiter(stickyBottomOffset);
157
+ }
158
+ else {
159
+ this._unstick();
160
+ }
161
+ }
162
+ else {
163
+ if (this._contentPanelRect.height + this.limiterBottomOffset < limiterRect.height) {
164
+ this._stickToTopOfAncestors(visibleLimiterTop);
165
+ }
166
+ else {
167
+ this._unstick();
168
+ }
169
+ }
170
+ }
171
+ else {
172
+ this._unstick();
173
+ }
174
+ // @if CK_DEBUG_STICKYPANEL // console.clear();
175
+ // @if CK_DEBUG_STICKYPANEL // console.log( 'isSticky', this.isSticky );
176
+ // @if CK_DEBUG_STICKYPANEL // console.log( '_isStickyToTheBottomOfLimiter', this._isStickyToTheBottomOfLimiter );
177
+ // @if CK_DEBUG_STICKYPANEL // console.log( '_stickyTopOffset', this._stickyTopOffset );
178
+ // @if CK_DEBUG_STICKYPANEL // console.log( '_stickyBottomOffset', this._stickyBottomOffset );
179
+ // @if CK_DEBUG_STICKYPANEL // if ( visibleLimiterRect ) {
180
+ // @if CK_DEBUG_STICKYPANEL // RectDrawer.draw( visibleLimiterRect,
181
+ // @if CK_DEBUG_STICKYPANEL // { ...diagonalStylesBlack,
182
+ // @if CK_DEBUG_STICKYPANEL // outlineWidth: '3px', opacity: '.8', outlineColor: 'orange', outlineOffset: '-3px',
183
+ // @if CK_DEBUG_STICKYPANEL // backgroundColor: 'rgba(0, 0, 255, .2)' },
184
+ // @if CK_DEBUG_STICKYPANEL // 'visibleLimiterRect'
185
+ // @if CK_DEBUG_STICKYPANEL // );
186
+ // @if CK_DEBUG_STICKYPANEL // }
187
+ }
188
+ /**
189
+ * Sticks the panel at the given CSS `top` offset.
190
+ *
191
+ * @private
192
+ * @param topOffset
193
+ */
194
+ _stickToTopOfAncestors(topOffset) {
195
+ this.isSticky = true;
196
+ this._isStickyToTheBottomOfLimiter = false;
197
+ this._stickyTopOffset = topOffset;
198
+ this._stickyBottomOffset = null;
199
+ this._marginLeft = toPx(-global.window.scrollX);
200
+ }
201
+ /**
202
+ * Sticks the panel at the bottom of the limiter with a given CSS `bottom` offset.
203
+ *
204
+ * @private
205
+ * @param stickyBottomOffset
206
+ */
207
+ _stickToBottomOfLimiter(stickyBottomOffset) {
208
+ this.isSticky = true;
209
+ this._isStickyToTheBottomOfLimiter = true;
210
+ this._stickyTopOffset = null;
211
+ this._stickyBottomOffset = stickyBottomOffset;
212
+ this._marginLeft = toPx(-global.window.scrollX);
213
+ }
214
+ /**
215
+ * Unsticks the panel putting it back to its original position.
216
+ *
217
+ * @private
218
+ */
219
+ _unstick() {
220
+ this.isSticky = false;
221
+ this._isStickyToTheBottomOfLimiter = false;
222
+ this._stickyTopOffset = null;
223
+ this._stickyBottomOffset = null;
224
+ this._marginLeft = null;
225
+ }
226
+ /**
227
+ * Returns the bounding rect of the {@link #_contentPanel}.
228
+ *
229
+ * @private
230
+ */
231
+ get _contentPanelRect() {
232
+ return new Rect(this._contentPanel);
233
+ }
234
+ }
@@ -0,0 +1,31 @@
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 type { FocusableView } from '../focuscycler';
6
+ /**
7
+ * @module ui/search/filteredview
8
+ */
9
+ /**
10
+ * A view that can be filtered by a {@link module:ui/search/text/searchtextview~SearchTextView}.
11
+ */
12
+ export default interface FilteredView extends FocusableView {
13
+ /**
14
+ * Filters the view by the given regular expression.
15
+ */
16
+ filter(regExp: RegExp | null): {
17
+ resultsCount: number;
18
+ totalItemsCount: number;
19
+ };
20
+ }
21
+ /**
22
+ * Fired when the user selects an autocomplete option. The event data should contain the selected value.
23
+ *
24
+ * @eventName ~FilteredView#execute
25
+ */
26
+ export interface FilteredViewExecuteEvent {
27
+ name: 'execute';
28
+ args: [{
29
+ value: string;
30
+ }];
31
+ }
@@ -0,0 +1,5 @@
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
+ export {};
@@ -0,0 +1,45 @@
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/searchinfoview
7
+ */
8
+ import type { FocusableView } from '../focuscycler';
9
+ import View from '../view';
10
+ /**
11
+ * A view displaying an information text related to different states of {@link module:ui/search/text/searchtextview~SearchTextView}.
12
+ *
13
+ * @internal
14
+ */
15
+ export default class SearchInfoView extends View implements FocusableView {
16
+ /**
17
+ * Controls whether the view is visible.
18
+ *
19
+ * @observable
20
+ * @default false
21
+ */
22
+ isVisible: boolean;
23
+ /**
24
+ * Controls the primary line of text in the info.
25
+ *
26
+ * @observable
27
+ * @default ''
28
+ */
29
+ primaryText: string;
30
+ /**
31
+ * Controls the secondary line of text in the info.
32
+ *
33
+ * @observable
34
+ * @default ''
35
+ */
36
+ secondaryText: string;
37
+ /**
38
+ * @inheritDoc
39
+ */
40
+ constructor();
41
+ /**
42
+ * Focuses the view
43
+ */
44
+ focus(): void;
45
+ }
@@ -0,0 +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
+ }