@salesforcedevs/docs-components 0.56.2 → 0.56.3-example

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 (80) hide show
  1. package/lwc.config.json +10 -2
  2. package/package.json +19 -13
  3. package/src/modules/doc/{amfReference/utils.ts → amfModelParser/amfModelParser.ts} +10 -5
  4. package/src/modules/doc/amfReference/amfReference.css +23 -3
  5. package/src/modules/doc/amfReference/amfReference.html +42 -21
  6. package/src/modules/doc/amfReference/amfReference.ts +1022 -341
  7. package/src/modules/doc/amfReference/constants.ts +76 -0
  8. package/src/modules/doc/amfReference/types.ts +45 -13
  9. package/src/modules/doc/amfTopic/amfTopic.css +20 -0
  10. package/src/modules/doc/amfTopic/amfTopic.ts +35 -18
  11. package/src/modules/doc/amfTopic/types.ts +15 -13
  12. package/src/modules/doc/amfTopic/utils.ts +12 -6
  13. package/src/modules/doc/breadcrumbItem/breadcrumbItem.css +2 -1
  14. package/src/modules/doc/breadcrumbItem/breadcrumbItem.html +1 -1
  15. package/src/modules/doc/breadcrumbItem/breadcrumbItem.ts +22 -0
  16. package/src/modules/doc/breadcrumbs/breadcrumbs.css +9 -1
  17. package/src/modules/doc/breadcrumbs/breadcrumbs.html +44 -34
  18. package/src/modules/doc/breadcrumbs/breadcrumbs.ts +62 -23
  19. package/src/modules/doc/componentPlayground/componentPlayground.css +22 -0
  20. package/src/modules/doc/componentPlayground/componentPlayground.html +20 -0
  21. package/src/modules/doc/componentPlayground/componentPlayground.ts +42 -0
  22. package/src/modules/doc/content/content.css +70 -76
  23. package/src/modules/doc/content/content.html +1 -0
  24. package/src/modules/doc/content/content.ts +26 -47
  25. package/src/modules/doc/contentCallout/contentCallout.css +15 -7
  26. package/src/modules/doc/contentCallout/contentCallout.html +13 -4
  27. package/src/modules/doc/contentCallout/contentCallout.ts +14 -2
  28. package/src/modules/doc/contentLayout/contentLayout.css +1 -100
  29. package/src/modules/doc/contentLayout/contentLayout.html +30 -17
  30. package/src/modules/doc/contentLayout/contentLayout.ts +354 -65
  31. package/src/modules/doc/doDont/doDont.css +47 -0
  32. package/src/modules/doc/doDont/doDont.html +27 -0
  33. package/src/modules/doc/doDont/doDont.ts +17 -0
  34. package/src/modules/doc/header/header.css +65 -36
  35. package/src/modules/doc/header/header.html +41 -139
  36. package/src/modules/doc/header/header.ts +54 -76
  37. package/src/modules/doc/heading/heading.css +16 -37
  38. package/src/modules/doc/heading/heading.html +4 -4
  39. package/src/modules/doc/heading/heading.ts +12 -10
  40. package/src/modules/doc/headingAnchor/headingAnchor.css +2 -2
  41. package/src/modules/doc/headingAnchor/headingAnchor.ts +2 -2
  42. package/src/modules/doc/headingContent/headingContent.css +6 -8
  43. package/src/modules/doc/headingContent/headingContent.html +9 -15
  44. package/src/modules/doc/headingContent/headingContent.ts +2 -14
  45. package/src/modules/doc/lwcContentLayout/lwcContentLayout.css +1 -0
  46. package/src/modules/doc/lwcContentLayout/lwcContentLayout.html +68 -0
  47. package/src/modules/doc/lwcContentLayout/lwcContentLayout.ts +256 -0
  48. package/src/modules/doc/overview/overview.css +40 -0
  49. package/src/modules/doc/overview/overview.html +34 -0
  50. package/src/modules/doc/overview/overview.ts +12 -0
  51. package/src/modules/doc/phase/phase.css +18 -3
  52. package/src/modules/doc/phase/phase.html +15 -3
  53. package/src/modules/doc/phase/phase.ts +44 -8
  54. package/src/modules/doc/specificationContent/specificationContent.css +36 -0
  55. package/src/modules/doc/specificationContent/specificationContent.html +167 -0
  56. package/src/modules/doc/specificationContent/specificationContent.ts +127 -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/toc/toc.ts +1 -1
  61. package/src/modules/doc/versionPicker/versionPicker.css +64 -0
  62. package/src/modules/doc/versionPicker/versionPicker.html +38 -0
  63. package/src/modules/doc/versionPicker/versionPicker.ts +65 -0
  64. package/src/modules/doc/xmlContent/types.ts +12 -3
  65. package/src/modules/doc/xmlContent/utils.ts +17 -12
  66. package/src/modules/doc/xmlContent/xmlContent.css +32 -3
  67. package/src/modules/doc/xmlContent/xmlContent.html +41 -15
  68. package/src/modules/doc/xmlContent/xmlContent.ts +295 -95
  69. package/src/modules/docHelpers/amfStyle/amfStyle.css +10 -45
  70. package/src/modules/docHelpers/contentLayoutStyle/contentLayoutStyle.css +131 -0
  71. package/src/modules/docHelpers/imgStyle/imgStyle.css +59 -0
  72. package/src/modules/docHelpers/status/status.css +1 -1
  73. package/src/modules/docUtils/{SearchSyncer/SearchSyncer.ts → searchSyncer/searchSyncer.ts} +1 -0
  74. package/src/modules/docUtils/utils/__mocks__/coveo.analytics.ts +16 -0
  75. package/src/modules/docUtils/utils/coveo.analytics.d.ts +10 -0
  76. package/src/modules/docUtils/utils/utils.ts +32 -0
  77. package/LICENSE +0 -12
  78. package/src/modules/doc/amfReference/route-meta.ts +0 -22
  79. package/src/modules/docBaseElements/lightningElementWithState/lightningElementWithState.ts +0 -93
  80. package/src/modules/docHelpers/phaseContentLayout/phaseContentLayout.css +0 -39
