@ui5/webcomponents-base 0.0.0-d849bec2c → 0.0.0-dc3ccac50

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 (331) hide show
  1. package/.eslintignore +3 -0
  2. package/CHANGELOG.md +137 -0
  3. package/README.md +26 -2
  4. package/bundle.esm.js +16 -7
  5. package/dist/AssetRegistry.js +8 -7
  6. package/dist/Boot.js +43 -0
  7. package/dist/CSP.js +59 -0
  8. package/dist/CustomElementsRegistry.js +4 -10
  9. package/dist/CustomElementsScope.js +108 -0
  10. package/dist/DOMObserver.js +65 -0
  11. package/dist/Device.js +62 -778
  12. package/dist/EventProvider.js +38 -26
  13. package/dist/FontFace.js +19 -62
  14. package/dist/InitialConfiguration.js +43 -8
  15. package/dist/Keys.js +89 -2
  16. package/dist/ManagedStyles.js +83 -0
  17. package/dist/MediaRange.js +109 -0
  18. package/dist/PropertiesFileFormat.js +95 -0
  19. package/dist/Render.js +175 -0
  20. package/dist/RenderQueue.js +41 -17
  21. package/dist/RenderScheduler.js +24 -126
  22. package/dist/StaticArea.js +1 -39
  23. package/dist/StaticAreaItem.js +56 -63
  24. package/dist/SystemCSSVars.js +10 -0
  25. package/dist/Theming.js +2 -1
  26. package/dist/UI5Element.js +401 -320
  27. package/dist/UI5ElementMetadata.js +165 -17
  28. package/dist/asset-registries/Icons.js +129 -14
  29. package/dist/asset-registries/Illustrations.js +30 -0
  30. package/dist/asset-registries/LocaleData.js +99 -65
  31. package/dist/asset-registries/Themes.js +23 -32
  32. package/dist/asset-registries/i18n.js +72 -31
  33. package/dist/assets-meta/IconCollectionsAlias.js +18 -0
  34. package/dist/config/AnimationMode.js +11 -1
  35. package/dist/config/Language.js +58 -2
  36. package/dist/config/Theme.js +14 -0
  37. package/dist/css/FontFace.css +45 -0
  38. package/dist/css/OverrideFontFace.css +32 -0
  39. package/dist/css/SystemCSSVars.css +17 -0
  40. package/dist/delegate/ItemNavigation.js +243 -169
  41. package/dist/delegate/ResizeHandler.js +78 -37
  42. package/dist/delegate/ScrollEnablement.js +49 -20
  43. package/dist/features/OpenUI5Support.js +42 -7
  44. package/dist/generated/AssetParameters.js +1 -1
  45. package/dist/generated/css/FontFace.css.js +5 -0
  46. package/dist/generated/css/OverrideFontFace.css.js +5 -0
  47. package/dist/generated/css/SystemCSSVars.css.js +5 -0
  48. package/dist/getSharedResource.js +30 -0
  49. package/dist/i18nBundle.js +58 -5
  50. package/dist/isLegacyBrowser.js +3 -0
  51. package/dist/locale/RTLAwareRegistry.js +14 -0
  52. package/dist/locale/applyDirection.js +17 -0
  53. package/dist/locale/directionChange.js +32 -0
  54. package/dist/locale/getEffectiveDir.js +28 -0
  55. package/dist/locale/getLocale.js +12 -2
  56. package/dist/locale/languageChange.js +22 -0
  57. package/dist/renderer/LitRenderer.js +26 -7
  58. package/dist/renderer/directives/style-map.js +72 -0
  59. package/dist/renderer/executeTemplate.js +17 -0
  60. package/dist/resources/bundle.esm.js +17 -109
  61. package/dist/resources/bundle.esm.js.map +1 -1
  62. package/dist/sap/base/Log.js +241 -0
  63. package/dist/sap/base/assert.js +8 -0
  64. package/dist/sap/base/security/URLListValidator.js +148 -0
  65. package/dist/sap/base/security/sanitizeHTML.js +16 -0
  66. package/dist/sap/base/util/now.js +7 -0
  67. package/dist/sap/ui/thirdparty/caja-html-sanitizer.js +3585 -0
  68. package/dist/test-resources/assets/Themes.js +10 -6
  69. package/dist/test-resources/elements/Parent.js +6 -2
  70. package/dist/test-resources/elements/WithStaticArea.js +2 -1
  71. package/dist/test-resources/pages/AllTestElements.html +3 -3
  72. package/dist/test-resources/pages/Configuration.html +0 -2
  73. package/dist/test-resources/pages/ConfigurationScript.html +0 -2
  74. package/dist/test-resources/pages/assets/messagebundle_de.properties +1 -0
  75. package/dist/test-resources/pages/assets/messagebundle_en.properties +1 -0
  76. package/dist/test-resources/pages/assets/messagebundle_es.properties +1 -0
  77. package/dist/test-resources/pages/assets/messagebundle_fr.properties +1 -0
  78. package/dist/test-resources/pages/i18n.html +33 -0
  79. package/dist/test-resources/specs/ConfigurationChange.spec.js +10 -8
  80. package/dist/test-resources/specs/ConfigurationScript.spec.js +25 -23
  81. package/dist/test-resources/specs/ConfigurationURL.spec.js +65 -17
  82. package/dist/test-resources/specs/CustomTheme.spec.js +9 -7
  83. package/dist/test-resources/specs/EventProvider.spec.js +63 -0
  84. package/dist/test-resources/specs/StaticArea.spec.js +56 -12
  85. package/dist/test-resources/specs/Theming.spec.js +12 -10
  86. package/dist/test-resources/specs/UI5ElementInvalidation.js +54 -70
  87. package/dist/test-resources/specs/UI5ElementLifecycle.js +19 -14
  88. package/dist/test-resources/specs/UI5ElementListenForChildPropChanges.spec.js +25 -51
  89. package/dist/test-resources/specs/UI5ElementMetadataExt.js +9 -7
  90. package/dist/test-resources/specs/UI5ElementPropertyValidation.js +7 -5
  91. package/dist/test-resources/specs/UI5ElementPropsAndAttrs.spec.js +37 -35
  92. package/dist/test-resources/specs/UI5ElementShadowDOM.js +10 -8
  93. package/dist/test-resources/specs/UI5ElementSlots.js +10 -8
  94. package/dist/theming/CustomStyle.js +28 -7
  95. package/dist/theming/ThemeLoaded.js +22 -0
  96. package/dist/theming/applyTheme.js +7 -13
  97. package/dist/theming/getConstructableStyle.js +15 -10
  98. package/dist/theming/getEffectiveLinksHrefs.js +20 -0
  99. package/dist/theming/getEffectiveStyle.js +23 -8
  100. package/dist/theming/getStylesString.js +15 -0
  101. package/dist/theming/getThemeDesignerTheme.js +2 -1
  102. package/dist/theming/preloadLinks.js +23 -0
  103. package/dist/types/CSSColor.js +9 -0
  104. package/dist/types/CalendarType.js +1 -1
  105. package/dist/types/DataType.js +13 -1
  106. package/dist/types/Float.js +14 -0
  107. package/dist/types/Integer.js +4 -0
  108. package/dist/types/InvisibleMessageMode.js +30 -0
  109. package/dist/types/ItemNavigationBehavior.js +2 -7
  110. package/dist/types/NavigationMode.js +1 -0
  111. package/dist/types/PopupState.js +1 -1
  112. package/dist/types/ValueState.js +1 -1
  113. package/dist/updateShadowRoot.js +30 -0
  114. package/dist/util/AriaLabelHelper.js +41 -0
  115. package/dist/util/Caret.js +45 -0
  116. package/dist/util/ColorConversion.js +370 -0
  117. package/dist/util/FocusableElements.js +25 -7
  118. package/dist/util/HTMLSanitizer.js +7 -0
  119. package/dist/util/InvisibleMessage.js +58 -0
  120. package/dist/util/PopupUtils.js +93 -0
  121. package/dist/util/SlotsHelper.js +43 -0
  122. package/dist/util/TabbableElements.js +1 -1
  123. package/dist/util/arraysAreEqual.js +15 -0
  124. package/dist/util/clamp.js +12 -0
  125. package/dist/util/createLinkInHead.js +19 -0
  126. package/dist/util/debounce.js +17 -0
  127. package/dist/util/encodeCSS.js +24 -0
  128. package/dist/util/getActiveElement.js +11 -0
  129. package/dist/util/getClassCopy.js +10 -0
  130. package/dist/util/getEffectiveContentDensity.js +5 -0
  131. package/dist/util/getSingletonElementInstance.js +13 -0
  132. package/dist/util/isElementInView.js +15 -0
  133. package/dist/util/isNodeHidden.js +1 -5
  134. package/dist/util/isNodeTabbable.js +4 -4
  135. package/dist/util/isValidPropertyName.js +9 -3
  136. package/dist/util/setToArray.js +10 -0
  137. package/hash.txt +1 -0
  138. package/index.js +1 -1
  139. package/lib/generate-asset-parameters/index.js +0 -1
  140. package/lib/generate-styles/index.js +18 -0
  141. package/package-scripts.js +37 -19
  142. package/package.json +19 -13
  143. package/src/AssetRegistry.js +8 -7
  144. package/src/Boot.js +43 -0
  145. package/src/CSP.js +59 -0
  146. package/src/CustomElementsRegistry.js +4 -10
  147. package/src/CustomElementsScope.js +108 -0
  148. package/src/DOMObserver.js +65 -0
  149. package/src/Device.js +62 -778
  150. package/src/EventProvider.js +38 -26
  151. package/src/FontFace.js +19 -62
  152. package/src/InitialConfiguration.js +43 -8
  153. package/src/Keys.js +89 -2
  154. package/src/ManagedStyles.js +83 -0
  155. package/src/MediaRange.js +109 -0
  156. package/src/PropertiesFileFormat.js +95 -0
  157. package/src/Render.js +175 -0
  158. package/src/RenderQueue.js +41 -17
  159. package/src/RenderScheduler.js +24 -126
  160. package/src/StaticArea.js +1 -39
  161. package/src/StaticAreaItem.js +56 -63
  162. package/src/SystemCSSVars.js +10 -0
  163. package/src/Theming.js +2 -1
  164. package/src/UI5Element.js +401 -320
  165. package/src/UI5ElementMetadata.js +165 -17
  166. package/src/asset-registries/Icons.js +129 -14
  167. package/src/asset-registries/Illustrations.js +30 -0
  168. package/src/asset-registries/LocaleData.js +99 -65
  169. package/src/asset-registries/Themes.js +23 -32
  170. package/src/asset-registries/i18n.js +72 -31
  171. package/src/assets-meta/IconCollectionsAlias.js +18 -0
  172. package/src/config/AnimationMode.js +11 -1
  173. package/src/config/Language.js +58 -2
  174. package/src/config/Theme.js +14 -0
  175. package/src/css/FontFace.css +45 -0
  176. package/src/css/OverrideFontFace.css +32 -0
  177. package/src/css/SystemCSSVars.css +17 -0
  178. package/src/delegate/ItemNavigation.js +243 -169
  179. package/src/delegate/ResizeHandler.js +78 -37
  180. package/src/delegate/ScrollEnablement.js +49 -20
  181. package/src/features/OpenUI5Support.js +42 -7
  182. package/src/getSharedResource.js +30 -0
  183. package/src/i18nBundle.js +58 -5
  184. package/src/isLegacyBrowser.js +3 -0
  185. package/src/locale/RTLAwareRegistry.js +14 -0
  186. package/src/locale/applyDirection.js +17 -0
  187. package/src/locale/directionChange.js +32 -0
  188. package/src/locale/getEffectiveDir.js +28 -0
  189. package/src/locale/getLocale.js +12 -2
  190. package/src/locale/languageChange.js +22 -0
  191. package/src/renderer/LitRenderer.js +26 -7
  192. package/src/renderer/directives/style-map.js +72 -0
  193. package/src/renderer/executeTemplate.js +17 -0
  194. package/src/theming/CustomStyle.js +28 -7
  195. package/src/theming/ThemeLoaded.js +22 -0
  196. package/src/theming/applyTheme.js +7 -13
  197. package/src/theming/getConstructableStyle.js +15 -10
  198. package/src/theming/getEffectiveLinksHrefs.js +20 -0
  199. package/src/theming/getEffectiveStyle.js +23 -8
  200. package/src/theming/getStylesString.js +15 -0
  201. package/src/theming/getThemeDesignerTheme.js +2 -1
  202. package/src/theming/preloadLinks.js +23 -0
  203. package/src/types/CSSColor.js +9 -0
  204. package/src/types/CalendarType.js +1 -1
  205. package/src/types/DataType.js +13 -1
  206. package/src/types/Float.js +14 -0
  207. package/src/types/Integer.js +4 -0
  208. package/src/types/InvisibleMessageMode.js +30 -0
  209. package/src/types/ItemNavigationBehavior.js +2 -7
  210. package/src/types/NavigationMode.js +1 -0
  211. package/src/types/PopupState.js +1 -1
  212. package/src/types/ValueState.js +1 -1
  213. package/src/updateShadowRoot.js +30 -0
  214. package/src/util/AriaLabelHelper.js +41 -0
  215. package/src/util/Caret.js +45 -0
  216. package/src/util/ColorConversion.js +370 -0
  217. package/src/util/FocusableElements.js +25 -7
  218. package/src/util/HTMLSanitizer.js +7 -0
  219. package/src/util/InvisibleMessage.js +58 -0
  220. package/src/util/PopupUtils.js +93 -0
  221. package/src/util/SlotsHelper.js +43 -0
  222. package/src/util/TabbableElements.js +1 -1
  223. package/src/util/arraysAreEqual.js +15 -0
  224. package/src/util/clamp.js +12 -0
  225. package/src/util/createLinkInHead.js +19 -0
  226. package/src/util/debounce.js +17 -0
  227. package/src/util/encodeCSS.js +24 -0
  228. package/src/util/getActiveElement.js +11 -0
  229. package/src/util/getClassCopy.js +10 -0
  230. package/src/util/getEffectiveContentDensity.js +5 -0
  231. package/src/util/getSingletonElementInstance.js +13 -0
  232. package/src/util/isElementInView.js +15 -0
  233. package/src/util/isNodeHidden.js +1 -5
  234. package/src/util/isNodeTabbable.js +4 -4
  235. package/src/util/isValidPropertyName.js +9 -3
  236. package/src/util/setToArray.js +10 -0
  237. package/used-modules.txt +7 -0
  238. package/bundle.es5.js +0 -28
  239. package/dist/SVGIconRegistry.js +0 -60
  240. package/dist/boot.js +0 -32
  241. package/dist/compatibility/DOMObserver.js +0 -62
  242. package/dist/compatibility/patchNodeValue.js +0 -24
  243. package/dist/compatibility/whenPolyfillLoaded.js +0 -26
  244. package/dist/delegate/CustomResize.js +0 -78
  245. package/dist/delegate/NativeResize.js +0 -44
  246. package/dist/features/browsersupport/Edge.js +0 -6
  247. package/dist/features/browsersupport/IE11.js +0 -41
  248. package/dist/features/browsersupport/IE11WithWebComponentsPolyfill.js +0 -5
  249. package/dist/renderer/ifDefined.js +0 -21
  250. package/dist/resources/bundle.es5.js +0 -212
  251. package/dist/resources/bundle.es5.js.map +0 -1
  252. package/dist/theming/CSSVarsPonyfill.js +0 -24
  253. package/dist/theming/adaptCSSForIE.js +0 -90
  254. package/dist/theming/createComponentStyleTag.js +0 -49
  255. package/dist/theming/createThemePropertiesStyleTag.js +0 -20
  256. package/dist/thirdparty/Array.from.js +0 -16
  257. package/dist/thirdparty/Array.prototype.fill.js +0 -44
  258. package/dist/thirdparty/Array.prototype.find.js +0 -46
  259. package/dist/thirdparty/Array.prototype.includes.js +0 -51
  260. package/dist/thirdparty/Element.prototype.closest.js +0 -11
  261. package/dist/thirdparty/Element.prototype.matches.js +0 -6
  262. package/dist/thirdparty/Map.prototype.keys.js +0 -9
  263. package/dist/thirdparty/Number.isInteger.js +0 -5
  264. package/dist/thirdparty/Number.isNaN.js +0 -1
  265. package/dist/thirdparty/Number.parseInt.js +0 -1
  266. package/dist/thirdparty/Object.assign.js +0 -31
  267. package/dist/thirdparty/Object.entries.js +0 -11
  268. package/dist/thirdparty/Symbol.js +0 -2
  269. package/dist/thirdparty/WeakSet.js +0 -27
  270. package/dist/thirdparty/es6-string-methods.js +0 -182
  271. package/dist/thirdparty/events-polyfills.js +0 -89
  272. package/dist/thirdparty/fetch.js +0 -1
  273. package/dist/thirdparty/template.js +0 -600
  274. package/dist/thirdparty/webcomponents-sd-ce-pf.js +0 -318
  275. package/dist/util/isSlot.js +0 -3
  276. package/dist/webcomponentsjs/LICENSE.md +0 -19
  277. package/dist/webcomponentsjs/README.md +0 -229
  278. package/dist/webcomponentsjs/bundles/webcomponents-ce.js +0 -63
  279. package/dist/webcomponentsjs/bundles/webcomponents-ce.js.map +0 -1
  280. package/dist/webcomponentsjs/bundles/webcomponents-sd-ce-pf.js +0 -297
  281. package/dist/webcomponentsjs/bundles/webcomponents-sd-ce-pf.js.map +0 -1
  282. package/dist/webcomponentsjs/bundles/webcomponents-sd-ce.js +0 -208
  283. package/dist/webcomponentsjs/bundles/webcomponents-sd-ce.js.map +0 -1
  284. package/dist/webcomponentsjs/bundles/webcomponents-sd.js +0 -166
  285. package/dist/webcomponentsjs/bundles/webcomponents-sd.js.map +0 -1
  286. package/dist/webcomponentsjs/custom-elements-es5-adapter.js +0 -15
  287. package/dist/webcomponentsjs/package.json +0 -46
  288. package/dist/webcomponentsjs/src/entrypoints/custom-elements-es5-adapter-index.js +0 -16
  289. package/dist/webcomponentsjs/src/entrypoints/webcomponents-bundle-index.js +0 -53
  290. package/dist/webcomponentsjs/src/entrypoints/webcomponents-ce-index.js +0 -17
  291. package/dist/webcomponentsjs/src/entrypoints/webcomponents-sd-ce-index.js +0 -19
  292. package/dist/webcomponentsjs/src/entrypoints/webcomponents-sd-ce-pf-index.js +0 -28
  293. package/dist/webcomponentsjs/src/entrypoints/webcomponents-sd-index.js +0 -18
  294. package/dist/webcomponentsjs/webcomponents-bundle.js +0 -298
  295. package/dist/webcomponentsjs/webcomponents-bundle.js.map +0 -1
  296. package/dist/webcomponentsjs/webcomponents-loader.js +0 -185
  297. package/src/SVGIconRegistry.js +0 -60
  298. package/src/boot.js +0 -32
  299. package/src/compatibility/DOMObserver.js +0 -62
  300. package/src/compatibility/patchNodeValue.js +0 -24
  301. package/src/compatibility/whenPolyfillLoaded.js +0 -26
  302. package/src/delegate/CustomResize.js +0 -78
  303. package/src/delegate/NativeResize.js +0 -44
  304. package/src/features/browsersupport/Edge.js +0 -6
  305. package/src/features/browsersupport/IE11.js +0 -41
  306. package/src/features/browsersupport/IE11WithWebComponentsPolyfill.js +0 -5
  307. package/src/renderer/ifDefined.js +0 -21
  308. package/src/theming/CSSVarsPonyfill.js +0 -24
  309. package/src/theming/adaptCSSForIE.js +0 -90
  310. package/src/theming/createComponentStyleTag.js +0 -49
  311. package/src/theming/createThemePropertiesStyleTag.js +0 -20
  312. package/src/thirdparty/Array.from.js +0 -16
  313. package/src/thirdparty/Array.prototype.fill.js +0 -44
  314. package/src/thirdparty/Array.prototype.find.js +0 -46
  315. package/src/thirdparty/Array.prototype.includes.js +0 -51
  316. package/src/thirdparty/Element.prototype.closest.js +0 -11
  317. package/src/thirdparty/Element.prototype.matches.js +0 -6
  318. package/src/thirdparty/Map.prototype.keys.js +0 -9
  319. package/src/thirdparty/Number.isInteger.js +0 -5
  320. package/src/thirdparty/Number.isNaN.js +0 -1
  321. package/src/thirdparty/Number.parseInt.js +0 -1
  322. package/src/thirdparty/Object.assign.js +0 -31
  323. package/src/thirdparty/Object.entries.js +0 -11
  324. package/src/thirdparty/Symbol.js +0 -2
  325. package/src/thirdparty/WeakSet.js +0 -27
  326. package/src/thirdparty/es6-string-methods.js +0 -182
  327. package/src/thirdparty/events-polyfills.js +0 -89
  328. package/src/thirdparty/fetch.js +0 -1
  329. package/src/thirdparty/template.js +0 -600
  330. package/src/thirdparty/webcomponents-sd-ce-pf.js +0 -318
  331. package/src/util/isSlot.js +0 -3
