@salesforcedevs/docs-components 0.0.0 → 0.0.1-superscript

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 (83) hide show
  1. package/lwc.config.json +12 -2
  2. package/package.json +29 -27
  3. package/src/modules/doc/{amfReference/utils.ts → amfModelParser/amfModelParser.ts} +10 -5
  4. package/src/modules/doc/amfReference/amfReference.css +11 -3
  5. package/src/modules/doc/amfReference/amfReference.html +35 -26
  6. package/src/modules/doc/amfReference/amfReference.ts +239 -95
  7. package/src/modules/doc/amfReference/types.ts +3 -11
  8. package/src/modules/doc/amfTopic/amfTopic.css +20 -0
  9. package/src/modules/doc/amfTopic/amfTopic.ts +59 -18
  10. package/src/modules/doc/amfTopic/types.ts +15 -13
  11. package/src/modules/doc/amfTopic/utils.ts +12 -6
  12. package/src/modules/doc/breadcrumbItem/breadcrumbItem.ts +17 -10
  13. package/src/modules/doc/breadcrumbs/breadcrumbs.html +6 -9
  14. package/src/modules/doc/breadcrumbs/breadcrumbs.ts +30 -34
  15. package/src/modules/doc/componentPlayground/componentPlayground.css +30 -0
  16. package/src/modules/doc/componentPlayground/componentPlayground.html +20 -0
  17. package/src/modules/doc/componentPlayground/componentPlayground.ts +97 -0
  18. package/src/modules/doc/content/content.css +70 -76
  19. package/src/modules/doc/content/content.html +1 -0
  20. package/src/modules/doc/content/content.ts +24 -46
  21. package/src/modules/doc/contentCallout/contentCallout.css +11 -7
  22. package/src/modules/doc/contentCallout/contentCallout.html +11 -4
  23. package/src/modules/doc/contentCallout/contentCallout.ts +8 -1
  24. package/src/modules/doc/contentLayout/contentLayout.css +1 -98
  25. package/src/modules/doc/contentLayout/contentLayout.html +46 -31
  26. package/src/modules/doc/contentLayout/contentLayout.ts +337 -89
  27. package/src/modules/doc/contentMedia/contentMedia.css +1 -1
  28. package/src/modules/doc/doDont/doDont.css +47 -0
  29. package/src/modules/doc/doDont/doDont.html +27 -0
  30. package/src/modules/doc/doDont/doDont.ts +17 -0
  31. package/src/modules/doc/header/header.css +65 -36
  32. package/src/modules/doc/header/header.html +44 -138
  33. package/src/modules/doc/header/header.ts +62 -74
  34. package/src/modules/doc/heading/heading.css +16 -37
  35. package/src/modules/doc/heading/heading.html +4 -4
  36. package/src/modules/doc/heading/heading.ts +12 -10
  37. package/src/modules/doc/headingAnchor/headingAnchor.css +2 -2
  38. package/src/modules/doc/headingAnchor/headingAnchor.ts +2 -2
  39. package/src/modules/doc/headingContent/headingContent.css +1 -1
  40. package/src/modules/doc/headingContent/headingContent.html +2 -2
  41. package/src/modules/doc/headingContent/headingContent.ts +2 -2
  42. package/src/modules/doc/lwcContentLayout/lwcContentLayout.css +9 -0
  43. package/src/modules/doc/lwcContentLayout/lwcContentLayout.html +64 -0
  44. package/src/modules/doc/lwcContentLayout/lwcContentLayout.ts +269 -0
  45. package/src/modules/doc/overview/overview.css +40 -0
  46. package/src/modules/doc/overview/overview.html +34 -0
  47. package/src/modules/doc/overview/overview.ts +12 -0
  48. package/src/modules/doc/phase/phase.css +11 -3
  49. package/src/modules/doc/phase/phase.html +12 -2
  50. package/src/modules/doc/phase/phase.ts +44 -8
  51. package/src/modules/doc/redocReference/redocReference.css +7 -0
  52. package/src/modules/doc/redocReference/redocReference.html +13 -0
  53. package/src/modules/doc/redocReference/redocReference.ts +425 -0
  54. package/src/modules/doc/specificationContent/specificationContent.css +36 -0
  55. package/src/modules/doc/specificationContent/specificationContent.html +177 -0
  56. package/src/modules/doc/specificationContent/specificationContent.ts +166 -0
  57. package/src/modules/doc/sprigSurvey/sprigSurvey.html +20 -0
  58. package/src/modules/doc/sprigSurvey/sprigSurvey.scoped.css +16 -0
  59. package/src/modules/doc/sprigSurvey/sprigSurvey.ts +16 -0
  60. package/src/modules/doc/superscriptSubscript/superscriptSubscript.html +8 -0
  61. package/src/modules/doc/superscriptSubscript/superscriptSubscript.ts +16 -0
  62. package/src/modules/doc/toc/toc.html +1 -3
  63. package/src/modules/doc/toc/toc.ts +1 -1
  64. package/src/modules/doc/toolbar/toolbar.ts +6 -6
  65. package/src/modules/doc/versionPicker/versionPicker.css +64 -0
  66. package/src/modules/doc/versionPicker/versionPicker.html +40 -0
  67. package/src/modules/doc/versionPicker/versionPicker.ts +65 -0
  68. package/src/modules/doc/xmlContent/types.ts +9 -3
  69. package/src/modules/doc/xmlContent/utils.ts +3 -1
  70. package/src/modules/doc/xmlContent/xmlContent.css +16 -4
  71. package/src/modules/doc/xmlContent/xmlContent.html +36 -21
  72. package/src/modules/doc/xmlContent/xmlContent.ts +295 -120
  73. package/src/modules/docHelpers/amfStyle/amfStyle.css +6 -8
  74. package/src/modules/docHelpers/contentLayoutStyle/contentLayoutStyle.css +162 -0
  75. package/src/modules/docHelpers/imgStyle/imgStyle.css +59 -0
  76. package/src/modules/docHelpers/status/status.css +1 -1
  77. package/src/modules/docUtils/{SearchSyncer/SearchSyncer.ts → searchSyncer/searchSyncer.ts} +1 -0
  78. package/src/modules/docUtils/utils/__mocks__/coveo.analytics.ts +16 -0
  79. package/src/modules/docUtils/utils/coveo.analytics.d.ts +10 -0
  80. package/src/modules/docUtils/utils/utils.ts +32 -0
  81. package/LICENSE +0 -12
  82. package/src/modules/docBaseElements/lightningElementWithState/lightningElementWithState.ts +0 -93
  83. package/src/modules/docHelpers/phaseContentLayout/phaseContentLayout.css +0 -39
