@ui5/webcomponents-base 0.0.0-9195c41b8 → 0.0.0-9c26e8e4f

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 (354) hide show
  1. package/.eslintignore +3 -0
  2. package/CHANGELOG.md +362 -0
  3. package/README.md +53 -7
  4. package/bundle.esm.js +23 -16
  5. package/dist/AssetRegistry.js +8 -6
  6. package/dist/Boot.js +59 -0
  7. package/dist/CSP.js +59 -0
  8. package/dist/CustomElementsRegistry.js +79 -7
  9. package/dist/CustomElementsScope.js +30 -0
  10. package/dist/CustomElementsScopeUtils.js +108 -0
  11. package/dist/DOMObserver.js +65 -0
  12. package/dist/Device.js +71 -773
  13. package/dist/EventProvider.js +38 -26
  14. package/dist/FeaturesRegistry.js +4 -1
  15. package/dist/FontFace.js +19 -62
  16. package/dist/InitialConfiguration.js +43 -8
  17. package/dist/Keys.js +136 -2
  18. package/dist/ManagedStyles.js +83 -0
  19. package/dist/MediaRange.js +109 -0
  20. package/dist/PropertiesFileFormat.js +95 -0
  21. package/dist/Render.js +175 -0
  22. package/dist/RenderQueue.js +41 -17
  23. package/dist/RenderScheduler.js +24 -126
  24. package/dist/Runtimes.js +107 -0
  25. package/dist/StaticArea.js +1 -39
  26. package/dist/StaticAreaItem.js +58 -62
  27. package/dist/SystemCSSVars.js +10 -0
  28. package/dist/Theming.js +2 -1
  29. package/dist/UI5Element.js +435 -300
  30. package/dist/UI5ElementMetadata.js +173 -19
  31. package/dist/asset-registries/Icons.js +125 -14
  32. package/dist/asset-registries/Illustrations.js +30 -0
  33. package/dist/asset-registries/LocaleData.js +105 -66
  34. package/dist/asset-registries/Themes.js +30 -35
  35. package/dist/asset-registries/i18n.js +73 -29
  36. package/dist/assets/bundle.esm.eb35c35a.js +43 -0
  37. package/dist/assets-meta/IconCollectionsAlias.js +18 -0
  38. package/dist/config/AnimationMode.js +11 -1
  39. package/dist/config/Icons.js +52 -0
  40. package/dist/config/Language.js +58 -2
  41. package/dist/config/Theme.js +25 -0
  42. package/dist/css/BusyIndicator.css +80 -0
  43. package/dist/css/FontFace.css +75 -0
  44. package/dist/css/OverrideFontFace.css +32 -0
  45. package/dist/css/SystemCSSVars.css +17 -0
  46. package/dist/delegate/ItemNavigation.js +249 -171
  47. package/dist/delegate/ResizeHandler.js +78 -38
  48. package/dist/delegate/ScrollEnablement.js +49 -20
  49. package/dist/features/F6Navigation.js +110 -0
  50. package/dist/features/OpenUI5Enablement.js +119 -0
  51. package/dist/features/OpenUI5Support.js +42 -7
  52. package/dist/generated/AssetParameters.js +1 -1
  53. package/dist/generated/VersionInfo.js +10 -0
  54. package/dist/generated/css/BusyIndicator.css.js +5 -0
  55. package/dist/generated/css/FontFace.css.js +5 -0
  56. package/dist/generated/css/OverrideFontFace.css.js +5 -0
  57. package/dist/generated/css/SystemCSSVars.css.js +5 -0
  58. package/dist/getSharedResource.js +30 -0
  59. package/dist/i18nBundle.js +58 -5
  60. package/dist/locale/RTLAwareRegistry.js +14 -0
  61. package/dist/locale/applyDirection.js +17 -0
  62. package/dist/locale/directionChange.js +32 -0
  63. package/dist/locale/getEffectiveDir.js +28 -0
  64. package/dist/locale/getLocale.js +12 -2
  65. package/dist/locale/languageChange.js +22 -0
  66. package/dist/renderer/LitRenderer.js +44 -7
  67. package/dist/renderer/directives/style-map.js +72 -0
  68. package/dist/renderer/executeTemplate.js +34 -0
  69. package/dist/sap/base/Log.js +241 -0
  70. package/dist/sap/base/assert.js +8 -0
  71. package/dist/sap/base/security/URLListValidator.js +148 -0
  72. package/dist/sap/base/security/encodeCSS.js +14 -0
  73. package/dist/sap/base/security/encodeXML.js +23 -0
  74. package/dist/sap/base/security/sanitizeHTML.js +16 -0
  75. package/dist/sap/base/strings/toHex.js +8 -0
  76. package/dist/sap/base/util/now.js +7 -0
  77. package/dist/sap/ui/thirdparty/caja-html-sanitizer.js +3585 -0
  78. package/dist/theming/CustomStyle.js +47 -6
  79. package/dist/theming/ThemeLoaded.js +22 -0
  80. package/dist/theming/applyTheme.js +13 -15
  81. package/dist/theming/getConstructableStyle.js +15 -10
  82. package/dist/theming/getEffectiveLinksHrefs.js +27 -0
  83. package/dist/theming/getEffectiveStyle.js +32 -8
  84. package/dist/theming/getStylesString.js +15 -0
  85. package/dist/theming/getThemeDesignerTheme.js +25 -5
  86. package/dist/theming/preloadLinks.js +23 -0
  87. package/dist/types/CSSColor.js +9 -0
  88. package/dist/types/CalendarType.js +1 -1
  89. package/dist/types/DataType.js +13 -1
  90. package/dist/types/Float.js +14 -0
  91. package/dist/types/Integer.js +4 -0
  92. package/dist/types/InvisibleMessageMode.js +30 -0
  93. package/dist/types/ItemNavigationBehavior.js +2 -7
  94. package/dist/types/NavigationMode.js +1 -0
  95. package/dist/types/PopupState.js +1 -1
  96. package/dist/types/ValueState.js +1 -1
  97. package/dist/updateShadowRoot.js +29 -0
  98. package/dist/util/AriaLabelHelper.js +41 -0
  99. package/dist/util/Caret.js +32 -0
  100. package/dist/util/ColorConversion.js +398 -0
  101. package/dist/util/FocusableElements.js +30 -11
  102. package/dist/util/HTMLSanitizer.js +7 -0
  103. package/dist/util/InvisibleMessage.js +69 -0
  104. package/dist/util/PopupUtils.js +93 -0
  105. package/dist/util/SlotsHelper.js +43 -0
  106. package/dist/util/TabbableElements.js +5 -1
  107. package/dist/util/arraysAreEqual.js +15 -0
  108. package/dist/util/clamp.js +12 -0
  109. package/dist/util/createLinkInHead.js +19 -0
  110. package/dist/util/debounce.js +17 -0
  111. package/dist/util/escapeRegex.js +10 -0
  112. package/dist/util/generateHighlightedMarkup.js +42 -0
  113. package/dist/util/getActiveElement.js +11 -0
  114. package/dist/util/getClassCopy.js +10 -0
  115. package/dist/util/getEffectiveContentDensity.js +5 -0
  116. package/dist/util/getNormalizedTarget.js +16 -0
  117. package/dist/util/getSingletonElementInstance.js +13 -0
  118. package/dist/util/isDefaultSlotProvided.js +11 -0
  119. package/dist/util/isElementInView.js +15 -0
  120. package/dist/util/isNodeHidden.js +1 -5
  121. package/dist/util/isNodeTabbable.js +4 -4
  122. package/dist/util/isValidPropertyName.js +9 -3
  123. package/dist/util/setToArray.js +10 -0
  124. package/hash.txt +1 -0
  125. package/index.js +1 -1
  126. package/lib/generate-asset-parameters/index.js +8 -5
  127. package/lib/generate-styles/index.js +26 -0
  128. package/lib/generate-version-info/index.js +32 -0
  129. package/package-scripts.js +37 -28
  130. package/package.json +20 -12
  131. package/src/AssetRegistry.js +8 -6
  132. package/src/Boot.js +59 -0
  133. package/src/CSP.js +59 -0
  134. package/src/CustomElementsRegistry.js +79 -7
  135. package/src/CustomElementsScope.js +30 -0
  136. package/src/CustomElementsScopeUtils.js +108 -0
  137. package/src/DOMObserver.js +65 -0
  138. package/src/Device.js +71 -773
  139. package/src/EventProvider.js +38 -26
  140. package/src/FeaturesRegistry.js +4 -1
  141. package/src/FontFace.js +19 -62
  142. package/src/InitialConfiguration.js +43 -8
  143. package/src/Keys.js +136 -2
  144. package/src/ManagedStyles.js +83 -0
  145. package/src/MediaRange.js +109 -0
  146. package/src/PropertiesFileFormat.js +95 -0
  147. package/src/Render.js +175 -0
  148. package/src/RenderQueue.js +41 -17
  149. package/src/RenderScheduler.js +24 -126
  150. package/src/Runtimes.js +107 -0
  151. package/src/StaticArea.js +1 -39
  152. package/src/StaticAreaItem.js +58 -62
  153. package/src/SystemCSSVars.js +10 -0
  154. package/src/Theming.js +2 -1
  155. package/src/UI5Element.js +435 -300
  156. package/src/UI5ElementMetadata.js +173 -19
  157. package/src/asset-registries/Icons.js +125 -14
  158. package/src/asset-registries/Illustrations.js +30 -0
  159. package/src/asset-registries/LocaleData.js +105 -66
  160. package/src/asset-registries/Themes.js +30 -35
  161. package/src/asset-registries/i18n.js +73 -29
  162. package/src/assets-meta/IconCollectionsAlias.js +18 -0
  163. package/src/config/AnimationMode.js +11 -1
  164. package/src/config/Icons.js +52 -0
  165. package/src/config/Language.js +58 -2
  166. package/src/config/Theme.js +25 -0
  167. package/src/css/BusyIndicator.css +80 -0
  168. package/src/css/FontFace.css +75 -0
  169. package/src/css/OverrideFontFace.css +32 -0
  170. package/src/css/SystemCSSVars.css +17 -0
  171. package/src/delegate/ItemNavigation.js +249 -171
  172. package/src/delegate/ResizeHandler.js +78 -38
  173. package/src/delegate/ScrollEnablement.js +49 -20
  174. package/src/features/F6Navigation.js +110 -0
  175. package/src/features/OpenUI5Enablement.js +119 -0
  176. package/src/features/OpenUI5Support.js +42 -7
  177. package/src/getSharedResource.js +30 -0
  178. package/src/i18nBundle.js +58 -5
  179. package/src/locale/RTLAwareRegistry.js +14 -0
  180. package/src/locale/applyDirection.js +17 -0
  181. package/src/locale/directionChange.js +32 -0
  182. package/src/locale/getEffectiveDir.js +28 -0
  183. package/src/locale/getLocale.js +12 -2
  184. package/src/locale/languageChange.js +22 -0
  185. package/src/renderer/LitRenderer.js +44 -7
  186. package/src/renderer/directives/style-map.js +72 -0
  187. package/src/renderer/executeTemplate.js +34 -0
  188. package/src/theming/CustomStyle.js +47 -6
  189. package/src/theming/ThemeLoaded.js +22 -0
  190. package/src/theming/applyTheme.js +13 -15
  191. package/src/theming/getConstructableStyle.js +15 -10
  192. package/src/theming/getEffectiveLinksHrefs.js +27 -0
  193. package/src/theming/getEffectiveStyle.js +32 -8
  194. package/src/theming/getStylesString.js +15 -0
  195. package/src/theming/getThemeDesignerTheme.js +25 -5
  196. package/src/theming/preloadLinks.js +23 -0
  197. package/src/types/CSSColor.js +9 -0
  198. package/src/types/CalendarType.js +1 -1
  199. package/src/types/DataType.js +13 -1
  200. package/src/types/Float.js +14 -0
  201. package/src/types/Integer.js +4 -0
  202. package/src/types/InvisibleMessageMode.js +30 -0
  203. package/src/types/ItemNavigationBehavior.js +2 -7
  204. package/src/types/NavigationMode.js +1 -0
  205. package/src/types/PopupState.js +1 -1
  206. package/src/types/ValueState.js +1 -1
  207. package/src/updateShadowRoot.js +29 -0
  208. package/src/util/AriaLabelHelper.js +41 -0
  209. package/src/util/Caret.js +32 -0
  210. package/src/util/ColorConversion.js +398 -0
  211. package/src/util/FocusableElements.js +30 -11
  212. package/src/util/HTMLSanitizer.js +7 -0
  213. package/src/util/InvisibleMessage.js +69 -0
  214. package/src/util/PopupUtils.js +93 -0
  215. package/src/util/SlotsHelper.js +43 -0
  216. package/src/util/TabbableElements.js +5 -1
  217. package/src/util/arraysAreEqual.js +15 -0
  218. package/src/util/clamp.js +12 -0
  219. package/src/util/createLinkInHead.js +19 -0
  220. package/src/util/debounce.js +17 -0
  221. package/src/util/escapeRegex.js +10 -0
  222. package/src/util/generateHighlightedMarkup.js +42 -0
  223. package/src/util/getActiveElement.js +11 -0
  224. package/src/util/getClassCopy.js +10 -0
  225. package/src/util/getEffectiveContentDensity.js +5 -0
  226. package/src/util/getNormalizedTarget.js +16 -0
  227. package/src/util/getSingletonElementInstance.js +13 -0
  228. package/src/util/isDefaultSlotProvided.js +11 -0
  229. package/src/util/isElementInView.js +15 -0
  230. package/src/util/isNodeHidden.js +1 -5
  231. package/src/util/isNodeTabbable.js +4 -4
  232. package/src/util/isValidPropertyName.js +9 -3
  233. package/src/util/setToArray.js +10 -0
  234. package/used-modules.txt +10 -0
  235. package/bundle.es5.js +0 -28
  236. package/config/.eslintrc.js +0 -3
  237. package/config/rollup.config.js +0 -1
  238. package/dist/SVGIconRegistry.js +0 -60
  239. package/dist/boot.js +0 -32
  240. package/dist/compatibility/DOMObserver.js +0 -62
  241. package/dist/compatibility/patchNodeValue.js +0 -24
  242. package/dist/compatibility/whenPolyfillLoaded.js +0 -26
  243. package/dist/delegate/CustomResize.js +0 -78
  244. package/dist/delegate/NativeResize.js +0 -44
  245. package/dist/features/browsersupport/Edge.js +0 -6
  246. package/dist/features/browsersupport/IE11.js +0 -41
  247. package/dist/features/browsersupport/IE11WithWebComponentsPolyfill.js +0 -5
  248. package/dist/renderer/ifDefined.js +0 -21
  249. package/dist/resources/bundle.es5.js +0 -212
  250. package/dist/resources/bundle.es5.js.map +0 -1
  251. package/dist/resources/bundle.esm.js +0 -129
  252. package/dist/resources/bundle.esm.js.map +0 -1
  253. package/dist/test-resources/assets/Themes.js +0 -13
  254. package/dist/test-resources/elements/Child.js +0 -35
  255. package/dist/test-resources/elements/Generic.js +0 -84
  256. package/dist/test-resources/elements/GenericExt.js +0 -26
  257. package/dist/test-resources/elements/NoShadowDOM.js +0 -13
  258. package/dist/test-resources/elements/Parent.js +0 -37
  259. package/dist/test-resources/elements/WithStaticArea.js +0 -76
  260. package/dist/test-resources/pages/AllTestElements.html +0 -42
  261. package/dist/test-resources/pages/Configuration.html +0 -20
  262. package/dist/test-resources/pages/ConfigurationScript.html +0 -36
  263. package/dist/test-resources/specs/ConfigurationChange.spec.js +0 -25
  264. package/dist/test-resources/specs/ConfigurationScript.spec.js +0 -61
  265. package/dist/test-resources/specs/ConfigurationURL.spec.js +0 -45
  266. package/dist/test-resources/specs/CustomTheme.spec.js +0 -25
  267. package/dist/test-resources/specs/StaticArea.spec.js +0 -34
  268. package/dist/test-resources/specs/Theming.spec.js +0 -31
  269. package/dist/test-resources/specs/UI5ElementInvalidation.js +0 -258
  270. package/dist/test-resources/specs/UI5ElementLifecycle.js +0 -93
  271. package/dist/test-resources/specs/UI5ElementListenForChildPropChanges.spec.js +0 -101
  272. package/dist/test-resources/specs/UI5ElementMetadataExt.js +0 -40
  273. package/dist/test-resources/specs/UI5ElementPropertyValidation.js +0 -12
  274. package/dist/test-resources/specs/UI5ElementPropsAndAttrs.spec.js +0 -65
  275. package/dist/test-resources/specs/UI5ElementShadowDOM.js +0 -22
  276. package/dist/test-resources/specs/UI5ElementSlots.js +0 -34
  277. package/dist/theming/CSSVarsPonyfill.js +0 -24
  278. package/dist/theming/adaptCSSForIE.js +0 -90
  279. package/dist/theming/createComponentStyleTag.js +0 -49
  280. package/dist/theming/createThemePropertiesStyleTag.js +0 -20
  281. package/dist/thirdparty/Array.from.js +0 -16
  282. package/dist/thirdparty/Array.prototype.fill.js +0 -44
  283. package/dist/thirdparty/Array.prototype.find.js +0 -46
  284. package/dist/thirdparty/Array.prototype.includes.js +0 -51
  285. package/dist/thirdparty/Element.prototype.closest.js +0 -11
  286. package/dist/thirdparty/Element.prototype.matches.js +0 -6
  287. package/dist/thirdparty/Map.prototype.keys.js +0 -9
  288. package/dist/thirdparty/Number.isInteger.js +0 -5
  289. package/dist/thirdparty/Number.isNaN.js +0 -1
  290. package/dist/thirdparty/Number.parseInt.js +0 -1
  291. package/dist/thirdparty/Object.assign.js +0 -31
  292. package/dist/thirdparty/Object.entries.js +0 -11
  293. package/dist/thirdparty/Symbol.js +0 -2
  294. package/dist/thirdparty/WeakSet.js +0 -27
  295. package/dist/thirdparty/es6-string-methods.js +0 -182
  296. package/dist/thirdparty/events-polyfills.js +0 -89
  297. package/dist/thirdparty/fetch.js +0 -1
  298. package/dist/thirdparty/template.js +0 -600
  299. package/dist/thirdparty/webcomponents-sd-ce-pf.js +0 -318
  300. package/dist/webcomponentsjs/LICENSE.md +0 -19
  301. package/dist/webcomponentsjs/README.md +0 -229
  302. package/dist/webcomponentsjs/bundles/webcomponents-ce.js +0 -63
  303. package/dist/webcomponentsjs/bundles/webcomponents-ce.js.map +0 -1
  304. package/dist/webcomponentsjs/bundles/webcomponents-sd-ce-pf.js +0 -297
  305. package/dist/webcomponentsjs/bundles/webcomponents-sd-ce-pf.js.map +0 -1
  306. package/dist/webcomponentsjs/bundles/webcomponents-sd-ce.js +0 -208
  307. package/dist/webcomponentsjs/bundles/webcomponents-sd-ce.js.map +0 -1
  308. package/dist/webcomponentsjs/bundles/webcomponents-sd.js +0 -166
  309. package/dist/webcomponentsjs/bundles/webcomponents-sd.js.map +0 -1
  310. package/dist/webcomponentsjs/custom-elements-es5-adapter.js +0 -15
  311. package/dist/webcomponentsjs/package.json +0 -46
  312. package/dist/webcomponentsjs/src/entrypoints/custom-elements-es5-adapter-index.js +0 -16
  313. package/dist/webcomponentsjs/src/entrypoints/webcomponents-bundle-index.js +0 -53
  314. package/dist/webcomponentsjs/src/entrypoints/webcomponents-ce-index.js +0 -17
  315. package/dist/webcomponentsjs/src/entrypoints/webcomponents-sd-ce-index.js +0 -19
  316. package/dist/webcomponentsjs/src/entrypoints/webcomponents-sd-ce-pf-index.js +0 -28
  317. package/dist/webcomponentsjs/src/entrypoints/webcomponents-sd-index.js +0 -18
  318. package/dist/webcomponentsjs/webcomponents-bundle.js +0 -298
  319. package/dist/webcomponentsjs/webcomponents-bundle.js.map +0 -1
  320. package/dist/webcomponentsjs/webcomponents-loader.js +0 -185
  321. package/src/SVGIconRegistry.js +0 -60
  322. package/src/boot.js +0 -32
  323. package/src/compatibility/DOMObserver.js +0 -62
  324. package/src/compatibility/patchNodeValue.js +0 -24
  325. package/src/compatibility/whenPolyfillLoaded.js +0 -26
  326. package/src/delegate/CustomResize.js +0 -78
  327. package/src/delegate/NativeResize.js +0 -44
  328. package/src/features/browsersupport/Edge.js +0 -6
  329. package/src/features/browsersupport/IE11.js +0 -41
  330. package/src/features/browsersupport/IE11WithWebComponentsPolyfill.js +0 -5
  331. package/src/renderer/ifDefined.js +0 -21
  332. package/src/theming/CSSVarsPonyfill.js +0 -24
  333. package/src/theming/adaptCSSForIE.js +0 -90
  334. package/src/theming/createComponentStyleTag.js +0 -49
  335. package/src/theming/createThemePropertiesStyleTag.js +0 -20
  336. package/src/thirdparty/Array.from.js +0 -16
  337. package/src/thirdparty/Array.prototype.fill.js +0 -44
  338. package/src/thirdparty/Array.prototype.find.js +0 -46
  339. package/src/thirdparty/Array.prototype.includes.js +0 -51
  340. package/src/thirdparty/Element.prototype.closest.js +0 -11
  341. package/src/thirdparty/Element.prototype.matches.js +0 -6
  342. package/src/thirdparty/Map.prototype.keys.js +0 -9
  343. package/src/thirdparty/Number.isInteger.js +0 -5
  344. package/src/thirdparty/Number.isNaN.js +0 -1
  345. package/src/thirdparty/Number.parseInt.js +0 -1
  346. package/src/thirdparty/Object.assign.js +0 -31
  347. package/src/thirdparty/Object.entries.js +0 -11
  348. package/src/thirdparty/Symbol.js +0 -2
  349. package/src/thirdparty/WeakSet.js +0 -27
  350. package/src/thirdparty/es6-string-methods.js +0 -182
  351. package/src/thirdparty/events-polyfills.js +0 -89
  352. package/src/thirdparty/fetch.js +0 -1
  353. package/src/thirdparty/template.js +0 -600
  354. package/src/thirdparty/webcomponents-sd-ce-pf.js +0 -318
