@ui5/webcomponents-base 0.0.0-a3eca7ade → 0.0.0-a7032d86e

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 (665) hide show
  1. package/.eslintignore +1 -1
  2. package/CHANGELOG.md +219 -0
  3. package/README.md +28 -6
  4. package/bundle.esm.js +12 -10
  5. package/dist/AssetRegistry.d.ts +5 -0
  6. package/dist/AssetRegistry.js +2 -7
  7. package/dist/AssetRegistry.js.map +1 -0
  8. package/dist/Boot.d.ts +8 -0
  9. package/dist/Boot.js +29 -44
  10. package/dist/Boot.js.map +1 -0
  11. package/dist/CSP.d.ts +30 -0
  12. package/dist/CSP.js +16 -24
  13. package/dist/CSP.js.map +1 -0
  14. package/dist/CustomElementsRegistry.d.ts +5 -0
  15. package/dist/CustomElementsRegistry.js +66 -83
  16. package/dist/CustomElementsRegistry.js.map +1 -0
  17. package/dist/CustomElementsScope.d.ts +7 -0
  18. package/dist/CustomElementsScope.js +11 -108
  19. package/dist/CustomElementsScope.js.map +1 -0
  20. package/dist/CustomElementsScopeUtils.d.ts +55 -0
  21. package/dist/CustomElementsScopeUtils.js +90 -0
  22. package/dist/CustomElementsScopeUtils.js.map +1 -0
  23. package/dist/DOMObserver.d.ts +11 -0
  24. package/dist/DOMObserver.js +12 -54
  25. package/dist/DOMObserver.js.map +1 -0
  26. package/dist/Device.d.ts +12 -0
  27. package/dist/Device.js +54 -79
  28. package/dist/Device.js.map +1 -0
  29. package/dist/EventProvider.d.ts +25 -0
  30. package/dist/EventProvider.js +67 -82
  31. package/dist/EventProvider.js.map +1 -0
  32. package/dist/FeaturesRegistry.d.ts +3 -0
  33. package/dist/FeaturesRegistry.js +5 -10
  34. package/dist/FeaturesRegistry.js.map +1 -0
  35. package/dist/FontFace.d.ts +2 -0
  36. package/dist/FontFace.js +14 -19
  37. package/dist/FontFace.js.map +1 -0
  38. package/dist/InitialConfiguration.d.ts +22 -0
  39. package/dist/InitialConfiguration.js +112 -131
  40. package/dist/InitialConfiguration.js.map +1 -0
  41. package/dist/Keys.d.ts +57 -0
  42. package/dist/Keys.js +174 -276
  43. package/dist/Keys.js.map +1 -0
  44. package/dist/ManagedStyles.d.ts +8 -0
  45. package/dist/ManagedStyles.js +62 -68
  46. package/dist/ManagedStyles.js.map +1 -0
  47. package/dist/MarkedEvents.d.ts +9 -0
  48. package/dist/MarkedEvents.js +15 -0
  49. package/dist/MarkedEvents.js.map +1 -0
  50. package/dist/MediaRange.d.ts +37 -0
  51. package/dist/MediaRange.js +54 -65
  52. package/dist/MediaRange.js.map +1 -0
  53. package/dist/PropertiesFileFormat.d.ts +8 -0
  54. package/dist/PropertiesFileFormat.js +72 -82
  55. package/dist/PropertiesFileFormat.js.map +1 -0
  56. package/dist/Render.d.ts +47 -0
  57. package/dist/Render.js +81 -113
  58. package/dist/Render.js.map +1 -0
  59. package/dist/RenderQueue.d.ts +19 -0
  60. package/dist/RenderQueue.js +52 -62
  61. package/dist/RenderQueue.js.map +1 -0
  62. package/dist/Runtimes.d.ts +27 -0
  63. package/dist/Runtimes.js +49 -70
  64. package/dist/Runtimes.js.map +1 -0
  65. package/dist/StaticArea.d.ts +0 -0
  66. package/dist/StaticArea.js +4 -1
  67. package/dist/StaticArea.js.map +1 -0
  68. package/dist/StaticAreaItem.d.ts +36 -0
  69. package/dist/StaticAreaItem.js +85 -87
  70. package/dist/StaticAreaItem.js.map +1 -0
  71. package/dist/SystemCSSVars.d.ts +2 -0
  72. package/dist/SystemCSSVars.js +4 -5
  73. package/dist/SystemCSSVars.js.map +1 -0
  74. package/dist/Theming.d.ts +3 -0
  75. package/dist/Theming.js +1 -1
  76. package/dist/Theming.js.map +1 -0
  77. package/dist/UI5Element.d.ts +373 -0
  78. package/dist/UI5Element.js +929 -985
  79. package/dist/UI5Element.js.map +1 -0
  80. package/dist/UI5ElementMetadata.d.ts +150 -0
  81. package/dist/UI5ElementMetadata.js +278 -314
  82. package/dist/UI5ElementMetadata.js.map +1 -0
  83. package/dist/animations/AnimationQueue.d.ts +8 -0
  84. package/dist/animations/AnimationQueue.js +31 -38
  85. package/dist/animations/AnimationQueue.js.map +1 -0
  86. package/dist/animations/animate.d.ts +14 -0
  87. package/dist/animations/animate.js +46 -51
  88. package/dist/animations/animate.js.map +1 -0
  89. package/dist/animations/scroll.d.ts +5 -0
  90. package/dist/animations/scroll.js +18 -27
  91. package/dist/animations/scroll.js.map +1 -0
  92. package/dist/animations/slideDown.d.ts +5 -0
  93. package/dist/animations/slideDown.js +53 -78
  94. package/dist/animations/slideDown.js.map +1 -0
  95. package/dist/animations/slideUp.d.ts +5 -0
  96. package/dist/animations/slideUp.js +49 -70
  97. package/dist/animations/slideUp.js.map +1 -0
  98. package/dist/api.json +1 -0
  99. package/dist/asset-registries/Icons.d.ts +30 -0
  100. package/dist/asset-registries/Icons.js +86 -121
  101. package/dist/asset-registries/Icons.js.map +1 -0
  102. package/dist/asset-registries/Illustrations.d.ts +17 -0
  103. package/dist/asset-registries/Illustrations.js +41 -25
  104. package/dist/asset-registries/Illustrations.js.map +1 -0
  105. package/dist/asset-registries/LocaleData.d.ts +7 -0
  106. package/dist/asset-registries/LocaleData.js +104 -127
  107. package/dist/asset-registries/LocaleData.js.map +1 -0
  108. package/dist/asset-registries/Themes.d.ts +10 -0
  109. package/dist/asset-registries/Themes.js +38 -66
  110. package/dist/asset-registries/Themes.js.map +1 -0
  111. package/dist/asset-registries/i18n.d.ts +23 -0
  112. package/dist/asset-registries/i18n.js +55 -81
  113. package/dist/asset-registries/i18n.js.map +1 -0
  114. package/dist/assets/bundle.esm.0cfce34f.js +56 -0
  115. package/dist/assets-meta/IconCollectionsAlias.d.ts +17 -0
  116. package/dist/assets-meta/IconCollectionsAlias.js +4 -4
  117. package/dist/assets-meta/IconCollectionsAlias.js.map +1 -0
  118. package/dist/config/AnimationMode.d.ts +14 -0
  119. package/dist/config/AnimationMode.js +21 -18
  120. package/dist/config/AnimationMode.js.map +1 -0
  121. package/dist/config/CalendarType.d.ts +8 -0
  122. package/dist/config/CalendarType.js +13 -12
  123. package/dist/config/CalendarType.js.map +1 -0
  124. package/dist/config/FormatSettings.d.ts +11 -0
  125. package/dist/config/FormatSettings.js +10 -8
  126. package/dist/config/FormatSettings.js.map +1 -0
  127. package/dist/config/Icons.d.ts +30 -0
  128. package/dist/config/Icons.js +48 -0
  129. package/dist/config/Icons.js.map +1 -0
  130. package/dist/config/Language.d.ts +31 -0
  131. package/dist/config/Language.js +31 -43
  132. package/dist/config/Language.js.map +1 -0
  133. package/dist/config/NoConflict.d.ts +20 -0
  134. package/dist/config/NoConflict.js +40 -41
  135. package/dist/config/NoConflict.js.map +1 -0
  136. package/dist/config/RTL.d.ts +7 -0
  137. package/dist/config/RTL.js +23 -20
  138. package/dist/config/RTL.js.map +1 -0
  139. package/dist/config/Theme.d.ts +28 -0
  140. package/dist/config/Theme.js +38 -29
  141. package/dist/config/Theme.js.map +1 -0
  142. package/dist/config/ThemeRoots.d.ts +4 -0
  143. package/dist/config/ThemeRoots.js +28 -0
  144. package/dist/config/ThemeRoots.js.map +1 -0
  145. package/dist/css/BusyIndicator.css +80 -0
  146. package/dist/css/FontFace.css +31 -10
  147. package/dist/decorators/customElement.d.ts +8 -0
  148. package/dist/decorators/customElement.js +16 -0
  149. package/dist/decorators/customElement.js.map +1 -0
  150. package/dist/decorators/event.d.ts +10 -0
  151. package/dist/decorators/event.js +24 -0
  152. package/dist/decorators/event.js.map +1 -0
  153. package/dist/decorators/fastNavigation.d.ts +7 -0
  154. package/dist/decorators/fastNavigation.js +13 -0
  155. package/dist/decorators/fastNavigation.js.map +1 -0
  156. package/dist/decorators/languageAware.d.ts +7 -0
  157. package/dist/decorators/languageAware.js +13 -0
  158. package/dist/decorators/languageAware.js.map +1 -0
  159. package/dist/decorators/property.d.ts +9 -0
  160. package/dist/decorators/property.js +24 -0
  161. package/dist/decorators/property.js.map +1 -0
  162. package/dist/decorators/slot.d.ts +9 -0
  163. package/dist/decorators/slot.js +37 -0
  164. package/dist/decorators/slot.js.map +1 -0
  165. package/dist/decorators/themeAware.d.ts +7 -0
  166. package/dist/decorators/themeAware.js +13 -0
  167. package/dist/decorators/themeAware.js.map +1 -0
  168. package/dist/delegate/ItemNavigation.d.ts +113 -0
  169. package/dist/delegate/ItemNavigation.js +277 -312
  170. package/dist/delegate/ItemNavigation.js.map +1 -0
  171. package/dist/delegate/ResizeHandler.d.ts +24 -0
  172. package/dist/delegate/ResizeHandler.js +68 -91
  173. package/dist/delegate/ResizeHandler.js.map +1 -0
  174. package/dist/delegate/ScrollEnablement.d.ts +48 -0
  175. package/dist/delegate/ScrollEnablement.js +157 -180
  176. package/dist/delegate/ScrollEnablement.js.map +1 -0
  177. package/dist/features/F6Navigation.d.ts +16 -0
  178. package/dist/features/F6Navigation.js +106 -100
  179. package/dist/features/F6Navigation.js.map +1 -0
  180. package/dist/features/OpenUI5Element.d.ts +9 -0
  181. package/dist/features/OpenUI5Element.js +5 -0
  182. package/dist/features/OpenUI5Element.js.map +1 -0
  183. package/dist/features/OpenUI5Enablement.d.ts +11 -0
  184. package/dist/features/OpenUI5Enablement.js +96 -0
  185. package/dist/features/OpenUI5Enablement.js.map +1 -0
  186. package/dist/features/OpenUI5Support.d.ts +23 -0
  187. package/dist/features/OpenUI5Support.js +91 -119
  188. package/dist/features/OpenUI5Support.js.map +1 -0
  189. package/dist/generated/AssetParameters.js +1 -1
  190. package/dist/generated/VersionInfo.js +3 -3
  191. package/dist/generated/css/BusyIndicator.css.js +5 -0
  192. package/dist/generated/css/FontFace.css.js +1 -1
  193. package/dist/generated/templates/elements/WithComplexTemplateTemplate.lit.js +11 -0
  194. package/dist/getSharedResource.d.ts +11 -0
  195. package/dist/getSharedResource.js +12 -16
  196. package/dist/getSharedResource.js.map +1 -0
  197. package/dist/i18nBundle.d.ts +43 -0
  198. package/dist/i18nBundle.js +56 -64
  199. package/dist/i18nBundle.js.map +1 -0
  200. package/dist/locale/Locale.d.ts +22 -0
  201. package/dist/locale/Locale.js +75 -87
  202. package/dist/locale/Locale.js.map +1 -0
  203. package/dist/locale/RTLAwareRegistry.d.ts +4 -0
  204. package/dist/locale/RTLAwareRegistry.js +6 -11
  205. package/dist/locale/RTLAwareRegistry.js.map +1 -0
  206. package/dist/locale/applyDirection.d.ts +10 -0
  207. package/dist/locale/applyDirection.js +7 -7
  208. package/dist/locale/applyDirection.js.map +1 -0
  209. package/dist/locale/directionChange.d.ts +15 -0
  210. package/dist/locale/directionChange.js +7 -15
  211. package/dist/locale/directionChange.js.map +1 -0
  212. package/dist/locale/getEffectiveDir.d.ts +2 -0
  213. package/dist/locale/getEffectiveDir.js +20 -24
  214. package/dist/locale/getEffectiveDir.js.map +1 -0
  215. package/dist/locale/getLocale.d.ts +7 -0
  216. package/dist/locale/getLocale.js +26 -29
  217. package/dist/locale/getLocale.js.map +1 -0
  218. package/dist/locale/languageChange.d.ts +5 -0
  219. package/dist/locale/languageChange.js +8 -16
  220. package/dist/locale/languageChange.js.map +1 -0
  221. package/dist/locale/nextFallbackLocale.d.ts +8 -0
  222. package/dist/locale/nextFallbackLocale.js +15 -19
  223. package/dist/locale/nextFallbackLocale.js.map +1 -0
  224. package/dist/locale/normalizeLocale.d.ts +7 -0
  225. package/dist/locale/normalizeLocale.js +34 -41
  226. package/dist/locale/normalizeLocale.js.map +1 -0
  227. package/dist/renderer/LitRenderer.d.ts +14 -0
  228. package/dist/renderer/LitRenderer.js +31 -24
  229. package/dist/renderer/LitRenderer.js.map +1 -0
  230. package/dist/renderer/executeTemplate.d.ts +13 -0
  231. package/dist/renderer/executeTemplate.js +20 -7
  232. package/dist/renderer/executeTemplate.js.map +1 -0
  233. package/dist/sap/base/Log.js +28 -29
  234. package/dist/sap/base/assert.js +5 -6
  235. package/dist/sap/base/security/URLListValidator.js +13 -2
  236. package/dist/sap/ui/thirdparty/caja-html-sanitizer.js +1 -1
  237. package/dist/theming/CustomStyle.d.ts +6 -0
  238. package/dist/theming/CustomStyle.js +29 -43
  239. package/dist/theming/CustomStyle.js.map +1 -0
  240. package/dist/theming/ThemeLoaded.d.ts +5 -0
  241. package/dist/theming/ThemeLoaded.js +8 -16
  242. package/dist/theming/ThemeLoaded.js.map +1 -0
  243. package/dist/theming/applyTheme.d.ts +2 -0
  244. package/dist/theming/applyTheme.js +60 -64
  245. package/dist/theming/applyTheme.js.map +1 -0
  246. package/dist/theming/getConstructableStyle.d.ts +9 -0
  247. package/dist/theming/getConstructableStyle.js +12 -17
  248. package/dist/theming/getConstructableStyle.js.map +1 -0
  249. package/dist/theming/getEffectiveLinksHrefs.d.ts +3 -0
  250. package/dist/theming/getEffectiveLinksHrefs.js +13 -16
  251. package/dist/theming/getEffectiveLinksHrefs.js.map +1 -0
  252. package/dist/theming/getEffectiveStyle.d.ts +3 -0
  253. package/dist/theming/getEffectiveStyle.js +25 -23
  254. package/dist/theming/getEffectiveStyle.js.map +1 -0
  255. package/dist/theming/getStylesString.d.ts +3 -0
  256. package/dist/theming/getStylesString.js +9 -13
  257. package/dist/theming/getStylesString.js.map +1 -0
  258. package/dist/theming/getThemeDesignerTheme.d.ts +7 -0
  259. package/dist/theming/getThemeDesignerTheme.js +72 -79
  260. package/dist/theming/getThemeDesignerTheme.js.map +1 -0
  261. package/dist/theming/preloadLinks.d.ts +3 -0
  262. package/dist/theming/preloadLinks.js +13 -17
  263. package/dist/theming/preloadLinks.js.map +1 -0
  264. package/dist/thirdparty/_merge.d.ts +2 -0
  265. package/dist/thirdparty/_merge.js +7 -4
  266. package/dist/thirdparty/_merge.js.map +1 -0
  267. package/dist/thirdparty/isPlainObject.d.ts +2 -0
  268. package/dist/thirdparty/isPlainObject.js +11 -10
  269. package/dist/thirdparty/isPlainObject.js.map +1 -0
  270. package/dist/thirdparty/merge.d.ts +2 -0
  271. package/dist/thirdparty/merge.js +4 -8
  272. package/dist/thirdparty/merge.js.map +1 -0
  273. package/dist/types/AnimationMode.d.ts +32 -0
  274. package/dist/types/AnimationMode.js +33 -6
  275. package/dist/types/AnimationMode.js.map +1 -0
  276. package/dist/types/CSSColor.d.ts +16 -0
  277. package/dist/types/CSSColor.js +15 -5
  278. package/dist/types/CSSColor.js.map +1 -0
  279. package/dist/types/CalendarType.d.ts +37 -0
  280. package/dist/types/CalendarType.js +35 -18
  281. package/dist/types/CalendarType.js.map +1 -0
  282. package/dist/types/DOMReference.d.ts +17 -0
  283. package/dist/types/DOMReference.js +25 -0
  284. package/dist/types/DOMReference.js.map +1 -0
  285. package/dist/types/DataType.d.ts +25 -0
  286. package/dist/types/DataType.js +33 -26
  287. package/dist/types/DataType.js.map +1 -0
  288. package/dist/types/Float.d.ts +18 -0
  289. package/dist/types/Float.js +18 -10
  290. package/dist/types/Float.js.map +1 -0
  291. package/dist/types/Integer.d.ts +18 -0
  292. package/dist/types/Integer.js +18 -9
  293. package/dist/types/Integer.js.map +1 -0
  294. package/dist/types/InvisibleMessageMode.d.ts +25 -0
  295. package/dist/types/InvisibleMessageMode.js +20 -23
  296. package/dist/types/InvisibleMessageMode.js.map +1 -0
  297. package/dist/types/ItemNavigationBehavior.d.ts +24 -0
  298. package/dist/types/ItemNavigationBehavior.js +22 -12
  299. package/dist/types/ItemNavigationBehavior.js.map +1 -0
  300. package/dist/types/NavigationMode.d.ts +32 -0
  301. package/dist/types/NavigationMode.js +33 -6
  302. package/dist/types/NavigationMode.js.map +1 -0
  303. package/dist/types/ValueState.d.ts +42 -0
  304. package/dist/types/ValueState.js +41 -19
  305. package/dist/types/ValueState.js.map +1 -0
  306. package/dist/types.d.ts +18 -0
  307. package/dist/types.js +2 -0
  308. package/dist/types.js.map +1 -0
  309. package/dist/updateShadowRoot.d.ts +8 -0
  310. package/dist/updateShadowRoot.js +21 -17
  311. package/dist/updateShadowRoot.js.map +1 -0
  312. package/dist/util/AriaLabelHelper.d.ts +6 -0
  313. package/dist/util/AriaLabelHelper.js +37 -34
  314. package/dist/util/AriaLabelHelper.js.map +1 -0
  315. package/dist/util/Caret.d.ts +7 -0
  316. package/dist/util/Caret.js +16 -38
  317. package/dist/util/Caret.js.map +1 -0
  318. package/dist/util/ColorConversion.d.ts +30 -0
  319. package/dist/util/ColorConversion.js +315 -348
  320. package/dist/util/ColorConversion.js.map +1 -0
  321. package/dist/util/FetchHelper.d.ts +3 -0
  322. package/dist/util/FetchHelper.js +19 -25
  323. package/dist/util/FetchHelper.js.map +1 -0
  324. package/dist/util/FocusableElements.d.ts +4 -0
  325. package/dist/util/FocusableElements.js +54 -71
  326. package/dist/util/FocusableElements.js.map +1 -0
  327. package/dist/util/HTMLSanitizer.d.ts +3 -0
  328. package/dist/util/HTMLSanitizer.js +4 -5
  329. package/dist/util/HTMLSanitizer.js.map +1 -0
  330. package/dist/util/InvisibleMessage.d.ts +10 -0
  331. package/dist/util/InvisibleMessage.js +41 -45
  332. package/dist/util/InvisibleMessage.js.map +1 -0
  333. package/dist/util/PopupUtils.d.ts +7 -0
  334. package/dist/util/PopupUtils.js +58 -77
  335. package/dist/util/PopupUtils.js.map +1 -0
  336. package/dist/util/SlotsHelper.d.ts +9 -0
  337. package/dist/util/SlotsHelper.js +22 -35
  338. package/dist/util/SlotsHelper.js.map +1 -0
  339. package/dist/util/StringHelper.d.ts +3 -0
  340. package/dist/util/StringHelper.js +17 -20
  341. package/dist/util/StringHelper.js.map +1 -0
  342. package/dist/util/TabbableElements.d.ts +17 -0
  343. package/dist/util/TabbableElements.js +53 -47
  344. package/dist/util/TabbableElements.js.map +1 -0
  345. package/dist/util/arraysAreEqual.d.ts +2 -0
  346. package/dist/util/arraysAreEqual.js +10 -12
  347. package/dist/util/arraysAreEqual.js.map +1 -0
  348. package/dist/util/clamp.d.ts +9 -0
  349. package/dist/util/clamp.js +2 -2
  350. package/dist/util/clamp.js.map +1 -0
  351. package/dist/util/createLinkInHead.d.ts +7 -0
  352. package/dist/util/createLinkInHead.js +14 -12
  353. package/dist/util/createLinkInHead.js.map +1 -0
  354. package/dist/util/createStyleInHead.d.ts +8 -0
  355. package/dist/util/createStyleInHead.js +10 -10
  356. package/dist/util/createStyleInHead.js.map +1 -0
  357. package/dist/util/debounce.d.ts +2 -0
  358. package/dist/util/debounce.js +6 -8
  359. package/dist/util/debounce.js.map +1 -0
  360. package/dist/util/detectNavigatorLanguage.d.ts +2 -0
  361. package/dist/util/detectNavigatorLanguage.js +7 -10
  362. package/dist/util/detectNavigatorLanguage.js.map +1 -0
  363. package/dist/util/escapeRegex.d.ts +8 -0
  364. package/dist/util/escapeRegex.js +8 -7
  365. package/dist/util/escapeRegex.js.map +1 -0
  366. package/dist/util/formatMessage.d.ts +2 -0
  367. package/dist/util/formatMessage.js +15 -19
  368. package/dist/util/formatMessage.js.map +1 -0
  369. package/dist/util/generateHighlightedMarkup.d.ts +9 -0
  370. package/dist/util/generateHighlightedMarkup.js +26 -27
  371. package/dist/util/generateHighlightedMarkup.js.map +1 -0
  372. package/dist/util/getActiveElement.d.ts +2 -0
  373. package/dist/util/getActiveElement.js +6 -8
  374. package/dist/util/getActiveElement.js.map +1 -0
  375. package/dist/util/getClassCopy.d.ts +400 -0
  376. package/dist/util/getClassCopy.js +7 -7
  377. package/dist/util/getClassCopy.js.map +1 -0
  378. package/dist/util/getDesigntimePropertyAsArray.d.ts +2 -0
  379. package/dist/util/getDesigntimePropertyAsArray.js +4 -3
  380. package/dist/util/getDesigntimePropertyAsArray.js.map +1 -0
  381. package/dist/util/getEffectiveContentDensity.d.ts +2 -0
  382. package/dist/util/getEffectiveContentDensity.js +2 -3
  383. package/dist/util/getEffectiveContentDensity.js.map +1 -0
  384. package/dist/util/getEffectiveScrollbarStyle.d.ts +2 -0
  385. package/dist/util/getEffectiveScrollbarStyle.js +4 -0
  386. package/dist/util/getEffectiveScrollbarStyle.js.map +1 -0
  387. package/dist/util/getFastNavigationGroups.d.ts +2 -0
  388. package/dist/util/getFastNavigationGroups.js +51 -0
  389. package/dist/util/getFastNavigationGroups.js.map +1 -0
  390. package/dist/util/getFileExtension.d.ts +12 -0
  391. package/dist/util/getFileExtension.js +9 -11
  392. package/dist/util/getFileExtension.js.map +1 -0
  393. package/dist/util/getNormalizedTarget.d.ts +7 -0
  394. package/dist/util/getNormalizedTarget.js +14 -0
  395. package/dist/util/getNormalizedTarget.js.map +1 -0
  396. package/dist/util/getSingletonElementInstance.d.ts +2 -0
  397. package/dist/util/getSingletonElementInstance.js +7 -10
  398. package/dist/util/getSingletonElementInstance.js.map +1 -0
  399. package/dist/util/isElementClickable.d.ts +2 -0
  400. package/dist/util/isElementClickable.js +16 -0
  401. package/dist/util/isElementClickable.js.map +1 -0
  402. package/dist/util/isElementHidden.d.ts +2 -0
  403. package/dist/util/isElementHidden.js +8 -0
  404. package/dist/util/isElementHidden.js.map +1 -0
  405. package/dist/util/isElementInView.d.ts +6 -0
  406. package/dist/util/isElementInView.js +6 -9
  407. package/dist/util/isElementInView.js.map +1 -0
  408. package/dist/util/isElementTabbable.d.ts +9 -0
  409. package/dist/util/isElementTabbable.js +30 -0
  410. package/dist/util/isElementTabbable.js.map +1 -0
  411. package/dist/util/isValidPropertyName.d.ts +8 -0
  412. package/dist/util/isValidPropertyName.js +16 -17
  413. package/dist/util/isValidPropertyName.js.map +1 -0
  414. package/dist/util/whenDOMReady.d.ts +2 -0
  415. package/dist/util/whenDOMReady.js +11 -10
  416. package/dist/util/whenDOMReady.js.map +1 -0
  417. package/dist/util/willShowContent.d.ts +2 -0
  418. package/dist/util/willShowContent.js +7 -0
  419. package/dist/util/willShowContent.js.map +1 -0
  420. package/dist/validateThemeRoot.d.ts +2 -0
  421. package/dist/validateThemeRoot.js +47 -0
  422. package/dist/validateThemeRoot.js.map +1 -0
  423. package/global.d.ts +44 -0
  424. package/lib/generate-asset-parameters/index.js +8 -4
  425. package/lib/generate-styles/index.js +17 -9
  426. package/lib/generate-version-info/index.js +18 -13
  427. package/package-scripts.js +29 -29
  428. package/package.json +7 -6
  429. package/src/{AssetRegistry.js → AssetRegistry.ts} +0 -0
  430. package/src/Boot.ts +61 -0
  431. package/src/{CSP.js → CSP.ts} +14 -7
  432. package/src/{CustomElementsRegistry.js → CustomElementsRegistry.ts} +20 -17
  433. package/src/CustomElementsScope.ts +33 -0
  434. package/src/{CustomElementsScope.js → CustomElementsScopeUtils.ts} +14 -7
  435. package/src/DOMObserver.ts +28 -0
  436. package/src/{Device.js → Device.ts} +21 -13
  437. package/src/{EventProvider.js → EventProvider.ts} +9 -7
  438. package/src/FeaturesRegistry.ts +14 -0
  439. package/src/{FontFace.js → FontFace.ts} +3 -2
  440. package/src/{InitialConfiguration.js → InitialConfiguration.ts} +53 -12
  441. package/src/Keys.ts +295 -0
  442. package/src/ManagedStyles.ts +92 -0
  443. package/src/MarkedEvents.ts +20 -0
  444. package/src/{MediaRange.js → MediaRange.ts} +54 -53
  445. package/src/{PropertiesFileFormat.js → PropertiesFileFormat.ts} +8 -8
  446. package/src/{Render.js → Render.ts} +25 -20
  447. package/src/{RenderQueue.js → RenderQueue.ts} +10 -5
  448. package/src/{Runtimes.js → Runtimes.ts} +15 -8
  449. package/src/{StaticArea.js → StaticArea.ts} +0 -0
  450. package/src/{StaticAreaItem.js → StaticAreaItem.ts} +31 -19
  451. package/src/{SystemCSSVars.js → SystemCSSVars.ts} +0 -0
  452. package/src/{Theming.js → Theming.ts} +0 -0
  453. package/src/{UI5Element.js → UI5Element.ts} +280 -148
  454. package/src/{UI5ElementMetadata.js → UI5ElementMetadata.ts} +121 -59
  455. package/src/animations/{AnimationQueue.js → AnimationQueue.ts} +8 -7
  456. package/src/animations/animate.ts +64 -0
  457. package/src/animations/scroll.ts +21 -0
  458. package/src/animations/{slideDown.js → slideDown.ts} +27 -34
  459. package/src/animations/{slideUp.js → slideUp.ts} +28 -32
  460. package/src/asset-registries/Icons.ts +162 -0
  461. package/src/asset-registries/Illustrations.ts +75 -0
  462. package/src/asset-registries/{LocaleData.js → LocaleData.ts} +42 -29
  463. package/src/asset-registries/Themes.ts +67 -0
  464. package/src/asset-registries/{i18n.js → i18n.ts} +21 -24
  465. package/src/assets-meta/{IconCollectionsAlias.js → IconCollectionsAlias.ts} +0 -0
  466. package/src/config/AnimationMode.ts +33 -0
  467. package/src/config/{CalendarType.js → CalendarType.ts} +8 -3
  468. package/src/config/FormatSettings.ts +21 -0
  469. package/src/config/Icons.ts +59 -0
  470. package/src/config/{Language.js → Language.ts} +22 -18
  471. package/src/config/NoConflict.ts +67 -0
  472. package/src/config/{RTL.js → RTL.ts} +14 -4
  473. package/src/config/Theme.ts +64 -0
  474. package/src/config/ThemeRoots.ts +41 -0
  475. package/src/css/BusyIndicator.css +80 -0
  476. package/src/css/FontFace.css +31 -10
  477. package/src/decorators/customElement.ts +17 -0
  478. package/src/decorators/event.ts +28 -0
  479. package/src/decorators/fastNavigation.ts +14 -0
  480. package/src/decorators/languageAware.ts +14 -0
  481. package/src/decorators/property.ts +30 -0
  482. package/src/decorators/slot.ts +49 -0
  483. package/src/decorators/themeAware.ts +14 -0
  484. package/src/delegate/{ItemNavigation.js → ItemNavigation.ts} +65 -23
  485. package/src/delegate/{ResizeHandler.js → ResizeHandler.ts} +25 -36
  486. package/src/delegate/ScrollEnablement.ts +221 -0
  487. package/src/features/F6Navigation.ts +141 -0
  488. package/src/features/OpenUI5Element.ts +11 -0
  489. package/src/features/OpenUI5Enablement.ts +117 -0
  490. package/src/features/OpenUI5Support.ts +148 -0
  491. package/src/{getSharedResource.js → getSharedResource.ts} +3 -3
  492. package/src/{i18nBundle.js → i18nBundle.ts} +44 -22
  493. package/src/locale/{Locale.js → Locale.ts} +15 -5
  494. package/src/locale/RTLAwareRegistry.ts +16 -0
  495. package/src/locale/{applyDirection.js → applyDirection.ts} +4 -3
  496. package/src/locale/{directionChange.js → directionChange.ts} +6 -4
  497. package/src/locale/{getEffectiveDir.js → getEffectiveDir.ts} +1 -1
  498. package/src/locale/{getLocale.js → getLocale.ts} +12 -7
  499. package/src/locale/languageChange.ts +24 -0
  500. package/src/locale/{nextFallbackLocale.js → nextFallbackLocale.ts} +1 -1
  501. package/src/locale/{normalizeLocale.js → normalizeLocale.ts} +5 -3
  502. package/src/renderer/LitRenderer.ts +60 -0
  503. package/src/renderer/executeTemplate.ts +40 -0
  504. package/src/theming/{CustomStyle.js → CustomStyle.ts} +11 -9
  505. package/src/theming/{ThemeLoaded.js → ThemeLoaded.ts} +6 -4
  506. package/src/theming/{applyTheme.js → applyTheme.ts} +22 -11
  507. package/src/theming/{getConstructableStyle.js → getConstructableStyle.ts} +5 -4
  508. package/src/theming/getEffectiveLinksHrefs.ts +26 -0
  509. package/src/theming/{getEffectiveStyle.js → getEffectiveStyle.ts} +15 -4
  510. package/src/theming/getStylesString.ts +15 -0
  511. package/src/theming/{getThemeDesignerTheme.js → getThemeDesignerTheme.ts} +22 -8
  512. package/src/theming/{preloadLinks.js → preloadLinks.ts} +3 -2
  513. package/src/thirdparty/{_merge.js → _merge.ts} +2 -2
  514. package/src/thirdparty/{isPlainObject.js → isPlainObject.ts} +1 -1
  515. package/src/thirdparty/merge.ts +5 -0
  516. package/src/types/AnimationMode.ts +33 -0
  517. package/src/types/{CSSColor.js → CSSColor.ts} +12 -1
  518. package/src/types/CalendarType.ts +38 -0
  519. package/src/types/DOMReference.ts +28 -0
  520. package/src/types/DataType.ts +51 -0
  521. package/src/types/Float.ts +25 -0
  522. package/src/types/Integer.ts +25 -0
  523. package/src/types/InvisibleMessageMode.ts +27 -0
  524. package/src/types/ItemNavigationBehavior.ts +26 -0
  525. package/src/types/NavigationMode.ts +33 -0
  526. package/src/types/ValueState.ts +47 -0
  527. package/src/types.ts +30 -0
  528. package/src/updateShadowRoot.ts +37 -0
  529. package/src/util/AriaLabelHelper.ts +63 -0
  530. package/src/util/Caret.ts +28 -0
  531. package/src/util/ColorConversion.ts +399 -0
  532. package/src/util/{FetchHelper.js → FetchHelper.ts} +7 -7
  533. package/src/util/FocusableElements.ts +82 -0
  534. package/src/util/{HTMLSanitizer.js → HTMLSanitizer.ts} +2 -0
  535. package/src/util/{InvisibleMessage.js → InvisibleMessage.ts} +15 -6
  536. package/src/util/PopupUtils.ts +112 -0
  537. package/src/util/{SlotsHelper.js → SlotsHelper.ts} +9 -13
  538. package/src/util/{StringHelper.js → StringHelper.ts} +7 -7
  539. package/src/util/TabbableElements.ts +70 -0
  540. package/src/util/{arraysAreEqual.js → arraysAreEqual.ts} +1 -1
  541. package/src/util/{clamp.js → clamp.ts} +1 -1
  542. package/src/util/{createLinkInHead.js → createLinkInHead.ts} +10 -4
  543. package/src/util/{createStyleInHead.js → createStyleInHead.ts} +4 -2
  544. package/src/util/{debounce.js → debounce.ts} +5 -4
  545. package/src/util/{detectNavigatorLanguage.js → detectNavigatorLanguage.ts} +1 -1
  546. package/src/util/escapeRegex.ts +11 -0
  547. package/src/util/{formatMessage.js → formatMessage.ts} +4 -3
  548. package/src/util/{generateHighlightedMarkup.js → generateHighlightedMarkup.ts} +7 -6
  549. package/src/util/{getActiveElement.js → getActiveElement.ts} +0 -0
  550. package/src/util/{getClassCopy.js → getClassCopy.ts} +3 -1
  551. package/src/util/{getDesigntimePropertyAsArray.js → getDesigntimePropertyAsArray.ts} +1 -1
  552. package/src/util/getEffectiveContentDensity.ts +5 -0
  553. package/src/util/getEffectiveScrollbarStyle.ts +5 -0
  554. package/src/util/getFastNavigationGroups.ts +63 -0
  555. package/src/util/{getFileExtension.js → getFileExtension.ts} +3 -3
  556. package/src/util/getNormalizedTarget.ts +16 -0
  557. package/src/util/{getSingletonElementInstance.js → getSingletonElementInstance.ts} +1 -1
  558. package/src/util/isElementClickable.ts +19 -0
  559. package/src/util/isElementHidden.ts +9 -0
  560. package/src/util/{isElementInView.js → isElementInView.ts} +1 -1
  561. package/src/util/isElementTabbable.ts +37 -0
  562. package/src/util/{isValidPropertyName.js → isValidPropertyName.ts} +1 -1
  563. package/src/util/{whenDOMReady.js → whenDOMReady.ts} +1 -1
  564. package/src/util/willShowContent.ts +7 -0
  565. package/src/validateThemeRoot.ts +58 -0
  566. package/tsconfig.json +13 -0
  567. package/config/.eslintrc.js +0 -3
  568. package/config/rollup.config.js +0 -1
  569. package/dist/RenderScheduler.js +0 -44
  570. package/dist/animations/config.js +0 -5
  571. package/dist/isLegacyBrowser.js +0 -3
  572. package/dist/resources/bundle.esm.js +0 -37
  573. package/dist/resources/bundle.esm.js.map +0 -1
  574. package/dist/test-resources/assets/Themes.js +0 -17
  575. package/dist/test-resources/elements/Child.js +0 -35
  576. package/dist/test-resources/elements/Generic.js +0 -84
  577. package/dist/test-resources/elements/GenericExt.js +0 -26
  578. package/dist/test-resources/elements/NoShadowDOM.js +0 -13
  579. package/dist/test-resources/elements/Parent.js +0 -41
  580. package/dist/test-resources/elements/WithStaticArea.js +0 -77
  581. package/dist/test-resources/pages/AllTestElements.html +0 -42
  582. package/dist/test-resources/pages/Configuration.html +0 -18
  583. package/dist/test-resources/pages/ConfigurationScript.html +0 -34
  584. package/dist/test-resources/pages/assets/messagebundle_de.properties +0 -1
  585. package/dist/test-resources/pages/assets/messagebundle_en.properties +0 -1
  586. package/dist/test-resources/pages/assets/messagebundle_es.properties +0 -1
  587. package/dist/test-resources/pages/assets/messagebundle_fr.properties +0 -1
  588. package/dist/test-resources/pages/i18n.html +0 -33
  589. package/dist/test-resources/specs/ConfigurationChange.spec.js +0 -27
  590. package/dist/test-resources/specs/ConfigurationScript.spec.js +0 -63
  591. package/dist/test-resources/specs/ConfigurationURL.spec.js +0 -93
  592. package/dist/test-resources/specs/CustomTheme.spec.js +0 -27
  593. package/dist/test-resources/specs/EventProvider.spec.js +0 -63
  594. package/dist/test-resources/specs/StaticArea.spec.js +0 -78
  595. package/dist/test-resources/specs/Theming.spec.js +0 -33
  596. package/dist/test-resources/specs/UI5ElementInvalidation.js +0 -242
  597. package/dist/test-resources/specs/UI5ElementLifecycle.js +0 -98
  598. package/dist/test-resources/specs/UI5ElementListenForChildPropChanges.spec.js +0 -75
  599. package/dist/test-resources/specs/UI5ElementMetadataExt.js +0 -42
  600. package/dist/test-resources/specs/UI5ElementPropertyValidation.js +0 -14
  601. package/dist/test-resources/specs/UI5ElementPropsAndAttrs.spec.js +0 -67
  602. package/dist/test-resources/specs/UI5ElementShadowDOM.js +0 -24
  603. package/dist/test-resources/specs/UI5ElementSlots.js +0 -36
  604. package/dist/types/CSSSize.js +0 -9
  605. package/dist/types/PopupState.js +0 -37
  606. package/dist/util/findNodeOwner.js +0 -35
  607. package/dist/util/isDescendantOf.js +0 -15
  608. package/dist/util/isNodeClickable.js +0 -19
  609. package/dist/util/isNodeHidden.js +0 -9
  610. package/dist/util/isNodeTabbable.js +0 -28
  611. package/dist/util/setToArray.js +0 -10
  612. package/hash.txt +0 -1
  613. package/src/Boot.js +0 -59
  614. package/src/DOMObserver.js +0 -65
  615. package/src/FeaturesRegistry.js +0 -14
  616. package/src/Keys.js +0 -280
  617. package/src/ManagedStyles.js +0 -83
  618. package/src/RenderScheduler.js +0 -44
  619. package/src/animations/animate.js +0 -53
  620. package/src/animations/config.js +0 -5
  621. package/src/animations/scroll.js +0 -28
  622. package/src/asset-registries/Icons.js +0 -139
  623. package/src/asset-registries/Illustrations.js +0 -30
  624. package/src/asset-registries/Themes.js +0 -78
  625. package/src/config/AnimationMode.js +0 -23
  626. package/src/config/FormatSettings.js +0 -13
  627. package/src/config/NoConflict.js +0 -51
  628. package/src/config/Theme.js +0 -42
  629. package/src/delegate/ScrollEnablement.js +0 -188
  630. package/src/features/F6Navigation.js +0 -106
  631. package/src/features/OpenUI5Support.js +0 -125
  632. package/src/isLegacyBrowser.js +0 -3
  633. package/src/locale/RTLAwareRegistry.js +0 -14
  634. package/src/locale/languageChange.js +0 -22
  635. package/src/renderer/LitRenderer.js +0 -34
  636. package/src/renderer/executeTemplate.js +0 -17
  637. package/src/theming/getEffectiveLinksHrefs.js +0 -20
  638. package/src/theming/getStylesString.js +0 -15
  639. package/src/thirdparty/merge.js +0 -10
  640. package/src/types/AnimationMode.js +0 -7
  641. package/src/types/CSSSize.js +0 -9
  642. package/src/types/CalendarType.js +0 -22
  643. package/src/types/DataType.js +0 -37
  644. package/src/types/Float.js +0 -14
  645. package/src/types/Integer.js +0 -13
  646. package/src/types/InvisibleMessageMode.js +0 -30
  647. package/src/types/ItemNavigationBehavior.js +0 -16
  648. package/src/types/NavigationMode.js +0 -7
  649. package/src/types/PopupState.js +0 -37
  650. package/src/types/ValueState.js +0 -22
  651. package/src/updateShadowRoot.js +0 -30
  652. package/src/util/AriaLabelHelper.js +0 -41
  653. package/src/util/Caret.js +0 -45
  654. package/src/util/ColorConversion.js +0 -370
  655. package/src/util/FocusableElements.js +0 -79
  656. package/src/util/PopupUtils.js +0 -93
  657. package/src/util/TabbableElements.js +0 -51
  658. package/src/util/escapeRegex.js +0 -10
  659. package/src/util/findNodeOwner.js +0 -35
  660. package/src/util/getEffectiveContentDensity.js +0 -5
  661. package/src/util/isDescendantOf.js +0 -15
  662. package/src/util/isNodeClickable.js +0 -19
  663. package/src/util/isNodeHidden.js +0 -9
  664. package/src/util/isNodeTabbable.js +0 -28
  665. package/src/util/setToArray.js +0 -10
