@ui5/webcomponents-base 0.0.0-0fcda382e → 0.0.0-11d529e8a

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 (298) hide show
  1. package/.eslintignore +2 -0
  2. package/CHANGELOG.md +137 -0
  3. package/README.md +26 -1
  4. package/bundle.esm.js +17 -7
  5. package/dist/AssetRegistry.js +8 -6
  6. package/dist/Boot.js +43 -0
  7. package/dist/CustomElementsRegistry.js +24 -8
  8. package/dist/CustomElementsScope.js +108 -0
  9. package/dist/DOMObserver.js +65 -0
  10. package/dist/Device.js +58 -779
  11. package/dist/EventProvider.js +38 -26
  12. package/dist/FontFace.js +52 -7
  13. package/dist/InitialConfiguration.js +32 -8
  14. package/dist/Keys.js +89 -2
  15. package/dist/MediaRange.js +109 -0
  16. package/dist/PropertiesFileFormat.js +95 -0
  17. package/dist/Render.js +173 -0
  18. package/dist/RenderQueue.js +41 -17
  19. package/dist/RenderScheduler.js +24 -126
  20. package/dist/StaticArea.js +1 -39
  21. package/dist/StaticAreaItem.js +64 -62
  22. package/dist/SystemCSSVars.js +31 -0
  23. package/dist/Theming.js +2 -1
  24. package/dist/UI5Element.js +427 -299
  25. package/dist/UI5ElementMetadata.js +157 -19
  26. package/dist/asset-registries/Icons.js +118 -14
  27. package/dist/asset-registries/Illustrations.js +30 -0
  28. package/dist/asset-registries/LocaleData.js +90 -65
  29. package/dist/asset-registries/Themes.js +23 -32
  30. package/dist/asset-registries/i18n.js +72 -30
  31. package/dist/config/AnimationMode.js +11 -1
  32. package/dist/config/Language.js +58 -2
  33. package/dist/delegate/ItemNavigation.js +244 -171
  34. package/dist/delegate/ResizeHandler.js +78 -38
  35. package/dist/delegate/ScrollEnablement.js +49 -20
  36. package/dist/features/OpenUI5Support.js +42 -7
  37. package/dist/generated/AssetParameters.js +1 -1
  38. package/dist/getSharedResource.js +30 -0
  39. package/dist/i18nBundle.js +27 -4
  40. package/dist/isLegacyBrowser.js +3 -0
  41. package/dist/locale/RTLAwareRegistry.js +14 -0
  42. package/dist/locale/applyDirection.js +17 -0
  43. package/dist/locale/directionChange.js +32 -0
  44. package/dist/locale/getEffectiveDir.js +28 -0
  45. package/dist/locale/getLocale.js +12 -2
  46. package/dist/locale/languageChange.js +22 -0
  47. package/dist/renderer/LitRenderer.js +21 -4
  48. package/dist/renderer/executeTemplate.js +17 -0
  49. package/dist/resources/bundle.esm.js +17 -109
  50. package/dist/resources/bundle.esm.js.map +1 -1
  51. package/dist/sap/base/Log.js +241 -0
  52. package/dist/sap/base/assert.js +8 -0
  53. package/dist/sap/base/security/URLListValidator.js +148 -0
  54. package/dist/sap/base/security/sanitizeHTML.js +16 -0
  55. package/dist/sap/base/util/now.js +7 -0
  56. package/dist/sap/ui/thirdparty/caja-html-sanitizer.js +3585 -0
  57. package/dist/test-resources/assets/Themes.js +10 -6
  58. package/dist/test-resources/elements/Parent.js +6 -2
  59. package/dist/test-resources/elements/WithStaticArea.js +2 -1
  60. package/dist/test-resources/pages/AllTestElements.html +3 -3
  61. package/dist/test-resources/pages/Configuration.html +0 -2
  62. package/dist/test-resources/pages/ConfigurationScript.html +1 -3
  63. package/dist/test-resources/pages/assets/messagebundle_de.properties +1 -0
  64. package/dist/test-resources/pages/assets/messagebundle_en.properties +1 -0
  65. package/dist/test-resources/pages/assets/messagebundle_es.properties +1 -0
  66. package/dist/test-resources/pages/assets/messagebundle_fr.properties +1 -0
  67. package/dist/test-resources/pages/i18n.html +35 -0
  68. package/dist/test-resources/specs/ConfigurationChange.spec.js +11 -9
  69. package/dist/test-resources/specs/ConfigurationScript.spec.js +25 -23
  70. package/dist/test-resources/specs/ConfigurationURL.spec.js +65 -17
  71. package/dist/test-resources/specs/CustomTheme.spec.js +7 -5
  72. package/dist/test-resources/specs/EventProvider.spec.js +63 -0
  73. package/dist/test-resources/specs/StaticArea.spec.js +56 -12
  74. package/dist/test-resources/specs/Theming.spec.js +9 -7
  75. package/dist/test-resources/specs/UI5ElementInvalidation.js +54 -70
  76. package/dist/test-resources/specs/UI5ElementLifecycle.js +19 -14
  77. package/dist/test-resources/specs/UI5ElementListenForChildPropChanges.spec.js +25 -51
  78. package/dist/test-resources/specs/UI5ElementMetadataExt.js +9 -7
  79. package/dist/test-resources/specs/UI5ElementPropertyValidation.js +7 -5
  80. package/dist/test-resources/specs/UI5ElementPropsAndAttrs.spec.js +37 -35
  81. package/dist/test-resources/specs/UI5ElementShadowDOM.js +10 -8
  82. package/dist/test-resources/specs/UI5ElementSlots.js +10 -8
  83. package/dist/theming/CustomStyle.js +28 -7
  84. package/dist/theming/ThemeLoaded.js +22 -0
  85. package/dist/theming/applyTheme.js +2 -5
  86. package/dist/theming/getConstructableStyle.js +15 -10
  87. package/dist/theming/getEffectiveStyle.js +23 -8
  88. package/dist/theming/getStylesString.js +13 -0
  89. package/dist/types/CSSColor.js +9 -0
  90. package/dist/types/CalendarType.js +1 -1
  91. package/dist/types/DataType.js +13 -1
  92. package/dist/types/Float.js +14 -0
  93. package/dist/types/Integer.js +4 -0
  94. package/dist/types/InvisibleMessageMode.js +30 -0
  95. package/dist/types/ItemNavigationBehavior.js +2 -7
  96. package/dist/types/NavigationMode.js +1 -0
  97. package/dist/types/PopupState.js +1 -1
  98. package/dist/types/ValueState.js +1 -1
  99. package/dist/updateShadowRoot.js +26 -0
  100. package/dist/util/AriaLabelHelper.js +41 -0
  101. package/dist/util/Caret.js +45 -0
  102. package/dist/util/ColorConversion.js +370 -0
  103. package/dist/util/FocusableElements.js +25 -8
  104. package/dist/util/HTMLSanitizer.js +7 -0
  105. package/dist/util/InvisibleMessage.js +58 -0
  106. package/dist/util/PopupUtils.js +93 -0
  107. package/dist/util/SlotsHelper.js +43 -0
  108. package/dist/util/TabbableElements.js +1 -1
  109. package/dist/util/arraysAreEqual.js +15 -0
  110. package/dist/util/clamp.js +12 -0
  111. package/dist/util/debounce.js +17 -0
  112. package/dist/util/encodeCSS.js +24 -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/getSingletonElementInstance.js +13 -0
  117. package/dist/util/isElementInView.js +15 -0
  118. package/dist/util/isNodeHidden.js +1 -5
  119. package/dist/util/isNodeTabbable.js +4 -4
  120. package/dist/util/isValidPropertyName.js +9 -3
  121. package/dist/util/setToArray.js +10 -0
  122. package/hash.txt +1 -0
  123. package/index.js +1 -1
  124. package/package-scripts.js +33 -18
  125. package/package.json +20 -11
  126. package/src/AssetRegistry.js +8 -6
  127. package/src/Boot.js +43 -0
  128. package/src/CustomElementsRegistry.js +24 -8
  129. package/src/CustomElementsScope.js +108 -0
  130. package/src/DOMObserver.js +65 -0
  131. package/src/Device.js +58 -779
  132. package/src/EventProvider.js +38 -26
  133. package/src/FontFace.js +52 -7
  134. package/src/InitialConfiguration.js +32 -8
  135. package/src/Keys.js +89 -2
  136. package/src/MediaRange.js +109 -0
  137. package/src/PropertiesFileFormat.js +95 -0
  138. package/src/Render.js +173 -0
  139. package/src/RenderQueue.js +41 -17
  140. package/src/RenderScheduler.js +24 -126
  141. package/src/StaticArea.js +1 -39
  142. package/src/StaticAreaItem.js +64 -62
  143. package/src/SystemCSSVars.js +31 -0
  144. package/src/Theming.js +2 -1
  145. package/src/UI5Element.js +427 -299
  146. package/src/UI5ElementMetadata.js +157 -19
  147. package/src/asset-registries/Icons.js +118 -14
  148. package/src/asset-registries/Illustrations.js +30 -0
  149. package/src/asset-registries/LocaleData.js +90 -65
  150. package/src/asset-registries/Themes.js +23 -32
  151. package/src/asset-registries/i18n.js +72 -30
  152. package/src/config/AnimationMode.js +11 -1
  153. package/src/config/Language.js +58 -2
  154. package/src/delegate/ItemNavigation.js +244 -171
  155. package/src/delegate/ResizeHandler.js +78 -38
  156. package/src/delegate/ScrollEnablement.js +49 -20
  157. package/src/features/OpenUI5Support.js +42 -7
  158. package/src/getSharedResource.js +30 -0
  159. package/src/i18nBundle.js +27 -4
  160. package/src/isLegacyBrowser.js +3 -0
  161. package/src/locale/RTLAwareRegistry.js +14 -0
  162. package/src/locale/applyDirection.js +17 -0
  163. package/src/locale/directionChange.js +32 -0
  164. package/src/locale/getEffectiveDir.js +28 -0
  165. package/src/locale/getLocale.js +12 -2
  166. package/src/locale/languageChange.js +22 -0
  167. package/src/renderer/LitRenderer.js +21 -4
  168. package/src/renderer/executeTemplate.js +17 -0
  169. package/src/theming/CustomStyle.js +28 -7
  170. package/src/theming/ThemeLoaded.js +22 -0
  171. package/src/theming/applyTheme.js +2 -5
  172. package/src/theming/getConstructableStyle.js +15 -10
  173. package/src/theming/getEffectiveStyle.js +23 -8
  174. package/src/theming/getStylesString.js +13 -0
  175. package/src/types/CSSColor.js +9 -0
  176. package/src/types/CalendarType.js +1 -1
  177. package/src/types/DataType.js +13 -1
  178. package/src/types/Float.js +14 -0
  179. package/src/types/Integer.js +4 -0
  180. package/src/types/InvisibleMessageMode.js +30 -0
  181. package/src/types/ItemNavigationBehavior.js +2 -7
  182. package/src/types/NavigationMode.js +1 -0
  183. package/src/types/PopupState.js +1 -1
  184. package/src/types/ValueState.js +1 -1
  185. package/src/updateShadowRoot.js +26 -0
  186. package/src/util/AriaLabelHelper.js +41 -0
  187. package/src/util/Caret.js +45 -0
  188. package/src/util/ColorConversion.js +370 -0
  189. package/src/util/FocusableElements.js +25 -8
  190. package/src/util/HTMLSanitizer.js +7 -0
  191. package/src/util/InvisibleMessage.js +58 -0
  192. package/src/util/PopupUtils.js +93 -0
  193. package/src/util/SlotsHelper.js +43 -0
  194. package/src/util/TabbableElements.js +1 -1
  195. package/src/util/arraysAreEqual.js +15 -0
  196. package/src/util/clamp.js +12 -0
  197. package/src/util/debounce.js +17 -0
  198. package/src/util/encodeCSS.js +24 -0
  199. package/src/util/getActiveElement.js +11 -0
  200. package/src/util/getClassCopy.js +10 -0
  201. package/src/util/getEffectiveContentDensity.js +5 -0
  202. package/src/util/getSingletonElementInstance.js +13 -0
  203. package/src/util/isElementInView.js +15 -0
  204. package/src/util/isNodeHidden.js +1 -5
  205. package/src/util/isNodeTabbable.js +4 -4
  206. package/src/util/isValidPropertyName.js +9 -3
  207. package/src/util/setToArray.js +10 -0
  208. package/used-modules.txt +7 -0
  209. package/bundle.es5.js +0 -28
  210. package/dist/SVGIconRegistry.js +0 -60
  211. package/dist/boot.js +0 -32
  212. package/dist/compatibility/DOMObserver.js +0 -62
  213. package/dist/compatibility/patchNodeValue.js +0 -24
  214. package/dist/compatibility/whenPolyfillLoaded.js +0 -26
  215. package/dist/delegate/CustomResize.js +0 -78
  216. package/dist/delegate/NativeResize.js +0 -44
  217. package/dist/features/browsersupport/Edge.js +0 -6
  218. package/dist/features/browsersupport/IE11.js +0 -41
  219. package/dist/features/browsersupport/IE11WithWebComponentsPolyfill.js +0 -5
  220. package/dist/renderer/ifDefined.js +0 -21
  221. package/dist/resources/bundle.es5.js +0 -212
  222. package/dist/resources/bundle.es5.js.map +0 -1
  223. package/dist/theming/CSSVarsPonyfill.js +0 -24
  224. package/dist/theming/adaptCSSForIE.js +0 -90
  225. package/dist/theming/createComponentStyleTag.js +0 -49
  226. package/dist/thirdparty/Array.from.js +0 -16
  227. package/dist/thirdparty/Array.prototype.fill.js +0 -44
  228. package/dist/thirdparty/Array.prototype.find.js +0 -46
  229. package/dist/thirdparty/Array.prototype.includes.js +0 -51
  230. package/dist/thirdparty/Element.prototype.closest.js +0 -11
  231. package/dist/thirdparty/Element.prototype.matches.js +0 -6
  232. package/dist/thirdparty/Map.prototype.keys.js +0 -9
  233. package/dist/thirdparty/Number.isInteger.js +0 -5
  234. package/dist/thirdparty/Number.isNaN.js +0 -1
  235. package/dist/thirdparty/Number.parseInt.js +0 -1
  236. package/dist/thirdparty/Object.assign.js +0 -31
  237. package/dist/thirdparty/Object.entries.js +0 -11
  238. package/dist/thirdparty/Symbol.js +0 -2
  239. package/dist/thirdparty/WeakSet.js +0 -27
  240. package/dist/thirdparty/es6-string-methods.js +0 -182
  241. package/dist/thirdparty/events-polyfills.js +0 -89
  242. package/dist/thirdparty/fetch.js +0 -1
  243. package/dist/thirdparty/template.js +0 -600
  244. package/dist/thirdparty/webcomponents-sd-ce-pf.js +0 -318
  245. package/dist/webcomponentsjs/LICENSE.md +0 -19
  246. package/dist/webcomponentsjs/README.md +0 -229
  247. package/dist/webcomponentsjs/bundles/webcomponents-ce.js +0 -63
  248. package/dist/webcomponentsjs/bundles/webcomponents-ce.js.map +0 -1
  249. package/dist/webcomponentsjs/bundles/webcomponents-sd-ce-pf.js +0 -297
  250. package/dist/webcomponentsjs/bundles/webcomponents-sd-ce-pf.js.map +0 -1
  251. package/dist/webcomponentsjs/bundles/webcomponents-sd-ce.js +0 -208
  252. package/dist/webcomponentsjs/bundles/webcomponents-sd-ce.js.map +0 -1
  253. package/dist/webcomponentsjs/bundles/webcomponents-sd.js +0 -166
  254. package/dist/webcomponentsjs/bundles/webcomponents-sd.js.map +0 -1
  255. package/dist/webcomponentsjs/custom-elements-es5-adapter.js +0 -15
  256. package/dist/webcomponentsjs/package.json +0 -46
  257. package/dist/webcomponentsjs/src/entrypoints/custom-elements-es5-adapter-index.js +0 -16
  258. package/dist/webcomponentsjs/src/entrypoints/webcomponents-bundle-index.js +0 -53
  259. package/dist/webcomponentsjs/src/entrypoints/webcomponents-ce-index.js +0 -17
  260. package/dist/webcomponentsjs/src/entrypoints/webcomponents-sd-ce-index.js +0 -19
  261. package/dist/webcomponentsjs/src/entrypoints/webcomponents-sd-ce-pf-index.js +0 -28
  262. package/dist/webcomponentsjs/src/entrypoints/webcomponents-sd-index.js +0 -18
  263. package/dist/webcomponentsjs/webcomponents-bundle.js +0 -298
  264. package/dist/webcomponentsjs/webcomponents-bundle.js.map +0 -1
  265. package/dist/webcomponentsjs/webcomponents-loader.js +0 -185
  266. package/src/SVGIconRegistry.js +0 -60
  267. package/src/boot.js +0 -32
  268. package/src/compatibility/DOMObserver.js +0 -62
  269. package/src/compatibility/patchNodeValue.js +0 -24
  270. package/src/compatibility/whenPolyfillLoaded.js +0 -26
  271. package/src/delegate/CustomResize.js +0 -78
  272. package/src/delegate/NativeResize.js +0 -44
  273. package/src/features/browsersupport/Edge.js +0 -6
  274. package/src/features/browsersupport/IE11.js +0 -41
  275. package/src/features/browsersupport/IE11WithWebComponentsPolyfill.js +0 -5
  276. package/src/renderer/ifDefined.js +0 -21
  277. package/src/theming/CSSVarsPonyfill.js +0 -24
  278. package/src/theming/adaptCSSForIE.js +0 -90
  279. package/src/theming/createComponentStyleTag.js +0 -49
  280. package/src/thirdparty/Array.from.js +0 -16
  281. package/src/thirdparty/Array.prototype.fill.js +0 -44
  282. package/src/thirdparty/Array.prototype.find.js +0 -46
  283. package/src/thirdparty/Array.prototype.includes.js +0 -51
  284. package/src/thirdparty/Element.prototype.closest.js +0 -11
  285. package/src/thirdparty/Element.prototype.matches.js +0 -6
  286. package/src/thirdparty/Map.prototype.keys.js +0 -9
  287. package/src/thirdparty/Number.isInteger.js +0 -5
  288. package/src/thirdparty/Number.isNaN.js +0 -1
  289. package/src/thirdparty/Number.parseInt.js +0 -1
  290. package/src/thirdparty/Object.assign.js +0 -31
  291. package/src/thirdparty/Object.entries.js +0 -11
  292. package/src/thirdparty/Symbol.js +0 -2
  293. package/src/thirdparty/WeakSet.js +0 -27
  294. package/src/thirdparty/es6-string-methods.js +0 -182
  295. package/src/thirdparty/events-polyfills.js +0 -89
  296. package/src/thirdparty/fetch.js +0 -1
  297. package/src/thirdparty/template.js +0 -600
  298. 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,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
