@openui5/sap.ui.documentation 1.144.0 → 1.146.0

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 (75) hide show
  1. package/REUSE.toml +40 -16
  2. package/THIRDPARTY.txt +28 -7
  3. package/package.json +7 -7
  4. package/src/sap/ui/documentation/.library +1 -1
  5. package/src/sap/ui/documentation/LightTable.js +20 -46
  6. package/src/sap/ui/documentation/Row.js +146 -7
  7. package/src/sap/ui/documentation/library.js +2 -2
  8. package/src/sap/ui/documentation/messagebundle.properties +2 -2
  9. package/src/sap/ui/documentation/messagebundle_ar.properties +2 -2
  10. package/src/sap/ui/documentation/messagebundle_bg.properties +2 -2
  11. package/src/sap/ui/documentation/messagebundle_ca.properties +2 -2
  12. package/src/sap/ui/documentation/messagebundle_cnr.properties +2 -2
  13. package/src/sap/ui/documentation/messagebundle_cs.properties +2 -2
  14. package/src/sap/ui/documentation/messagebundle_cy.properties +2 -2
  15. package/src/sap/ui/documentation/messagebundle_da.properties +2 -2
  16. package/src/sap/ui/documentation/messagebundle_de.properties +3 -3
  17. package/src/sap/ui/documentation/messagebundle_el.properties +2 -2
  18. package/src/sap/ui/documentation/messagebundle_en_GB.properties +2 -2
  19. package/src/sap/ui/documentation/messagebundle_en_US_sappsd.properties +2 -2
  20. package/src/sap/ui/documentation/messagebundle_en_US_saprigi.properties +2 -2
  21. package/src/sap/ui/documentation/messagebundle_en_US_saptrc.properties +2 -2
  22. package/src/sap/ui/documentation/messagebundle_es.properties +2 -2
  23. package/src/sap/ui/documentation/messagebundle_es_MX.properties +2 -2
  24. package/src/sap/ui/documentation/messagebundle_et.properties +2 -2
  25. package/src/sap/ui/documentation/messagebundle_fi.properties +2 -2
  26. package/src/sap/ui/documentation/messagebundle_fr.properties +2 -2
  27. package/src/sap/ui/documentation/messagebundle_fr_CA.properties +2 -2
  28. package/src/sap/ui/documentation/messagebundle_hi.properties +2 -2
  29. package/src/sap/ui/documentation/messagebundle_hr.properties +2 -2
  30. package/src/sap/ui/documentation/messagebundle_hu.properties +2 -2
  31. package/src/sap/ui/documentation/messagebundle_id.properties +2 -2
  32. package/src/sap/ui/documentation/messagebundle_it.properties +5 -5
  33. package/src/sap/ui/documentation/messagebundle_iw.properties +2 -2
  34. package/src/sap/ui/documentation/messagebundle_ja.properties +2 -2
  35. package/src/sap/ui/documentation/messagebundle_kk.properties +2 -2
  36. package/src/sap/ui/documentation/messagebundle_ko.properties +2 -2
  37. package/src/sap/ui/documentation/messagebundle_lt.properties +2 -2
  38. package/src/sap/ui/documentation/messagebundle_lv.properties +2 -2
  39. package/src/sap/ui/documentation/messagebundle_mk.properties +2 -2
  40. package/src/sap/ui/documentation/messagebundle_ms.properties +2 -2
  41. package/src/sap/ui/documentation/messagebundle_nl.properties +2 -2
  42. package/src/sap/ui/documentation/messagebundle_no.properties +2 -2
  43. package/src/sap/ui/documentation/messagebundle_pl.properties +2 -2
  44. package/src/sap/ui/documentation/messagebundle_pt.properties +2 -2
  45. package/src/sap/ui/documentation/messagebundle_pt_PT.properties +2 -2
  46. package/src/sap/ui/documentation/messagebundle_ro.properties +2 -2
  47. package/src/sap/ui/documentation/messagebundle_ru.properties +2 -2
  48. package/src/sap/ui/documentation/messagebundle_sh.properties +2 -2
  49. package/src/sap/ui/documentation/messagebundle_sk.properties +2 -2
  50. package/src/sap/ui/documentation/messagebundle_sl.properties +2 -2
  51. package/src/sap/ui/documentation/messagebundle_sr.properties +2 -2
  52. package/src/sap/ui/documentation/messagebundle_sv.properties +2 -2
  53. package/src/sap/ui/documentation/messagebundle_th.properties +2 -2
  54. package/src/sap/ui/documentation/messagebundle_tr.properties +2 -2
  55. package/src/sap/ui/documentation/messagebundle_uk.properties +2 -2
  56. package/src/sap/ui/documentation/messagebundle_vi.properties +2 -2
  57. package/src/sap/ui/documentation/messagebundle_zh_CN.properties +2 -2
  58. package/src/sap/ui/documentation/messagebundle_zh_TW.properties +2 -2
  59. package/src/sap/ui/documentation/sdk/controller/App.controller.js +1 -1
  60. package/src/sap/ui/documentation/sdk/controller/Code.controller.js +2 -0
  61. package/src/sap/ui/documentation/sdk/controller/ErrorHandler.js +1 -0
  62. package/src/sap/ui/documentation/sdk/controller/Sample.controller.js +18 -7
  63. package/src/sap/ui/documentation/sdk/controller/SubApiDetail.controller.js +487 -17
  64. package/src/sap/ui/documentation/sdk/controller/util/ConfigUtil.js +1 -0
  65. package/src/sap/ui/documentation/sdk/controller/util/CookiesConsentManager.js +1 -0
  66. package/src/sap/ui/documentation/sdk/controller/util/UsageTracker.js +7 -2
  67. package/src/sap/ui/documentation/sdk/cookieSettingsDialog/controller/CookieSettingsDialog.controller.js +1 -0
  68. package/src/sap/ui/documentation/sdk/thirdparty/highlight.js/highlight.js +3 -3
  69. package/src/sap/ui/documentation/sdk/util/DocumentationRouter.js +5 -0
  70. package/src/sap/ui/documentation/sdk/view/FooterMaster.fragment.xml +1 -1
  71. package/src/sap/ui/documentation/sdk/view/SubApiDetail.view.xml +10 -24
  72. package/src/sap/ui/documentation/themes/base/Documentation.less +4 -4
  73. package/src/sap/ui/documentation/themes/base/LightTable.less +29 -0
  74. package/src/sap/ui/documentation/themes/sap_belize_base/Documentation.less +4 -4
  75. package/src/sap/ui/documentation/themes/sap_horizon_dark/Documentation.less +1 -1
