@salesforcedevs/docs-components 1.34.4 → 1.34.5-bug-fix-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 +0 -1
- package/package.json +28 -28
- package/src/modules/doc/amfReference/amfReference.html +2 -2
- package/src/modules/doc/redocReference/redocReference.css +1 -0
- package/src/modules/doc/redocReference/redocReference.ts +347 -23
- package/src/modules/doc/unifiedContentLayout/unifiedContentLayout.html +8 -0
- package/src/modules/doc/unifiedContentLayout/unifiedContentLayout.ts +75 -46
- package/src/modules/doc/xmlContent/xmlContent.html +2 -2
- package/src/modules/docUtils/searchClient/searchClient.ts +16 -0
- package/src/modules/docUtils/utils/utils.ts +20 -2
- package/LICENSE +0 -12
- package/src/modules/doc/versionPicker/versionPicker.css +0 -64
- package/src/modules/doc/versionPicker/versionPicker.html +0 -40
- package/src/modules/doc/versionPicker/versionPicker.ts +0 -65
package/lwc.config.json
CHANGED
package/package.json
CHANGED
|
@@ -1,29 +1,29 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
}
|
|
2
|
+
"name": "@salesforcedevs/docs-components",
|
|
3
|
+
"version": "1.34.5-bug-fix-alpha1",
|
|
4
|
+
"description": "Docs Lightning web components for DSC",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"main": "index.js",
|
|
7
|
+
"engines": {
|
|
8
|
+
"node": "22.x"
|
|
9
|
+
},
|
|
10
|
+
"publishConfig": {
|
|
11
|
+
"access": "public"
|
|
12
|
+
},
|
|
13
|
+
"dependencies": {
|
|
14
|
+
"@api-components/amf-helper-mixin": "4.5.29",
|
|
15
|
+
"classnames": "2.5.1",
|
|
16
|
+
"dompurify": "3.2.4",
|
|
17
|
+
"kagekiri": "1.4.2",
|
|
18
|
+
"lodash.orderby": "4.6.0",
|
|
19
|
+
"lodash.uniqby": "4.7.0",
|
|
20
|
+
"query-string": "7.1.3",
|
|
21
|
+
"sentence-case": "3.0.4"
|
|
22
|
+
},
|
|
23
|
+
"devDependencies": {
|
|
24
|
+
"@types/classnames": "2.3.1",
|
|
25
|
+
"@types/lodash.orderby": "4.6.9",
|
|
26
|
+
"@types/lodash.uniqby": "4.7.9"
|
|
27
|
+
},
|
|
28
|
+
"gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
|
|
29
|
+
}
|
|
@@ -35,13 +35,13 @@
|
|
|
35
35
|
ondismissphase={handleDismissVersionBanner}
|
|
36
36
|
></doc-phase>
|
|
37
37
|
<div lwc:if={isVersionEnabled} slot="sidebar-header">
|
|
38
|
-
<
|
|
38
|
+
<dx-version-picker
|
|
39
39
|
onchange={handleVersionChange}
|
|
40
40
|
data-type="version"
|
|
41
41
|
versions={versions}
|
|
42
42
|
selected-version={selectedVersion}
|
|
43
43
|
latest-version={latestVersion}
|
|
44
|
-
></
|
|
44
|
+
></dx-version-picker>
|
|
45
45
|
</div>
|
|
46
46
|
<template lwc:if={showSpecBasedReference}>
|
|
47
47
|
<div class="container">
|
|
@@ -4,11 +4,26 @@ import DocPhase from "doc/phase";
|
|
|
4
4
|
import DxFooter from "dx/footer";
|
|
5
5
|
import DxIcon from "dx/icon";
|
|
6
6
|
import SidebarFooterNav from "dx/sidebarFooterNav";
|
|
7
|
+
import VersionPicker from "dx/versionPicker";
|
|
7
8
|
import SprigSurvey from "doc/sprigSurvey";
|
|
8
9
|
import { throttle } from "throttle-debounce";
|
|
9
10
|
import { pollUntil } from "dxUtils/async";
|
|
10
11
|
import { toJson } from "dxUtils/normalizers";
|
|
11
|
-
import
|
|
12
|
+
import { oldVersionDocInfo } from "docUtils/utils";
|
|
13
|
+
import {
|
|
14
|
+
applyVersionToHref,
|
|
15
|
+
collectSubtreeCanonicalHrefs,
|
|
16
|
+
DOCS_LOCALE_SEGMENT_INDEX,
|
|
17
|
+
DOCS_PATH_SEGMENT,
|
|
18
|
+
normalizePath,
|
|
19
|
+
getTopicVersionKey,
|
|
20
|
+
getVersionPickerOptions,
|
|
21
|
+
persistTopicVersion,
|
|
22
|
+
REFERENCES_LOCALE_SEGMENT_INDEX,
|
|
23
|
+
toCanonicalHref
|
|
24
|
+
} from "dxUtils/topicVersion";
|
|
25
|
+
import type { VersionedNode } from "dxUtils/topicVersion";
|
|
26
|
+
import type { DocPhaseInfo, OptionWithLink } from "typings/custom";
|
|
12
27
|
|
|
13
28
|
declare global {
|
|
14
29
|
interface Window {
|
|
@@ -33,8 +48,20 @@ type ReferenceItem = {
|
|
|
33
48
|
topic?: ReferenceTopic;
|
|
34
49
|
};
|
|
35
50
|
|
|
51
|
+
/** A selectable spec version. Mirrors `ReferenceVersion` in `doc/amfReference`. */
|
|
52
|
+
type ReferenceVersion = {
|
|
53
|
+
id: string;
|
|
54
|
+
label: string;
|
|
55
|
+
deprecated?: boolean;
|
|
56
|
+
selected?: boolean;
|
|
57
|
+
link: { href: string };
|
|
58
|
+
};
|
|
59
|
+
|
|
36
60
|
type ReferenceConfig = {
|
|
37
61
|
refList: ReferenceItem[];
|
|
62
|
+
versions?: ReferenceVersion[];
|
|
63
|
+
/** Sidebar topic name. Sidebar stores the selected version under this key. */
|
|
64
|
+
versionTopicKey?: string;
|
|
38
65
|
};
|
|
39
66
|
|
|
40
67
|
const SCROLL_THROTTLE_DELAY = 50;
|
|
@@ -42,7 +69,7 @@ const ELEMENT_TIMEOUT = 10000;
|
|
|
42
69
|
const ELEMENT_CHECK_INTERVAL = 100;
|
|
43
70
|
const DEFAULT_PROJECT_TITLE = "All Reference";
|
|
44
71
|
const BACK_TARGET_STORAGE_KEY = "redoc-back-target";
|
|
45
|
-
const
|
|
72
|
+
const SELECTED_VIEW_STORAGE_KEY = "redoc-selected-view";
|
|
46
73
|
const DEFAULT_LOCALE = "en-us";
|
|
47
74
|
|
|
48
75
|
export default class RedocReference extends LightningElement {
|
|
@@ -80,6 +107,7 @@ export default class RedocReference extends LightningElement {
|
|
|
80
107
|
error
|
|
81
108
|
);
|
|
82
109
|
}
|
|
110
|
+
this.refreshVersions();
|
|
83
111
|
}
|
|
84
112
|
|
|
85
113
|
@api
|
|
@@ -116,6 +144,30 @@ export default class RedocReference extends LightningElement {
|
|
|
116
144
|
*/
|
|
117
145
|
@api headerHref: string | null = null;
|
|
118
146
|
|
|
147
|
+
/**
|
|
148
|
+
* Versioned topic that owns this spec, including its children.
|
|
149
|
+
* Href matches this page, so an older version still has its version
|
|
150
|
+
* in the path.
|
|
151
|
+
*/
|
|
152
|
+
@api
|
|
153
|
+
set parentTopicFamily(value: string | { topics?: VersionedNode[] } | null) {
|
|
154
|
+
try {
|
|
155
|
+
const parsed = toJson(value) as { topics?: VersionedNode[] } | null;
|
|
156
|
+
this._parentTopicFamilyNode = parsed?.topics?.[0] ?? null;
|
|
157
|
+
} catch (error) {
|
|
158
|
+
this._parentTopicFamilyNode = null;
|
|
159
|
+
}
|
|
160
|
+
this.refreshVersions();
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
get parentTopicFamily(): { topics?: VersionedNode[] } | null {
|
|
164
|
+
return this._parentTopicFamilyNode
|
|
165
|
+
? { topics: [this._parentTopicFamilyNode] }
|
|
166
|
+
: null;
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
private _parentTopicFamilyNode: VersionedNode | null = null;
|
|
170
|
+
|
|
119
171
|
@api
|
|
120
172
|
get contentType(): string {
|
|
121
173
|
return this._contentType;
|
|
@@ -152,6 +204,76 @@ export default class RedocReference extends LightningElement {
|
|
|
152
204
|
return refCount > 1;
|
|
153
205
|
}
|
|
154
206
|
|
|
207
|
+
private _versions: ReferenceVersion[] = [];
|
|
208
|
+
|
|
209
|
+
get versions(): ReferenceVersion[] {
|
|
210
|
+
return this._versions;
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
/**
|
|
214
|
+
* Picker hrefs for the open page. Both setters call this because LWC can
|
|
215
|
+
* assign referenceConfig and parentTopicFamily in either order. The page
|
|
216
|
+
* URL is already set by then and does not change for this instance.
|
|
217
|
+
*/
|
|
218
|
+
private refreshVersions(): void {
|
|
219
|
+
const versions = this._referenceConfig?.versions ?? [];
|
|
220
|
+
const node = this._parentTopicFamilyNode;
|
|
221
|
+
if (!node?.versions?.length || typeof window === "undefined") {
|
|
222
|
+
this._versions = versions;
|
|
223
|
+
return;
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
// Same helper as the markdown sidebar. The same array means this page
|
|
227
|
+
// is outside the topic, so the backend switching URLs stay as authored.
|
|
228
|
+
const rewritten = getVersionPickerOptions(node);
|
|
229
|
+
if (!rewritten || rewritten === node.versions) {
|
|
230
|
+
this._versions = versions;
|
|
231
|
+
return;
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
this._versions = versions.map((version) => {
|
|
235
|
+
const href = rewritten.find((option) => option.id === version.id)
|
|
236
|
+
?.link?.href;
|
|
237
|
+
if (!href || href === version.link?.href) {
|
|
238
|
+
return version;
|
|
239
|
+
}
|
|
240
|
+
return {
|
|
241
|
+
...version,
|
|
242
|
+
link: { ...version.link, href }
|
|
243
|
+
};
|
|
244
|
+
});
|
|
245
|
+
}
|
|
246
|
+
|
|
247
|
+
/** The version flagged `selected`, else the first (the latest/GA version). */
|
|
248
|
+
get selectedVersion(): ReferenceVersion | null {
|
|
249
|
+
const versions = this.versions;
|
|
250
|
+
return versions.find((v) => v.selected) ?? versions[0] ?? null;
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
/** True when the selected version is the latest/GA one (index 0). */
|
|
254
|
+
get latestVersion(): boolean {
|
|
255
|
+
return this.versions.length
|
|
256
|
+
? this.selectedVersion?.id === this.versions[0].id
|
|
257
|
+
: false;
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
get hasVersionPicker(): boolean {
|
|
261
|
+
return this.versions.length > 0;
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
/** "Newer version available" banner info when on a non-latest version, else null. */
|
|
265
|
+
private get oldVersionInfo(): DocPhaseInfo | null {
|
|
266
|
+
if (this.versions.length > 1 && !this.latestVersion) {
|
|
267
|
+
return oldVersionDocInfo(this.versions[0].link.href);
|
|
268
|
+
}
|
|
269
|
+
return null;
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
/** A single version has nothing to choose, so it renders read-only. */
|
|
273
|
+
get isVersionReadOnly(): boolean {
|
|
274
|
+
return this.versions.length === 1;
|
|
275
|
+
}
|
|
276
|
+
|
|
155
277
|
// Reads stored back target
|
|
156
278
|
private getBackTargetFromSession(): string | null {
|
|
157
279
|
return sessionStorage.getItem(BACK_TARGET_STORAGE_KEY);
|
|
@@ -186,13 +308,64 @@ export default class RedocReference extends LightningElement {
|
|
|
186
308
|
private onBackClick = (event: Event): void => {
|
|
187
309
|
event.preventDefault();
|
|
188
310
|
|
|
189
|
-
const target = this.
|
|
311
|
+
const target = this.getVersionedBackTarget() ?? this.headerHref;
|
|
190
312
|
|
|
191
313
|
if (target) {
|
|
192
314
|
window.location.assign(target);
|
|
193
315
|
}
|
|
194
316
|
};
|
|
195
317
|
|
|
318
|
+
/**
|
|
319
|
+
* When the back target is in this spec's topic, return it on the
|
|
320
|
+
* selected version. With no back target, do the same for the header
|
|
321
|
+
* link when that link is the versioned parent.
|
|
322
|
+
*/
|
|
323
|
+
private getVersionedBackTarget(): string | null {
|
|
324
|
+
const stored = this.getTranslatedBackTarget();
|
|
325
|
+
const selectedVersion = this.selectedVersion;
|
|
326
|
+
const target = stored ?? this.headerHref;
|
|
327
|
+
if (!target || !selectedVersion) {
|
|
328
|
+
return stored;
|
|
329
|
+
}
|
|
330
|
+
|
|
331
|
+
let targetUrl: URL;
|
|
332
|
+
try {
|
|
333
|
+
targetUrl = new URL(target, window.location.origin);
|
|
334
|
+
} catch {
|
|
335
|
+
return target;
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
// Family hrefs match this page's version. Compare them without
|
|
339
|
+
// the version segment. Rewrite only the pathname so the target's
|
|
340
|
+
// query and hash survive.
|
|
341
|
+
const familyHrefs = this._parentTopicFamilyNode
|
|
342
|
+
? collectSubtreeCanonicalHrefs(this._parentTopicFamilyNode).map(
|
|
343
|
+
(href) => toCanonicalHref(href, this.versions)
|
|
344
|
+
)
|
|
345
|
+
: [];
|
|
346
|
+
|
|
347
|
+
const canonicalTarget = toCanonicalHref(
|
|
348
|
+
targetUrl.pathname,
|
|
349
|
+
this.versions
|
|
350
|
+
);
|
|
351
|
+
const inFamily = familyHrefs.some(
|
|
352
|
+
(href) => normalizePath(href) === normalizePath(canonicalTarget)
|
|
353
|
+
);
|
|
354
|
+
if (!inFamily) {
|
|
355
|
+
return target;
|
|
356
|
+
}
|
|
357
|
+
|
|
358
|
+
const versioned = applyVersionToHref(
|
|
359
|
+
canonicalTarget,
|
|
360
|
+
selectedVersion,
|
|
361
|
+
this.versions
|
|
362
|
+
);
|
|
363
|
+
if (!versioned) {
|
|
364
|
+
return target;
|
|
365
|
+
}
|
|
366
|
+
return `${versioned}${targetUrl.search}${targetUrl.hash}`;
|
|
367
|
+
}
|
|
368
|
+
|
|
196
369
|
private getTranslatedBackTarget(): string | null {
|
|
197
370
|
const stored = this.getBackTargetFromSession();
|
|
198
371
|
if (stored) {
|
|
@@ -202,7 +375,9 @@ export default class RedocReference extends LightningElement {
|
|
|
202
375
|
}
|
|
203
376
|
|
|
204
377
|
const referrer = this.getSameOriginReferrerHref();
|
|
205
|
-
return referrer &&
|
|
378
|
+
return referrer &&
|
|
379
|
+
!this.isLocaleHref(new URL(referrer).pathname) &&
|
|
380
|
+
!this.isVersionHref(new URL(referrer).pathname)
|
|
206
381
|
? referrer
|
|
207
382
|
: null;
|
|
208
383
|
}
|
|
@@ -216,7 +391,9 @@ export default class RedocReference extends LightningElement {
|
|
|
216
391
|
const segments = url.pathname.split("/").filter(Boolean);
|
|
217
392
|
|
|
218
393
|
// docs -> right after "docs"; references -> after the product segment.
|
|
219
|
-
const localeIndex = this.isDocContentType
|
|
394
|
+
const localeIndex = this.isDocContentType
|
|
395
|
+
? DOCS_LOCALE_SEGMENT_INDEX
|
|
396
|
+
: REFERENCES_LOCALE_SEGMENT_INDEX;
|
|
220
397
|
|
|
221
398
|
if (segments[0] === DOCS_PATH_SEGMENT) {
|
|
222
399
|
// Drop the existing locale segment, if any
|
|
@@ -241,7 +418,10 @@ export default class RedocReference extends LightningElement {
|
|
|
241
418
|
}
|
|
242
419
|
|
|
243
420
|
const referrerUrl = new URL(referrerHref);
|
|
244
|
-
if (
|
|
421
|
+
if (
|
|
422
|
+
this.isLocaleHref(referrerUrl.pathname) ||
|
|
423
|
+
this.isVersionHref(referrerUrl.pathname)
|
|
424
|
+
) {
|
|
245
425
|
return;
|
|
246
426
|
}
|
|
247
427
|
|
|
@@ -282,6 +462,19 @@ export default class RedocReference extends LightningElement {
|
|
|
282
462
|
});
|
|
283
463
|
}
|
|
284
464
|
|
|
465
|
+
/**
|
|
466
|
+
* switching version on this same page.
|
|
467
|
+
*/
|
|
468
|
+
private isVersionHref(pathname: string): boolean {
|
|
469
|
+
return this.versions.some((version) => {
|
|
470
|
+
const href = version?.link?.href;
|
|
471
|
+
return (
|
|
472
|
+
!!href &&
|
|
473
|
+
new URL(href, window.location.origin).pathname === pathname
|
|
474
|
+
);
|
|
475
|
+
});
|
|
476
|
+
}
|
|
477
|
+
|
|
285
478
|
/** When origin is provided, pass it to the footer; otherwise use dx-footer's default. */
|
|
286
479
|
get effectiveFooterOrigin(): string {
|
|
287
480
|
return (
|
|
@@ -297,6 +490,13 @@ export default class RedocReference extends LightningElement {
|
|
|
297
490
|
// Track the back target, preserving it across locale switches
|
|
298
491
|
this.trackBackTarget();
|
|
299
492
|
|
|
493
|
+
// Remember the selected version for the sidebar. Changing version
|
|
494
|
+
// reloads this page.
|
|
495
|
+
const topicKey = this.getParentTopicVersionKey();
|
|
496
|
+
if (topicKey && this.selectedVersion) {
|
|
497
|
+
persistTopicVersion(topicKey, this.selectedVersion.id);
|
|
498
|
+
}
|
|
499
|
+
|
|
300
500
|
window.addEventListener("scroll", this.handleScrollAndResize);
|
|
301
501
|
window.addEventListener("resize", this.handleScrollAndResize);
|
|
302
502
|
}
|
|
@@ -354,6 +554,14 @@ export default class RedocReference extends LightningElement {
|
|
|
354
554
|
return parseInt(value, 10) || 0;
|
|
355
555
|
}
|
|
356
556
|
|
|
557
|
+
/** Redoc's LNB background color, themeable via `--doc-c-redoc-sidebar-bg`. */
|
|
558
|
+
private get sidebarBackgroundColor(): string {
|
|
559
|
+
const value = getComputedStyle(this.template.host).getPropertyValue(
|
|
560
|
+
"--doc-c-redoc-sidebar-bg"
|
|
561
|
+
);
|
|
562
|
+
return value.trim() || "white";
|
|
563
|
+
}
|
|
564
|
+
|
|
357
565
|
/*
|
|
358
566
|
** Since we could not use --dx-g-global-header-height as getPropertyValue returns a calc expression,
|
|
359
567
|
** we are using the respective CSS variables to calculate the height.
|
|
@@ -469,7 +677,14 @@ export default class RedocReference extends LightningElement {
|
|
|
469
677
|
specUrl,
|
|
470
678
|
{
|
|
471
679
|
// Dynamic scroll offset to account for headers
|
|
472
|
-
scrollYOffset: this.calculateScrollYOffset
|
|
680
|
+
scrollYOffset: this.calculateScrollYOffset,
|
|
681
|
+
// Redoc's own styled background outranks injected
|
|
682
|
+
// CSS, so the LNB background must be set via theme.
|
|
683
|
+
theme: {
|
|
684
|
+
sidebar: {
|
|
685
|
+
backgroundColor: this.sidebarBackgroundColor
|
|
686
|
+
}
|
|
687
|
+
}
|
|
473
688
|
},
|
|
474
689
|
redocContainer,
|
|
475
690
|
(error: any) => {
|
|
@@ -515,10 +730,7 @@ export default class RedocReference extends LightningElement {
|
|
|
515
730
|
const apiContentDiv = await this.waitForApiContent(redocContainer);
|
|
516
731
|
apiContentDiv.setAttribute("lwc:dom", "manual");
|
|
517
732
|
|
|
518
|
-
|
|
519
|
-
if (docPhaseInfo) {
|
|
520
|
-
this.insertDocPhase(apiContentDiv, docPhaseInfo);
|
|
521
|
-
}
|
|
733
|
+
this.insertStatusItems(apiContentDiv);
|
|
522
734
|
|
|
523
735
|
this.appendFooterItems(apiContentDiv);
|
|
524
736
|
|
|
@@ -527,10 +739,22 @@ export default class RedocReference extends LightningElement {
|
|
|
527
739
|
|
|
528
740
|
// Wait for footer to be rendered before updating styles
|
|
529
741
|
requestAnimationFrame(() => {
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
742
|
+
try {
|
|
743
|
+
this.updateRedocThirdColumnStyle(redocContainer);
|
|
744
|
+
|
|
745
|
+
// Restore the view selected before a version switch only
|
|
746
|
+
// after all layout mutations (footer, header) are
|
|
747
|
+
// complete, so the scroll lands on the correct element.
|
|
748
|
+
this.restoreSelectedView();
|
|
749
|
+
|
|
750
|
+
// Fix initial hash scroll after doc phase insertion
|
|
751
|
+
this.handleInitialHashScrollFix();
|
|
752
|
+
} catch (error) {
|
|
753
|
+
this.showErrorUI(
|
|
754
|
+
"Failed to integrate custom components:",
|
|
755
|
+
error
|
|
756
|
+
);
|
|
757
|
+
}
|
|
534
758
|
});
|
|
535
759
|
} catch (error) {
|
|
536
760
|
this.showErrorUI("Failed to integrate custom components:", error);
|
|
@@ -560,6 +784,70 @@ export default class RedocReference extends LightningElement {
|
|
|
560
784
|
}
|
|
561
785
|
}
|
|
562
786
|
|
|
787
|
+
/** Builds the version picker DOM by reusing `dx-version-picker`. */
|
|
788
|
+
private buildVersionPickerDom(): HTMLElement {
|
|
789
|
+
const wrapper = document.createElement("div");
|
|
790
|
+
wrapper.className = "redoc-version-picker";
|
|
791
|
+
|
|
792
|
+
const picker = createElement("dx-version-picker", {
|
|
793
|
+
is: VersionPicker
|
|
794
|
+
});
|
|
795
|
+
|
|
796
|
+
Object.assign(picker, {
|
|
797
|
+
versions: this.versions,
|
|
798
|
+
selectedVersion: this.selectedVersion,
|
|
799
|
+
latestVersion: this.latestVersion,
|
|
800
|
+
readOnly: this.isVersionReadOnly
|
|
801
|
+
});
|
|
802
|
+
picker.addEventListener("change", this.onVersionChange);
|
|
803
|
+
wrapper.appendChild(picker);
|
|
804
|
+
|
|
805
|
+
return wrapper;
|
|
806
|
+
}
|
|
807
|
+
|
|
808
|
+
/**
|
|
809
|
+
* Key the sidebar uses for this topic's selected version.
|
|
810
|
+
* Missing `versionTopicKey` returns null so nothing is written.
|
|
811
|
+
*/
|
|
812
|
+
private getParentTopicVersionKey(): string | null {
|
|
813
|
+
const versionTopicKey = this._referenceConfig?.versionTopicKey;
|
|
814
|
+
if (!versionTopicKey) {
|
|
815
|
+
return null;
|
|
816
|
+
}
|
|
817
|
+
return (
|
|
818
|
+
getTopicVersionKey(
|
|
819
|
+
{ name: versionTopicKey },
|
|
820
|
+
this.language ?? undefined
|
|
821
|
+
) || null
|
|
822
|
+
);
|
|
823
|
+
}
|
|
824
|
+
|
|
825
|
+
/** Stashes the current view (URL hash) before the version link navigates. */
|
|
826
|
+
private onVersionChange = (): void => {
|
|
827
|
+
sessionStorage.setItem(
|
|
828
|
+
SELECTED_VIEW_STORAGE_KEY,
|
|
829
|
+
window.location.hash || ""
|
|
830
|
+
);
|
|
831
|
+
};
|
|
832
|
+
|
|
833
|
+
/**
|
|
834
|
+
* Re-applies the view stashed before a version switch, if its anchor exists
|
|
835
|
+
* in the new spec; otherwise a no-op (lands on the spec root).
|
|
836
|
+
*/
|
|
837
|
+
private restoreSelectedView(): void {
|
|
838
|
+
const storedHash = sessionStorage.getItem(SELECTED_VIEW_STORAGE_KEY);
|
|
839
|
+
sessionStorage.removeItem(SELECTED_VIEW_STORAGE_KEY);
|
|
840
|
+
|
|
841
|
+
if (!storedHash || window.location.hash) {
|
|
842
|
+
return;
|
|
843
|
+
}
|
|
844
|
+
|
|
845
|
+
const targetId = storedHash.replace(/^#/, "");
|
|
846
|
+
if (targetId && document.getElementById(targetId)) {
|
|
847
|
+
window.location.hash = storedHash;
|
|
848
|
+
}
|
|
849
|
+
}
|
|
850
|
+
|
|
563
851
|
/**
|
|
564
852
|
* Builds the locale picker DOM by reusing `dx-sidebar-footer-nav`
|
|
565
853
|
*/
|
|
@@ -581,12 +869,17 @@ export default class RedocReference extends LightningElement {
|
|
|
581
869
|
}
|
|
582
870
|
|
|
583
871
|
/**
|
|
584
|
-
* Builds a
|
|
872
|
+
* Builds the doc header: a title group (back link + spec title) and, when
|
|
873
|
+
* versions are available, the version picker as a sibling row. Layout/gaps
|
|
874
|
+
* are styled by the developer-website's redoc CSS.
|
|
585
875
|
*/
|
|
586
876
|
private buildProjectHeaderDom(): HTMLElement {
|
|
587
877
|
const wrapper = document.createElement("div");
|
|
588
878
|
wrapper.className = "redoc-project-header";
|
|
589
879
|
|
|
880
|
+
const main = document.createElement("div");
|
|
881
|
+
main.className = "redoc-project-header-main";
|
|
882
|
+
|
|
590
883
|
if (this.projectTitle) {
|
|
591
884
|
const backLink = document.createElement("a");
|
|
592
885
|
backLink.className = "redoc-project-back";
|
|
@@ -607,14 +900,20 @@ export default class RedocReference extends LightningElement {
|
|
|
607
900
|
|
|
608
901
|
backLink.appendChild(icon);
|
|
609
902
|
backLink.appendChild(label);
|
|
610
|
-
|
|
903
|
+
main.appendChild(backLink);
|
|
611
904
|
}
|
|
612
905
|
|
|
613
906
|
if (this.specTitle) {
|
|
614
907
|
const specEl = document.createElement("h2");
|
|
615
908
|
specEl.className = "redoc-spec-title dx-text-display-7";
|
|
616
909
|
specEl.textContent = this.specTitle;
|
|
617
|
-
|
|
910
|
+
main.appendChild(specEl);
|
|
911
|
+
}
|
|
912
|
+
|
|
913
|
+
wrapper.appendChild(main);
|
|
914
|
+
|
|
915
|
+
if (this.hasVersionPicker) {
|
|
916
|
+
wrapper.appendChild(this.buildVersionPickerDom());
|
|
618
917
|
}
|
|
619
918
|
|
|
620
919
|
return wrapper;
|
|
@@ -639,15 +938,40 @@ export default class RedocReference extends LightningElement {
|
|
|
639
938
|
return container.querySelector<HTMLElement>(".api-content")!;
|
|
640
939
|
}
|
|
641
940
|
|
|
642
|
-
//
|
|
643
|
-
|
|
941
|
+
// Inserts the doc phase and, on a non-latest version, a dismissible
|
|
942
|
+
// "newer version" banner into a shared doc-phase-wrapper at container start
|
|
943
|
+
private insertStatusItems(container: HTMLElement): void {
|
|
944
|
+
const docPhaseInfo = this.getDocPhaseInfo();
|
|
945
|
+
const oldVersionInfo = this.oldVersionInfo;
|
|
946
|
+
if (!docPhaseInfo && !oldVersionInfo) {
|
|
947
|
+
return;
|
|
948
|
+
}
|
|
949
|
+
|
|
644
950
|
const wrapper = document.createElement("div");
|
|
645
951
|
wrapper.className = "doc-phase-wrapper";
|
|
646
952
|
container.insertBefore(wrapper, container.firstChild);
|
|
647
953
|
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
954
|
+
if (docPhaseInfo) {
|
|
955
|
+
const docPhaseElement = createElement("doc-phase", {
|
|
956
|
+
is: DocPhase
|
|
957
|
+
});
|
|
958
|
+
Object.assign(docPhaseElement, { docPhaseInfo });
|
|
959
|
+
wrapper.appendChild(docPhaseElement);
|
|
960
|
+
}
|
|
961
|
+
|
|
962
|
+
if (oldVersionInfo) {
|
|
963
|
+
const versionBanner = createElement("doc-phase", { is: DocPhase });
|
|
964
|
+
Object.assign(versionBanner, {
|
|
965
|
+
docPhaseInfo: oldVersionInfo,
|
|
966
|
+
dismissible: true,
|
|
967
|
+
iconName: "warning"
|
|
968
|
+
});
|
|
969
|
+
versionBanner.addEventListener("dismissphase", () => {
|
|
970
|
+
versionBanner.remove();
|
|
971
|
+
this.updateSidebarPosition();
|
|
972
|
+
});
|
|
973
|
+
wrapper.appendChild(versionBanner);
|
|
974
|
+
}
|
|
651
975
|
}
|
|
652
976
|
|
|
653
977
|
// Appends footer component to container
|
|
@@ -24,6 +24,14 @@
|
|
|
24
24
|
lwc:if={docPhaseInfo}
|
|
25
25
|
doc-phase-info={docPhaseInfo}
|
|
26
26
|
></doc-phase>
|
|
27
|
+
<doc-phase
|
|
28
|
+
slot="version-banner"
|
|
29
|
+
lwc:if={showVersionBanner}
|
|
30
|
+
doc-phase-info={oldVersionInfo}
|
|
31
|
+
icon-name="warning"
|
|
32
|
+
dismissible="true"
|
|
33
|
+
ondismissphase={handleDismissVersionBanner}
|
|
34
|
+
></doc-phase>
|
|
27
35
|
<slot></slot>
|
|
28
36
|
</doc-content-layout>
|
|
29
37
|
</template>
|
|
@@ -1,6 +1,12 @@
|
|
|
1
|
-
import { LightningElement, api } from "lwc";
|
|
1
|
+
import { LightningElement, api, track } from "lwc";
|
|
2
2
|
import { toJson } from "dxUtils/normalizers";
|
|
3
|
-
import type {
|
|
3
|
+
import type { VersionedNode } from "dxUtils/topicVersion";
|
|
4
|
+
import {
|
|
5
|
+
findTopicVersionForCurrentPage,
|
|
6
|
+
latestHrefForCurrentPage
|
|
7
|
+
} from "dxUtils/topicVersion";
|
|
8
|
+
import { oldVersionDocInfo } from "docUtils/utils";
|
|
9
|
+
import type { DocPhaseInfo, OptionWithLink, TreeNode } from "typings/custom";
|
|
4
10
|
|
|
5
11
|
/**
|
|
6
12
|
* Per-topic type emitted by the docs content-type parser
|
|
@@ -10,61 +16,48 @@ import type { OptionWithLink, TreeNode } from "typings/custom";
|
|
|
10
16
|
*/
|
|
11
17
|
const TOPIC_TYPE_SPEC = "spec";
|
|
12
18
|
|
|
13
|
-
/**
|
|
14
|
-
* Walks down the first-child chain and returns the first markdown content
|
|
15
|
-
* page found, descending through nested content-less parents. Returns
|
|
16
|
-
* undefined if the chain breaks on a spec or external link before reaching a
|
|
17
|
-
* content page.
|
|
18
|
-
*/
|
|
19
|
-
function firstChildContentPage(node: TreeNode): TreeNode | undefined {
|
|
20
|
-
const firstChild = node.children?.[0];
|
|
21
|
-
if (!firstChild) {
|
|
22
|
-
return undefined;
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
const isSpec =
|
|
26
|
-
(firstChild as { topicType?: string }).topicType === TOPIC_TYPE_SPEC;
|
|
27
|
-
const isExternal = firstChild.link?.target === "_blank";
|
|
28
|
-
if (isSpec || isExternal) {
|
|
29
|
-
return undefined;
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
if (firstChild.link?.href) {
|
|
33
|
-
return firstChild;
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
return firstChildContentPage(firstChild);
|
|
37
|
-
}
|
|
38
|
-
|
|
39
19
|
/**
|
|
40
20
|
* Translates per-topic `topicType` into the generic `showForwardArrow` flag
|
|
41
|
-
* that `dx-tree-tile` reads (spec topics get the forward arrow icon for Redoc)
|
|
42
|
-
*
|
|
21
|
+
* that `dx-tree-tile` reads (spec topics get the forward arrow icon for Redoc).
|
|
22
|
+
*
|
|
23
|
+
* Content-less parents are flagged with redirectToChild and left without a
|
|
24
|
+
* link. The tree selects the first markdown descendant. Copying that child's
|
|
25
|
+
* href onto the parent makes the parent win selection.
|
|
43
26
|
*/
|
|
44
|
-
function
|
|
45
|
-
topics:
|
|
27
|
+
function decorateTopicsWithForwardArrow(
|
|
28
|
+
topics:
|
|
29
|
+
| Array<TreeNode & { topicType?: string; versions?: unknown }>
|
|
30
|
+
| undefined
|
|
46
31
|
): TreeNode[] | undefined {
|
|
47
32
|
return topics?.map((topic) => {
|
|
48
|
-
const { topicType, ...decorated } = topic;
|
|
33
|
+
const { topicType, versions, ...decorated } = topic;
|
|
49
34
|
if (topicType === TOPIC_TYPE_SPEC) {
|
|
50
35
|
decorated.showForwardArrow = true;
|
|
36
|
+
// Nested and standalone specs never get a sidebar picker; only the
|
|
37
|
+
// parent MD topic (when versioned) shows one.
|
|
38
|
+
} else if (Array.isArray(versions)) {
|
|
39
|
+
decorated.versions = versions.map(
|
|
40
|
+
(version: { children?: TreeNode[] }) =>
|
|
41
|
+
version.children
|
|
42
|
+
? {
|
|
43
|
+
...version,
|
|
44
|
+
children: decorateTopicsWithForwardArrow(
|
|
45
|
+
version.children
|
|
46
|
+
)
|
|
47
|
+
}
|
|
48
|
+
: version
|
|
49
|
+
);
|
|
51
50
|
}
|
|
52
51
|
if (decorated.children) {
|
|
53
|
-
decorated.children =
|
|
52
|
+
decorated.children = decorateTopicsWithForwardArrow(
|
|
53
|
+
decorated.children
|
|
54
|
+
);
|
|
54
55
|
}
|
|
55
56
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
const isContentlessParent =
|
|
60
|
-
!!decorated.children?.length && !decorated.link?.href;
|
|
61
|
-
|
|
62
|
-
if (isContentlessParent) {
|
|
57
|
+
// Flag a parent with no page of its own. Leave its link empty so the
|
|
58
|
+
// child's URL stays indexed to the child.
|
|
59
|
+
if (!!decorated.children?.length && !decorated.link?.href) {
|
|
63
60
|
decorated.redirectToChild = true;
|
|
64
|
-
const firstChild = firstChildContentPage(topic);
|
|
65
|
-
if (firstChild?.link) {
|
|
66
|
-
decorated.link = { ...firstChild.link };
|
|
67
|
-
}
|
|
68
61
|
}
|
|
69
62
|
|
|
70
63
|
return decorated;
|
|
@@ -101,6 +94,9 @@ export default class UnifiedContentLayout extends LightningElement {
|
|
|
101
94
|
|
|
102
95
|
private _docPhaseInfo: string | null = null;
|
|
103
96
|
private _sidebarContent: unknown = null;
|
|
97
|
+
private _oldVersionInfo: DocPhaseInfo | null = null;
|
|
98
|
+
|
|
99
|
+
@track showVersionBanner = false;
|
|
104
100
|
|
|
105
101
|
@api
|
|
106
102
|
get docPhaseInfo(): string | null {
|
|
@@ -117,7 +113,40 @@ export default class UnifiedContentLayout extends LightningElement {
|
|
|
117
113
|
}
|
|
118
114
|
|
|
119
115
|
set sidebarContent(value: string) {
|
|
120
|
-
|
|
116
|
+
const topics = decorateTopicsWithForwardArrow(toJson(value)?.topics);
|
|
117
|
+
this._sidebarContent = topics;
|
|
118
|
+
this.updateTopicVersionBanner(topics as VersionedNode[] | undefined);
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
get oldVersionInfo(): DocPhaseInfo | null {
|
|
122
|
+
return this._oldVersionInfo;
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
handleDismissVersionBanner(): void {
|
|
126
|
+
this.showVersionBanner = false;
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
/**
|
|
130
|
+
* Same banner references use when the reader is on an older version.
|
|
131
|
+
* Topic versions are not a separate page property: the sidebar tree
|
|
132
|
+
* carries each version's switching URL, and the current pathname says
|
|
133
|
+
* which one is open.
|
|
134
|
+
*/
|
|
135
|
+
private updateTopicVersionBanner(
|
|
136
|
+
topics: VersionedNode[] | undefined
|
|
137
|
+
): void {
|
|
138
|
+
const match = findTopicVersionForCurrentPage(topics);
|
|
139
|
+
const latest = match?.node.versions?.[0];
|
|
140
|
+
const latestHref = latestHrefForCurrentPage(match?.node.versions);
|
|
141
|
+
|
|
142
|
+
if (match && latest && match.version.id !== latest.id && latestHref) {
|
|
143
|
+
this._oldVersionInfo = oldVersionDocInfo(latestHref);
|
|
144
|
+
this.showVersionBanner = true;
|
|
145
|
+
return;
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
this._oldVersionInfo = null;
|
|
149
|
+
this.showVersionBanner = false;
|
|
121
150
|
}
|
|
122
151
|
|
|
123
152
|
private get enableFooter(): boolean {
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
ondismissphase={handleDismissVersionBanner}
|
|
25
25
|
></doc-phase>
|
|
26
26
|
<div lwc:if={showVersionPicker} slot="sidebar-header">
|
|
27
|
-
<
|
|
27
|
+
<dx-version-picker
|
|
28
28
|
data-type="version"
|
|
29
29
|
analytics-event="custEv_linkClick"
|
|
30
30
|
analytics-payload={ANALYTICS_PAYLOAD}
|
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
selected-version={version}
|
|
33
33
|
latest-version={latestVersion}
|
|
34
34
|
hide-badge={previewVersion}
|
|
35
|
-
></
|
|
35
|
+
></dx-version-picker>
|
|
36
36
|
</div>
|
|
37
37
|
<div class="breadcrumb-row" lwc:if={showBreadcrumbs}>
|
|
38
38
|
<doc-breadcrumbs
|
|
@@ -23,6 +23,9 @@ export interface SearchResult {
|
|
|
23
23
|
// and existing fixtures still satisfy the type.
|
|
24
24
|
snippet?: string | null;
|
|
25
25
|
snippetSource?: SnippetSource;
|
|
26
|
+
// `url` plus `#anchor` of the page section that matched, or null/absent
|
|
27
|
+
// when the matched chunk has no anchor. Link to it via resultHref().
|
|
28
|
+
sectionUrl?: string | null;
|
|
26
29
|
}
|
|
27
30
|
|
|
28
31
|
export interface FacetBucket {
|
|
@@ -208,6 +211,19 @@ export function sanitizeSnippetHtml(value: unknown): string {
|
|
|
208
211
|
* text path. So for anything but a headline we return `null` and let the
|
|
209
212
|
* caller keep today's text rendering.
|
|
210
213
|
*/
|
|
214
|
+
/**
|
|
215
|
+
* Where a result's title should link: the matched section when the backend
|
|
216
|
+
* returned one, else the page. The section link is only trusted when it is the
|
|
217
|
+
* page URL plus a fragment, so a malformed value can never send the user
|
|
218
|
+
* somewhere else.
|
|
219
|
+
*/
|
|
220
|
+
export function resultHref(result: SearchResult): string {
|
|
221
|
+
const { url, sectionUrl } = result;
|
|
222
|
+
return typeof sectionUrl === "string" && sectionUrl.startsWith(`${url}#`)
|
|
223
|
+
? sectionUrl
|
|
224
|
+
: url;
|
|
225
|
+
}
|
|
226
|
+
|
|
211
227
|
export function highlightedSnippetHtml(result: SearchResult): string | null {
|
|
212
228
|
if (result.snippetSource !== "headline") {
|
|
213
229
|
return null;
|
|
@@ -1,10 +1,28 @@
|
|
|
1
1
|
import { CoveoAnalyticsClient } from "coveo.analytics/dist/browser.mjs"; // This fix is required for Node 20 upgrade, so that Coveo analytics is loaded properly by LWR.
|
|
2
2
|
|
|
3
|
+
// Resolve against the current origin (version links are usually relative) and
|
|
4
|
+
// keep only http/https. Blocks executable schemes like javascript:/data: that
|
|
5
|
+
// would run when the innerHTML-rendered link is clicked
|
|
6
|
+
// encodeURI then keeps the value from breaking out of the href attribute.
|
|
7
|
+
const toSafeHref = (link: string): string => {
|
|
8
|
+
try {
|
|
9
|
+
const { protocol } = new URL(link, window.location.origin);
|
|
10
|
+
if (protocol === "http:" || protocol === "https:") {
|
|
11
|
+
return encodeURI(link);
|
|
12
|
+
}
|
|
13
|
+
} catch {
|
|
14
|
+
// Fall through to the rejection below.
|
|
15
|
+
}
|
|
16
|
+
console.warn(`Blocked unsafe version link: ${link}`);
|
|
17
|
+
return "#";
|
|
18
|
+
};
|
|
19
|
+
|
|
3
20
|
export const oldVersionDocInfo = (latestVersionLink: string) => {
|
|
21
|
+
const safeLink = toSafeHref(latestVersionLink);
|
|
4
22
|
return {
|
|
5
23
|
title: "Newer Version Available",
|
|
6
|
-
body: `This content describes an older version of this product.
|
|
7
|
-
<a style="font-weight: bold;" href="${
|
|
24
|
+
body: `This content describes an older version of this product.
|
|
25
|
+
<a style="font-weight: bold;" href="${safeLink}">View Latest</a>`
|
|
8
26
|
};
|
|
9
27
|
};
|
|
10
28
|
|
package/LICENSE
DELETED
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
Copyright (c) 2020, Salesforce.com, Inc.
|
|
2
|
-
All rights reserved.
|
|
3
|
-
|
|
4
|
-
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
|
5
|
-
|
|
6
|
-
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
|
7
|
-
|
|
8
|
-
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
|
9
|
-
|
|
10
|
-
* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
|
11
|
-
|
|
12
|
-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
@@ -1,64 +0,0 @@
|
|
|
1
|
-
@import "dxHelpers/reset";
|
|
2
|
-
|
|
3
|
-
/* NOTE: doc-version-picker-width width variable is used by both dx-button and dx-dropdown to maintain a consistent width. */
|
|
4
|
-
:host {
|
|
5
|
-
--dx-c-dropdown-option-font-weight: normal;
|
|
6
|
-
--dx-c-dropdown-option-label-color: var(--dx-g-gray-10);
|
|
7
|
-
--popover-container-open-transform: translateY(4px);
|
|
8
|
-
}
|
|
9
|
-
|
|
10
|
-
.version-picker-container {
|
|
11
|
-
padding: 8px var(--dx-g-spacing-lg) 8px
|
|
12
|
-
var(--dx-g-global-header-padding-horizontal);
|
|
13
|
-
border-top: 1px solid var(--dx-g-gray-90);
|
|
14
|
-
border-bottom: 1px solid var(--dx-g-gray-90);
|
|
15
|
-
}
|
|
16
|
-
|
|
17
|
-
.version-picker-button {
|
|
18
|
-
display: flex;
|
|
19
|
-
width: var(--doc-version-picker-width, 296px);
|
|
20
|
-
}
|
|
21
|
-
|
|
22
|
-
.version-picker-button:hover,
|
|
23
|
-
.version-picker-button:active,
|
|
24
|
-
.version-picker-button:focus {
|
|
25
|
-
--dx-c-button-secondary-color-hover: var(--dx-g-cloud-blue-vibrant-95);
|
|
26
|
-
--dx-c-button-primary-color: var(--dx-g-blue-vibrant-40);
|
|
27
|
-
}
|
|
28
|
-
|
|
29
|
-
/**
|
|
30
|
-
* NOTE: This CSS ensures the span inside the button stays within the parent's width, avoiding overflow.
|
|
31
|
-
* Not keeping this in common component to ensure that existing functionality works as it is.
|
|
32
|
-
*/
|
|
33
|
-
dx-button::part(content) {
|
|
34
|
-
width: inherit;
|
|
35
|
-
overflow: hidden;
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
.selected-version {
|
|
39
|
-
display: flex;
|
|
40
|
-
flex-direction: row;
|
|
41
|
-
align-items: center;
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
.selected-version-label {
|
|
45
|
-
flex: 1;
|
|
46
|
-
overflow: hidden;
|
|
47
|
-
text-align: left;
|
|
48
|
-
text-overflow: ellipsis;
|
|
49
|
-
white-space: nowrap;
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
dx-type-badge.latest-badge {
|
|
53
|
-
--dx-c-type-badge-color: var(--dx-g-green-vibrant-40);
|
|
54
|
-
--dx-c-type-badge-background: var(--dx-g-green-vibrant-95);
|
|
55
|
-
|
|
56
|
-
margin-left: var(--dx-g-spacing-sm);
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
dx-type-badge.not-latest-badge {
|
|
60
|
-
--dx-c-type-badge-color: var(--dx-g-red-vibrant-40);
|
|
61
|
-
--dx-c-type-badge-background: var(--dx-g-red-vibrant-95);
|
|
62
|
-
|
|
63
|
-
margin-left: var(--dx-g-spacing-sm);
|
|
64
|
-
}
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
<template>
|
|
2
|
-
<div lwc:if={showVersionPicker} class="version-picker-container">
|
|
3
|
-
<dx-dropdown
|
|
4
|
-
options={versions}
|
|
5
|
-
analytics-event="custEv_docVersionSelect"
|
|
6
|
-
analytics-payload={analyticsPayload}
|
|
7
|
-
value={selectedVersion.id}
|
|
8
|
-
width="var(--doc-version-picker-width)"
|
|
9
|
-
onchange={onVersionChange}
|
|
10
|
-
>
|
|
11
|
-
<dx-button
|
|
12
|
-
class="version-picker-button"
|
|
13
|
-
variant="tertiary"
|
|
14
|
-
size="small"
|
|
15
|
-
icon-symbol="chevrondown"
|
|
16
|
-
icon-size="medium"
|
|
17
|
-
>
|
|
18
|
-
<div class="selected-version">
|
|
19
|
-
<p class="selected-version-label">
|
|
20
|
-
{selectedVersion.label}
|
|
21
|
-
</p>
|
|
22
|
-
<template lwc:if={showLatestTag}>
|
|
23
|
-
<dx-type-badge
|
|
24
|
-
class="latest-badge"
|
|
25
|
-
lwc:if={latestVersion}
|
|
26
|
-
value="Latest"
|
|
27
|
-
size="small"
|
|
28
|
-
></dx-type-badge>
|
|
29
|
-
<dx-type-badge
|
|
30
|
-
class="not-latest-badge"
|
|
31
|
-
lwc:else
|
|
32
|
-
value="Not Latest"
|
|
33
|
-
size="small"
|
|
34
|
-
></dx-type-badge>
|
|
35
|
-
</template>
|
|
36
|
-
</div>
|
|
37
|
-
</dx-button>
|
|
38
|
-
</dx-dropdown>
|
|
39
|
-
</div>
|
|
40
|
-
</template>
|
|
@@ -1,65 +0,0 @@
|
|
|
1
|
-
import { LightningElement, api, track } from "lwc";
|
|
2
|
-
|
|
3
|
-
import { AnalyticsPayload, OptionWithNested } from "typings/custom";
|
|
4
|
-
|
|
5
|
-
import { toJson, normalizeBoolean } from "dxUtils/normalizers";
|
|
6
|
-
|
|
7
|
-
export default class VersionPicker extends LightningElement {
|
|
8
|
-
@api analyticsEvent?: string;
|
|
9
|
-
@api analyticsPayload?: AnalyticsPayload;
|
|
10
|
-
|
|
11
|
-
@track private _versions!: OptionWithNested[];
|
|
12
|
-
private _selectedVersion?: OptionWithNested;
|
|
13
|
-
private _latestVersion: boolean = false;
|
|
14
|
-
private _hideBadge: boolean = false;
|
|
15
|
-
|
|
16
|
-
@api
|
|
17
|
-
get versions() {
|
|
18
|
-
return this._versions;
|
|
19
|
-
}
|
|
20
|
-
|
|
21
|
-
set versions(value: OptionWithNested[]) {
|
|
22
|
-
this._versions = toJson(value);
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
@api
|
|
26
|
-
get selectedVersion(): OptionWithNested | undefined {
|
|
27
|
-
return this._selectedVersion || this.versions[0];
|
|
28
|
-
}
|
|
29
|
-
|
|
30
|
-
set selectedVersion(value: OptionWithNested) {
|
|
31
|
-
if (value) {
|
|
32
|
-
this._selectedVersion = toJson(value);
|
|
33
|
-
}
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
@api
|
|
37
|
-
get latestVersion() {
|
|
38
|
-
return this._latestVersion;
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
set latestVersion(value) {
|
|
42
|
-
this._latestVersion = normalizeBoolean(value);
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
@api
|
|
46
|
-
get hideBadge() {
|
|
47
|
-
return this._hideBadge;
|
|
48
|
-
}
|
|
49
|
-
|
|
50
|
-
set hideBadge(value) {
|
|
51
|
-
this._hideBadge = normalizeBoolean(value);
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
private get showVersionPicker() {
|
|
55
|
-
return this._versions && this._versions.length !== 0;
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
private get showLatestTag(): boolean {
|
|
59
|
-
return !this.hideBadge;
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
private onVersionChange(e: CustomEvent) {
|
|
63
|
-
this.dispatchEvent(new CustomEvent("change", { detail: e.detail }));
|
|
64
|
-
}
|
|
65
|
-
}
|