@ui5/webcomponents-base 0.0.0-b4cbc43ba → 0.0.0-b93bc8b37

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