@@ -1,4 +1,3 @@
1
- import RenderScheduler from "../RenderScheduler.js";
2
1
  import {
3
2
  isDown,
4
3
  isUp,
@@ -6,157 +5,307 @@ import {
6
5
  isRight,
7
6
  isHome,
8
7
  isEnd,
8
+ isPageDown,
9
+ isPageUp,
9
10
  } from "../Keys.js";
11
+ import getActiveElement from "../util/getActiveElement.js";
10
12
 
11
- import EventProvider from "../EventProvider.js";
12
- import UI5Element from "../UI5Element.js";
13
13
  import NavigationMode from "../types/NavigationMode.js";
14
14
  import ItemNavigationBehavior from "../types/ItemNavigationBehavior.js";
15
15
 
16
- // navigatable items must have id and tabindex
17
- class ItemNavigation extends EventProvider {
16
+ /**
17
+ * The ItemNavigation class manages the calculations to determine the correct "tabindex" for a group of related items inside a root component.
18
+ * Important: ItemNavigation only does the calculations and does not change "tabindex" directly, this is a responsibility of the developer.
19
+ *
20
+ * The keys that trigger ItemNavigation are:
21
+ * - Up/down
22
+ * - Left/right
23
+ * - Home/End
24
+ *
25
+ * Usage:
26
+ * 1) Use the "getItemsCallback" constructor property to pass a callback to ItemNavigation, which, whenever called, will return the list of items to navigate among.
27
+ *
28
+ * Each item passed to ItemNavigation via "getItemsCallback" must be:
29
+ * - A) either a UI5Element with a "_tabIndex" property
30
+ * - B) or an Object with "id" and "_tabIndex" properties which represents a part of the root component's shadow DOM.
31
+ * The "id" must be a valid ID within the shadow root of the component ItemNavigation operates on.
32
+ * This object must not be a DOM object because, as said, ItemNavigation will not set "tabindex" on it. It must be a representation of a DOM object only
33
+ * and the developer has the responsibility to update the "tabindex" in the component's DOM.
34
+ * - C) a combination of the above
35
+ *
36
+ * Whenever the user navigates with the keyboard, ItemNavigation will modify the "_tabIndex" properties of the items.
37
+ * It is the items' responsibilities to re-render themselves and apply the correct value of "tabindex" (i.e. to map the "_tabIndex" ItemNavigation set to them to the "tabindex" property).
38
+ * If the items of the ItemNavigation are UI5Elements themselves, this can happen naturally since they will be invalidated by their "_tabIndex" property.
39
+ * If the items are Objects with "id" and "_tabIndex" however, it is the developer's responsibility to apply these and the easiest way is to have the root component invalidated by ItemNavigation.
40
+ * To do so, set the "affectedPropertiesNames" constructor property to point to one or more of the root component's properties that need refreshing when "_tabIndex" is changed deeply.
41
+ *
42
+ * 2) Call the "setCurrentItem" method of ItemNavigation whenever you want to change the current item.
43
+ * This is most commonly required if the user for example clicks on an item and thus selects it directly.
44
+ * Pass as the only argument to "setCurrentItem" the item that becomes current (must be one of the items, returned by "getItemsCallback").
45
+ *
46
+ * @class
47
+ * @public
48
+ */
49
+ class ItemNavigation {
50
+ /**
51
+ *
52
+ * @param rootWebComponent the component to operate on (component that slots or contains within its shadow root the items the user navigates among)
53
+ * @param options Object with configuration options:
54
+ * - currentIndex: the index of the item that will be initially selected (from which navigation will begin)
55
+ * - navigationMode (Auto|Horizontal|Vertical): whether the items are displayed horizontally (Horizontal), vertically (Vertical) or as a matrix (Auto) meaning the user can navigate in both directions (up/down and left/right)
56
+ * - rowSize: tells how many items per row there are when the items are not rendered as a flat list but rather as a matrix. Relevant for navigationMode=Auto
57
+ * - skipItemsSize: tells how many items upon PAGE_UP and PAGE_DOWN should be skipped to applying the focus on the next item
58
+ * - behavior (Static|Cycling): tells what to do when trying to navigate beyond the first and last items
59
+ * Static means that nothing happens if the user tries to navigate beyond the first/last item.
60
+ * Cycling means that when the user navigates beyond the last item they go to the first and vice versa.
61
+ * - getItemsCallback: function that, when called, returns an array with all items the user can navigate among
62
+ * - affectedPropertiesNames: a list of metadata properties on the root component which, upon user navigation, will be reassigned by address thus causing the root component to invalidate
63
+ */
18
64
  constructor(rootWebComponent, options = {}) {
19
- super();
20
-
21
- this.currentIndex = options.currentIndex || 0;
22
- this.rowSize = options.rowSize || 1;
23
- this.behavior = options.behavior || ItemNavigationBehavior.Static;
24
- this.hasNextPage = true; // used in Paging mode and controlled from the rootWebComponent
25
- this.hasPrevPage = true; // used in Paging mode and controlled from the rootWebComponent
26
- const navigationMode = options.navigationMode;
27
- const autoNavigation = !navigationMode || navigationMode === NavigationMode.Auto;
28
- this.horizontalNavigationOn = autoNavigation || navigationMode === NavigationMode.Horizontal;
29
- this.verticalNavigationOn = autoNavigation || navigationMode === NavigationMode.Vertical;
65
+ this._setRootComponent(rootWebComponent);
66
+ this._initOptions(options);
67
+ }
30
68
 
69
+ _setRootComponent(rootWebComponent) {
70
+ if (!rootWebComponent.isUI5Element) {
71
+ throw new Error("The root web component must be a UI5 Element instance");
72
+ }
31
73
  this.rootWebComponent = rootWebComponent;
32
- this.rootWebComponent.addEventListener("keydown", this.onkeydown.bind(this));
74
+ this.rootWebComponent.addEventListener("keydown", this._onkeydown.bind(this));
33
75
  this.rootWebComponent._onComponentStateFinalized = () => {
34
76
  this._init();
35
77
  };
36
78
  }
37
79
 
38
- _init() {
39
- this._getItems().forEach((item, idx) => {
40
- item._tabIndex = (idx === this.currentIndex) ? "0" : "-1";
41
- });
80
+ _initOptions(options) {
81
+ if (typeof options.getItemsCallback !== "function") {
82
+ throw new Error("getItemsCallback is required");
83
+ }
84
+
85
+ this._getItems = options.getItemsCallback;
86
+ this._currentIndex = options.currentIndex || 0;
87
+ this._rowSize = options.rowSize || 1;
88
+ this._behavior = options.behavior || ItemNavigationBehavior.Static;
89
+ this._navigationMode = options.navigationMode || NavigationMode.Auto;
90
+ this._affectedPropertiesNames = options.affectedPropertiesNames || [];
91
+ this._skipItemsSize = options.skipItemsSize || null;
42
92
  }
43
93
 
44
- _horizontalNavigationOn() {
45
- return this.horizontalNavigationOn;
94
+ /**
95
+ * Call this method to set a new "current" (selected) item in the item navigation
96
+ * Note: the item passed to this function must be one of the items, returned by the getItemsCallback function
97
+ *
98
+ * @public
99
+ * @param current the new selected item
100
+ */
101
+ setCurrentItem(current) {
102
+ const currentItemIndex = this._getItems().indexOf(current);
103
+
104
+ if (currentItemIndex === -1) {
105
+ console.warn(`The provided item is not managed by ItemNavigation`, current); // eslint-disable-line
106
+ return;
107
+ }
108
+
109
+ this._currentIndex = currentItemIndex;
110
+ this._applyTabIndex();
46
111
  }
47
112
 
48
- _verticalNavigationOn() {
49
- return this.verticalNavigationOn;
113
+ /**
114
+ * Call this method to dynamically change the row size
115
+ *
116
+ * @public
117
+ * @param newRowSize
118
+ */
119
+ setRowSize(newRowSize) {
120
+ this._rowSize = newRowSize;
50
121
  }
51
122
 
52
- async _onKeyPress(event) {
53
- if (this.currentIndex >= this._getItems().length) {
54
- this.onOverflowBottomEdge();
55
- } else if (this.currentIndex < 0) {
56
- this.onOverflowTopEdge();
57
- }
123
+ _init() {
124
+ this._getItems().forEach((item, idx) => {
125
+ item._tabIndex = (idx === this._currentIndex) ? "0" : "-1";
126
+ });
127
+ }
58
128
 
59
- event.preventDefault();
129
+ _onkeydown(event) {
130
+ if (!this._canNavigate()) {
131
+ return;
132
+ }
60
133
 
61
- await RenderScheduler.whenFinished();
134
+ const horizontalNavigationOn = this._navigationMode === NavigationMode.Horizontal || this._navigationMode === NavigationMode.Auto;
135
+ const verticalNavigationOn = this._navigationMode === NavigationMode.Vertical || this._navigationMode === NavigationMode.Auto;
136
+ const isRTL = this.rootWebComponent.effectiveDir === "rtl";
137
+
138
+ if (isRTL && isLeft(event) && horizontalNavigationOn) {
139
+ this._handleRight();
140
+ } else if (isRTL && isRight(event) && horizontalNavigationOn) {
141
+ this._handleLeft();
142
+ } else if (isLeft(event) && horizontalNavigationOn) {
143
+ this._handleLeft();
144
+ } else if (isRight(event) && horizontalNavigationOn) {
145
+ this._handleRight();
146
+ } else if (isUp(event) && verticalNavigationOn) {
147
+ this._handleUp();
148
+ } else if (isDown(event) && verticalNavigationOn) {
149
+ this._handleDown();
150
+ } else if (isHome(event)) {
151
+ this._handleHome();
152
+ } else if (isEnd(event)) {
153
+ this._handleEnd();
154
+ } else if (isPageUp(event)) {
155
+ this._handlePageUp();
156
+ } else if (isPageDown(event)) {
157
+ this._handlePageDown();
158
+ } else {
159
+ return; // if none of the supported keys is pressed, we don't want to prevent the event or update the item navigation
160
+ }
62
161
 
63
- this.update();
64
- this.focusCurrent();
162
+ event.preventDefault();
163
+ this._applyTabIndex();
164
+ this._focusCurrentItem();
65
165
  }
66
166
 
67
- onkeydown(event) {
68
- if (isUp(event) && this._verticalNavigationOn()) {
69
- return this._handleUp(event);
167
+ _handleUp() {
168
+ const itemsLength = this._getItems().length;
169
+ if (this._currentIndex - this._rowSize >= 0) { // no border reached, just decrease the index by a row
170
+ this._currentIndex -= this._rowSize;
171
+ return;
70
172
  }
71
173
 
72
- if (isDown(event) && this._verticalNavigationOn()) {
73
- return this._handleDown(event);
174
+ if (this._behavior === ItemNavigationBehavior.Cyclic) { // if cyclic, go to the **last** item in the **previous** column
175
+ const firstItemInThisColumnIndex = this._currentIndex % this._rowSize;
176
+ const firstItemInPreviousColumnIndex = firstItemInThisColumnIndex === 0 ? this._rowSize - 1 : firstItemInThisColumnIndex - 1; // find the first item in the previous column (if the current column is the first column -> move to the last column)
177
+ const rows = Math.ceil(itemsLength / this._rowSize); // how many rows there are (even if incomplete, f.e. for 14 items and _rowSize=4 -> 4 rows total, although only 2 items on the last row)
178
+ let lastItemInPreviousColumnIndex = firstItemInPreviousColumnIndex + (rows - 1) * this._rowSize; // multiply rows by columns, and add the column's first item's index
179
+ if (lastItemInPreviousColumnIndex > itemsLength - 1) { // for incomplete rows, use the previous row's last item, as for them the last item is missing
180
+ lastItemInPreviousColumnIndex -= this._rowSize;
181
+ }
182
+ this._currentIndex = lastItemInPreviousColumnIndex;
183
+ } else { // not cyclic, so just go to the first item
184
+ this._currentIndex = 0;
74
185
  }
186
+ }
75
187
 
76
- if (isLeft(event) && this._horizontalNavigationOn()) {
77
- return this._handleLeft(event);
188
+ _handleDown() {
189
+ const itemsLength = this._getItems().length;
190
+ if (this._currentIndex + this._rowSize < itemsLength) { // no border reached, just increase the index by a row
191
+ this._currentIndex += this._rowSize;
192
+ return;
78
193
  }
79
194
 
80
- if (isRight(event) && this._horizontalNavigationOn()) {
81
- return this._handleRight(event);
195
+ if (this._behavior === ItemNavigationBehavior.Cyclic) { // if cyclic, go to the **first** item in the **next** column
196
+ const firstItemInThisColumnIndex = this._currentIndex % this._rowSize; // find the first item in the current column first
197
+ const firstItemInNextColumnIndex = (firstItemInThisColumnIndex + 1) % this._rowSize; // to get the first item in the next column, just increase the index by 1. The modulo by rows is for the case when we are at the last column
198
+ this._currentIndex = firstItemInNextColumnIndex;
199
+ } else { // not cyclic, so just go to the last item
200
+ this._currentIndex = itemsLength - 1;
82
201
  }
202
+ }
83
203
 
84
- if (isHome(event)) {
85
- return this._handleHome(event);
204
+ _handleLeft() {
205
+ const itemsLength = this._getItems().length;
206
+ if (this._currentIndex > 0) {
207
+ this._currentIndex -= 1;
208
+ return;
86
209
  }
87
210
 
88
- if (isEnd(event)) {
89
- return this._handleEnd(event);
211
+ if (this._behavior === ItemNavigationBehavior.Cyclic) { // go to the first item in the next column
212
+ this._currentIndex = itemsLength - 1;
90
213
  }
91
214
  }
92
215
 
93
- _handleUp(event) {
94
- if (this._canNavigate()) {
95
- this.currentIndex -= this.rowSize;
96
- this._onKeyPress(event);
216
+ _handleRight() {
217
+ const itemsLength = this._getItems().length;
218
+ if (this._currentIndex < itemsLength - 1) {
219
+ this._currentIndex += 1;
220
+ return;
97
221
  }
98
- }
99
222
 
100
- _handleDown(event) {
101
- if (this._canNavigate()) {
102
- this.currentIndex += this.rowSize;
103
- this._onKeyPress(event);
223
+ if (this._behavior === ItemNavigationBehavior.Cyclic) { // go to the first item in the next column
224
+ this._currentIndex = 0;
104
225
  }
105
226
  }
106
227
 
107
- _handleLeft(event) {
108
- if (this._canNavigate()) {
109
- this.currentIndex -= 1;
110
- this._onKeyPress(event);
111
- }
228
+ _handleHome() {
229
+ const homeEndRange = this._rowSize > 1 ? this._rowSize : this._getItems().length;
230
+ this._currentIndex -= this._currentIndex % homeEndRange;
112
231
  }
113
232
 
114
- _handleRight(event) {
115
- if (this._canNavigate()) {
116
- this.currentIndex += 1;
117
- this._onKeyPress(event);
118
- }
233
+ _handleEnd() {
234
+ const homeEndRange = this._rowSize > 1 ? this._rowSize : this._getItems().length;
235
+ this._currentIndex += (homeEndRange - 1 - this._currentIndex % homeEndRange); // eslint-disable-line
119
236
  }
120
237
 
121
- _handleHome(event) {
122
- if (this._canNavigate()) {
123
- const homeEndRange = this.rowSize > 1 ? this.rowSize : this._getItems().length;
124
- this.currentIndex -= this.currentIndex % homeEndRange;
125
- this._onKeyPress(event);
238
+ _handlePageUp() {
239
+ if (this._rowSize > 1) {
240
+ // eslint-disable-next-line
241
+ // TODO: handle page up on matrix (grid) layout - ColorPalette, ProductSwitch.
242
+ return;
126
243
  }
244
+ this._handlePageUpFlat();
127
245
  }
128
246
 
129
- _handleEnd(event) {
130
- if (this._canNavigate()) {
131
- const homeEndRange = this.rowSize > 1 ? this.rowSize : this._getItems().length;
132
- this.currentIndex += (homeEndRange - 1 - this.currentIndex % homeEndRange); // eslint-disable-line
133
- this._onKeyPress(event);
247
+ _handlePageDown() {
248
+ if (this._rowSize > 1) {
249
+ // eslint-disable-next-line
250
+ // TODO: handle page up on matrix (grid) layout - ColorPalette, ProductSwitch.
251
+ return;
134
252
  }
253
+ this._handlePageDownFlat();
135
254
  }
136
255
 
137
- update(current) {
138
- const origItems = this._getItems();
256
+ /**
257
+ * Handles PAGE_UP in a flat list-like structure, both vertically and horizontally.
258
+ */
259
+ _handlePageUpFlat() {
260
+ if (this._skipItemsSize === null) {
261
+ // Move the focus to the very top (as Home).
262
+ this._currentIndex -= this._currentIndex;
263
+ }
139
264
 
140
- if (current) {
141
- this.currentIndex = this._getItems().indexOf(current);
265
+ if (this._currentIndex + 1 > this._skipItemsSize) {
266
+ // When there are more than "skipItemsSize" number of items to the top,
267
+ // move the focus up/left with the predefined number.
268
+ this._currentIndex -= this._skipItemsSize;
269
+ } else {
270
+ // Otherwise, move the focus to the very top (as Home).
271
+ this._currentIndex -= this._currentIndex;
142
272
  }
273
+ }
143
274
 
144
- if (!origItems[this.currentIndex]
145
- || (origItems[this.currentIndex]._tabIndex && origItems[this.currentIndex]._tabIndex === "0")) {
146
- return;
275
+ /**
276
+ * Handles PAGE_DOWN in a flat list-like structure, both vertically and horizontally.
277
+ */
278
+ _handlePageDownFlat() {
279
+ if (this._skipItemsSize === null) {
280
+ // Move the focus to the very bottom (as End).
281
+ this._currentIndex = this._getItems().length - 1;
147
282
  }
148
283
 
149
- const items = origItems.slice(0);
284
+ const currentToEndRange = this._getItems().length - this._currentIndex - 1;
150
285
 
151
- for (let i = 0; i < items.length; i++) {
152
- items[i]._tabIndex = (i === this.currentIndex ? "0" : "-1");
286
+ if (currentToEndRange > this._skipItemsSize) {
287
+ // When there are more than "skipItemsSize" number of items until the bottom,
288
+ // move the focus down/right with the predefined number.
289
+ this._currentIndex += this._skipItemsSize;
290
+ } else {
291
+ // Otherwise, move the focus to the very bottom (as End).
292
+ this._currentIndex = this._getItems().length - 1;
153
293
  }
294
+ }
154
295
 
296
+ _applyTabIndex() {
297
+ const items = this._getItems();
298
+ for (let i = 0; i < items.length; i++) {
299
+ items[i]._tabIndex = i === this._currentIndex ? "0" : "-1";
300
+ }
155
301
 
156
- this.rootWebComponent._invalidate();
302
+ this._affectedPropertiesNames.forEach(propName => {
303
+ const prop = this.rootWebComponent[propName];
304
+ this.rootWebComponent[propName] = Array.isArray(prop) ? [...prop] : { ...prop };
305
+ });
157
306
  }
158
307
 
159
- focusCurrent() {
308
+ _focusCurrentItem() {
160
309
  const currentItem = this._getCurrentItem();
161
310
  if (currentItem) {
162
311
  currentItem.focus();
@@ -165,12 +314,7 @@ class ItemNavigation extends EventProvider {
165
314
 
166
315
  _canNavigate() {
167
316
  const currentItem = this._getCurrentItem();
168
-
169
- let activeElement = document.activeElement;
170
-
171
- while (activeElement.shadowRoot && activeElement.shadowRoot.activeElement) {
172
- activeElement = activeElement.shadowRoot.activeElement;
173
- }
317
+ const activeElement = getActiveElement();
174
318
 
175
319
  return currentItem && currentItem === activeElement;
176
320
  }
@@ -183,96 +327,30 @@ class ItemNavigation extends EventProvider {
183
327
  }
184
328
 
185
329
  // normalize the index
186
- while (this.currentIndex >= items.length) {
187
- this.currentIndex -= this.rowSize;
330
+ while (this._currentIndex >= items.length) {
331
+ this._currentIndex -= this._rowSize;
188
332
  }
189
333
 
190
- if (this.currentIndex < 0) {
191
- this.currentIndex = 0;
192
- }
193
-
194
- const currentItem = items[this.currentIndex];
195
-
196
- if (currentItem instanceof UI5Element) {
197
- return currentItem.getFocusDomRef();
198
- }
199
-
200
- if (!this.rootWebComponent.getDomRef()) {
201
- return;
334
+ if (this._currentIndex < 0) {
335
+ this._currentIndex = 0;
202
336
  }
203
337
 
204
- return this.rootWebComponent.getDomRef().querySelector(`#${currentItem.id}`);
205
- }
206
-
207
- set getItemsCallback(fn) {
208
- this._getItems = fn;
209
- }
210
-
211
- set current(val) {
212
- this.currentIndex = val;
213
- }
338
+ const currentItem = items[this._currentIndex];
214
339
 
215
- onOverflowBottomEdge() {
216
- const items = this._getItems();
217
- const offset = this.currentIndex - items.length;
218
-
219
- if (this.behavior === ItemNavigationBehavior.Cyclic) {
220
- this.currentIndex = 0;
340
+ if (!currentItem) {
221
341
  return;
222
342
  }
223
343
 
224
- if (this.behavior === ItemNavigationBehavior.Paging) {
225
- this._handleNextPage();
226
- } else {
227
- this.currentIndex = items.length - 1;
344
+ if (currentItem.isUI5Element) {
345
+ return currentItem.getFocusDomRef();
228
346
  }
229
347
 
230
- this.fireEvent(ItemNavigation.BORDER_REACH, { start: false, end: true, offset });
231
- }
232
-
233
- onOverflowTopEdge() {
234
- const items = this._getItems();
235
- const offset = this.currentIndex + this.rowSize;
236
-
237
- if (this.behavior === ItemNavigationBehavior.Cyclic) {
238
- this.currentIndex = items.length - 1;
348
+ if (!this.rootWebComponent.getDomRef()) {
239
349
  return;
240
350
  }
241
351
 
242
- if (this.behavior === ItemNavigationBehavior.Paging) {
243
- this._handlePrevPage();
244
- } else {
245
- this.currentIndex = 0;
246
- }
247
-
248
- this.fireEvent(ItemNavigation.BORDER_REACH, { start: true, end: false, offset });
249
- }
250
-
251
- _handleNextPage() {
252
- this.fireEvent(ItemNavigation.PAGE_BOTTOM);
253
- const items = this._getItems();
254
-
255
- if (!this.hasNextPage) {
256
- this.currentIndex = items.length - 1;
257
- } else {
258
- this.currentIndex = 0;
259
- }
260
- }
261
-
262
- _handlePrevPage() {
263
- this.fireEvent(ItemNavigation.PAGE_TOP);
264
- const items = this._getItems();
265
-
266
- if (!this.hasPrevPage) {
267
- this.currentIndex = 0;
268
- } else {
269
- this.currentIndex = (this.pageSize || items.length) - 1;
270
- }
352
+ return this.rootWebComponent.getDomRef().querySelector(`#${currentItem.id}`);
271
353
  }
272
354
  }
273
355
 
274
- ItemNavigation.PAGE_TOP = "PageTop";
275
- ItemNavigation.PAGE_BOTTOM = "PageBottom";
276
- ItemNavigation.BORDER_REACH = "_borderReach";
277
-
278
356
  export default ItemNavigation;
@@ -1,66 +1,106 @@
1
- import UI5Element from "../UI5Element.js";
2
- import NativeResize from "./NativeResize.js";
3
- import CustomResize from "./CustomResize.js";
1
+ let resizeObserver;
2
+ const observedElements = new Map();
4
3
 
5
- class ResizeHandler {
6
- static initialize() {
7
- ResizeHandler.Implementation = window.ResizeObserver ? NativeResize : CustomResize;
8
- ResizeHandler.Implementation.initialize();
4
+ const getResizeObserver = () => {
5
+ if (!resizeObserver) {
6
+ resizeObserver = new window.ResizeObserver(entries => {
7
+ entries.forEach(entry => {
8
+ const callbacks = observedElements.get(entry.target);
9
+ callbacks.forEach(callback => callback());
10
+ });
11
+ });
9
12
  }
13
+ return resizeObserver;
14
+ };
10
15
 
11
- /**
12
- * @static
13
- * @private
14
- * @param {*} ref Reference to be observed
15
- * @param {*} callback Callback to be executed
16
- * @memberof ResizeHandler
17
- */
18
- static attachListener(ref, callback) {
19
- ResizeHandler.Implementation.attachListener.call(ResizeHandler.Implementation, ref, callback);
16
+ let observe = (element, callback) => {
17
+ const callbacks = observedElements.get(element) || [];
18
+
19
+ // if no callbacks have been added for this element - start observing it
20
+ if (!callbacks.length) {
21
+ getResizeObserver().observe(element);
20
22
  }
21
23
 
22
- /**
23
- * @static
24
- * @private
25
- * @param {*} ref Reference to be unobserved
26
- * @memberof ResizeHandler
27
- */
28
- static detachListener(ref, callback) {
29
- ResizeHandler.Implementation.detachListener.call(ResizeHandler.Implementation, ref, callback);
24
+ // save the callbacks in an array
25
+ observedElements.set(element, [...callbacks, callback]);
26
+ };
27
+
28
+ let unobserve = (element, callback) => {
29
+ const callbacks = observedElements.get(element) || [];
30
+ if (callbacks.length === 0) {
31
+ return;
30
32
  }
31
33
 
34
+ const filteredCallbacks = callbacks.filter(fn => fn !== callback);
35
+ if (filteredCallbacks.length === 0) {
36
+ getResizeObserver().unobserve(element);
37
+ observedElements.delete(element);
38
+ } else {
39
+ observedElements.set(element, filteredCallbacks);
40
+ }
41
+ };
32
42
 
43
+ /**
44
+ * Allows to register/deregister resize observers for a DOM element
45
+ *
46
+ * @public
47
+ * @class
48
+ */
49
+ class ResizeHandler {
33
50
  /**
34
51
  * @static
35
52
  * @public
36
- * @param {*} ref Reference to a UI5 Web Component or DOM Element to be observed
53
+ * @param {*} element UI5 Web Component or DOM Element to be observed
37
54
  * @param {*} callback Callback to be executed
38
- * @memberof ResizeHandler
39
55
  */
40
- static register(ref, callback) {
41
- if (ref instanceof UI5Element) {
42
- ref = ref.getDomRef();
56
+ static register(element, callback) {
57
+ if (element.isUI5Element) {
58
+ element = element.getDomRef();
43
59
  }
44
60
 
45
- ResizeHandler.attachListener(ref, callback);
61
+ if (element instanceof HTMLElement) {
62
+ observe(element, callback);
63
+ } else {
64
+ console.warn("Cannot register ResizeHandler for element", element); // eslint-disable-line
65
+ }
46
66
  }
47
67
 
48
-
49
68
  /**
50
69
  * @static
51
70
  * @public
52
- * @param {*} ref Reference to UI5 Web Component or DOM Element to be unobserved
53
- * @memberof ResizeHandler
71
+ * @param {*} element UI5 Web Component or DOM Element to be unobserved
72
+ * @param {*} callback Callback to be removed
54
73
  */
55
- static deregister(ref, callback) {
56
- if (ref instanceof UI5Element) {
57
- ref = ref.getDomRef();
74
+ static deregister(element, callback) {
75
+ if (element.isUI5Element) {
76
+ element = element.getDomRef();
58
77
  }
59
78
 
60
- ResizeHandler.detachListener(ref, callback);
79
+ if (element instanceof HTMLElement) {
80
+ unobserve(element, callback);
81
+ } else {
82
+ console.warn("Cannot deregister ResizeHandler for element", element); // eslint-disable-line
83
+ }
61
84
  }
62
85
  }
63
86
 
64
- ResizeHandler.initialize();
87
+ /**
88
+ * Set a function to be executed whenever a DOM node needs to be observed for size change.
89
+ * @public
90
+ * @param fn
91
+ */
92
+ const setResizeHandlerObserveFn = fn => {
93
+ observe = fn;
94
+ };
95
+
96
+ /**
97
+ * Set a function to be executed whenever a DOM node needs to no longer be observed for size changes
98
+ * @public
99
+ * @param fn
100
+ */
101
+ const setResizeHandlerUnobserveFn = fn => {
102
+ unobserve = fn;
103
+ };
65
104
 
66
105
  export default ResizeHandler;
106
+ export { setResizeHandlerObserveFn, setResizeHandlerUnobserveFn };