@@ -10,1014 +10,958 @@ import { registerTag, isTagRegistered, recordTagRegistrationFailure } from "./Cu
10
10
  import { observeDOMNode, unobserveDOMNode } from "./DOMObserver.js";
11
11
  import { skipOriginalEvent } from "./config/NoConflict.js";
12
12
  import getEffectiveDir from "./locale/getEffectiveDir.js";
13
- import DataType from "./types/DataType.js";
14
13
  import { kebabToCamelCase, camelToKebabCase } from "./util/StringHelper.js";
15
14
  import isValidPropertyName from "./util/isValidPropertyName.js";
16
- import isDescendantOf from "./util/isDescendantOf.js";
17
- import { isSlot, getSlotName, getSlottedElementsList } from "./util/SlotsHelper.js";
15
+ import { getSlotName, getSlottedNodesList } from "./util/SlotsHelper.js";
18
16
  import arraysAreEqual from "./util/arraysAreEqual.js";
19
- import getClassCopy from "./util/getClassCopy.js";
20
17
  import { markAsRtlAware } from "./locale/RTLAwareRegistry.js";
21
18
  import preloadLinks from "./theming/preloadLinks.js";
22
-
23
19
  let autoId = 0;
24
-
25
20
  const elementTimeouts = new Map();
26
21
  const uniqueDependenciesCache = new Map();
