@salesforcedevs/docs-components 0.6.0 → 0.7.59-sppage-alpha1
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.
- package/lwc.config.json +17 -3
- package/package.json +16 -6
- package/src/modules/README.md +41 -0
- package/src/modules/doc/amfModelParser/amfModelParser.ts +674 -0
- package/src/modules/doc/amfReference/amfReference.css +25 -0
- package/src/modules/doc/amfReference/amfReference.html +60 -0
- package/src/modules/doc/amfReference/amfReference.ts +1494 -0
- package/src/modules/doc/amfReference/constants.ts +76 -0
- package/src/modules/doc/amfReference/types.ts +125 -0
- package/src/modules/doc/amfTopic/amfTopic.css +21 -0
- package/src/modules/doc/amfTopic/amfTopic.html +3 -0
- package/src/modules/doc/amfTopic/amfTopic.ts +111 -0
- package/src/modules/doc/amfTopic/types.ts +56 -0
- package/src/modules/doc/amfTopic/utils.ts +136 -0
- package/src/modules/doc/breadcrumbItem/breadcrumbItem.css +51 -0
- package/src/modules/doc/breadcrumbItem/breadcrumbItem.html +5 -0
- package/src/modules/doc/breadcrumbItem/breadcrumbItem.ts +71 -0
- package/src/modules/doc/breadcrumbs/breadcrumbs.css +27 -0
- package/src/modules/doc/breadcrumbs/breadcrumbs.html +58 -0
- package/src/modules/doc/breadcrumbs/breadcrumbs.ts +192 -0
- package/src/modules/doc/content/content.css +94 -70
- package/src/modules/doc/content/content.ts +233 -169
- package/src/modules/doc/contentCallout/contentCallout.css +17 -23
- package/src/modules/doc/contentCallout/contentCallout.html +13 -4
- package/src/modules/doc/contentCallout/contentCallout.ts +16 -3
- package/src/modules/doc/contentLayout/contentLayout.css +131 -0
- package/src/modules/doc/contentLayout/contentLayout.html +64 -0
- package/src/modules/doc/contentLayout/contentLayout.ts +610 -0
- package/src/modules/doc/doDont/doDont.css +47 -0
- package/src/modules/doc/doDont/doDont.html +27 -0
- package/src/modules/doc/doDont/doDont.ts +17 -0
- package/src/modules/doc/header/header.css +70 -37
- package/src/modules/doc/header/header.html +40 -134
- package/src/modules/doc/header/header.ts +29 -78
- package/src/modules/doc/heading/heading.css +33 -0
- package/src/modules/doc/heading/heading.html +14 -0
- package/src/modules/doc/heading/heading.ts +67 -0
- package/src/modules/doc/headingAnchor/headingAnchor.css +33 -0
- package/src/modules/doc/headingAnchor/headingAnchor.html +19 -0
- package/src/modules/doc/headingAnchor/headingAnchor.ts +43 -0
- package/src/modules/doc/headingContent/headingContent.css +53 -0
- package/src/modules/doc/headingContent/headingContent.html +13 -0
- package/src/modules/doc/headingContent/headingContent.ts +30 -0
- package/src/modules/doc/overview/overview.css +40 -0
- package/src/modules/doc/overview/overview.html +34 -0
- package/src/modules/doc/overview/overview.ts +12 -0
- package/src/modules/doc/phase/phase.css +70 -0
- package/src/modules/doc/phase/phase.html +38 -0
- package/src/modules/doc/phase/phase.ts +93 -0
- package/src/modules/doc/specificationContent/specificationContent.css +3 -0
- package/src/modules/doc/specificationContent/specificationContent.html +99 -0
- package/src/modules/doc/specificationContent/specificationContent.ts +56 -0
- package/src/modules/doc/sprigSurvey/sprigSurvey.html +20 -0
- package/src/modules/doc/sprigSurvey/sprigSurvey.scoped.css +16 -0
- package/src/modules/doc/sprigSurvey/sprigSurvey.ts +16 -0
- package/src/modules/doc/toc/toc.ts +1 -1
- package/src/modules/doc/versionPicker/versionPicker.css +64 -0
- package/src/modules/doc/versionPicker/versionPicker.html +38 -0
- package/src/modules/doc/versionPicker/versionPicker.ts +65 -0
- package/src/modules/doc/xmlContent/types.ts +120 -0
- package/src/modules/doc/xmlContent/utils.ts +163 -0
- package/src/modules/doc/xmlContent/xmlContent.css +54 -0
- package/src/modules/doc/xmlContent/xmlContent.html +52 -0
- package/src/modules/doc/xmlContent/xmlContent.ts +780 -0
- package/src/modules/docHelpers/amfStyle/amfStyle.css +355 -0
- package/src/modules/docHelpers/imgStyle/imgStyle.css +59 -0
- package/src/modules/docHelpers/status/status.css +22 -0
- package/src/modules/docUtils/searchSyncer/searchSyncer.ts +86 -0
- package/src/modules/docUtils/utils/utils.ts +32 -0
- package/LICENSE +0 -12
- package/src/modules/doc/content/__tests__/content.test.ts +0 -120
- package/src/modules/doc/content/__tests__/mockDocContent.ts +0 -292
- package/src/modules/doc/content/__tests__/mockPageReference.ts +0 -8
- package/src/modules/doc/content/content.stories.ts +0 -108
- package/src/modules/doc/contentCallout/__tests__/contentCallout.test.ts +0 -80
- package/src/modules/doc/contentCallout/__tests__/mockProps.ts +0 -14
- package/src/modules/doc/contentCallout/contentCallout.stories.ts +0 -29
- package/src/modules/doc/contentMedia/__tests__/contentMedia.test.ts +0 -97
- package/src/modules/doc/contentMedia/contentMedia.stories.ts +0 -113
- package/src/modules/doc/header/__tests__/coveoConfig.ts +0 -12
- package/src/modules/doc/header/__tests__/header.test.ts +0 -409
- package/src/modules/doc/header/__tests__/mockNavDevelopers.ts +0 -427
- package/src/modules/doc/header/__tests__/mockNavs.ts +0 -115
- package/src/modules/doc/header/__tests__/mockProps.ts +0 -149
- package/src/modules/doc/header/header.stories.ts +0 -160
- package/src/modules/doc/nav/__tests__/mockAvailableLanguages.ts +0 -8
- package/src/modules/doc/nav/__tests__/mockAvailableVersions.ts +0 -122
- package/src/modules/doc/nav/__tests__/mockPageReference.ts +0 -8
- package/src/modules/doc/nav/__tests__/mockPdfUrl.ts +0 -1
- package/src/modules/doc/nav/__tests__/mockSelectedLanguage.ts +0 -8
- package/src/modules/doc/nav/__tests__/mockSelectedVersion.ts +0 -8
- package/src/modules/doc/nav/__tests__/mockToc.ts +0 -146
- package/src/modules/doc/nav/__tests__/nav.test.ts +0 -58
- package/src/modules/doc/toc/__tests__/mockPageReference.ts +0 -8
- package/src/modules/doc/toc/__tests__/mockToc.ts +0 -146
- package/src/modules/doc/toc/__tests__/toc.test.ts +0 -29
- package/src/modules/doc/toolbar/__tests__/mockAvailableLanguages.ts +0 -8
- package/src/modules/doc/toolbar/__tests__/mockAvailableVersions.ts +0 -122
- package/src/modules/doc/toolbar/__tests__/mockPdfUrl.ts +0 -1
- package/src/modules/doc/toolbar/__tests__/mockSelectedLanguage.ts +0 -8
- package/src/modules/doc/toolbar/__tests__/mockSelectedVersion.ts +0 -8
- package/src/modules/doc/toolbar/__tests__/toolbar.test.ts +0 -44
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
:host {
|
|
2
|
+
--dx-c-content-vertical-spacing: var(--dx-g-spacing-lg);
|
|
3
|
+
--dx-c-content-sidebar-sticky-top: calc(
|
|
4
|
+
var(--dx-g-global-header-height) + var(--dx-g-doc-header-height)
|
|
5
|
+
);
|
|
6
|
+
--dx-c-sidebar-height: calc(
|
|
7
|
+
100vh -
|
|
8
|
+
calc(
|
|
9
|
+
var(--dx-g-global-header-height) + var(--dx-g-doc-header-height)
|
|
10
|
+
)
|
|
11
|
+
);
|
|
12
|
+
--dx-c-content-scroll-margin-top: calc(
|
|
13
|
+
var(--dx-g-global-header-height) + var(--dx-g-doc-header-height) +
|
|
14
|
+
var(--dx-g-spacing-2xl)
|
|
15
|
+
);
|
|
16
|
+
|
|
17
|
+
display: block;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
doc-breadcrumbs {
|
|
21
|
+
--dx-c-popover-z-index: 5;
|
|
22
|
+
|
|
23
|
+
display: block;
|
|
24
|
+
margin-bottom: var(--dx-g-spacing-2xl);
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
dx-sidebar,
|
|
28
|
+
dx-sidebar-old {
|
|
29
|
+
--dx-c-sidebar-vertical-padding: var(--dx-g-spacing-md);
|
|
30
|
+
|
|
31
|
+
z-index: calc(var(--dx-g-z-index-100) + 5);
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
dx-toc {
|
|
35
|
+
--dx-c-toc-width: unset;
|
|
36
|
+
|
|
37
|
+
height: calc(100% - var(--dx-c-content-vertical-spacing) * 2);
|
|
38
|
+
margin: var(--dx-c-content-vertical-spacing) 0;
|
|
39
|
+
overflow-y: auto;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
dx-sidebar,
|
|
43
|
+
dx-toc {
|
|
44
|
+
display: block;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/* offset page jump link due to fixed header */
|
|
48
|
+
::slotted(doc-heading) {
|
|
49
|
+
scroll-margin-top: var(--dx-c-content-scroll-margin-top);
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
.content {
|
|
53
|
+
display: flex;
|
|
54
|
+
position: relative;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
.content-body-doc-phase-container {
|
|
58
|
+
flex: 1;
|
|
59
|
+
border-left: 1px solid var(--dx-g-gray-90);
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
.content-body-container {
|
|
63
|
+
display: flex;
|
|
64
|
+
flex-direction: row;
|
|
65
|
+
justify-content: center;
|
|
66
|
+
max-width: var(--dx-g-doc-content-max-width);
|
|
67
|
+
|
|
68
|
+
/* Derived this manually by substracting (topHeader, doc header, banner and the content). */
|
|
69
|
+
min-height: 62vh;
|
|
70
|
+
margin: auto;
|
|
71
|
+
padding: 0 var(--dx-g-global-header-padding-horizontal);
|
|
72
|
+
margin-bottom: calc(2 * (var(--dx-g-spacing-5xl) + 4px));
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
.content-body {
|
|
76
|
+
margin: var(--dx-g-spacing-md) 0 0;
|
|
77
|
+
max-width: 900px;
|
|
78
|
+
flex: 1;
|
|
79
|
+
width: 0;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
.is-sticky {
|
|
83
|
+
align-self: flex-start;
|
|
84
|
+
position: sticky;
|
|
85
|
+
top: var(--dx-c-content-sidebar-sticky-top);
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
.right-nav-bar {
|
|
89
|
+
margin-left: var(--dx-g-spacing-2xl);
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
@media screen and (max-width: 1024px) {
|
|
93
|
+
.right-nav-bar {
|
|
94
|
+
display: none;
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
@media screen and (max-width: 800px) {
|
|
99
|
+
.content-body {
|
|
100
|
+
margin-top: var(--dx-c-content-vertical-spacing);
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
.content-body-doc-phase-container {
|
|
104
|
+
border-left: 0;
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
@media screen and (max-width: 768px) {
|
|
109
|
+
.is-sticky {
|
|
110
|
+
width: 100%;
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
.content {
|
|
114
|
+
flex-direction: column;
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
.content-body-container {
|
|
118
|
+
padding-right: 0;
|
|
119
|
+
overflow-x: auto;
|
|
120
|
+
margin-bottom: calc(var(--dx-g-spacing-5xl) + 4px);
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
.left-nav-bar {
|
|
124
|
+
height: unset;
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
.content-body {
|
|
128
|
+
margin-left: var(--dx-g-spacing-mlg, 20px);
|
|
129
|
+
margin-right: var(--dx-g-spacing-mlg, 20px);
|
|
130
|
+
}
|
|
131
|
+
}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
<template>
|
|
2
|
+
<div class="content">
|
|
3
|
+
<template lwc:if={useOldSidebar}>
|
|
4
|
+
<dx-sidebar-old
|
|
5
|
+
class="is-sticky left-nav-bar"
|
|
6
|
+
trees={sidebarContent}
|
|
7
|
+
value={sidebarValue}
|
|
8
|
+
header={sidebarHeader}
|
|
9
|
+
ontogglesidebar={onToggleSidebar}
|
|
10
|
+
languages={languages}
|
|
11
|
+
language={language}
|
|
12
|
+
bail-href={bailHref}
|
|
13
|
+
bail-label={bailLabel}
|
|
14
|
+
>
|
|
15
|
+
<slot name="sidebar-header" slot="version-picker"></slot>
|
|
16
|
+
</dx-sidebar-old>
|
|
17
|
+
</template>
|
|
18
|
+
<template lwc:else>
|
|
19
|
+
<dx-sidebar
|
|
20
|
+
class="is-sticky left-nav-bar"
|
|
21
|
+
trees={sidebarContent}
|
|
22
|
+
value={sidebarValue}
|
|
23
|
+
header={sidebarHeader}
|
|
24
|
+
coveo-organization-id={coveoOrganizationId}
|
|
25
|
+
coveo-public-access-token={coveoPublicAccessToken}
|
|
26
|
+
coveo-search-hub={coveoSearchHub}
|
|
27
|
+
coveo-advanced-query-config={coveoAdvancedQueryConfig}
|
|
28
|
+
ontogglesidebar={onToggleSidebar}
|
|
29
|
+
languages={languages}
|
|
30
|
+
language={language}
|
|
31
|
+
bail-href={bailHref}
|
|
32
|
+
bail-label={bailLabel}
|
|
33
|
+
>
|
|
34
|
+
<slot name="sidebar-header" slot="version-picker"></slot>
|
|
35
|
+
</dx-sidebar>
|
|
36
|
+
</template>
|
|
37
|
+
<div class="content-body-doc-phase-container">
|
|
38
|
+
<slot name="doc-phase"></slot>
|
|
39
|
+
<slot name="version-banner"></slot>
|
|
40
|
+
<div class="content-body-container">
|
|
41
|
+
<div class="content-body">
|
|
42
|
+
<doc-breadcrumbs
|
|
43
|
+
lwc:if={showBreadcrumbs}
|
|
44
|
+
breadcrumbs={breadcrumbs}
|
|
45
|
+
></doc-breadcrumbs>
|
|
46
|
+
<slot onslotchange={onSlotChange}></slot>
|
|
47
|
+
<doc-sprig-survey
|
|
48
|
+
lwc:if={shouldDisplayFeedback}
|
|
49
|
+
></doc-sprig-survey>
|
|
50
|
+
</div>
|
|
51
|
+
<div lwc:if={showToc} class="right-nav-bar is-sticky">
|
|
52
|
+
<dx-toc
|
|
53
|
+
header={tocTitle}
|
|
54
|
+
options={tocOptions}
|
|
55
|
+
value={tocValue}
|
|
56
|
+
></dx-toc>
|
|
57
|
+
</div>
|
|
58
|
+
</div>
|
|
59
|
+
<div lwc:if={showFooter} class="footer-container">
|
|
60
|
+
<dx-footer variant="no-signup"></dx-footer>
|
|
61
|
+
</div>
|
|
62
|
+
</div>
|
|
63
|
+
</div>
|
|
64
|
+
</template>
|