- 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
+
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
+ }
62
156
 
63
- this.update();
64
- this.focusCurrent();
157
+ event.preventDefault();
158
+ this._applyTabIndex();
159
+ this._focusCurrentItem();
65
160
  }
66
161
 
67
- onkeydown(event) {
68
- if (isUp(event) && this._verticalNavigationOn()) {
69
- 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;
70
167
  }
71
168
 
72
- if (isDown(event) && this._verticalNavigationOn()) {
73
- 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;
74
180
  }
181
+ }
75
182
 
76
- if (isLeft(event) && this._horizontalNavigationOn()) {
77
- 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;
78
188
  }
79
189
 
80
- if (isRight(event) && this._horizontalNavigationOn()) {
81
- 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;
82
196
  }
197
+ }
83
198
 
84
- if (isHome(event)) {
85
- return this._handleHome(event);
199
+ _handleLeft() {
200
+ const itemsLength = this._getItems().length;
201
+ if (this._currentIndex > 0) {
202
+ this._currentIndex -= 1;
203
+ return;
86
204
  }
87
205
 
88
- if (isEnd(event)) {
89
- return this._handleEnd(event);
206
+ if (this._behavior === ItemNavigationBehavior.Cyclic) { // go to the first item in the next column
207
+ this._currentIndex = itemsLength - 1;
90
208
  }
91
209
  }
92
210
 
93
- _handleUp(event) {
94
- if (this._canNavigate()) {
95
- this.currentIndex -= this.rowSize;
96
- this._onKeyPress(event);
211
+ _handleRight() {
212
+ const itemsLength = this._getItems().length;
213
+ if (this._currentIndex < itemsLength - 1) {
214
+ this._currentIndex += 1;
215
+ return;
97
216
  }
98
- }
99
217
 
100
- _handleDown(event) {
101
- if (this._canNavigate()) {
102
- this.currentIndex += this.rowSize;
103
- this._onKeyPress(event);
218
+ if (this._behavior === ItemNavigationBehavior.Cyclic) { // go to the first item in the next column
219
+ this._currentIndex = 0;
104
220
  }
105
221
  }
106
222
 
107
- _handleLeft(event) {
108
- if (this._canNavigate()) {
109
- this.currentIndex -= 1;
110
- this._onKeyPress(event);
111
- }
223
+ _handleHome() {
224
+ const homeEndRange = this._rowSize > 1 ? this._rowSize : this._getItems().length;
225
+ this._currentIndex -= this._currentIndex % homeEndRange;
112
226
  }
113
227
 
114
- _handleRight(event) {
115
- if (this._canNavigate()) {
116
- this.currentIndex += 1;
117
- this._onKeyPress(event);
118
- }
228
+ _handleEnd() {
229
+ const homeEndRange = this._rowSize > 1 ? this._rowSize : this._getItems().length;
230
+ this._currentIndex += (homeEndRange - 1 - this._currentIndex % homeEndRange); // eslint-disable-line
119
231
  }
120
232
 
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);
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;
126
238
  }
239
+ this._handlePageUpFlat();
127
240
  }
128
241
 
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);
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;
134
247
  }
248
+ this._handlePageDownFlat();
135
249
  }
136
250
 
137
- update(current) {
138
- 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
+ }
139
259
 
140
- if (current) {
141
- 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;
142
267
  }
268
+ }
143
269
 