27
-
28
22
  /**
29
23
  * Triggers re-rendering of a UI5Element instance due to state change.
30
- *
31
- * @param changeInfo An object with information about the change that caused invalidation.
24
+ * @param {ChangeInfo} changeInfo An object with information about the change that caused invalidation.
32
25
  * @private
33
26
  */
34
27
  function _invalidate(changeInfo) {
35
- // Invalidation should be suppressed: 1) before the component is rendered for the first time 2) and during the execution of onBeforeRendering
36
- // This is necessary not only as an optimization, but also to avoid infinite loops on invalidation between children and parents (when invalidateOnChildChange is used)
37
- if (this._suppressInvalidation) {
38
- return;
39
- }
40
-
41
- // Call the onInvalidation hook
42
- this.onInvalidation(changeInfo);
43
-
44
- this._changedState.push(changeInfo);
45
- renderDeferred(this);
46
- this._eventProvider.fireEvent("invalidate", { ...changeInfo, target: this });
28
+ // Invalidation should be suppressed: 1) before the component is rendered for the first time 2) and during the execution of onBeforeRendering
29
+ // This is necessary not only as an optimization, but also to avoid infinite loops on invalidation between children and parents (when invalidateOnChildChange is used)
30
+ if (this._suppressInvalidation) {
31
+ return;
32
+ }
33
+ // Call the onInvalidation hook
34
+ this.onInvalidation(changeInfo);
35
+ this._changedState.push(changeInfo);
36
+ renderDeferred(this);
37
+ this._eventProvider.fireEvent("invalidate", { ...changeInfo, target: this });
47
38
  }