@@ -6,11 +6,17 @@
6
6
  border-radius: 4px;
7
7
  }
8
8
 
9
- .dx-callout-base {
9
+ .dx-callout-base,
10
+ .dx-callout-plain {
10
11
  background-color: var(--dx-g-gray-95);
11
12
  border-color: var(--dx-g-gray-50);
12
13
  }
13
14
 
15
+ .dx-callout-plain {
16
+ border: none;
17
+ margin-bottom: var(--dx-g-text-2xl);
18
+ }
19
+
14
20
  .dx-callout-note {
15
21
  background-color: var(--dx-g-blue-vibrant-95);
16
22
  border-color: var(--dx-g-blue-vibrant-50);
@@ -26,6 +32,11 @@
26
32
  border-color: var(--dx-g-red-vibrant-50);
27
33
  }
28
34
 
35
+ .dx-callout-warning {
36
+ background-color: var(--dx-g-red-natural-95);
37
+ border-color: var(--dx-g-red-vibrant-50);
38
+ }
39
+
29
40
  .dx-callout-base_section {
30
41
  width: 100%;
31
42
  }
@@ -42,10 +53,7 @@
42
53
  flex-direction: row;
43
54
  }
44
55
 
45
- .dx-callout-base_column > *:not(:last-child):not(dx-type-badge-group) {
46
- margin-bottom: var(--dx-g-spacing-sm);
47
- }
48
-
49
- .dx-callout-base_column > dx-type-badge-group {
50
- margin-bottom: var(--dx-g-spacing-sm);
56
+ .dx-callout-content {
57
+ flex: 1;
58
+ overflow: auto;
51
59
  }
@@ -1,10 +1,19 @@
1
1
  <template>
2
2
  <div class={className}>
3
- <div class="doc-status-icon dx-callout-icon">
4
- <dx-icon symbol={iconName} size="large" color={iconColor}></dx-icon>
5
- </div>
3
+ <template if:false={hideIcon}>
4
+ <div class="doc-status-icon dx-callout-icon">
5
+ <dx-icon
6
+ symbol={iconName}
7
+ size="large"
8
+ color={iconColor}
9
+ ></dx-icon>
10
+ </div>
11
+ </template>
12
+
6
13
  <div class="dx-callout-content">
7
- <p class="doc-status-title dx-callout-title dx-text-body-3">{title}</p>
14
+ <p class="doc-status-title dx-callout-title dx-text-body-3">
15
+ {header}
16
+ </p>
8
17
  <span class="dx-callout-body dx-text-body-3">
9
18
  <slot onslotchange={onSlotChange}></slot>
10
19
  </span>
@@ -3,7 +3,7 @@ import cx from "classnames";
3
3
  import { CalloutVariant, LightningSlotElement } from "typings/custom";
4
4
 
5
5
  export default class ContentCallout extends LightningElement {
6
- @api title!: string;
6
+ @api header!: string;
7
7
  @api variant!: CalloutVariant;
8
8
  cardVariant?: string;
9
9
  iconName?: string;
@@ -11,6 +11,9 @@ export default class ContentCallout extends LightningElement {
11
11
 
12
12
  connectedCallback() {
13
13
  switch (this.variant) {
14
+ case "plain":
15
+ this.cardVariant = "dx-callout-plain";
16
+ break;
14
17
  case "tip":
15
18
  this.cardVariant = "dx-callout-tip";
16
19
  this.iconColor = "green-vibrant-60";
@@ -18,7 +21,7 @@ export default class ContentCallout extends LightningElement {
18
21
  break;
19
22
  case "warning":
20
23
  this.cardVariant = "doc-status-container dx-callout-warning";
21
- this.iconColor = "gray-10";
24
+ this.iconColor = "red-vibrant-50";
22
25
  this.iconName = "warning";
23
26
  break;
24
27
  case "caution":
@@ -26,6 +29,11 @@ export default class ContentCallout extends LightningElement {
26
29
  this.iconColor = "red-vibrant-50";
27
30
  this.iconName = "alert";
28
31
  break;
32
+ case "important":
33
+ this.cardVariant = "doc-status-container dx-callout-important";
34
+ this.iconColor = "gray-10";
35
+ this.iconName = "announcement";
36
+ break;
29
37
  case "note":
30
38
  default:
31
39
  this.cardVariant = "dx-callout-note";
@@ -44,6 +52,10 @@ export default class ContentCallout extends LightningElement {
44
52
  );
45
53
  }
46
54
 
55
+ get hideIcon() {
56
+ return this.variant === "plain";
57
+ }
58
+
47
59
  private isSlotEmpty: boolean = true;
48
60
  private onSlotChange(e: LightningSlotElement) {
49
61
  // @ts-ignore
@@ -1,100 +1 @@
1
- :host {
2
- --dx-c-content-vertical-spacing: var(--dx-g-spacing-lg);
3
-
4
- display: block;
5
- }
6
-
7
- dx-sidebar,
8
- dx-sidebar-old {
9
- --dx-c-sidebar-height: 100%;
10
- --dx-c-sidebar-vertical-padding: var(--dx-c-content-vertical-spacing);
11
-
12
- z-index: 5;
13
- }
14
-
15
- dx-toc {
16
- --dx-c-toc-width: unset;
17
-
18
- height: calc(100% - var(--dx-c-content-vertical-spacing) * 2);
19
- margin: var(--dx-c-content-vertical-spacing) 0;
20
- overflow-y: auto;
21
- }
22
-
23
- dx-sidebar,
24
- dx-toc {
25
- display: block;
26
- }
27
-
28
- .content {
29
- display: flex;
30
- }
31
-
32
- .content-body-doc-phase-container {
33
- flex: 1;
34
- }
35
-
36
- .content-body-container {
37
- display: flex;
38
- flex-direction: row;
39
- padding-right: var(--dx-g-page-padding-horizontal);
40
- }
41
-
42
- .content-body {
43
- margin: var(--dx-g-spacing-sm) var(--dx-c-content-vertical-spacing)
44
- var(--dx-g-spacing-xl);
45
- flex: 1;
46
- width: 0;
47
- }
48
-
49
- .is-sticky {
50
- height: 100vh;
51
- position: sticky;
52
- top: 0;
53
- }
54
-
55
- .right-nav-bar {
56
- max-width: 275px;
57
- }
58
-
59
- dx-breadcrumbs {
60
- display: block;
61
- margin-bottom: var(--dx-g-spacing-2xl);
62
- }
63
-
64
- @media screen and (max-width: 1024px) {
65
- .right-nav-bar {
66
- display: none;
67
- }
68
- }
69
-
70
- @media screen and (max-width: 800px) {
71
- dx-breadcrumbs {
72
- display: none;
73
- }
74
-
75
- .content-body {
76
- margin-top: var(--dx-c-content-vertical-spacing);
77
- }
78
- }
79
-
80
- @media screen and (max-width: 768px) {
81
- .content {
82
- flex-direction: column;
83
- }
84
-
85
- .content-body-container {
86
- padding-right: 0;
87
- }
88
-
89
- .left-nav-bar {
90
- --dx-c-sidebar-height: 80vh;
91
-
92
- height: unset;
93
- z-index: 10;
94
- }
95
-
96
- .content-body {
97
- margin-left: var(--dx-g-spacing-mlg, 20px);
98
- margin-right: var(--dx-g-spacing-mlg, 20px);
99
- }
100
- }
1
+ @import "docHelpers/contentLayoutStyle";
@@ -1,16 +1,23 @@
1
1
  <template>
2
2
  <div class="content">
3
- <template if:true={useOldSidebar}>
3
+ <template lwc:if={useOldSidebar}>
4
4
  <dx-sidebar-old
5
5
  class="is-sticky left-nav-bar"
6
6
  trees={sidebarContent}
7
7
  value={sidebarValue}
8
8
  header={sidebarHeader}
9
+ ontogglesidebar={onToggleSidebar}
10
+ languages={languages}
11
+ language={language}
12
+ bail-href={bailHref}
13
+ bail-label={bailLabel}
14
+ dev-center={devCenter}
15
+ brand={brand}
9
16
  >
10
- <slot name="sidebar-header" slot="header"></slot>
17
+ <slot name="sidebar-header" slot="version-picker"></slot>
11
18
  </dx-sidebar-old>
12
19
  </template>
13
- <template if:false={useOldSidebar}>
20
+ <template lwc:else>
14
21
  <dx-sidebar
15
22
  class="is-sticky left-nav-bar"
16
23
  trees={sidebarContent}
@@ -20,36 +27,42 @@
20
27
  coveo-public-access-token={coveoPublicAccessToken}
21
28
  coveo-search-hub={coveoSearchHub}
22
29
  coveo-advanced-query-config={coveoAdvancedQueryConfig}
30
+ ontogglesidebar={onToggleSidebar}
31
+ languages={languages}
32
+ language={language}
33
+ bail-href={bailHref}
34
+ bail-label={bailLabel}
35
+ dev-center={devCenter}
36
+ brand={brand}
23
37
  >
24
- <slot name="sidebar-header" slot="header"></slot>
38
+ <slot name="sidebar-header" slot="version-picker"></slot>
25
39
  </dx-sidebar>
26
40
  </template>
27
41
  <div class="content-body-doc-phase-container">
28
42
  <slot name="doc-phase"></slot>
43
+ <slot name="version-banner"></slot>
29
44
  <div class="content-body-container">
30
45
  <div class="content-body">
31
- <dx-breadcrumbs
32
- if:true={breadcrumbs}
46
+ <doc-breadcrumbs
47
+ lwc:if={showBreadcrumbs}
33
48
  breadcrumbs={breadcrumbs}
34
- truncate
35
- hide-current-location
36
- ></dx-breadcrumbs>
37
- <dx-breadcrumbs
38
- if:false={breadcrumbs}
39
- pathname={pathname}
40
- hide-current-location
41
- ></dx-breadcrumbs>
49
+ ></doc-breadcrumbs>
42
50
  <slot onslotchange={onSlotChange}></slot>
51
+ <doc-sprig-survey
52
+ lwc:if={shouldDisplayFeedback}
53
+ ></doc-sprig-survey>
43
54
  </div>
44
- <div class="right-nav-bar is-sticky">
55
+ <div lwc:if={showToc} class="right-nav-bar is-sticky">
45
56
  <dx-toc
46
- if:true={showToc}
47
- title={tocTitle}
57
+ header={tocTitle}
48
58
  options={tocOptions}
49
59
  value={tocValue}
50
60
  ></dx-toc>
51
61
  </div>
52
62
  </div>
63
+ <div lwc:if={showFooter} class="footer-container">
64
+ <dx-footer variant="no-signup"></dx-footer>
65
+ </div>
53
66
  </div>
54
67
  </div>
55
68
  </template>