@@ -1,4 +1,3 @@
1
- import RenderScheduler from "../RenderScheduler.js";
2
1
  import {
3
2
  isDown,
4
3
  isUp,
@@ -6,156 +5,302 @@ 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
13
  import NavigationMode from "../types/NavigationMode.js";
13
14
  import ItemNavigationBehavior from "../types/ItemNavigationBehavior.js";
14
15
 
15
- // navigatable items must have id and tabindex
16
- 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
+ */
17
64
  constructor(rootWebComponent, options = {}) {
18
- super();
19
-
20
- this.currentIndex = options.currentIndex || 0;
21
- this.rowSize = options.rowSize || 1;
22
- this.behavior = options.behavior || ItemNavigationBehavior.Static;
23
- this.hasNextPage = true; // used in Paging mode and controlled from the rootWebComponent
24
- this.hasPrevPage = true; // used in Paging mode and controlled from the rootWebComponent
25
- const navigationMode = options.navigationMode;
26
- const autoNavigation = !navigationMode || navigationMode === NavigationMode.Auto;
27
- this.horizontalNavigationOn = autoNavigation || navigationMode === NavigationMode.Horizontal;
28
- this.verticalNavigationOn = autoNavigation || navigationMode === NavigationMode.Vertical;
65
+ this._setRootComponent(rootWebComponent);
66
+ this._initOptions(options);
67
+ }
29
68
 
69
+ _setRootComponent(rootWebComponent) {
70
+ if (!rootWebComponent.isUI5Element) {
71
+ throw new Error("The root web component must be a UI5 Element instance");
72
+ }
30
73
  this.rootWebComponent = rootWebComponent;
31
- this.rootWebComponent.addEventListener("keydown", this.onkeydown.bind(this));
74
+ this.rootWebComponent.addEventListener("keydown", this._onkeydown.bind(this));
32
75
  this.rootWebComponent._onComponentStateFinalized = () => {
33
76
  this._init();
34
77
  };
35
78
  }
36
79
 
37
- _init() {
38
- this._getItems().forEach((item, idx) => {
39
- item._tabIndex = (idx === this.currentIndex) ? "0" : "-1";
40
- });
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;
41
92
  }
42
93
 
43
- _horizontalNavigationOn() {
44
- 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();
45
111
  }
46
112
 
47
- _verticalNavigationOn() {
48
- 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;
49
121
  }
50
122
 
51
- async _onKeyPress(event) {
52
- if (this.currentIndex >= this._getItems().length) {
53
- this.onOverflowBottomEdge();
54
- } else if (this.currentIndex < 0) {
55
- this.onOverflowTopEdge();
56
- }
123
+ _init() {
124
+ this._getItems().forEach((item, idx) => {
125
+ item._tabIndex = (idx === this._currentIndex) ? "0" : "-1";
126
+ });
127
+ }
57
128
 
58
- event.preventDefault();
129
+ _onkeydown(event) {
130
+ if (!this._canNavigate()) {
131
+ return;
132
+ }
59
133
 
60
- 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
+
137
+ if (isUp(event) && verticalNavigationOn) {
138
+ this._handleUp();
139
+ } else if (isDown(event) && verticalNavigationOn) {
140
+ this._handleDown();
141
+ } else if (isLeft(event) && horizontalNavigationOn) {
142
+ this._handleLeft();
143
+ } else if (isRight(event) && horizontalNavigationOn) {
144
+ this._handleRight();
145
+ } else if (isHome(event)) {
146
+ this._handleHome();
147
+ } else if (isEnd(event)) {
148
+ this._handleEnd();
149
+ } else if (isPageUp(event)) {
150
+ this._handlePageUp();
151
+ } else if (isPageDown(event)) {
152
+ this._handlePageDown();
153
+ } else {
154
+ return; // if none of the supported keys is pressed, we don't want to prevent the event or update the item navigation
155
+ }
61
156
 
62
- this.update();
63
- this.focusCurrent();
157
+ event.preventDefault();
158
+ this._applyTabIndex();
159
+ this._focusCurrentItem();
64
160
  }
65
161
 
66
- onkeydown(event) {
67
- if (isUp(event) && this._verticalNavigationOn()) {
68
- return this._handleUp(event);
162
+ _handleUp() {
163
+ const itemsLength = this._getItems().length;
164
+ if (this._currentIndex - this._rowSize >= 0) { // no border reached, just decrease the index by a row
165
+ this._currentIndex -= this._rowSize;
166
+ return;
69
167
  }
70
168
 
71
- if (isDown(event) && this._verticalNavigationOn()) {
72
- return this._handleDown(event);
169
+ if (this._behavior === ItemNavigationBehavior.Cyclic) { // if cyclic, go to the **last** item in the **previous** column
170
+ const firstItemInThisColumnIndex = this._currentIndex % this._rowSize;
171
+ 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)
172
+ 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)
173
+ let lastItemInPreviousColumnIndex = firstItemInPreviousColumnIndex + (rows - 1) * this._rowSize; // multiply rows by columns, and add the column's first item's index
174
+ if (lastItemInPreviousColumnIndex > itemsLength - 1) { // for incomplete rows, use the previous row's last item, as for them the last item is missing
175
+ lastItemInPreviousColumnIndex -= this._rowSize;
176
+ }
177
+ this._currentIndex = lastItemInPreviousColumnIndex;
178
+ } else { // not cyclic, so just go to the first item
179
+ this._currentIndex = 0;
73
180
  }
181
+ }
74
182
 
75
- if (isLeft(event) && this._horizontalNavigationOn()) {
76
- return this._handleLeft(event);
183
+ _handleDown() {
184
+ const itemsLength = this._getItems().length;
185
+ if (this._currentIndex + this._rowSize < itemsLength) { // no border reached, just increase the index by a row
186
+ this._currentIndex += this._rowSize;
187
+ return;
77
188
  }
78
189
 
79
- if (isRight(event) && this._horizontalNavigationOn()) {
80
- return this._handleRight(event);
190
+ if (this._behavior === ItemNavigationBehavior.Cyclic) { // if cyclic, go to the **first** item in the **next** column
191
+ const firstItemInThisColumnIndex = this._currentIndex % this._rowSize; // find the first item in the current column first
192
+ 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
193
+ this._currentIndex = firstItemInNextColumnIndex;
194
+ } else { // not cyclic, so just go to the last item
195
+ this._currentIndex = itemsLength - 1;
81
196
  }
197
+ }
82
198
 
83
- if (isHome(event)) {
84
- return this._handleHome(event);
199
+ _handleLeft() {
200
+ const itemsLength = this._getItems().length;
201
+ if (this._currentIndex > 0) {
202
+ this._currentIndex -= 1;
203
+ return;
85
204
  }
86
205
 
87
- if (isEnd(event)) {
88
- return this._handleEnd(event);
206
+ if (this._behavior === ItemNavigationBehavior.Cyclic) { // go to the first item in the next column
207
+ this._currentIndex = itemsLength - 1;
89
208
  }
90
209
  }
91
210
 
92
- _handleUp(event) {
93
- if (this._canNavigate()) {
94
- this.currentIndex -= this.rowSize;
95
- this._onKeyPress(event);
211
+ _handleRight() {
212
+ const itemsLength = this._getItems().length;
213
+ if (this._currentIndex < itemsLength - 1) {
214
+ this._currentIndex += 1;
215
+ return;
96
216
  }
97
- }
98
217
 
99
- _handleDown(event) {
100
- if (this._canNavigate()) {
101
- this.currentIndex += this.rowSize;
102
- this._onKeyPress(event);
218
+ if (this._behavior === ItemNavigationBehavior.Cyclic) { // go to the first item in the next column
219
+ this._currentIndex = 0;
103
220
  }
104
221
  }
105
222
 
106
- _handleLeft(event) {
107
- if (this._canNavigate()) {
108
- this.currentIndex -= 1;
109
- this._onKeyPress(event);
110
- }
223
+ _handleHome() {
224
+ const homeEndRange = this._rowSize > 1 ? this._rowSize : this._getItems().length;
225
+ this._currentIndex -= this._currentIndex % homeEndRange;
111
226
  }
112
227
 
113
- _handleRight(event) {
114
- if (this._canNavigate()) {
115
- this.currentIndex += 1;
116
- this._onKeyPress(event);
117
- }
228
+ _handleEnd() {
229
+ const homeEndRange = this._rowSize > 1 ? this._rowSize : this._getItems().length;
230
+ this._currentIndex += (homeEndRange - 1 - this._currentIndex % homeEndRange); // eslint-disable-line
118
231
  }
119
232
 
120
- _handleHome(event) {
121
- if (this._canNavigate()) {
122
- const homeEndRange = this.rowSize > 1 ? this.rowSize : this._getItems().length;
123
- this.currentIndex -= this.currentIndex % homeEndRange;
124
- this._onKeyPress(event);
233
+ _handlePageUp() {
234
+ if (this._rowSize > 1) {
235
+ // eslint-disable-next-line
236
+ // TODO: handle page up on matrix (grid) layout - ColorPalette, ProductSwitch.
237
+ return;
125
238
  }
239
+ this._handlePageUpFlat();
126
240
  }
127
241
 
128
- _handleEnd(event) {
129
- if (this._canNavigate()) {
130
- const homeEndRange = this.rowSize > 1 ? this.rowSize : this._getItems().length;
131
- this.currentIndex += (homeEndRange - 1 - this.currentIndex % homeEndRange); // eslint-disable-line
132
- this._onKeyPress(event);
242
+ _handlePageDown() {
243
+ if (this._rowSize > 1) {
244
+ // eslint-disable-next-line
245
+ // TODO: handle page up on matrix (grid) layout - ColorPalette, ProductSwitch.
246
+ return;
133
247
  }
248
+ this._handlePageDownFlat();
134
249
  }
135
250
 
136
- update(current) {
137
- const origItems = this._getItems();
251
+ /**
252
+ * Handles PAGE_UP in a flat list-like structure, both vertically and horizontally.
253
+ */
254
+ _handlePageUpFlat() {
255
+ if (this._skipItemsSize === null) {
256
+ // Move the focus to the very top (as Home).
257
+ this._currentIndex -= this._currentIndex;
258
+ }
138
259
 
139
- if (current) {
140
- this.currentIndex = this._getItems().indexOf(current);
260
+ if (this._currentIndex + 1 > this._skipItemsSize) {
261
+ // When there are more than "skipItemsSize" number of items to the top,
262
+ // move the focus up/left with the predefined number.
263
+ this._currentIndex -= this._skipItemsSize;
264
+ } else {
265
+ // Otherwise, move the focus to the very top (as Home).
266
+ this._currentIndex -= this._currentIndex;
141
267
  }
268
+ }
142
269
 
143
- if (!origItems[this.currentIndex]
144
- || (origItems[this.currentIndex]._tabIndex && origItems[this.currentIndex]._tabIndex === "0")) {
145
- return;
270
+ /**
271
+ * Handles PAGE_DOWN in a flat list-like structure, both vertically and horizontally.
272
+ */
273
+ _handlePageDownFlat() {
274
+ if (this._skipItemsSize === null) {
275
+ // Move the focus to the very bottom (as End).
276
+ this._currentIndex = this._getItems().length - 1;
146
277
  }
147
278
 
148
- const items = origItems.slice(0);
279
+ const currentToEndRange = this._getItems().length - this._currentIndex - 1;
149
280
 
150
- for (let i = 0; i < items.length; i++) {
151
- items[i]._tabIndex = (i === this.currentIndex ? "0" : "-1");
281
+ if (currentToEndRange > this._skipItemsSize) {
282
+ // When there are more than "skipItemsSize" number of items until the bottom,
283
+ // move the focus down/right with the predefined number.
284
+ this._currentIndex += this._skipItemsSize;
285
+ } else {
286
+ // Otherwise, move the focus to the very bottom (as End).
287
+ this._currentIndex = this._getItems().length - 1;
152
288
  }
289
+ }
153
290
 
291
+ _applyTabIndex() {
292
+ const items = this._getItems();
293
+ for (let i = 0; i < items.length; i++) {
294
+ items[i]._tabIndex = i === this._currentIndex ? "0" : "-1";
295
+ }
154
296
 
155
- this.rootWebComponent._invalidate();
297
+ this._affectedPropertiesNames.forEach(propName => {
298
+ const prop = this.rootWebComponent[propName];
299
+ this.rootWebComponent[propName] = Array.isArray(prop) ? [...prop] : { ...prop };
300
+ });
156
301
  }
157
302
 
158
- focusCurrent() {
303
+ _focusCurrentItem() {
159
304
  const currentItem = this._getCurrentItem();
160
305
  if (currentItem) {
161
306
  currentItem.focus();
@@ -164,12 +309,7 @@ class ItemNavigation extends EventProvider {
164
309
 
165
310
  _canNavigate() {
166
311
  const currentItem = this._getCurrentItem();
167
-
168
- let activeElement = document.activeElement;
169
-
170
- while (activeElement.shadowRoot && activeElement.shadowRoot.activeElement) {
171
- activeElement = activeElement.shadowRoot.activeElement;
172
- }
312
+ const activeElement = getActiveElement();
173
313
 
174
314
  return currentItem && currentItem === activeElement;
175
315
  }
@@ -182,15 +322,19 @@ class ItemNavigation extends EventProvider {
182
322
  }
183
323
 
184
324
  // normalize the index
185
- while (this.currentIndex >= items.length) {
186
- this.currentIndex -= this.rowSize;
325
+ while (this._currentIndex >= items.length) {
326
+ this._currentIndex -= this._rowSize;
187
327
  }
188
328
 
189
- if (this.currentIndex < 0) {
190
- this.currentIndex = 0;
329
+ if (this._currentIndex < 0) {
330
+ this._currentIndex = 0;
191
331
  }
192
332
 
193
- const currentItem = items[this.currentIndex];
333
+ const currentItem = items[this._currentIndex];
334
+
335
+ if (!currentItem) {
336
+ return;
337
+ }
194
338
 
195
339
  if (currentItem.isUI5Element) {
196
340
  return currentItem.getFocusDomRef();
@@ -202,76 +346,6 @@ class ItemNavigation extends EventProvider {
202
346
 
203
347
  return this.rootWebComponent.getDomRef().querySelector(`#${currentItem.id}`);
204
348
  }
205
-
206
- set getItemsCallback(fn) {
207
- this._getItems = fn;
208
- }
209
-
210
- set current(val) {
211
- this.currentIndex = val;
212
- }
213
-
214
- onOverflowBottomEdge() {
215
- const items = this._getItems();
216
- const offset = this.currentIndex - items.length;
217
-
218
- if (this.behavior === ItemNavigationBehavior.Cyclic) {
219
- this.currentIndex = 0;
220
- return;
221
- }
222
-
223
- if (this.behavior === ItemNavigationBehavior.Paging) {
224
- this._handleNextPage();
225
- } else {
226
- this.currentIndex = items.length - 1;
227
- }
228
-
229
- this.fireEvent(ItemNavigation.BORDER_REACH, { start: false, end: true, offset });
230
- }
231
-
232
- onOverflowTopEdge() {
233
- const items = this._getItems();
234
- const offset = this.currentIndex + this.rowSize;
235
-
236
- if (this.behavior === ItemNavigationBehavior.Cyclic) {
237
- this.currentIndex = items.length - 1;
238
- return;
239
- }
240
-
241
- if (this.behavior === ItemNavigationBehavior.Paging) {
242
- this._handlePrevPage();
243
- } else {
244
- this.currentIndex = 0;
245
- }
246
-
247
- this.fireEvent(ItemNavigation.BORDER_REACH, { start: true, end: false, offset });
248
- }
249
-
250
- _handleNextPage() {
251
- this.fireEvent(ItemNavigation.PAGE_BOTTOM);
252
- const items = this._getItems();
253
-
254
- if (!this.hasNextPage) {
255
- this.currentIndex = items.length - 1;
256
- } else {
257
- this.currentIndex = 0;
258
- }
259
- }
260
-
261
- _handlePrevPage() {
262
- this.fireEvent(ItemNavigation.PAGE_TOP);
263
- const items = this._getItems();
264
-
265
- if (!this.hasPrevPage) {
266
- this.currentIndex = 0;
267
- } else {
268
- this.currentIndex = (this.pageSize || items.length) - 1;
269
- }
270
- }
271
349
  }
272
350
 
273
- ItemNavigation.PAGE_TOP = "PageTop";
274
- ItemNavigation.PAGE_BOTTOM = "PageBottom";
275
- ItemNavigation.BORDER_REACH = "_borderReach";
276
-
277
351
  export default ItemNavigation;
@@ -1,65 +1,106 @@
1
- import NativeResize from "./NativeResize.js";
2
- import CustomResize from "./CustomResize.js";
1
+ let resizeObserver;
2
+ const observedElements = new Map();
3
3
 
4
- class ResizeHandler {
5
- static initialize() {
6
- ResizeHandler.Implementation = window.ResizeObserver ? NativeResize : CustomResize;
7
- 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
+ });
8
12
  }
13
+ return resizeObserver;
14
+ };
9
15
 
10
- /**
11
- * @static
12
- * @private
13
- * @param {*} ref Reference to be observed
14
- * @param {*} callback Callback to be executed
15
- * @memberof ResizeHandler
16
- */
17
- static attachListener(ref, callback) {
18
- 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);
19
22
  }
20
23
 
21
- /**
22
- * @static
23
- * @private
24
- * @param {*} ref Reference to be unobserved
25
- * @memberof ResizeHandler
26
- */
27
- static detachListener(ref, callback) {
28
- 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;
29
32
  }
30
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
+ };
31
42
 
43
+ /**
44
+ * Allows to register/deregister resize observers for a DOM element
45
+ *
46
+ * @public
47
+ * @class
48
+ */
49
+ class ResizeHandler {
32
50
  /**
33
51
  * @static
34
52
  * @public
35
- * @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
36
54
  * @param {*} callback Callback to be executed
37
- * @memberof ResizeHandler
38
55
  */
39
- static register(ref, callback) {
40
- if (ref.isUI5Element) {
41
- ref = ref.getDomRef();
56
+ static register(element, callback) {
57
+ if (element.isUI5Element) {
58
+ element = element.getDomRef();
42
59
  }
43
60
 
44
- 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
+ }
45
66
  }
46
67
 
47
-
48
68
  /**
49
69
  * @static
50
70
  * @public
51
- * @param {*} ref Reference to UI5 Web Component or DOM Element to be unobserved
52
- * @memberof ResizeHandler
71
+ * @param {*} element UI5 Web Component or DOM Element to be unobserved
72
+ * @param {*} callback Callback to be removed
53
73
  */
54
- static deregister(ref, callback) {
55
- if (ref.isUI5Element) {
56
- ref = ref.getDomRef();
74
+ static deregister(element, callback) {
75
+ if (element.isUI5Element) {
76
+ element = element.getDomRef();
57
77
  }
58
78
 
59
- 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
+ }
60
84
  }
61
85
  }
62
86
 
63
- 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
+ };
64
104
 
65
105
  export default ResizeHandler;
106
+ export { setResizeHandlerObserveFn, setResizeHandlerUnobserveFn };