@@ -26,8 +26,10 @@ sap.ui.define(
26
26
  const oURL = new URL(sURL),
27
27
  sSectionTitle = oRouter.getRouteTopLevelTitle(oRouteConfig);
28
28
 
29
+ var sHash = oURL.hash.replace(/\.html/, '');
30
+
29
31
  this.url = sURL;
30
- this.name = oURL.pathname + oURL.hash;
32
+ this.name = oURL.pathname + sHash;
31
33
  this.section = sSectionTitle || "/";
32
34
  this.title = undefined;
33
35
  this.language = oUserLanguageTag.language;
@@ -67,6 +69,7 @@ sap.ui.define(
67
69
  "sap.ui.documentation.sdk.controller.util.UsageTracker",
68
70
  {
69
71
  constructor: function (oComponent) {
72
+ BaseObject.call(this);
70
73
  this._oComponent = oComponent;
71
74
  this._oRouter = oComponent.getRouter();
72
75
  this._oConfig = oComponent.getConfig();
@@ -250,6 +253,7 @@ sap.ui.define(
250
253
  * Triggered when router does not find the route
251
254
  */
252
255
  _logPageNotFound: function (sHash) {
256
+ sHash = sHash.replace(/\.html/, '');
253
257
  this._addToLogs({
254
258
  event: "errorPage",
255
259
  page: {
@@ -274,9 +278,10 @@ sap.ui.define(
274
278
  oPageInfo = new PageInfo(oRouteConfig, this._oRouter);
275
279
  } else {
276
280
  var oURL = new URL(window.location.href);
281
+ var sHash = oURL.hash.replace(/\.html/, '');
277
282
  oPageInfo = {
278
283
  url: window.location.href,
279
- name: oURL.pathname + oURL.hash,
284
+ name: oURL.pathname + sHash,
280
285
  section: "/"
281
286
  };
282
287
  }
@@ -16,6 +16,7 @@ sap.ui.define([
16
16
  return Controller.extend("sap.ui.documentation.sdk.cookieSettingsDialog.controller.CookieSettingsDialog", {
17
17
 
18
18
  constructor: function() {
19
+ Controller.call(this);
19
20
  this._oCookiesUtil = null;
20
21
  this._oRootView = null;
21
22
  this._oInitOptions = null;
@@ -998,10 +998,10 @@ var hljs = (function () {
998
998
  * @param {string} message
999
999
  */
1000
1000
  const deprecated = (version, message) => {
1001
- if (seenDeprecations[`1.144.0/${message}`]) return;
1001
+ if (seenDeprecations[`1.146.0/${message}`]) return;
1002
1002
 
1003
- console.log(`Deprecated as of 1.144.0. ${message}`);
1004
- seenDeprecations[`1.144.0/${message}`] = true;
1003
+ console.log(`Deprecated as of 1.146.0. ${message}`);
1004
+ seenDeprecations[`1.146.0/${message}`] = true;
1005
1005
  };
1006
1006
 
1007
1007
  /* eslint-disable no-throw-literal */
@@ -732,6 +732,11 @@ sap.ui.define([
732
732
  return sNewHref;
733
733
  };
734
734
 
735
+ DocumentationRouter.prototype.destroy = function () {
736
+ this.detachPopstateHandler();
737
+ Router.prototype.destroy.apply(this, arguments);
738
+ };
739
+
735
740
  // util
736
741
  function getClosestParentLink(oAnchorElement, bSameWindow, iMaxDrillUp) {
737
742
  var bIsAnchor = isAnchorElement(oAnchorElement, bSameWindow), iDrillUp = 0;
@@ -2,7 +2,7 @@
2
2
  xmlns="sap.m"
3
3
  xmlns:tnt="sap.tnt"
4
4
  xmlns:core="sap.ui.core">
5
- <tnt:NavigationList itemSelect="handleFooterMasterItemPress">
5
+ <tnt:NavigationList visible="{= !${device>/system/phone} }" itemSelect="handleFooterMasterItemPress">
6
6
  <tnt:NavigationListItem icon="sap-icon://compare" key="legal" text="{i18n>APP_INFORMATION_BTN_LEGAL}" />
7
7
  <tnt:NavigationListItem icon="sap-icon://locked" key="privacy" text="{i18n>APP_INFORMATION_BTN_PRIVACY}" />
8
8
  <tnt:NavigationListItem icon="sap-icon://permission" text="{i18n>APP_INFORMATION_BTN_LICENSE}" key="license" visible="{versionData>/isOpenUI5}" />
@@ -26,16 +26,16 @@
26
26
  <headerTitle>
27
27
  <ObjectPageDynamicHeaderTitle id="title">
28
28
  <expandedHeading>
29
- <m:FlexBox fitContainer="true" alignItems="Center">
29
+ <m:FlexBox fitContainer="true" direction="Column" alignItems="Start">
30
30
  <m:Title text="{/title}" wrapping="true" />
31
- <m:Label text="{/subTitle}" />
31
+ <m:Label text="{/subTitle}" class="sapUiTinyMarginTop" />
32
32
  </m:FlexBox>
33
33
  </expandedHeading>
34
34
 
35
35
  <snappedHeading>
36
- <m:FlexBox fitContainer="true" alignItems="Center">
36
+ <m:FlexBox fitContainer="true" direction="Column" alignItems="Start">
37
37
  <m:Title text="{/title}" wrapping="true" />
38
- <m:Label text="{/subTitle}" />
38
+ <m:Label text="{/subTitle}" class="sapUiTinyMarginTop" />
39
39
  </m:FlexBox>
40
40
  </snappedHeading>
41
41
 
@@ -248,7 +248,7 @@
248
248
  columnTitles="Param,Type,Default Value,Description"
249
249
  columnCount="4"
250
250
  class="sapUiDocumentationParamsTable">
251
- <custom:Row>
251
+ <custom:Row expandable="{= ${typeInfo/refersToTypedef} === true}" typedefName="{= ${typeInfo/UI5Types} ? ${typeInfo/UI5Types/0} : ${typeInfo/type} }" expandToggle="onTypedefToggle">
252
252
  <custom:ParamText text="{name}" phoneText="{phoneName}" depth="{depth}" optional="{optional}"/>
253
253
  <custom:JSDocType typeInfo="{parts: ['typeInfo', 'types', 'type', 'linkEnabled'], formatter: '.formatter.formatJSDocType'}"/>
254
254
  <m:Text text="{defaultValue}" wrapping="false"/>
@@ -295,7 +295,7 @@
295
295
  <m:Text text="{defaultValue}"/>
296
296
  <layout:VerticalLayout width="100%">
297
297
  <custom:JSDocText sanitizeContent="false" text="{description}"/>
298
- <layout:HorizontalLayout width="100%">
298
+ <layout:HorizontalLayout>
299
299
  <m:ObjectStatus text="Visibility: {parts : [{path : 'visibility'}, {path : 'allowedFor'}], formatter : '.formatter.formatVisibility'}"
300
300
  state="{= ${visibility} === 'public' ? 'Success' : 'Warning'}"/>
301
301
  <core:Icon
@@ -512,7 +512,7 @@
512
512
 
513
513
  <custom:JSDocText sanitizeContent="false" text="{path: 'event>description', formatter: '.formatter.escapeSettingsValue'}"/>
514
514
 
515
- <layout:HorizontalLayout width="100%">
515
+ <layout:HorizontalLayout>
516
516
  <m:ObjectStatus text="Visibility: {parts : [{path : 'event>visibility'}, {path : 'event>allowedFor'}], formatter : '.formatter.formatVisibility'}"
517
517
  state="{= ${event>visibility} === 'public' ? 'Success' : 'Warning'}" class="sapUiSmallMarginBottom"/>
518
518
  <core:Icon
@@ -544,7 +544,7 @@
544
544
  <template:if test="{= !!${event>parameters} &amp;&amp; ${event>parameters}.length > 0}">
545
545
  <custom:LightTable columnTitles="Param,Type,Description" columnCount="3">
546
546
  <template:repeat list="{event>parameters}" var="parameter">
547
- <custom:Row>
547
+ <custom:Row expandable="{= ${parameter>typeInfo/refersToTypedef} === true}" typedefName="{= ${parameter>typeInfo/UI5Types} ? ${parameter>typeInfo/UI5Types/0} : ${parameter>typeInfo/type} }" expandToggle="onTypedefToggle">
548
548
  <custom:ParamText text="{parameter>name}" phoneText="{parameter>phoneName}" depth="{parameter>depth}" optional="{parameter>optional}"/>
549
549
  <custom:JSDocType typeInfo="{parts: ['parameter>typeInfo', 'parameter>types', 'parameter>type', 'parameter>linkEnabled'], formatter: '.formatter.stringifyJSDocType'}"/>
550
550
  <layout:VerticalLayout>
@@ -627,7 +627,7 @@
627
627
  </layout:VerticalLayout>
628
628
 
629
629
  <m:FlexBox class="sapUiTinyMarginBottom">
630
- <layout:HorizontalLayout width="100%">
630
+ <layout:HorizontalLayout>
631
631
  <m:ObjectStatus text="Visibility: {parts : [{path : 'method>visibility'}, {path : 'method>allowedFor'}], formatter : '.formatter.formatVisibility'}"
632
632
  state="{= ${method>visibility} === 'public' ? 'Success' : 'Warning'}"/>
633
633
  <core:Icon
@@ -668,7 +668,7 @@
668
668
  columnTitles="Param,Type,Default Value,Description"
669
669
  class="sapUiDocumentationParamsTable">
670
670
  <template:repeat list="{method>parameters}" var="parameter">
671
- <custom:Row>
671
+ <custom:Row expandable="{= ${parameter>typeInfo/refersToTypedef} === true}" typedefName="{= ${parameter>typeInfo/UI5Types} ? ${parameter>typeInfo/UI5Types/0} : ${parameter>typeInfo/type} }" expandToggle="onTypedefToggle">
672
672
  <custom:ParamText text="{parameter>name}" phoneText="{parameter>phoneName}" depth="{parameter>depth}" optional="{parameter>optional}"/>
673
673
  <custom:JSDocType typeInfo="{parts: ['parameter>typeInfo','parameter>types'], formatter: '.formatter.stringifyJSDocType'}"/>
674
674
  <m:Text text="{parameter>defaultValue}" wrapping="false"/>
@@ -782,20 +782,6 @@
782
782
  </ObjectPageSection>
783
783
  </template:if>
784
784
 
785
- <template:if test="{data>/hasFAQ}">
786
- <ObjectPageSection id="faq" title="FAQ" class="faqContent">
787
- <subSections>
788
- <custom:ObjectPageSubSection>
789
- <custom:blocks>
790
- <core:HTML id="parserId" content="{/faqContent}"/>
791
- </custom:blocks>
792
- </custom:ObjectPageSubSection>
793
- </subSections>
794
- </ObjectPageSection>
795
- </template:if>
796
-
797
- <core:ExtensionPoint name="customSections" />
798
-
799
785
  </sections>
800
786
 
801
787
  </ObjectPageLayout>
@@ -42,7 +42,7 @@ html.sap-tablet:not(.sap-desktop) {
42
42
  }
43
43
  }
44
44
 
45
- .faqContent {
45
+ .sectionContent {
46
46
  details {
47
47
  margin: 0.8em;
48
48
  }
@@ -67,10 +67,10 @@ html.sap-tablet:not(.sap-desktop) {
67
67
  }
68
68
 
69
69
  #d4h5-main-container,
70
- .faqContent {
70
+ .sectionContent {
71
71
  font-size: 0.875em;
72
72
 
73
- &.faqContent pre > code {
73
+ &.sectionContent pre > code {
74
74
  font-family: monospace;
75
75
  }
76
76
 
@@ -157,7 +157,7 @@ html.sap-tablet:not(.sap-desktop) {
157
157
  }
158
158
  }
159
159
 
160
- &.faqContent h2,
160
+ &.sectionContent h2,
161
161
  .section.topic > .innerTitle > h2 {
162
162
  font-size: 2em;
163
163
  font-weight: 400;
@@ -144,6 +144,30 @@
144
144
  border-bottom: solid 1px #e5e5e5;
145
145
  border-left: solid 1px #e5e5e5;
146
146
  border-right: solid 1px #e5e5e5;
147
+
148
+ &.subrow,
149
+ &.expanded {
150
+ background-color: #f5f5f5;
151
+ }
152
+
153
+ /* Expandable rows - display icon and ParamText inline */
154
+ &.collapsed,
155
+ &.expanded {
156
+ > .cell:first-child {
157
+ display: flex;
158
+ align-items: flex-start;
159
+
160
+ .sapUiDocTypedefExpandIcon {
161
+ margin-top: 0.25rem;
162
+ flex-shrink: 0;
163
+ color: var(--sapButton_Lite_TextColor);
164
+ }
165
+
166
+ .sapUiParamText {
167
+ flex: 1;
168
+ }
169
+ }
170
+ }
147
171
  }
148
172
 
149
173
  .sapUiTheme-sap_belize_hcb .sapUiDocLightTable .head,
@@ -182,6 +206,11 @@
182
206
  .sapUiDocLightTable .row {
183
207
  background-color: @sapBaseColor;
184
208
  border-bottom: solid 1px @sapPageHeader_BorderColor;
209
+
210
+ &.subrow,
211
+ &.expanded {
212
+ background-color: #282c34;
213
+ }
185
214
  }
186
215
 
187
216
  .sapUiDocLightTable .head,
@@ -42,7 +42,7 @@ html.sap-tablet:not(.sap-desktop) {
42
42
  }
43
43
  }
44
44
 
45
- .faqContent {
45
+ .sectionContent {
46
46
  details {
47
47
  margin: 0.8em;
48
48
  }
@@ -67,10 +67,10 @@ html.sap-tablet:not(.sap-desktop) {
67
67
  }
68
68
 
69
69
  #d4h5-main-container,
70
- .faqContent {
70
+ .sectionContent {
71
71
  font-size: 0.875em;
72
72
 
73
- &.faqContent pre > code {
73
+ &.sectionContent pre > code {
74
74
  font-family: monospace;
75
75
  }
76
76
 
@@ -156,7 +156,7 @@ html.sap-tablet:not(.sap-desktop) {
156
156
  }
157
157
  }
158
158
 
159
- &.faqContent h2,
159
+ &.sectionContent h2,
160
160
  .section.topic > .innerTitle > h2 {
161
161
  font-size: 2em;
162
162
  font-weight: 400;
@@ -3,7 +3,7 @@
3
3
  @code-highlight-color: #24435e;
4
4
 
5
5
  #d4h5-main-container,
6
- .faqContent {
6
+ .sectionContent {
7
7
 
8
8
  .note,
9
9
  pre.codeblock,