@@ -3,11 +3,16 @@
3
3
  --button-primary-color-hover: var(--dx-g-blue-vibrant-40);
4
4
  }
5
5
 
6
+ doc-content-layout {
7
+ --dx-c-content-sidebar-sticky-top: var(--dx-g-global-header-height);
8
+ --dx-c-sidebar-height: calc(100vh - var(--dx-g-global-header-height));
9
+ }
10
+
6
11
  doc-breadcrumbs {
7
12
  --dx-c-popover-z-index: 5;
8
13
 
9
14
  display: block;
10
- margin-bottom: var(--dx-g-spacing-2xl);
15
+ margin-bottom: var(--dx-g-spacing-md);
11
16
  }
12
17
 
13
18
  dx-dropdown {
@@ -26,7 +31,14 @@ dx-dropdown > dx-button:hover {
26
31
  --border-color: var(--button-primary-color-hover);
27
32
  }
28
33
 
29
- .document-pickers {
30
- margin-left: auto;
31
- margin-right: var(--dx-g-spacing-sm);
34
+ @media screen and (max-width: 768px) {
35
+ doc-content-layout {
36
+ --dx-g-doc-header-main-nav-height: 41px;
37
+ --dx-g-doc-header-height: calc(
38
+ var(--dx-g-doc-header-main-nav-height) + 40px
39
+ );
40
+ --dx-c-content-sidebar-sticky-top: calc(
41
+ var(--dx-g-global-header-height) + var(--dx-g-doc-header-height)
42
+ );
43
+ }
32
44
  }
@@ -1,32 +1,40 @@
1
1
  <template>
2
2
  <doc-content-layout
3
- if:true={loaded}
4
- coveo-organization-id={coveoOrganizationId}
5
- coveo-public-access-token={coveoPublicAccessToken}
6
- coveo-search-hub="Developer_Docs_SS"
7
- coveo-advanced-query-config={coveoAdvancedQueryConfig}
8
- sidebar-header="Pages"
3
+ lwc:if={displayContent}
4
+ lwc:ref="docContentLayout"
5
+ sidebar-header={docTitle}
9
6
  sidebar-content={sidebarContent}
10
7
  sidebar-value={sidebarValue}
11
8
  onselect={handleSelect}
12
- use-old-sidebar={useOldSidebar}
9
+ onlangchange={handleLanguageChange}
10
+ languages={sidebarFooterContent.languages}
11
+ language={sidebarFooterContent.language}
12
+ bail-href={sidebarFooterContent.bailHref}
13
+ bail-label={sidebarFooterContent.bailLabel}
14
+ show-footer={enableFooter}
15
+ reading-time={computedReadingTime}
13
16
  >
14
- <div slot="sidebar-header" class="document-pickers">
15
- <dx-dropdown
17
+ <doc-phase
18
+ slot="version-banner"
19
+ lwc:if={showVersionBanner}
20
+ doc-phase-info={oldVersionInfo}
21
+ icon-name="warning"
22
+ dismissible="true"
23
+ ondismissphase={handleDismissVersionBanner}
24
+ ></doc-phase>
25
+ <div lwc:if={showVersionPicker} slot="sidebar-header">
26
+ <doc-version-picker
16
27
  data-type="version"
17
- suppress-gtm-nav-headings
18
- analytics-event={analyticsEvent}
19
- options={versionOptions}
20
- value={version.id}
21
- width="290px"
22
- >
23
- <dx-button variant="inline" disabled={disableVersion}>
24
- {version.releaseVersion}
25
- </dx-button>
26
- </dx-dropdown>
28
+ analytics-event="custEv_linkClick"
29
+ analytics-payload={ANALYTICS_PAYLOAD}
30
+ versions={versionOptions}
31
+ selected-version={version}
32
+ latest-version={latestVersion}
33
+ hide-badge={previewVersion}
34
+ ></doc-version-picker>
27
35
  </div>
28
36
  <doc-breadcrumbs
29
- if:true={showBreadcrumbs}
37
+ lwc:if={showBreadcrumbs}
30
38
  breadcrumbs={breadcrumbs}
31
39
  pixel-per-character={breadcrumbPixelPerCharacter}
32
40
  ></doc-breadcrumbs>
@@ -34,7 +42,14 @@
34
42
  docs-data={docContent}
35
43
  page-reference={pageReference}
36
44
  onnavclick={handleNavClick}
37
- style={docContentStyle}
38
45
  ></doc-content>
39
46
  </doc-content-layout>
47
+ <div lwc:if={display404}>
48
+ <dx-error
49
+ image="https://a.sfdcstatic.com/developer-website/prod/images/404.svg"
50
+ code="404"
51
+ header="Beep boop. That did not compute."
52
+ subtitle="The document you're looking for doesn't seem to exist."
53
+ ></dx-error>
54
+ </div>
40
55
  </template>