144
- if (!origItems[this.currentIndex]
145
- || (origItems[this.currentIndex]._tabIndex && origItems[this.currentIndex]._tabIndex === "0")) {
146
- 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;
147
277
  }
148
278
 
149
- const items = origItems.slice(0);
279
+ const currentToEndRange = this._getItems().length - this._currentIndex - 1;
150
280
 
151
- for (let i = 0; i < items.length; i++) {
152
- 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;
153
288
  }
289
+ }
154
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
+ }
155
296
 
156
- this.rootWebComponent._invalidate();
297
+ this._affectedPropertiesNames.forEach(propName => {
298
+ const prop = this.rootWebComponent[propName];
299
+ this.rootWebComponent[propName] = Array.isArray(prop) ? [...prop] : { ...prop };
300
+ });
157
301
  }
158
302
 
159
- focusCurrent() {
303
+ _focusCurrentItem() {
160
304
  const currentItem = this._getCurrentItem();
161
305
  if (currentItem) {
162
306
  currentItem.focus();
@@ -165,12 +309,7 @@ class ItemNavigation extends EventProvider {
165
309
 
166
310
  _canNavigate() {
167
311
  const currentItem = this._getCurrentItem();
168
-
169
- let activeElement = document.activeElement;
170
-
171
- while (activeElement.shadowRoot && activeElement.shadowRoot.activeElement) {
172
- activeElement = activeElement.shadowRoot.activeElement;
173
- }
312
+ const activeElement = getActiveElement();
174
313
 
175
314
  return currentItem && currentItem === activeElement;
176
315
  }
@@ -183,96 +322,30 @@ class ItemNavigation extends EventProvider {
183
322
  }
184
323
 
185
324
  // normalize the index
186
- while (this.currentIndex >= items.length) {
187
- this.currentIndex -= this.rowSize;
325
+ while (this._currentIndex >= items.length) {
326
+ this._currentIndex -= this._rowSize;
188
327
  }
189
328
 
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;
329
+ if (this._currentIndex < 0) {
330
+ this._currentIndex = 0;
202
331
  }
203
332
 
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
- }
333
+ const currentItem = items[this._currentIndex];
214
334
 
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;
335
+ if (!currentItem) {
221
336
  return;
222
337
  }
223
338
 
224
- if (this.behavior === ItemNavigationBehavior.Paging) {
225
- this._handleNextPage();
226
- } else {
227
- this.currentIndex = items.length - 1;
339
+ if (currentItem.isUI5Element) {
340
+ return currentItem.getFocusDomRef();
228
341
  }
229
342
 
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;
343
+ if (!this.rootWebComponent.getDomRef()) {
239
344
  return;
240
345
  }
241
346
 
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
- }
347
+ return this.rootWebComponent.getDomRef().querySelector(`#${currentItem.id}`);
271
348
  }
272
349
  }
273
350
 
274
- ItemNavigation.PAGE_TOP = "PageTop";
275
- ItemNavigation.PAGE_BOTTOM = "PageBottom";
276
- ItemNavigation.BORDER_REACH = "_borderReach";
277
-
278
351
  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 };