48
-
39
+ let metadata = {};
49
40
  /**
50
41
  * Base class for all UI5 Web Components
51
42
  *
52
43
  * @class
53
44
  * @constructor
54
45
  * @author SAP SE
55
- * @alias sap.ui.webcomponents.base.UI5Element
46
+ * @alias sap.ui.webc.base.UI5Element
56
47
  * @extends HTMLElement
57
48
  * @public
58
49
  */
59
50
  class UI5Element extends HTMLElement {
60
- constructor() {
61
- super();
62
-
63
- this._changedState = []; // Filled on each invalidation, cleared on re-render (used for debugging)
64
- this._suppressInvalidation = true; // A flag telling whether all invalidations should be ignored. Initialized with "true" because a UI5Element can not be invalidated until it is rendered for the first time
65
- this._inDOM = false; // A flag telling whether the UI5Element is currently in the DOM tree of the document or not
66
- this._fullyConnected = false; // A flag telling whether the UI5Element's onEnterDOM hook was called (since it's possible to have the element removed from DOM before that)
67
- this._childChangeListeners = new Map(); // used to store lazy listeners per slot for the child change event of every child inside that slot
68
- this._slotChangeListeners = new Map(); // used to store lazy listeners per slot for the slotchange event of all slot children inside that slot
69
- this._eventProvider = new EventProvider(); // used by parent components for listening to changes to child components
70
- let deferredResolve;
71
- this._domRefReadyPromise = new Promise(resolve => {
72
- deferredResolve = resolve;
73
- });
74
- this._domRefReadyPromise._deferredResolve = deferredResolve;
75
-
76
- this._initializeState();
77
- this._upgradeAllProperties();
78
-
79
- if (this.constructor._needsShadowDOM()) {
80
- this.attachShadow({ mode: "open" });
81
- }
82
- }
83
-
84
- /**
85
- * Returns a unique ID for this UI5 Element
86
- *
87
- * @deprecated - This property is not guaranteed in future releases
88
- * @protected
89
- */
90
- get _id() {
91
- if (!this.__id) {
92
- this.__id = `ui5wc_${++autoId}`;
93
- }
94
-
95
- return this.__id;
96
- }
97
-
98
- /**
99
- * Do not call this method from derivatives of UI5Element, use "onEnterDOM" only
100
- * @private
101
- */
102
- async connectedCallback() {
103
- this.setAttribute(this.constructor.getMetadata().getPureTag(), "");
104
- if (this.constructor.getMetadata().supportsF6FastNavigation()) {
105
- this.setAttribute("data-sap-ui-fastnavgroup", "true");
106
- }
107
-
108
- const slotsAreManaged = this.constructor.getMetadata().slotsAreManaged();
109
-
110
- this._inDOM = true;
111
-
112
- if (slotsAreManaged) {
113
- // always register the observer before yielding control to the main thread (await)
114
- this._startObservingDOMChildren();
115
- await this._processChildren();
116
- }
117
-
118
- if (!this._inDOM) { // Component removed from DOM while _processChildren was running
119
- return;
120
- }
121
-
122
- renderImmediately(this);
123
- this._domRefReadyPromise._deferredResolve();
124
- this._fullyConnected = true;
125
- if (typeof this.onEnterDOM === "function") {
126
- this.onEnterDOM();
127
- }
128
- }
129
-
130
- /**
131
- * Do not call this method from derivatives of UI5Element, use "onExitDOM" only
132
- * @private
133
- */
134
- disconnectedCallback() {
135
- const slotsAreManaged = this.constructor.getMetadata().slotsAreManaged();
136
-
137
- this._inDOM = false;
138
-
139
- if (slotsAreManaged) {
140
- this._stopObservingDOMChildren();
141
- }
142
-
143
- if (this._fullyConnected) {
144
- if (typeof this.onExitDOM === "function") {
145
- this.onExitDOM();
146
- }
147
- this._fullyConnected = false;
148
- }
149
-
150
- if (this.staticAreaItem && this.staticAreaItem.parentElement) {
151
- this.staticAreaItem.parentElement.removeChild(this.staticAreaItem);
152
- }
153
-
154
- cancelRender(this);
155
- }
156
-
157
- /**
158
- * @private
159
- */
160
- _startObservingDOMChildren() {
161
- const shouldObserveChildren = this.constructor.getMetadata().hasSlots();
162
- if (!shouldObserveChildren) {
163
- return;
164
- }
165
-
166
- const canSlotText = this.constructor.getMetadata().canSlotText();
167
- const mutationObserverOptions = {
168
- childList: true,
169
- subtree: canSlotText,
170
- characterData: canSlotText,
171
- };
172
- observeDOMNode(this, this._processChildren.bind(this), mutationObserverOptions);
173
- }
174
-
175
- /**
176
- * @private
177
- */
178
- _stopObservingDOMChildren() {
179
- unobserveDOMNode(this);
180
- }
181
-
182
- /**
183
- * Note: this method is also manually called by "compatibility/patchNodeValue.js"
184
- * @private
185
- */
186
- async _processChildren() {
187
- const hasSlots = this.constructor.getMetadata().hasSlots();
188
- if (hasSlots) {
189
- await this._updateSlots();
190
- }
191
- }
192
-
193
- /**
194
- * @private
195
- */
196
- async _updateSlots() {
197
- const slotsMap = this.constructor.getMetadata().getSlots();
198
- const canSlotText = this.constructor.getMetadata().canSlotText();
199
- const domChildren = Array.from(canSlotText ? this.childNodes : this.children);
200
-
201
- const slotsCachedContentMap = new Map(); // Store here the content of each slot before the mutation occurred
202
- const propertyNameToSlotMap = new Map(); // Used for reverse lookup to determine to which slot the property name corresponds
203
-
204
- // Init the _state object based on the supported slots and store the previous values
205
- for (const [slotName, slotData] of Object.entries(slotsMap)) { // eslint-disable-line
206
- const propertyName = slotData.propertyName || slotName;
207
- propertyNameToSlotMap.set(propertyName, slotName);
208
- slotsCachedContentMap.set(propertyName, [...this._state[propertyName]]);
209
- this._clearSlot(slotName, slotData);
210
- }
211
-
212
- const autoIncrementMap = new Map();
213
- const slottedChildrenMap = new Map();
214
-
215
- const allChildrenUpgraded = domChildren.map(async (child, idx) => {
216
- // Determine the type of the child (mainly by the slot attribute)
217
- const slotName = getSlotName(child);
218
- const slotData = slotsMap[slotName];
219
-
220
- // Check if the slotName is supported
221
- if (slotData === undefined) {
222
- const validValues = Object.keys(slotsMap).join(", ");
223
- console.warn(`Unknown slotName: ${slotName}, ignoring`, child, `Valid values are: ${validValues}`); // eslint-disable-line
224
- return;
225
- }
226
-
227
- // For children that need individual slots, calculate them
228
- if (slotData.individualSlots) {
229
- const nextIndex = (autoIncrementMap.get(slotName) || 0) + 1;
230
- autoIncrementMap.set(slotName, nextIndex);
231
- child._individualSlot = `${slotName}-${nextIndex}`;
232
- }
233
-
234
- // Await for not-yet-defined custom elements
235
- if (child instanceof HTMLElement) {
236
- const localName = child.localName;
237
- const isCustomElement = localName.includes("-");
238
- if (isCustomElement) {
239
- const isDefined = window.customElements.get(localName);
240
- if (!isDefined) {
241
- const whenDefinedPromise = window.customElements.whenDefined(localName); // Class registered, but instances not upgraded yet
242
- let timeoutPromise = elementTimeouts.get(localName);
243
- if (!timeoutPromise) {
244
- timeoutPromise = new Promise(resolve => setTimeout(resolve, 1000));
245
- elementTimeouts.set(localName, timeoutPromise);
246
- }
247
- await Promise.race([whenDefinedPromise, timeoutPromise]);
248
- }
249
- window.customElements.upgrade(child);
250
- }
251
- }
252
-
253
- child = this.constructor.getMetadata().constructor.validateSlotValue(child, slotData);
254
-
255
- // Listen for any invalidation on the child if invalidateOnChildChange is true or an object (ignore when false or not set)
256
- if (child.isUI5Element && slotData.invalidateOnChildChange) {
257
- const method = (child.attachInvalidate || child._attachChange).bind(child);
258
- method(this._getChildChangeListener(slotName));
259
- }
260
-
261
- // Listen for the slotchange event if the child is a slot itself
262
- if (isSlot(child)) {
263
- this._attachSlotChange(child, slotName);
264
- }
265
-
266
- const propertyName = slotData.propertyName || slotName;
267
-
268
- if (slottedChildrenMap.has(propertyName)) {
269
- slottedChildrenMap.get(propertyName).push({ child, idx });
270
- } else {
271
- slottedChildrenMap.set(propertyName, [{ child, idx }]);
272
- }
273
- });
274
-
275
- await Promise.all(allChildrenUpgraded);
276
-
277
- // Distribute the child in the _state object, keeping the Light DOM order,
278
- // not the order elements are defined.
279
- slottedChildrenMap.forEach((children, propertyName) => {
280
- this._state[propertyName] = children.sort((a, b) => a.idx - b.idx).map(_ => _.child);
281
- });
282
-
283
- // Compare the content of each slot with the cached values and invalidate for the ones that changed
284
- let invalidated = false;
285
- for (const [slotName, slotData] of Object.entries(slotsMap)) { // eslint-disable-line
286
- const propertyName = slotData.propertyName || slotName;
287
- if (!arraysAreEqual(slotsCachedContentMap.get(propertyName), this._state[propertyName])) {
288
- _invalidate.call(this, {
289
- type: "slot",
290
- name: propertyNameToSlotMap.get(propertyName),
291
- reason: "children",
292
- });
293
- invalidated = true;
294
- }
295
- }
296
-
297
- // If none of the slots had an invalidation due to changes to immediate children,
298
- // the change is considered to be text content of the default slot
299
- if (!invalidated) {
300
- _invalidate.call(this, {
301
- type: "slot",
302
- name: "default",
303
- reason: "textcontent",
304
- });
305
- }
306
- }
307
-
308
- /**
309
- * Removes all children from the slot and detaches listeners, if any
310
- * @private
311
- */
312
- _clearSlot(slotName, slotData) {
313
- const propertyName = slotData.propertyName || slotName;
314
- const children = this._state[propertyName];
315
-
316
- children.forEach(child => {
317
- if (child && child.isUI5Element) {
318
- const method = (child.detachInvalidate || child._detachChange).bind(child);
319
- method(this._getChildChangeListener(slotName));
320
- }
321
-
322
- if (isSlot(child)) {
323
- this._detachSlotChange(child, slotName);
324
- }
325
- });
326
-
327
- this._state[propertyName] = [];
328
- }
329
-
330
- /**
331
- * Attach a callback that will be executed whenever the component is invalidated
332
- *
333
- * @param callback
334
- * @public
335
- */
336
- attachInvalidate(callback) {
337
- this._eventProvider.attachEvent("invalidate", callback);
338
- }
339
-
340
- /**
341
- * Detach the callback that is executed whenever the component is invalidated
342
- *
343
- * @param callback
344
- * @public
345
- */
346
- detachInvalidate(callback) {
347
- this._eventProvider.detachEvent("invalidate", callback);
348
- }
349
-
350
- /**
351
- * Callback that is executed whenever a monitored child changes its state
352
- *
353
- * @param slotName the slot in which a child was invalidated
354
- * @param childChangeInfo the changeInfo object for the child in the given slot
355
- * @private
356
- */
357
- _onChildChange(slotName, childChangeInfo) {
358
- if (!this.constructor.getMetadata().shouldInvalidateOnChildChange(slotName, childChangeInfo.type, childChangeInfo.name)) {
359
- return;
360
- }
361
-
362
- // The component should be invalidated as this type of change on the child is listened for
363
- // However, no matter what changed on the child (property/slot), the invalidation is registered as "type=slot" for the component itself
364
- _invalidate.call(this, {
365
- type: "slot",
366
- name: slotName,
367
- reason: "childchange",
368
- child: childChangeInfo.target,
369
- });
370
- }
371
-
372
- /**
373
- * Do not override this method in derivatives of UI5Element
374
- * @private
375
- */
376
- attributeChangedCallback(name, oldValue, newValue) {
377
- const properties = this.constructor.getMetadata().getProperties();
378
- const realName = name.replace(/^ui5-/, "");
379
- const nameInCamelCase = kebabToCamelCase(realName);
380
- if (properties.hasOwnProperty(nameInCamelCase)) { // eslint-disable-line
381
- const propertyTypeClass = properties[nameInCamelCase].type;
382
- if (propertyTypeClass === Boolean) {
383
- newValue = newValue !== null;
384
- } else if (isDescendantOf(propertyTypeClass, DataType)) {
385
- newValue = propertyTypeClass.attributeToProperty(newValue);
386
- }
387
- this[nameInCamelCase] = newValue;
388
- }
389
- }
390
-
391
- /**
392
- * @private
393
- */
394
- _updateAttribute(name, newValue) {
395
- if (!this.constructor.getMetadata().hasAttribute(name)) {
396
- return;
397
- }
398
- const properties = this.constructor.getMetadata().getProperties();
399
- const propertyTypeClass = properties[name].type;
400
- const attrName = camelToKebabCase(name);
401
- const attrValue = this.getAttribute(attrName);
402
-
403
- if (propertyTypeClass === Boolean) {
404
- if (newValue === true && attrValue === null) {
405
- this.setAttribute(attrName, "");
406
- } else if (newValue === false && attrValue !== null) {
407
- this.removeAttribute(attrName);
408
- }
409
- } else if (isDescendantOf(propertyTypeClass, DataType)) {
410
- this.setAttribute(attrName, propertyTypeClass.propertyToAttribute(newValue));
411
- } else if (typeof newValue !== "object") {
412
- if (attrValue !== newValue) {
413
- this.setAttribute(attrName, newValue);
414
- }
415
- } // else { return; } // old object handling
416
- }
417
-
418
- /**
419
- * @private
420
- */
421
- _upgradeProperty(prop) {
422
- if (this.hasOwnProperty(prop)) { // eslint-disable-line
423
- const value = this[prop];
424
- delete this[prop];
425
- this[prop] = value;
426
- }
427
- }
428
-
429
- /**
430
- * @private
431
- */
432
- _upgradeAllProperties() {
433
- const allProps = this.constructor.getMetadata().getPropertiesList();
434
- allProps.forEach(this._upgradeProperty, this);
435
- }
436
-
437
- /**
438
- * @private
439
- */
440
- _initializeState() {
441
- this._state = { ...this.constructor.getMetadata().getInitialState() };
442
- }
443
-
444
- /**
445
- * Returns a singleton event listener for the "change" event of a child in a given slot
446
- *
447
- * @param slotName the name of the slot, where the child is
448
- * @returns {any}
449
- * @private
450
- */
451
- _getChildChangeListener(slotName) {
452
- if (!this._childChangeListeners.has(slotName)) {
453
- this._childChangeListeners.set(slotName, this._onChildChange.bind(this, slotName));
454
- }
455
- return this._childChangeListeners.get(slotName);
456
- }
457
-
458
- /**
459
- * Returns a singleton slotchange event listener that invalidates the component due to changes in the given slot
460
- *
461
- * @param slotName the name of the slot, where the slot element (whose slotchange event we're listening to) is
462
- * @returns {any}
463
- * @private
464
- */
465
- _getSlotChangeListener(slotName) {
466
- if (!this._slotChangeListeners.has(slotName)) {
467
- this._slotChangeListeners.set(slotName, this._onSlotChange.bind(this, slotName));
468
- }
469
- return this._slotChangeListeners.get(slotName);
470
- }
471
-
472
- /**
473
- * @private
474
- */
475
- _attachSlotChange(child, slotName) {
476
- child.addEventListener("slotchange", this._getSlotChangeListener(slotName));
477
- }
478
-
479
- /**
480
- * @private
481
- */
482
- _detachSlotChange(child, slotName) {
483
- child.removeEventListener("slotchange", this._getSlotChangeListener(slotName));
484
- }
485
-
486
- /**
487
- * Whenever a slot element is slotted inside a UI5 Web Component, its slotchange event invalidates the component
488
- *
489
- * @param slotName the name of the slot, where the slot element (whose slotchange event we're listening to) is
490
- * @private
491
- */
492
- _onSlotChange(slotName) {
493
- _invalidate.call(this, {
494
- type: "slot",
495
- name: slotName,
496
- reason: "slotchange",
497
- });
498
- }
499
-
500
- /**
501
- * A callback that is executed each time an already rendered component is invalidated (scheduled for re-rendering)
502
- *
503
- * @param changeInfo An object with information about the change that caused invalidation.
504
- * The object can have the following properties:
505
- * - type: (property|slot) tells what caused the invalidation
506
- * 1) property: a property value was changed either directly or as a result of changing the corresponding attribute
507
- * 2) slot: a slotted node(nodes) changed in one of several ways (see "reason")
508
- *
509
- * - name: the name of the property or slot that caused the invalidation
510
- *
511
- * - reason: (children|textcontent|childchange|slotchange) relevant only for type="slot" only and tells exactly what changed in the slot
512
- * 1) children: immediate children (HTML elements or text nodes) were added, removed or reordered in the slot
513
- * 2) textcontent: text nodes in the slot changed value (or nested text nodes were added or changed value). Can only trigger for slots of "type: Node"
514
- * 3) slotchange: a slot element, slotted inside that slot had its "slotchange" event listener called. This practically means that transitively slotted children changed.
515
- * Can only trigger if the child of a slot is a slot element itself.
516
- * 4) childchange: indicates that a UI5Element child in that slot was invalidated and in turn invalidated the component.
517
- * Can only trigger for slots with "invalidateOnChildChange" metadata descriptor
518
- *
519
- * - newValue: the new value of the property (for type="property" only)
520
- *
521
- * - oldValue: the old value of the property (for type="property" only)
522
- *
523
- * - child the child that was changed (for type="slot" and reason="childchange" only)
524
- *
525
- * @public
526
- */
527
- onInvalidation(changeInfo) {}
528
-
529
- /**
530
- * Do not call this method directly, only intended to be called by js
531
- * @protected
532
- */
533
- _render() {
534
- const hasIndividualSlots = this.constructor.getMetadata().hasIndividualSlots();
535
-
536
- // suppress invalidation to prevent state changes scheduling another rendering
537
- this._suppressInvalidation = true;
538
-
539
- if (typeof this.onBeforeRendering === "function") {
540
- this.onBeforeRendering();
541
- }
542
-
543
- // Intended for framework usage only. Currently ItemNavigation updates tab indexes after the component has updated its state but before the template is rendered
544
- if (this._onComponentStateFinalized) {
545
- this._onComponentStateFinalized();
546
- }
547
-
548
- // resume normal invalidation handling
549
- this._suppressInvalidation = false;
550
-
551
- // Update the shadow root with the render result
552
- /*
553
- if (this._changedState.length) {
554
- let element = this.localName;
555
- if (this.id) {
556
- element = `${element}#${this.id}`;
557
- }
558
- console.log("Re-rendering:", element, this._changedState.map(x => { // eslint-disable-line
559
- let res = `${x.type}`;
560
- if (x.reason) {
561
- res = `${res}(${x.reason})`;
562
- }
563
- res = `${res}: ${x.name}`;
564
- if (x.type === "property") {
565
- res = `${res} ${x.oldValue} => ${x.newValue}`;
566
- }
567
-
568
- return res;
569
- }));
570
- }
571
- */
572
- this._changedState = [];
573
-
574
- // Update shadow root and static area item
575
- if (this.constructor._needsShadowDOM()) {
576
- updateShadowRoot(this);
577
- }
578
- if (this.staticAreaItem) {
579
- this.staticAreaItem.update();
580
- }
581
-
582
- // Safari requires that children get the slot attribute only after the slot tags have been rendered in the shadow DOM
583
- if (hasIndividualSlots) {
584
- this._assignIndividualSlotsToChildren();
585
- }
586
-
587
- // Call the onAfterRendering hook
588
- if (typeof this.onAfterRendering === "function") {
589
- this.onAfterRendering();
590
- }
591
- }
592
-
593
- /**
594
- * @private
595
- */
596
- _assignIndividualSlotsToChildren() {
597
- const domChildren = Array.from(this.children);
598
-
599
- domChildren.forEach(child => {
600
- if (child._individualSlot) {
601
- child.setAttribute("slot", child._individualSlot);
602
- }
603
- });
604
- }
605
-
606
- /**
607
- * @private
608
- */
609
- _waitForDomRef() {
610
- return this._domRefReadyPromise;
611
- }
612
-
613
- /**
614
- * Returns the DOM Element inside the Shadow Root that corresponds to the opening tag in the UI5 Web Component's template
615
- * *Note:* For logical (abstract) elements (items, options, etc...), returns the part of the parent's DOM that represents this option
616
- * Use this method instead of "this.shadowRoot" to read the Shadow DOM, if ever necessary
617
- *
618
- * @public
619
- */
620
- getDomRef() {
621
- // If a component set _getRealDomRef to its children, use the return value of this function
622
- if (typeof this._getRealDomRef === "function") {
623
- return this._getRealDomRef();
624
- }
625
-
626
- if (!this.shadowRoot || this.shadowRoot.children.length === 0) {
627
- return;
628
- }
629
-
630
- const children = [...this.shadowRoot.children].filter(child => !["link", "style"].includes(child.localName));
631
- if (children.length !== 1) {
632
- console.warn(`The shadow DOM for ${this.constructor.getMetadata().getTag()} does not have a top level element, the getDomRef() method might not work as expected`); // eslint-disable-line
633
- }
634
-
635
- return children[0];
636
- }
637
-
638
- /**
639
- * Returns the DOM Element marked with "data-sap-focus-ref" inside the template.
640
- * This is the element that will receive the focus by default.
641
- * @public
642
- */
643
- getFocusDomRef() {
644
- const domRef = this.getDomRef();
645
- if (domRef) {
646
- const focusRef = domRef.querySelector("[data-sap-focus-ref]");
647
- return focusRef || domRef;
648
- }
649
- }
650
-
651
- /**
652
- * Waits for dom ref and then returns the DOM Element marked with "data-sap-focus-ref" inside the template.
653
- * This is the element that will receive the focus by default.
654
- * @public
655
- */
656
- async getFocusDomRefAsync() {
657
- await this._waitForDomRef();
658
- return this.getFocusDomRef();
659
- }
660
-
661
- /**
662
- * Set the focus to the element, returned by "getFocusDomRef()" (marked by "data-sap-focus-ref")
663
- * @public
664
- */
665
- async focus() {
666
- await this._waitForDomRef();
667
-
668
- const focusDomRef = this.getFocusDomRef();
669
-
670
- if (focusDomRef && typeof focusDomRef.focus === "function") {
671
- focusDomRef.focus();
672
- }
673
- }
674
-
675
- /**
676
- *
677
- * @public
678
- * @param name - name of the event
679
- * @param data - additional data for the event
680
- * @param cancelable - true, if the user can call preventDefault on the event object
681
- * @param bubbles - true, if the event bubbles
682
- * @returns {boolean} false, if the event was cancelled (preventDefault called), true otherwise
683
- */
684
- fireEvent(name, data, cancelable = false, bubbles = true) {
685
- const eventResult = this._fireEvent(name, data, cancelable, bubbles);
686
- const camelCaseEventName = kebabToCamelCase(name);
687
-
688
- if (camelCaseEventName !== name) {
689
- return eventResult && this._fireEvent(camelCaseEventName, data, cancelable);
690
- }
691
-
692
- return eventResult;
693
- }
694
-
695
- _fireEvent(name, data, cancelable = false, bubbles = true) {
696
- const noConflictEvent = new CustomEvent(`ui5-${name}`, {
697
- detail: data,
698
- composed: false,
699
- bubbles,
700
- cancelable,
701
- });
702
-
703
- // This will be false if the no-conflict event is prevented
704
- const noConflictEventResult = this.dispatchEvent(noConflictEvent);
705
-
706
- if (skipOriginalEvent(name)) {
707
- return noConflictEventResult;
708
- }
709
-
710
- const normalEvent = new CustomEvent(name, {
711
- detail: data,
712
- composed: false,
713
- bubbles,
714
- cancelable,
715
- });
716
-
717
- // This will be false if the normal event is prevented
718
- const normalEventResult = this.dispatchEvent(normalEvent);
719
-
720
- // Return false if any of the two events was prevented (its result was false).
721
- return normalEventResult && noConflictEventResult;
722
- }
723
-
724
- /**
725
- * Returns the actual children, associated with a slot.
726
- * Useful when there are transitive slots in nested component scenarios and you don't want to get a list of the slots, but rather of their content.
727
- * @public
728
- */
729
- getSlottedNodes(slotName) {
730
- return getSlottedElementsList(this[slotName]);
731
- }
732
-
733
- /**
734
- * Determines whether the component should be rendered in RTL mode or not.
735
- * Returns: "rtl", "ltr" or undefined
736
- *
737
- * @public
738
- * @returns {String|undefined}
739
- */
740
- get effectiveDir() {
741
- markAsRtlAware(this.constructor); // if a UI5 Element calls this method, it's considered to be rtl-aware
742
- return getEffectiveDir(this);
743
- }
744
-
745
- /**
746
- * Used to duck-type UI5 elements without using instanceof
747
- * @returns {boolean}
748
- * @public
749
- */
750
- get isUI5Element() {
751
- return true;
752
- }
753
-
754
- /**
755
- * Do not override this method in derivatives of UI5Element, use metadata properties instead
756
- * @private
757
- */
758
- static get observedAttributes() {
759
- return this.getMetadata().getAttributesList();
760
- }
761
-
762
- /**
763
- * @private
764
- */
765
- static _needsShadowDOM() {
766
- return !!this.template;
767
- }
768
-
769
- /**
770
- * @private
771
- */
772
- static _needsStaticArea() {
773
- return !!this.staticAreaTemplate;
774
- }
775
-
776
- /**
777
- * @public
778
- */
779
- getStaticAreaItemDomRef() {
780
- if (!this.constructor._needsStaticArea()) {
781
- throw new Error("This component does not use the static area");
782
- }
783
-
784
- if (!this.staticAreaItem) {
785
- this.staticAreaItem = StaticAreaItem.createInstance();
786
- this.staticAreaItem.setOwnerElement(this);
787
- }
788
- if (!this.staticAreaItem.parentElement) {
789
- getSingletonElementInstance("ui5-static-area").appendChild(this.staticAreaItem);
790
- }
791
-
792
- return this.staticAreaItem.getDomRef();
793
- }
794
-
795
- /**
796
- * @private
797
- */
798
- static _generateAccessors() {
799
- const proto = this.prototype;
800
- const slotsAreManaged = this.getMetadata().slotsAreManaged();
801
-
802
- // Properties
803
- const properties = this.getMetadata().getProperties();
804
- for (const [prop, propData] of Object.entries(properties)) { // eslint-disable-line
805
- if (!isValidPropertyName(prop)) {
806
- console.warn(`"${prop}" is not a valid property name. Use a name that does not collide with DOM APIs`); /* eslint-disable-line */
807
- }
808
-
809
- if (propData.type === Boolean && propData.defaultValue) {
810
- throw new Error(`Cannot set a default value for property "${prop}". All booleans are false by default.`);
811
- }
812
-
813
- if (propData.type === Array) {
814
- throw new Error(`Wrong type for property "${prop}". Properties cannot be of type Array - use "multiple: true" and set "type" to the single value type, such as "String", "Object", etc...`);
815
- }
816
-
817
- if (propData.type === Object && propData.defaultValue) {
818
- throw new Error(`Cannot set a default value for property "${prop}". All properties of type "Object" are empty objects by default.`);
819
- }
820
-
821
- if (propData.multiple && propData.defaultValue) {
822
- throw new Error(`Cannot set a default value for property "${prop}". All multiple properties are empty arrays by default.`);
823
- }
824
-
825
- Object.defineProperty(proto, prop, {
826
- get() {
827
- if (this._state[prop] !== undefined) {
828
- return this._state[prop];
829
- }
830
-
831
- const propDefaultValue = propData.defaultValue;
832
-
833
- if (propData.type === Boolean) {
834
- return false;
835
- } else if (propData.type === String) { // eslint-disable-line
836
- return propDefaultValue;
837
- } else if (propData.multiple) { // eslint-disable-line
838
- return [];
839
- } else {
840
- return propDefaultValue;
841
- }
842
- },
843
- set(value) {
844
- let isDifferent;
845
- value = this.constructor.getMetadata().constructor.validatePropertyValue(value, propData);
846
-
847
- const oldState = this._state[prop];
848
- if (propData.multiple && propData.compareValues) {
849
- isDifferent = !arraysAreEqual(oldState, value);
850
- } else if (isDescendantOf(propData.type, DataType)) {
851
- isDifferent = !propData.type.valuesAreEqual(oldState, value);
852
- } else {
853
- isDifferent = oldState !== value;
854
- }
855
-
856
- if (isDifferent) {
857
- this._state[prop] = value;
858
- _invalidate.call(this, {
859
- type: "property",
860
- name: prop,
861
- newValue: value,
862
- oldValue: oldState,
863
- });
864
- this._updateAttribute(prop, value);
865
- }
866
- },
867
- });
868
- }
869
-
870
- // Slots
871
- if (slotsAreManaged) {
872
- const slots = this.getMetadata().getSlots();
873
- for (const [slotName, slotData] of Object.entries(slots)) { // eslint-disable-line
874
- if (!isValidPropertyName(slotName)) {
875
- console.warn(`"${slotName}" is not a valid property name. Use a name that does not collide with DOM APIs`); /* eslint-disable-line */
876
- }
877
-
878
- const propertyName = slotData.propertyName || slotName;
879
- Object.defineProperty(proto, propertyName, {
880
- get() {
881
- if (this._state[propertyName] !== undefined) {
882
- return this._state[propertyName];
883
- }
884
- return [];
885
- },
886
- set() {
887
- throw new Error("Cannot set slot content directly, use the DOM APIs (appendChild, removeChild, etc...)");
888
- },
889
- });
890
- }
891
- }
892
- }
893
-
894
- /**
895
- * Returns the metadata object for this UI5 Web Component Class
896
- * @protected
897
- */
898
- static get metadata() {
899
- return {};
900
- }
901
-
902
- /**
903
- * Returns the CSS for this UI5 Web Component Class
904
- * @protected
905
- */
906
- static get styles() {
907
- return "";
908
- }
909
-
910
- /**
911
- * Returns the Static Area CSS for this UI5 Web Component Class
912
- * @protected
913
- */
914
- static get staticAreaStyles() {
915
- return "";
916
- }
917
-
918
- /**
919
- * Returns an array with the dependencies for this UI5 Web Component, which could be:
920
- * - composed components (used in its shadow root or static area item)
921
- * - slotted components that the component may need to communicate with
922
- *
923
- * @protected
924
- */
925
- static get dependencies() {
926
- return [];
927
- }
928
-
929
- /**
930
- * Returns a list of the unique dependencies for this UI5 Web Component
931
- *
932
- * @public
933
- */
934
- static getUniqueDependencies() {
935
- if (!uniqueDependenciesCache.has(this)) {
936
- const filtered = this.dependencies.filter((dep, index, deps) => deps.indexOf(dep) === index);
937
- uniqueDependenciesCache.set(this, filtered);
938
- }
939
-
940
- return uniqueDependenciesCache.get(this);
941
- }
942
-
943
- /**
944
- * Returns a promise that resolves whenever all dependencies for this UI5 Web Component have resolved
945
- *
946
- * @returns {Promise<any[]>}
947
- */
948
- static whenDependenciesDefined() {
949
- return Promise.all(this.getUniqueDependencies().map(dep => dep.define()));
950
- }
951
-
952
- /**
953
- * Hook that will be called upon custom element definition
954
- *
955
- * @protected
956
- * @returns {Promise<void>}
957
- */
958
- static async onDefine() {
959
- return Promise.resolve();
960
- }
961
-
962
- /**
963
- * Registers a UI5 Web Component in the browser window object
964
- * @public
965
- * @returns {Promise<UI5Element>}
966
- */
967
- static async define() {
968
- await boot();
969
-
970
- await Promise.all([
971
- this.whenDependenciesDefined(),
972
- this.onDefine(),
973
- ]);
974
-
975
- const tag = this.getMetadata().getTag();
976
- const altTag = this.getMetadata().getAltTag();
977
-
978
- const definedLocally = isTagRegistered(tag);
979
- const definedGlobally = customElements.get(tag);
980
-
981
- if (definedGlobally && !definedLocally) {
982
- recordTagRegistrationFailure(tag);
983
- } else if (!definedGlobally) {
984
- this._generateAccessors();
985
- registerTag(tag);
986
- window.customElements.define(tag, this);
987
- preloadLinks(this);
988
-
989
- if (altTag && !customElements.get(altTag)) {
990
- registerTag(altTag);
991
- window.customElements.define(altTag, getClassCopy(this, () => {
992
- console.log(`The ${altTag} tag is deprecated and will be removed in the next release, please use ${tag} instead.`); // eslint-disable-line
993
- }));
994
- }
995
- }
996
- return this;
997
- }
998
-
999
- /**
1000
- * Returns an instance of UI5ElementMetadata.js representing this UI5 Web Component's full metadata (its and its parents')
1001
- * Note: not to be confused with the "get metadata()" method, which returns an object for this class's metadata only
1002
- * @public
1003
- * @returns {UI5ElementMetadata}
1004
- */
1005
- static getMetadata() {
1006
- if (this.hasOwnProperty("_metadata")) { // eslint-disable-line
1007
- return this._metadata;
1008
- }
1009
-
1010
- const metadataObjects = [this.metadata];
1011
- let klass = this; // eslint-disable-line
1012
- while (klass !== UI5Element) {
1013
- klass = Object.getPrototypeOf(klass);
1014
- metadataObjects.unshift(klass.metadata);
1015
- }
1016
- const mergedMetadata = merge({}, ...metadataObjects);
1017
-
1018
- this._metadata = new UI5ElementMetadata(mergedMetadata);
1019
- return this._metadata;
1020
- }
51
+ constructor() {
52
+ super();
53
+ const ctor = this.constructor;
54
+ this._changedState = []; // Filled on each invalidation, cleared on re-render (used for debugging)
55
+ this._suppressInvalidation = true; // A flag telling whether all invalidations should be ignored. Initialized with "true" because a UI5Element can not be invalidated until it is rendered for the first time
56
+ this._inDOM = false; // A flag telling whether the UI5Element is currently in the DOM tree of the document or not
57
+ this._fullyConnected = false; // A flag telling whether the UI5Element's onEnterDOM hook was called (since it's possible to have the element removed from DOM before that)
58
+ this._childChangeListeners = new Map(); // used to store lazy listeners per slot for the child change event of every child inside that slot
59
+ this._slotChangeListeners = new Map(); // used to store lazy listeners per slot for the slotchange event of all slot children inside that slot
60
+ this._eventProvider = new EventProvider(); // used by parent components for listening to changes to child components
61
+ let deferredResolve;
62
+ this._domRefReadyPromise = new Promise(resolve => {
63
+ deferredResolve = resolve;
64
+ });
65
+ this._domRefReadyPromise._deferredResolve = deferredResolve;
66
+ this._doNotSyncAttributes = new Set(); // attributes that are excluded from attributeChangedCallback synchronization
67
+ this._state = { ...ctor.getMetadata().getInitialState() };
68
+ this._upgradeAllProperties();
69
+ if (ctor._needsShadowDOM()) {
70
+ this.attachShadow({ mode: "open" });
71
+ }
72
+ }
73
+ /**
74
+ * Returns a unique ID for this UI5 Element
75
+ *
76
+ * @deprecated - This property is not guaranteed in future releases
77
+ * @protected
78
+ */
79
+ get _id() {
80
+ if (!this.__id) {
81
+ this.__id = `ui5wc_${++autoId}`;
82
+ }
83
+ return this.__id;
84
+ }
85
+ /**
86
+ * Do not call this method from derivatives of UI5Element, use "onEnterDOM" only
87
+ * @private
88
+ */
89
+ async connectedCallback() {
90
+ const ctor = this.constructor;
91
+ this.setAttribute(ctor.getMetadata().getPureTag(), "");
92
+ if (ctor.getMetadata().supportsF6FastNavigation()) {
93
+ this.setAttribute("data-sap-ui-fastnavgroup", "true");
94
+ }
95
+ const slotsAreManaged = ctor.getMetadata().slotsAreManaged();
96
+ this._inDOM = true;
97
+ if (slotsAreManaged) {
98
+ // always register the observer before yielding control to the main thread (await)
99
+ this._startObservingDOMChildren();
100
+ await this._processChildren();
101
+ }
102
+ if (!this._inDOM) { // Component removed from DOM while _processChildren was running
103
+ return;
104
+ }
105
+ renderImmediately(this);
106
+ this._domRefReadyPromise._deferredResolve();
107
+ this._fullyConnected = true;
108
+ this.onEnterDOM();
109
+ }
110
+ /**
111
+ * Do not call this method from derivatives of UI5Element, use "onExitDOM" only
112
+ * @private
113
+ */
114
+ disconnectedCallback() {
115
+ const ctor = this.constructor;
116
+ const slotsAreManaged = ctor.getMetadata().slotsAreManaged();
117
+ this._inDOM = false;
118
+ if (slotsAreManaged) {
119
+ this._stopObservingDOMChildren();
120
+ }
121
+ if (this._fullyConnected) {
122
+ this.onExitDOM();
123
+ this._fullyConnected = false;
124
+ }
125
+ if (this.staticAreaItem && this.staticAreaItem.parentElement) {
126
+ this.staticAreaItem.parentElement.removeChild(this.staticAreaItem);
127
+ }
128
+ cancelRender(this);
129
+ }
130
+ /**
131
+ * Called every time before the component renders.
132
+ * @public
133
+ */
134
+ onBeforeRendering() { }
135
+ /**
136
+ * Called every time after the component renders.
137
+ * @public
138
+ */
139
+ onAfterRendering() { }
140
+ /**
141
+ * Called on connectedCallback - added to the DOM.
142
+ * @public
143
+ */
144
+ onEnterDOM() { }
145
+ /**
146
+ * Called on disconnectedCallback - removed from the DOM.
147
+ * @public
148
+ */
149
+ onExitDOM() { }
150
+ /**
151
+ * @private
152
+ */
153
+ _startObservingDOMChildren() {
154
+ const ctor = this.constructor;
155
+ const shouldObserveChildren = ctor.getMetadata().hasSlots();
156
+ if (!shouldObserveChildren) {
157
+ return;
158
+ }
159
+ const canSlotText = ctor.getMetadata().canSlotText();
160
+ const mutationObserverOptions = {
161
+ childList: true,
162
+ subtree: canSlotText,
163
+ characterData: canSlotText,
164
+ };
165
+ observeDOMNode(this, this._processChildren.bind(this), mutationObserverOptions);
166
+ }
167
+ /**
168
+ * @private
169
+ */
170
+ _stopObservingDOMChildren() {
171
+ unobserveDOMNode(this);
172
+ }
173
+ /**
174
+ * Note: this method is also manually called by "compatibility/patchNodeValue.js"
175
+ * @private
176
+ */
177
+ async _processChildren() {
178
+ const hasSlots = this.constructor.getMetadata().hasSlots();
179
+ if (hasSlots) {
180
+ await this._updateSlots();
181
+ }
182
+ }
183
+ /**
184
+ * @private
185
+ */
186
+ async _updateSlots() {
187
+ const ctor = this.constructor;
188
+ const slotsMap = ctor.getMetadata().getSlots();
189
+ const canSlotText = ctor.getMetadata().canSlotText();
190
+ const domChildren = Array.from(canSlotText ? this.childNodes : this.children);
191
+ const slotsCachedContentMap = new Map(); // Store here the content of each slot before the mutation occurred
192
+ const propertyNameToSlotMap = new Map(); // Used for reverse lookup to determine to which slot the property name corresponds
193
+ // Init the _state object based on the supported slots and store the previous values
194
+ for (const [slotName, slotData] of Object.entries(slotsMap)) { // eslint-disable-line
195
+ const propertyName = slotData.propertyName || slotName;
196
+ propertyNameToSlotMap.set(propertyName, slotName);
197
+ slotsCachedContentMap.set(propertyName, [...this._state[propertyName]]);
198
+ this._clearSlot(slotName, slotData);
199
+ }
200
+ const autoIncrementMap = new Map();
201
+ const slottedChildrenMap = new Map();
202
+ const allChildrenUpgraded = domChildren.map(async (child, idx) => {
203
+ // Determine the type of the child (mainly by the slot attribute)
204
+ const slotName = getSlotName(child);
205
+ const slotData = slotsMap[slotName];
206
+ // Check if the slotName is supported
207
+ if (slotData === undefined) {
208
+ if (slotName !== "default") {
209
+ const validValues = Object.keys(slotsMap).join(", ");
210
+ console.warn(`Unknown slotName: ${slotName}, ignoring`, child, `Valid values are: ${validValues}`); // eslint-disable-line
211
+ }
212
+ return;
213
+ }
214
+ // For children that need individual slots, calculate them
215
+ if (slotData.individualSlots) {
216
+ const nextIndex = (autoIncrementMap.get(slotName) || 0) + 1;
217
+ autoIncrementMap.set(slotName, nextIndex);
218
+ child._individualSlot = `${slotName}-${nextIndex}`;
219
+ }
220
+ // Await for not-yet-defined custom elements
221
+ if (child instanceof HTMLElement) {
222
+ const localName = child.localName;
223
+ const isCustomElement = localName.includes("-");
224
+ if (isCustomElement) {
225
+ const isDefined = window.customElements.get(localName);
226
+ if (!isDefined) {
227
+ const whenDefinedPromise = window.customElements.whenDefined(localName); // Class registered, but instances not upgraded yet
228
+ let timeoutPromise = elementTimeouts.get(localName);
229
+ if (!timeoutPromise) {
230
+ timeoutPromise = new Promise(resolve => setTimeout(resolve, 1000));
231
+ elementTimeouts.set(localName, timeoutPromise);
232
+ }
233
+ await Promise.race([whenDefinedPromise, timeoutPromise]);
234
+ }
235
+ window.customElements.upgrade(child);
236
+ }
237
+ }
238
+ child = ctor.getMetadata().constructor.validateSlotValue(child, slotData);
239
+ // Listen for any invalidation on the child if invalidateOnChildChange is true or an object (ignore when false or not set)
240
+ if (instanceOfUI5Element(child) && slotData.invalidateOnChildChange) {
241
+ const childChangeListener = this._getChildChangeListener(slotName);
242
+ if (childChangeListener) {
243
+ child.attachInvalidate.call(child, childChangeListener);
244
+ }
245
+ }
246
+ // Listen for the slotchange event if the child is a slot itself
247
+ if (child instanceof HTMLSlotElement) {
248
+ this._attachSlotChange(child, slotName);
249
+ }
250
+ const propertyName = slotData.propertyName || slotName;
251
+ if (slottedChildrenMap.has(propertyName)) {
252
+ slottedChildrenMap.get(propertyName).push({ child, idx });
253
+ }
254
+ else {
255
+ slottedChildrenMap.set(propertyName, [{ child, idx }]);
256
+ }
257
+ });
258
+ await Promise.all(allChildrenUpgraded);
259
+ // Distribute the child in the _state object, keeping the Light DOM order,
260
+ // not the order elements are defined.
261
+ slottedChildrenMap.forEach((children, propertyName) => {
262
+ this._state[propertyName] = children.sort((a, b) => a.idx - b.idx).map(_ => _.child);
263
+ });
264
+ // Compare the content of each slot with the cached values and invalidate for the ones that changed
265
+ let invalidated = false;
266
+ for (const [slotName, slotData] of Object.entries(slotsMap)) { // eslint-disable-line
267
+ const propertyName = slotData.propertyName || slotName;
268
+ if (!arraysAreEqual(slotsCachedContentMap.get(propertyName), this._state[propertyName])) {
269
+ _invalidate.call(this, {
270
+ type: "slot",
271
+ name: propertyNameToSlotMap.get(propertyName),
272
+ reason: "children",
273
+ });
274
+ invalidated = true;
275
+ }
276
+ }
277
+ // If none of the slots had an invalidation due to changes to immediate children,
278
+ // the change is considered to be text content of the default slot
279
+ if (!invalidated) {
280
+ _invalidate.call(this, {
281
+ type: "slot",
282
+ name: "default",
283
+ reason: "textcontent",
284
+ });
285
+ }
286
+ }
287
+ /**
288
+ * Removes all children from the slot and detaches listeners, if any
289
+ * @private
290
+ */
291
+ _clearSlot(slotName, slotData) {
292
+ const propertyName = slotData.propertyName || slotName;
293
+ const children = this._state[propertyName];
294
+ children.forEach(child => {
295
+ if (instanceOfUI5Element(child)) {
296
+ const childChangeListener = this._getChildChangeListener(slotName);
297
+ if (childChangeListener) {
298
+ child.detachInvalidate.call(child, childChangeListener);
299
+ }
300
+ }
301
+ if (child instanceof HTMLSlotElement) {
302
+ this._detachSlotChange(child, slotName);
303
+ }
304
+ });
305
+ this._state[propertyName] = [];
306
+ }
307
+ /**
308
+ * Attach a callback that will be executed whenever the component is invalidated
309
+ *
310
+ * @param {InvalidationInfo} callback
311
+ * @public
312
+ */
313
+ attachInvalidate(callback) {
314
+ this._eventProvider.attachEvent("invalidate", callback);
315
+ }
316
+ /**
317
+ * Detach the callback that is executed whenever the component is invalidated
318
+ *
319
+ * @param {InvalidationInfo} callback
320
+ * @public
321
+ */
322
+ detachInvalidate(callback) {
323
+ this._eventProvider.detachEvent("invalidate", callback);
324
+ }
325
+ /**
326
+ * Callback that is executed whenever a monitored child changes its state
327
+ *
328
+ * @param {sting} slotName the slot in which a child was invalidated
329
+ * @param { ChangeInfo } childChangeInfo the changeInfo object for the child in the given slot
330
+ * @private
331
+ */
332
+ _onChildChange(slotName, childChangeInfo) {
333
+ if (!this.constructor.getMetadata().shouldInvalidateOnChildChange(slotName, childChangeInfo.type, childChangeInfo.name)) {
334
+ return;
335
+ }
336
+ // The component should be invalidated as this type of change on the child is listened for
337
+ // However, no matter what changed on the child (property/slot), the invalidation is registered as "type=slot" for the component itself
338
+ _invalidate.call(this, {
339
+ type: "slot",
340
+ name: slotName,
341
+ reason: "childchange",
342
+ child: childChangeInfo.target,
343
+ });
344
+ }
345
+ /**
346
+ * Do not override this method in derivatives of UI5Element
347
+ * @private
348
+ */
349
+ attributeChangedCallback(name, oldValue, newValue) {
350
+ let newPropertyValue;
351
+ if (this._doNotSyncAttributes.has(name)) { // This attribute is mutated internally, not by the user
352
+ return;
353
+ }
354
+ const properties = this.constructor.getMetadata().getProperties();
355
+ const realName = name.replace(/^ui5-/, "");
356
+ const nameInCamelCase = kebabToCamelCase(realName);
357
+ if (properties.hasOwnProperty(nameInCamelCase)) { // eslint-disable-line
358
+ const propData = properties[nameInCamelCase];
359
+ const propertyType = propData.type;
360
+ let propertyValidator = propData.validator;
361
+ if (propertyType && propertyType.isDataTypeClass) {
362
+ propertyValidator = propertyType;
363
+ }
364
+ if (propertyValidator) {
365
+ newPropertyValue = propertyValidator.attributeToProperty(newValue);
366
+ }
367
+ else if (propertyType === Boolean) {
368
+ newPropertyValue = newValue !== null;
369
+ }
370
+ else {
371
+ newPropertyValue = newValue;
372
+ }
373
+ this[nameInCamelCase] = newPropertyValue;
374
+ }
375
+ }
376
+ /**
377
+ * @private
378
+ */
379
+ _updateAttribute(name, newValue) {
380
+ const ctor = this.constructor;
381
+ if (!ctor.getMetadata().hasAttribute(name)) {
382
+ return;
383
+ }
384
+ const properties = ctor.getMetadata().getProperties();
385
+ const propData = properties[name];
386
+ const propertyType = propData.type;
387
+ let propertyValidator = propData.validator;
388
+ const attrName = camelToKebabCase(name);
389
+ const attrValue = this.getAttribute(attrName);
390
+ if (propertyType && propertyType.isDataTypeClass) {
391
+ propertyValidator = propertyType;
392
+ }
393
+ if (propertyValidator) {
394
+ const newAttrValue = propertyValidator.propertyToAttribute(newValue);
395
+ if (newAttrValue === null) { // null means there must be no attribute for the current value of the property
396
+ this._doNotSyncAttributes.add(attrName); // skip the attributeChangedCallback call for this attribute
397
+ this.removeAttribute(attrName); // remove the attribute safely (will not trigger synchronization to the property value due to the above line)
398
+ this._doNotSyncAttributes.delete(attrName); // enable synchronization again for this attribute
399
+ }
400
+ else {
401
+ this.setAttribute(attrName, newAttrValue);
402
+ }
403
+ }
404
+ else if (propertyType === Boolean) {
405
+ if (newValue === true && attrValue === null) {
406
+ this.setAttribute(attrName, "");
407
+ }
408
+ else if (newValue === false && attrValue !== null) {
409
+ this.removeAttribute(attrName);
410
+ }
411
+ }
412
+ else if (typeof newValue !== "object") {
413
+ if (attrValue !== newValue) {
414
+ this.setAttribute(attrName, newValue);
415
+ }
416
+ } // else { return; } // old object handling
417
+ }
418
+ /**
419
+ * @private
420
+ */
421
+ _upgradeProperty(propertyName) {
422
+ if (this.hasOwnProperty(propertyName)) { // eslint-disable-line
423
+ const value = this[propertyName];
424
+ delete this[propertyName];
425
+ this[propertyName] = value;
426
+ }
427
+ }
428
+ /**
429
+ * @private
430
+ */
431
+ _upgradeAllProperties() {
432
+ const allProps = this.constructor.getMetadata().getPropertiesList();
433
+ allProps.forEach(this._upgradeProperty.bind(this));
434
+ }
435
+ /**
436
+ * Returns a singleton event listener for the "change" event of a child in a given slot
437
+ *
438
+ * @param slotName the name of the slot, where the child is
439
+ * @returns {ChildChangeListener}
440
+ * @private
441
+ */
442
+ _getChildChangeListener(slotName) {
443
+ if (!this._childChangeListeners.has(slotName)) {
444
+ this._childChangeListeners.set(slotName, this._onChildChange.bind(this, slotName));
445
+ }
446
+ return this._childChangeListeners.get(slotName);
447
+ }
448
+ /**
449
+ * Returns a singleton slotchange event listener that invalidates the component due to changes in the given slot
450
+ *
451
+ * @param slotName the name of the slot, where the slot element (whose slotchange event we're listening to) is
452
+ * @returns {SlotChangeListener}
453
+ * @private
454
+ */
455
+ _getSlotChangeListener(slotName) {
456
+ if (!this._slotChangeListeners.has(slotName)) {
457
+ this._slotChangeListeners.set(slotName, this._onSlotChange.bind(this, slotName));
458
+ }
459
+ return this._slotChangeListeners.get(slotName);
460
+ }
461
+ /**
462
+ * @private
463
+ */
464
+ _attachSlotChange(child, slotName) {
465
+ const slotChangeListener = this._getSlotChangeListener(slotName);
466
+ if (slotChangeListener) {
467
+ child.addEventListener("slotchange", slotChangeListener);
468
+ }
469
+ }
470
+ /**
471
+ * @private
472
+ */
473
+ _detachSlotChange(child, slotName) {
474
+ child.removeEventListener("slotchange", this._getSlotChangeListener(slotName));
475
+ }
476
+ /**
477
+ * Whenever a slot element is slotted inside a UI5 Web Component, its slotchange event invalidates the component
478
+ *
479
+ * @param slotName the name of the slot, where the slot element (whose slotchange event we're listening to) is
480
+ * @private
481
+ */
482
+ _onSlotChange(slotName) {
483
+ _invalidate.call(this, {
484
+ type: "slot",
485
+ name: slotName,
486
+ reason: "slotchange",
487
+ });
488
+ }
489
+ /**
490
+ * A callback that is executed each time an already rendered component is invalidated (scheduled for re-rendering)
491
+ *
492
+ * @param changeInfo An object with information about the change that caused invalidation.
493
+ * The object can have the following properties:
494
+ * - type: (property|slot) tells what caused the invalidation
495
+ * 1) property: a property value was changed either directly or as a result of changing the corresponding attribute
496
+ * 2) slot: a slotted node(nodes) changed in one of several ways (see "reason")
497
+ *
498
+ * - name: the name of the property or slot that caused the invalidation
499
+ *
500
+ * - reason: (children|textcontent|childchange|slotchange) relevant only for type="slot" only and tells exactly what changed in the slot
501
+ * 1) children: immediate children (HTML elements or text nodes) were added, removed or reordered in the slot
502
+ * 2) textcontent: text nodes in the slot changed value (or nested text nodes were added or changed value). Can only trigger for slots of "type: Node"
503
+ * 3) slotchange: a slot element, slotted inside that slot had its "slotchange" event listener called. This practically means that transitively slotted children changed.
504
+ * Can only trigger if the child of a slot is a slot element itself.
505
+ * 4) childchange: indicates that a UI5Element child in that slot was invalidated and in turn invalidated the component.
506
+ * Can only trigger for slots with "invalidateOnChildChange" metadata descriptor
507
+ *
508
+ * - newValue: the new value of the property (for type="property" only)
509
+ *
510
+ * - oldValue: the old value of the property (for type="property" only)
511
+ *
512
+ * - child the child that was changed (for type="slot" and reason="childchange" only)
513
+ *
514
+ * @public
515
+ */
516
+ onInvalidation(changeInfo) { } // eslint-disable-line
517
+ /**
518
+ * Do not call this method directly, only intended to be called by js
519
+ * @protected
520
+ */
521
+ _render() {
522
+ const ctor = this.constructor;
523
+ const hasIndividualSlots = ctor.getMetadata().hasIndividualSlots();
524
+ // suppress invalidation to prevent state changes scheduling another rendering
525
+ this._suppressInvalidation = true;
526
+ this.onBeforeRendering();
527
+ // Intended for framework usage only. Currently ItemNavigation updates tab indexes after the component has updated its state but before the template is rendered
528
+ if (this._onComponentStateFinalized) {
529
+ this._onComponentStateFinalized();
530
+ }
531
+ // resume normal invalidation handling
532
+ this._suppressInvalidation = false;
533
+ // Update the shadow root with the render result
534
+ /*
535
+ if (this._changedState.length) {
536
+ let element = this.localName;
537
+ if (this.id) {
538
+ element = `${element}#${this.id}`;
539
+ }
540
+ console.log("Re-rendering:", element, this._changedState.map(x => { // eslint-disable-line
541
+ let res = `${x.type}`;
542
+ if (x.reason) {
543
+ res = `${res}(${x.reason})`;
544
+ }
545
+ res = `${res}: ${x.name}`;
546
+ if (x.type === "property") {
547
+ res = `${res} ${x.oldValue} => ${x.newValue}`;
548
+ }
549
+
550
+ return res;
551
+ }));
552
+ }
553
+ */
554
+ this._changedState = [];
555
+ // Update shadow root and static area item
556
+ if (ctor._needsShadowDOM()) {
557
+ updateShadowRoot(this);
558
+ }
559
+ if (this.staticAreaItem) {
560
+ this.staticAreaItem.update();
561
+ }
562
+ // Safari requires that children get the slot attribute only after the slot tags have been rendered in the shadow DOM
563
+ if (hasIndividualSlots) {
564
+ this._assignIndividualSlotsToChildren();
565
+ }
566
+ // Call the onAfterRendering hook
567
+ this.onAfterRendering();
568
+ }
569
+ /**
570
+ * @private
571
+ */
572
+ _assignIndividualSlotsToChildren() {
573
+ const domChildren = Array.from(this.children);
574
+ domChildren.forEach((child) => {
575
+ if (child._individualSlot) {
576
+ child.setAttribute("slot", child._individualSlot);
577
+ }
578
+ });
579
+ }
580
+ /**
581
+ * @private
582
+ */
583
+ _waitForDomRef() {
584
+ return this._domRefReadyPromise;
585
+ }
586
+ /**
587
+ * Returns the DOM Element inside the Shadow Root that corresponds to the opening tag in the UI5 Web Component's template
588
+ * *Note:* For logical (abstract) elements (items, options, etc...), returns the part of the parent's DOM that represents this option
589
+ * Use this method instead of "this.shadowRoot" to read the Shadow DOM, if ever necessary
590
+ *
591
+ * @public
592
+ */
593
+ getDomRef() {
594
+ // If a component set _getRealDomRef to its children, use the return value of this function
595
+ if (typeof this._getRealDomRef === "function") {
596
+ return this._getRealDomRef();
597
+ }
598
+ if (!this.shadowRoot || this.shadowRoot.children.length === 0) {
599
+ return;
600
+ }
601
+ const children = [...this.shadowRoot.children].filter(child => !["link", "style"].includes(child.localName));
602
+ if (children.length !== 1) {
603
+ console.warn(`The shadow DOM for ${this.constructor.getMetadata().getTag()} does not have a top level element, the getDomRef() method might not work as expected`); // eslint-disable-line
604
+ }
605
+ return children[0];
606
+ }
607
+ /**
608
+ * Returns the DOM Element marked with "data-sap-focus-ref" inside the template.
609
+ * This is the element that will receive the focus by default.
610
+ * @public
611
+ */
612
+ getFocusDomRef() {
613
+ const domRef = this.getDomRef();
614
+ if (domRef) {
615
+ const focusRef = domRef.querySelector("[data-sap-focus-ref]");
616
+ return focusRef || domRef;
617
+ }
618
+ }
619
+ /**
620
+ * Waits for dom ref and then returns the DOM Element marked with "data-sap-focus-ref" inside the template.
621
+ * This is the element that will receive the focus by default.
622
+ * @public
623
+ */
624
+ async getFocusDomRefAsync() {
625
+ await this._waitForDomRef();
626
+ return this.getFocusDomRef();
627
+ }
628
+ /**
629
+ * Set the focus to the element, returned by "getFocusDomRef()" (marked by "data-sap-focus-ref")
630
+ * @public
631
+ */
632
+ async focus() {
633
+ await this._waitForDomRef();
634
+ const focusDomRef = this.getFocusDomRef();
635
+ if (focusDomRef && typeof focusDomRef.focus === "function") {
636
+ focusDomRef.focus();
637
+ }
638
+ }
639
+ /**
640
+ *
641
+ * @public
642
+ * @param name - name of the event
643
+ * @param data - additional data for the event
644
+ * @param cancelable - true, if the user can call preventDefault on the event object
645
+ * @param bubbles - true, if the event bubbles
646
+ * @returns {boolean} false, if the event was cancelled (preventDefault called), true otherwise
647
+ */
648
+ fireEvent(name, data, cancelable = false, bubbles = true) {
649
+ const eventResult = this._fireEvent(name, data, cancelable, bubbles);
650
+ const camelCaseEventName = kebabToCamelCase(name);
651
+ if (camelCaseEventName !== name) {
652
+ return eventResult && this._fireEvent(camelCaseEventName, data, cancelable);
653
+ }
654
+ return eventResult;
655
+ }
656
+ _fireEvent(name, data, cancelable = false, bubbles = true) {
657
+ const noConflictEvent = new CustomEvent(`ui5-${name}`, {
658
+ detail: data,
659
+ composed: false,
660
+ bubbles,
661
+ cancelable,
662
+ });
663
+ // This will be false if the no-conflict event is prevented
664
+ const noConflictEventResult = this.dispatchEvent(noConflictEvent);
665
+ if (skipOriginalEvent(name)) {
666
+ return noConflictEventResult;
667
+ }
668
+ const normalEvent = new CustomEvent(name, {
669
+ detail: data,
670
+ composed: false,
671
+ bubbles,
672
+ cancelable,
673
+ });
674
+ // This will be false if the normal event is prevented
675
+ const normalEventResult = this.dispatchEvent(normalEvent);
676
+ // Return false if any of the two events was prevented (its result was false).
677
+ return normalEventResult && noConflictEventResult;
678
+ }
679
+ /**
680
+ * Returns the actual children, associated with a slot.
681
+ * Useful when there are transitive slots in nested component scenarios and you don't want to get a list of the slots, but rather of their content.
682
+ * @public
683
+ */
684
+ getSlottedNodes(slotName) {
685
+ return getSlottedNodesList(this[slotName]);
686
+ }
687
+ /**
688
+ * Determines whether the component should be rendered in RTL mode or not.
689
+ * Returns: "rtl", "ltr" or undefined
690
+ *
691
+ * @public
692
+ * @returns {String|undefined}
693
+ */
694
+ get effectiveDir() {
695
+ markAsRtlAware(this.constructor); // if a UI5 Element calls this method, it's considered to be rtl-aware
696
+ return getEffectiveDir(this);
697
+ }
698
+ /**
699
+ * Used to duck-type UI5 elements without using instanceof
700
+ * @returns {boolean}
701
+ * @public
702
+ */
703
+ get isUI5Element() {
704
+ return true;
705
+ }
706
+ get classes() {
707
+ return {};
708
+ }
709
+ /**
710
+ * Do not override this method in derivatives of UI5Element, use metadata properties instead
711
+ * @private
712
+ */
713
+ static get observedAttributes() {
714
+ return this.getMetadata().getAttributesList();
715
+ }
716
+ /**
717
+ * @private
718
+ */
719
+ static _needsShadowDOM() {
720
+ return !!this.template;
721
+ }
722
+ /**
723
+ * @private
724
+ */
725
+ static _needsStaticArea() {
726
+ return !!this.staticAreaTemplate;
727
+ }
728
+ /**
729
+ * @public
730
+ */
731
+ getStaticAreaItemDomRef() {
732
+ if (!this.constructor._needsStaticArea()) {
733
+ throw new Error("This component does not use the static area");
734
+ }
735
+ if (!this.staticAreaItem) {
736
+ this.staticAreaItem = StaticAreaItem.createInstance();
737
+ this.staticAreaItem.setOwnerElement(this);
738
+ }
739
+ if (!this.staticAreaItem.parentElement) {
740
+ getSingletonElementInstance("ui5-static-area").appendChild(this.staticAreaItem);
741
+ }
742
+ return this.staticAreaItem.getDomRef();
743
+ }
744
+ /**
745
+ * @private
746
+ */
747
+ static _generateAccessors() {
748
+ const proto = this.prototype;
749
+ const slotsAreManaged = this.getMetadata().slotsAreManaged();
750
+ // Properties
751
+ const properties = this.getMetadata().getProperties();
752
+ for (const [prop, propData] of Object.entries(properties)) { // eslint-disable-line
753
+ if (!isValidPropertyName(prop)) {
754
+ console.warn(`"${prop}" is not a valid property name. Use a name that does not collide with DOM APIs`); /* eslint-disable-line */
755
+ }
756
+ if (propData.type === Boolean && propData.defaultValue) {
757
+ throw new Error(`Cannot set a default value for property "${prop}". All booleans are false by default.`);
758
+ }
759
+ if (propData.type === Array) {
760
+ throw new Error(`Wrong type for property "${prop}". Properties cannot be of type Array - use "multiple: true" and set "type" to the single value type, such as "String", "Object", etc...`);
761
+ }
762
+ if (propData.type === Object && propData.defaultValue) {
763
+ throw new Error(`Cannot set a default value for property "${prop}". All properties of type "Object" are empty objects by default.`);
764
+ }
765
+ if (propData.multiple && propData.defaultValue) {
766
+ throw new Error(`Cannot set a default value for property "${prop}". All multiple properties are empty arrays by default.`);
767
+ }
768
+ Object.defineProperty(proto, prop, {
769
+ get() {
770
+ if (this._state[prop] !== undefined) {
771
+ return this._state[prop];
772
+ }
773
+ const propDefaultValue = propData.defaultValue;
774
+ if (propData.type === Boolean) {
775
+ return false;
776
+ }
777
+ else if (propData.type === String) { // eslint-disable-line
778
+ return propDefaultValue;
779
+ }
780
+ else if (propData.multiple) { // eslint-disable-line
781
+ return [];
782
+ }
783
+ else {
784
+ return propDefaultValue;
785
+ }
786
+ },
787
+ set(value) {
788
+ let isDifferent;
789
+ const ctor = this.constructor;
790
+ const metadataCtor = ctor.getMetadata().constructor;
791
+ value = metadataCtor.validatePropertyValue(value, propData);
792
+ const propertyType = propData.type;
793
+ let propertyValidator = propData.validator;
794
+ const oldState = this._state[prop];
795
+ if (propertyType && propertyType.isDataTypeClass) {
796
+ propertyValidator = propertyType;
797
+ }
798
+ if (propertyValidator) {
799
+ isDifferent = !propertyValidator.valuesAreEqual(oldState, value);
800
+ }
801
+ else if (Array.isArray(oldState) && Array.isArray(value) && propData.multiple && propData.compareValues) { // compareValues is added for IE, test if needed now
802
+ isDifferent = !arraysAreEqual(oldState, value);
803
+ }
804
+ else {
805
+ isDifferent = oldState !== value;
806
+ }
807
+ if (isDifferent) {
808
+ this._state[prop] = value;
809
+ _invalidate.call(this, {
810
+ type: "property",
811
+ name: prop,
812
+ newValue: value,
813
+ oldValue: oldState,
814
+ });
815
+ this._updateAttribute(prop, value);
816
+ }
817
+ },
818
+ });
819
+ }
820
+ // Slots
821
+ if (slotsAreManaged) {
822
+ const slots = this.getMetadata().getSlots();
823
+ for (const [slotName, slotData] of Object.entries(slots)) { // eslint-disable-line
824
+ if (!isValidPropertyName(slotName)) {
825
+ console.warn(`"${slotName}" is not a valid property name. Use a name that does not collide with DOM APIs`); /* eslint-disable-line */
826
+ }
827
+ const propertyName = slotData.propertyName || slotName;
828
+ Object.defineProperty(proto, propertyName, {
829
+ get() {
830
+ if (this._state[propertyName] !== undefined) {
831
+ return this._state[propertyName];
832
+ }
833
+ return [];
834
+ },
835
+ set() {
836
+ throw new Error("Cannot set slot content directly, use the DOM APIs (appendChild, removeChild, etc...)");
837
+ },
838
+ });
839
+ }
840
+ }
841
+ }
842
+ /**
843
+ * Returns the metadata object for this UI5 Web Component Class
844
+ * @protected
845
+ */
846
+ static get metadata() {
847
+ return metadata;
848
+ }
849
+ /**
850
+ * Sets a new metadata object for this UI5 Web Component Class
851
+ * @protected
852
+ */
853
+ static set metadata(newMetadata) {
854
+ metadata = newMetadata;
855
+ }
856
+ /**
857
+ * Returns the CSS for this UI5 Web Component Class
858
+ * @protected
859
+ */
860
+ static get styles() {
861
+ return "";
862
+ }
863
+ /**
864
+ * Returns the Static Area CSS for this UI5 Web Component Class
865
+ * @protected
866
+ */
867
+ static get staticAreaStyles() {
868
+ return "";
869
+ }
870
+ /**
871
+ * Returns an array with the dependencies for this UI5 Web Component, which could be:
872
+ * - composed components (used in its shadow root or static area item)
873
+ * - slotted components that the component may need to communicate with
874
+ *
875
+ * @protected
876
+ */
877
+ static get dependencies() {
878
+ return [];
879
+ }
880
+ /**
881
+ * Returns a list of the unique dependencies for this UI5 Web Component
882
+ *
883
+ * @public
884
+ */
885
+ static getUniqueDependencies() {
886
+ if (!uniqueDependenciesCache.has(this)) {
887
+ const filtered = this.dependencies.filter((dep, index, deps) => deps.indexOf(dep) === index);
888
+ uniqueDependenciesCache.set(this, filtered);
889
+ }
890
+ return uniqueDependenciesCache.get(this) || [];
891
+ }
892
+ /**
893
+ * Returns a promise that resolves whenever all dependencies for this UI5 Web Component have resolved
894
+ *
895
+ * @returns {Promise}
896
+ */
897
+ static whenDependenciesDefined() {
898
+ return Promise.all(this.getUniqueDependencies().map(dep => dep.define()));
899
+ }
900
+ /**
901
+ * Hook that will be called upon custom element definition
902
+ *
903
+ * @protected
904
+ * @returns {Promise<void>}
905
+ */
906
+ static async onDefine() {
907
+ return Promise.resolve();
908
+ }
909
+ /**
910
+ * Registers a UI5 Web Component in the browser window object
911
+ * @public
912
+ * @returns {Promise<UI5Element>}
913
+ */
914
+ static async define() {
915
+ await boot();
916
+ await Promise.all([
917
+ this.whenDependenciesDefined(),
918
+ this.onDefine(),
919
+ ]);
920
+ const tag = this.getMetadata().getTag();
921
+ const definedLocally = isTagRegistered(tag);
922
+ const definedGlobally = customElements.get(tag);
923
+ if (definedGlobally && !definedLocally) {
924
+ recordTagRegistrationFailure(tag);
925
+ }
926
+ else if (!definedGlobally) {
927
+ this._generateAccessors();
928
+ registerTag(tag);
929
+ window.customElements.define(tag, this);
930
+ preloadLinks(this);
931
+ }
932
+ return this;
933
+ }
934
+ /**
935
+ * Returns an instance of UI5ElementMetadata.js representing this UI5 Web Component's full metadata (its and its parents')
936
+ * Note: not to be confused with the "get metadata()" method, which returns an object for this class's metadata only
937
+ * @public
938
+ * @returns {UI5ElementMetadata}
939
+ */
940
+ static getMetadata() {
941
+ if (this.hasOwnProperty("_metadata")) { // eslint-disable-line
942
+ return this._metadata;
943
+ }
944
+ const effectiveMetadata = Object.keys(this.metadata).length ? this.metadata : this.decoratorMetadata;
945
+ const metadataObjects = [effectiveMetadata];
946
+ let klass = this; // eslint-disable-line
947
+ while (klass !== UI5Element) {
948
+ klass = Object.getPrototypeOf(klass);
949
+ const effectiveKlassMetadata = Object.keys(klass.metadata).length ? klass.metadata : klass.decoratorMetadata;
950
+ metadataObjects.unshift(effectiveKlassMetadata);
951
+ }
952
+ const mergedMetadata = merge({}, ...metadataObjects);
953
+ this._metadata = new UI5ElementMetadata(mergedMetadata);
954
+ return this._metadata;
955
+ }
1021
956
  }
1022
-
957
+ UI5Element.decoratorMetadata = {};
958
+ /**
959
+ * Always use duck-typing to cover all runtimes on the page.
960
+ * @returns {boolean}
961
+ */
962
+ const instanceOfUI5Element = (object) => {
963
+ return "isUI5Element" in object;
964
+ };
1023
965
  export default UI5Element;
966
+ export { instanceOfUI5Element };
967
+ //# sourceMappingURL=UI5Element.js.map