@salesforcedevs/docs-components 1.34.5-fix-locale-ver-1 → 1.34.5-scroll-1

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@salesforcedevs/docs-components",
3
- "version": "1.34.5-fix-locale-ver-1",
3
+ "version": "1.34.5-scroll-1",
4
4
  "description": "Docs Lightning web components for DSC",
5
5
  "license": "MIT",
6
6
  "main": "index.js",
@@ -26,5 +26,5 @@
26
26
  "@types/lodash.uniqby": "4.7.9"
27
27
  },
28
28
  "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad",
29
- "stableVersion": "1.34.4"
29
+ "stableVersion": "1.34.5"
30
30
  }
@@ -31,6 +31,9 @@ const HIGHLIGHTABLE_SELECTOR = [
31
31
  "td"
32
32
  ].join(",");
33
33
  export const OBSERVER_ATTACH_WAIT_TIME = 500;
34
+ const HASH_SCROLL_DELAY = 500;
35
+ const MAX_HASH_SCROLL_WAIT_TIME = 10000;
36
+ const CODE_BLOCK_TAG = "dx-code-block";
34
37
 
35
38
  const DEFAULT_READING_TIME_LOCALE = "en-us";
36
39
 
@@ -191,6 +194,9 @@ export default class ContentLayout extends LightningElement {
191
194
  // eslint-disable-next-line no-undef
192
195
  protected observerTimerId?: NodeJS.Timeout;
193
196
  protected didScrollToSelectedHash = false;
197
+ // eslint-disable-next-line no-undef
198
+ protected hashScrollTimerId?: NodeJS.Timeout;
199
+ protected hashScrollWaitStart?: number;
194
200
  protected _scrollInterval = 0;
195
201
  protected handleLinkClick = buildDocLinkClickHandler();
196
202
 
@@ -335,6 +341,7 @@ export default class ContentLayout extends LightningElement {
335
341
  this.clearRenderObserverTimer();
336
342
 
337
343
  window.clearInterval(this._scrollInterval);
344
+ clearTimeout(this.hashScrollTimerId);
338
345
 
339
346
  // Remove link click handler
340
347
  this.template.removeEventListener("click", this.handleLinkClick);
@@ -496,9 +503,45 @@ export default class ContentLayout extends LightningElement {
496
503
  }
497
504
 
498
505
  if (!this.didScrollToSelectedHash) {
506
+ this.tryScrollToHash(headingElements);
507
+ }
508
+ }
509
+
510
+ /**
511
+ * Scrolls to the hash once available, retrying while code blocks render
512
+ * to avoid unexpected scrolling on observer re-attach.
513
+ */
514
+ // eslint-disable-next-line no-undef
515
+ protected tryScrollToHash(headingElements: NodeListOf<Element>): void {
516
+ if (!window.location.hash) {
499
517
  this.didScrollToSelectedHash = true;
500
- this.scrollToHash(headingElements);
518
+ return;
519
+ }
520
+ if (this.hasPendingCodeBlocks()) {
521
+ this.hashScrollWaitStart ??= Date.now();
522
+ if (
523
+ Date.now() - this.hashScrollWaitStart <
524
+ MAX_HASH_SCROLL_WAIT_TIME
525
+ ) {
526
+ clearTimeout(this.hashScrollTimerId);
527
+ this.hashScrollTimerId = setTimeout(
528
+ () => this.tryScrollToHash(this.getHeadingElements()),
529
+ HASH_SCROLL_DELAY
530
+ );
531
+ return;
532
+ }
501
533
  }
534
+ if (this.scrollToHash(headingElements)) {
535
+ this.didScrollToSelectedHash = true;
536
+ this.hashScrollWaitStart = undefined;
537
+ clearTimeout(this.hashScrollTimerId);
538
+ }
539
+ }
540
+
541
+ protected hasPendingCodeBlocks(): boolean {
542
+ return Array.from(document.querySelectorAll(CODE_BLOCK_TAG)).some(
543
+ (codeBlock) => !(codeBlock as any).rendered
544
+ );
502
545
  }
503
546
 
504
547
  attachInteractionObserver = (): void => {
@@ -585,6 +628,10 @@ export default class ContentLayout extends LightningElement {
585
628
  this.updateRNB();
586
629
  this.updateContentActionToolbar();
587
630
  this.contentLoaded = true;
631
+
632
+ if (!this.didScrollToSelectedHash) {
633
+ this.tryScrollToHash(this.getHeadingElements());
634
+ }
588
635
  }
589
636
 
590
637
  protected disconnectObserver(): void {
@@ -595,7 +642,7 @@ export default class ContentLayout extends LightningElement {
595
642
  }
596
643
 
597
644
  // eslint-disable-next-line no-undef
598
- protected scrollToHash(headingElements: NodeListOf<Element>): void {
645
+ protected scrollToHash(headingElements: NodeListOf<Element>): boolean {
599
646
  let { hash } = window.location;
600
647
  if (hash) {
601
648
  hash = hash.substr(1);
@@ -610,14 +657,18 @@ export default class ContentLayout extends LightningElement {
610
657
  "hgf-c360contextnav"
611
658
  ) as HTMLElement;
612
659
 
660
+ if (!docHeaderEl || !globalNavEl || !contextNavEl) {
661
+ return false;
662
+ }
663
+
613
664
  const headerHeight =
614
- docHeaderEl?.offsetHeight +
615
- globalNavEl?.offsetHeight +
616
- contextNavEl?.offsetHeight;
665
+ (docHeaderEl.offsetHeight || 0) +
666
+ (globalNavEl.offsetHeight || 0) +
667
+ (contextNavEl.offsetHeight || 0);
617
668
 
618
669
  const docPhaseEl = (
619
670
  this.template.querySelector("[name=doc-phase]")! as any
620
- ).assignedElements()[0] as HTMLSlotElement;
671
+ )?.assignedElements?.()[0] as HTMLSlotElement | undefined;
621
672
 
622
673
  const offset = docPhaseEl
623
674
  ? headerHeight + docPhaseEl.offsetHeight
@@ -626,10 +677,11 @@ export default class ContentLayout extends LightningElement {
626
677
  for (const headingElement of headingElements as any) {
627
678
  if (headingElement.getAttribute("id") === hash) {
628
679
  this.scrollIntoViewWithOffset(headingElement, offset);
629
- break;
680
+ return true;
630
681
  }
631
682
  }
632
683
  }
684
+ return false;
633
685
  }
634
686
 
635
687
  protected scrollIntoViewWithOffset(
@@ -3,5 +3,4 @@
3
3
  --doc-c-redoc-sidebar-top: calc(
4
4
  var(--dx-g-global-header-height) + var(--dx-g-doc-header-height)
5
5
  );
6
- --doc-c-redoc-sidebar-bg: white;
7
6
  }
@@ -4,25 +4,11 @@ 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 "doc/versionPicker";
8
7
  import SprigSurvey from "doc/sprigSurvey";
9
8
  import { throttle } from "throttle-debounce";
10
9
  import { pollUntil } from "dxUtils/async";
11
10
  import { toJson } from "dxUtils/normalizers";
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
- persistTopicVersion,
21
- REFERENCES_LOCALE_SEGMENT_INDEX,
22
- toCanonicalHref
23
- } from "dxUtils/topicVersion";
24
- import type { VersionedNode } from "dxUtils/topicVersion";
25
- import type { DocPhaseInfo, OptionWithLink } from "typings/custom";
11
+ import type { OptionWithLink } from "typings/custom";
26
12
 
27
13
  declare global {
28
14
  interface Window {
@@ -47,20 +33,8 @@ type ReferenceItem = {
47
33
  topic?: ReferenceTopic;
48
34
  };
49
35
 
50
- /** A selectable spec version. Mirrors `ReferenceVersion` in `doc/amfReference`. */
51
- type ReferenceVersion = {
52
- id: string;
53
- label: string;
54
- deprecated?: boolean;
55
- selected?: boolean;
56
- link: { href: string };
57
- };
58
-
59
36
  type ReferenceConfig = {
60
37
  refList: ReferenceItem[];
61
- versions?: ReferenceVersion[];
62
- /** Sidebar topic name. Sidebar stores the selected version under this key. */
63
- versionTopicKey?: string;
64
38
  };
65
39
 
66
40
  const SCROLL_THROTTLE_DELAY = 50;
@@ -68,7 +42,7 @@ const ELEMENT_TIMEOUT = 10000;
68
42
  const ELEMENT_CHECK_INTERVAL = 100;
69
43
  const DEFAULT_PROJECT_TITLE = "All Reference";
70
44
  const BACK_TARGET_STORAGE_KEY = "redoc-back-target";
71
- const SELECTED_VIEW_STORAGE_KEY = "redoc-selected-view";
45
+ const DOCS_PATH_SEGMENT = "docs";
72
46
  const DEFAULT_LOCALE = "en-us";
73
47
 
74
48
  export default class RedocReference extends LightningElement {
@@ -142,29 +116,6 @@ export default class RedocReference extends LightningElement {
142
116
  */
143
117
  @api headerHref: string | null = null;
144
118
 
145
- /**
146
- * Versioned topic that owns this spec, including its children.
147
- * Href matches this page, so an older version still has its version
148
- * in the path.
149
- */
150
- @api
151
- set parentTopicFamily(value: string | { topics?: VersionedNode[] } | null) {
152
- try {
153
- const parsed = toJson(value) as { topics?: VersionedNode[] } | null;
154
- this._parentTopicFamilyNode = parsed?.topics?.[0] ?? null;
155
- } catch (error) {
156
- this._parentTopicFamilyNode = null;
157
- }
158
- }
159
-
160
- get parentTopicFamily(): { topics?: VersionedNode[] } | null {
161
- return this._parentTopicFamilyNode
162
- ? { topics: [this._parentTopicFamilyNode] }
163
- : null;
164
- }
165
-
166
- private _parentTopicFamilyNode: VersionedNode | null = null;
167
-
168
119
  @api
169
120
  get contentType(): string {
170
121
  return this._contentType;
@@ -201,40 +152,6 @@ export default class RedocReference extends LightningElement {
201
152
  return refCount > 1;
202
153
  }
203
154
 
204
- get versions(): ReferenceVersion[] {
205
- return this._referenceConfig?.versions ?? [];
206
- }
207
-
208
- /** The version flagged `selected`, else the first (the latest/GA version). */
209
- get selectedVersion(): ReferenceVersion | null {
210
- const versions = this.versions;
211
- return versions.find((v) => v.selected) ?? versions[0] ?? null;
212
- }
213
-
214
- /** True when the selected version is the latest/GA one (index 0). */
215
- get latestVersion(): boolean {
216
- return this.versions.length
217
- ? this.selectedVersion?.id === this.versions[0].id
218
- : false;
219
- }
220
-
221
- get hasVersionPicker(): boolean {
222
- return this.versions.length > 0;
223
- }
224
-
225
- /** "Newer version available" banner info when on a non-latest version, else null. */
226
- private get oldVersionInfo(): DocPhaseInfo | null {
227
- if (this.versions.length > 1 && !this.latestVersion) {
228
- return oldVersionDocInfo(this.versions[0].link.href);
229
- }
230
- return null;
231
- }
232
-
233
- /** A single version has nothing to choose, so it renders read-only. */
234
- get isVersionReadOnly(): boolean {
235
- return this.versions.length === 1;
236
- }
237
-
238
155
  // Reads stored back target
239
156
  private getBackTargetFromSession(): string | null {
240
157
  return sessionStorage.getItem(BACK_TARGET_STORAGE_KEY);
@@ -269,64 +186,13 @@ export default class RedocReference extends LightningElement {
269
186
  private onBackClick = (event: Event): void => {
270
187
  event.preventDefault();
271
188
 
272
- const target = this.getVersionedBackTarget() ?? this.headerHref;
189
+ const target = this.getTranslatedBackTarget() ?? this.headerHref;
273
190
 
274
191
  if (target) {
275
192
  window.location.assign(target);
276
193
  }
277
194
  };
278
195
 
279
- /**
280
- * When the back target is in this spec's topic, return it on the
281
- * selected version. With no back target, do the same for the header
282
- * link when that link is the versioned parent.
283
- */
284
- private getVersionedBackTarget(): string | null {
285
- const stored = this.getTranslatedBackTarget();
286
- const selectedVersion = this.selectedVersion;
287
- const target = stored ?? this.headerHref;
288
- if (!target || !selectedVersion) {
289
- return stored;
290
- }
291
-
292
- let targetUrl: URL;
293
- try {
294
- targetUrl = new URL(target, window.location.origin);
295
- } catch {
296
- return target;
297
- }
298
-
299
- // Family hrefs match this page's version. Compare them without
300
- // the version segment. Rewrite only the pathname so the target's
301
- // query and hash survive.
302
- const familyHrefs = this._parentTopicFamilyNode
303
- ? collectSubtreeCanonicalHrefs(this._parentTopicFamilyNode).map(
304
- (href) => toCanonicalHref(href, this.versions)
305
- )
306
- : [];
307
-
308
- const canonicalTarget = toCanonicalHref(
309
- targetUrl.pathname,
310
- this.versions
311
- );
312
- const inFamily = familyHrefs.some(
313
- (href) => normalizePath(href) === normalizePath(canonicalTarget)
314
- );
315
- if (!inFamily) {
316
- return target;
317
- }
318
-
319
- const versioned = applyVersionToHref(
320
- canonicalTarget,
321
- selectedVersion,
322
- this.versions
323
- );
324
- if (!versioned) {
325
- return target;
326
- }
327
- return `${versioned}${targetUrl.search}${targetUrl.hash}`;
328
- }
329
-
330
196
  private getTranslatedBackTarget(): string | null {
331
197
  const stored = this.getBackTargetFromSession();
332
198
  if (stored) {
@@ -336,9 +202,7 @@ export default class RedocReference extends LightningElement {
336
202
  }
337
203
 
338
204
  const referrer = this.getSameOriginReferrerHref();
339
- return referrer &&
340
- !this.isLocaleHref(new URL(referrer).pathname) &&
341
- !this.isVersionHref(new URL(referrer).pathname)
205
+ return referrer && !this.isLocaleHref(new URL(referrer).pathname)
342
206
  ? referrer
343
207
  : null;
344
208
  }
@@ -352,9 +216,7 @@ export default class RedocReference extends LightningElement {
352
216
  const segments = url.pathname.split("/").filter(Boolean);
353
217
 
354
218
  // docs -> right after "docs"; references -> after the product segment.
355
- const localeIndex = this.isDocContentType
356
- ? DOCS_LOCALE_SEGMENT_INDEX
357
- : REFERENCES_LOCALE_SEGMENT_INDEX;
219
+ const localeIndex = this.isDocContentType ? 1 : 2;
358
220
 
359
221
  if (segments[0] === DOCS_PATH_SEGMENT) {
360
222
  // Drop the existing locale segment, if any
@@ -379,10 +241,7 @@ export default class RedocReference extends LightningElement {
379
241
  }
380
242
 
381
243
  const referrerUrl = new URL(referrerHref);
382
- if (
383
- this.isLocaleHref(referrerUrl.pathname) ||
384
- this.isVersionHref(referrerUrl.pathname)
385
- ) {
244
+ if (this.isLocaleHref(referrerUrl.pathname)) {
386
245
  return;
387
246
  }
388
247
 
@@ -423,19 +282,6 @@ export default class RedocReference extends LightningElement {
423
282
  });
424
283
  }
425
284
 
426
- /**
427
- * switching version on this same page.
428
- */
429
- private isVersionHref(pathname: string): boolean {
430
- return this.versions.some((version) => {
431
- const href = version?.link?.href;
432
- return (
433
- !!href &&
434
- new URL(href, window.location.origin).pathname === pathname
435
- );
436
- });
437
- }
438
-
439
285
  /** When origin is provided, pass it to the footer; otherwise use dx-footer's default. */
440
286
  get effectiveFooterOrigin(): string {
441
287
  return (
@@ -451,13 +297,6 @@ export default class RedocReference extends LightningElement {
451
297
  // Track the back target, preserving it across locale switches
452
298
  this.trackBackTarget();
453
299
 
454
- // Remember the selected version for the sidebar. Changing version
455
- // reloads this page.
456
- const topicKey = this.getParentTopicVersionKey();
457
- if (topicKey && this.selectedVersion) {
458
- persistTopicVersion(topicKey, this.selectedVersion.id);
459
- }
460
-
461
300
  window.addEventListener("scroll", this.handleScrollAndResize);
462
301
  window.addEventListener("resize", this.handleScrollAndResize);
463
302
  }
@@ -515,14 +354,6 @@ export default class RedocReference extends LightningElement {
515
354
  return parseInt(value, 10) || 0;
516
355
  }
517
356
 
518
- /** Redoc's LNB background color, themeable via `--doc-c-redoc-sidebar-bg`. */
519
- private get sidebarBackgroundColor(): string {
520
- const value = getComputedStyle(this.template.host).getPropertyValue(
521
- "--doc-c-redoc-sidebar-bg"
522
- );
523
- return value.trim() || "white";
524
- }
525
-
526
357
  /*
527
358
  ** Since we could not use --dx-g-global-header-height as getPropertyValue returns a calc expression,
528
359
  ** we are using the respective CSS variables to calculate the height.
@@ -638,14 +469,7 @@ export default class RedocReference extends LightningElement {
638
469
  specUrl,
639
470
  {
640
471
  // Dynamic scroll offset to account for headers
641
- scrollYOffset: this.calculateScrollYOffset,
642
- // Redoc's own styled background outranks injected
643
- // CSS, so the LNB background must be set via theme.
644
- theme: {
645
- sidebar: {
646
- backgroundColor: this.sidebarBackgroundColor
647
- }
648
- }
472
+ scrollYOffset: this.calculateScrollYOffset
649
473
  },
650
474
  redocContainer,
651
475
  (error: any) => {
@@ -691,7 +515,10 @@ export default class RedocReference extends LightningElement {
691
515
  const apiContentDiv = await this.waitForApiContent(redocContainer);
692
516
  apiContentDiv.setAttribute("lwc:dom", "manual");
693
517
 
694
- this.insertStatusItems(apiContentDiv);
518
+ const docPhaseInfo = this.getDocPhaseInfo();
519
+ if (docPhaseInfo) {
520
+ this.insertDocPhase(apiContentDiv, docPhaseInfo);
521
+ }
695
522
 
696
523
  this.appendFooterItems(apiContentDiv);
697
524
 
@@ -700,22 +527,10 @@ export default class RedocReference extends LightningElement {
700
527
 
701
528
  // Wait for footer to be rendered before updating styles
702
529
  requestAnimationFrame(() => {
703
- try {
704
- this.updateRedocThirdColumnStyle(redocContainer);
705
-
706
- // Restore the view selected before a version switch only
707
- // after all layout mutations (footer, header) are
708
- // complete, so the scroll lands on the correct element.
709
- this.restoreSelectedView();
710
-
711
- // Fix initial hash scroll after doc phase insertion
712
- this.handleInitialHashScrollFix();
713
- } catch (error) {
714
- this.showErrorUI(
715
- "Failed to integrate custom components:",
716
- error
717
- );
718
- }
530
+ this.updateRedocThirdColumnStyle(redocContainer);
531
+
532
+ // Fix initial hash scroll after doc phase insertion
533
+ this.handleInitialHashScrollFix();
719
534
  });
720
535
  } catch (error) {
721
536
  this.showErrorUI("Failed to integrate custom components:", error);
@@ -745,70 +560,6 @@ export default class RedocReference extends LightningElement {
745
560
  }
746
561
  }
747
562
 
748
- /** Builds the version picker DOM by reusing `doc-version-picker`. */
749
- private buildVersionPickerDom(): HTMLElement {
750
- const wrapper = document.createElement("div");
751
- wrapper.className = "redoc-version-picker";
752
-
753
- const picker = createElement("doc-version-picker", {
754
- is: VersionPicker
755
- });
756
-
757
- Object.assign(picker, {
758
- versions: this.versions,
759
- selectedVersion: this.selectedVersion,
760
- latestVersion: this.latestVersion,
761
- readOnly: this.isVersionReadOnly
762
- });
763
- picker.addEventListener("change", this.onVersionChange);
764
- wrapper.appendChild(picker);
765
-
766
- return wrapper;
767
- }
768
-
769
- /**
770
- * Key the sidebar uses for this topic's selected version.
771
- * Missing `versionTopicKey` returns null so nothing is written.
772
- */
773
- private getParentTopicVersionKey(): string | null {
774
- const versionTopicKey = this._referenceConfig?.versionTopicKey;
775
- if (!versionTopicKey) {
776
- return null;
777
- }
778
- return (
779
- getTopicVersionKey(
780
- { name: versionTopicKey },
781
- this.language ?? undefined
782
- ) || null
783
- );
784
- }
785
-
786
- /** Stashes the current view (URL hash) before the version link navigates. */
787
- private onVersionChange = (): void => {
788
- sessionStorage.setItem(
789
- SELECTED_VIEW_STORAGE_KEY,
790
- window.location.hash || ""
791
- );
792
- };
793
-
794
- /**
795
- * Re-applies the view stashed before a version switch, if its anchor exists
796
- * in the new spec; otherwise a no-op (lands on the spec root).
797
- */
798
- private restoreSelectedView(): void {
799
- const storedHash = sessionStorage.getItem(SELECTED_VIEW_STORAGE_KEY);
800
- sessionStorage.removeItem(SELECTED_VIEW_STORAGE_KEY);
801
-
802
- if (!storedHash || window.location.hash) {
803
- return;
804
- }
805
-
806
- const targetId = storedHash.replace(/^#/, "");
807
- if (targetId && document.getElementById(targetId)) {
808
- window.location.hash = storedHash;
809
- }
810
- }
811
-
812
563
  /**
813
564
  * Builds the locale picker DOM by reusing `dx-sidebar-footer-nav`
814
565
  */
@@ -830,17 +581,12 @@ export default class RedocReference extends LightningElement {
830
581
  }
831
582
 
832
583
  /**
833
- * Builds the doc header: a title group (back link + spec title) and, when
834
- * versions are available, the version picker as a sibling row. Layout/gaps
835
- * are styled by the developer-website's redoc CSS.
584
+ * Builds a fresh project-title/spec-title header DOM node.
836
585
  */
837
586
  private buildProjectHeaderDom(): HTMLElement {
838
587
  const wrapper = document.createElement("div");
839
588
  wrapper.className = "redoc-project-header";
840
589
 
841
- const main = document.createElement("div");
842
- main.className = "redoc-project-header-main";
843
-
844
590
  if (this.projectTitle) {
845
591
  const backLink = document.createElement("a");
846
592
  backLink.className = "redoc-project-back";
@@ -861,20 +607,14 @@ export default class RedocReference extends LightningElement {
861
607
 
862
608
  backLink.appendChild(icon);
863
609
  backLink.appendChild(label);
864
- main.appendChild(backLink);
610
+ wrapper.appendChild(backLink);
865
611
  }
866
612
 
867
613
  if (this.specTitle) {
868
614
  const specEl = document.createElement("h2");
869
615
  specEl.className = "redoc-spec-title dx-text-display-7";
870
616
  specEl.textContent = this.specTitle;
871
- main.appendChild(specEl);
872
- }
873
-
874
- wrapper.appendChild(main);
875
-
876
- if (this.hasVersionPicker) {
877
- wrapper.appendChild(this.buildVersionPickerDom());
617
+ wrapper.appendChild(specEl);
878
618
  }
879
619
 
880
620
  return wrapper;
@@ -899,40 +639,15 @@ export default class RedocReference extends LightningElement {
899
639
  return container.querySelector<HTMLElement>(".api-content")!;
900
640
  }
901
641
 
902
- // Inserts the doc phase and, on a non-latest version, a dismissible
903
- // "newer version" banner into a shared doc-phase-wrapper at container start
904
- private insertStatusItems(container: HTMLElement): void {
905
- const docPhaseInfo = this.getDocPhaseInfo();
906
- const oldVersionInfo = this.oldVersionInfo;
907
- if (!docPhaseInfo && !oldVersionInfo) {
908
- return;
909
- }
910
-
642
+ // Creates and inserts doc phase component at container start
643
+ private insertDocPhase(container: HTMLElement, docPhaseInfo: string): void {
911
644
  const wrapper = document.createElement("div");
912
645
  wrapper.className = "doc-phase-wrapper";
913
646
  container.insertBefore(wrapper, container.firstChild);
914
647
 
915
- if (docPhaseInfo) {
916
- const docPhaseElement = createElement("doc-phase", {
917
- is: DocPhase
918
- });
919
- Object.assign(docPhaseElement, { docPhaseInfo });
920
- wrapper.appendChild(docPhaseElement);
921
- }
922
-
923
- if (oldVersionInfo) {
924
- const versionBanner = createElement("doc-phase", { is: DocPhase });
925
- Object.assign(versionBanner, {
926
- docPhaseInfo: oldVersionInfo,
927
- dismissible: true,
928
- iconName: "warning"
929
- });
930
- versionBanner.addEventListener("dismissphase", () => {
931
- versionBanner.remove();
932
- this.updateSidebarPosition();
933
- });
934
- wrapper.appendChild(versionBanner);
935
- }
648
+ const docPhaseElement = createElement("doc-phase", { is: DocPhase });
649
+ Object.assign(docPhaseElement, { docPhaseInfo });
650
+ wrapper.appendChild(docPhaseElement);
936
651
  }
937
652
 
938
653
  // Appends footer component to container
@@ -24,14 +24,6 @@
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>
35
27
  <slot></slot>
36
28
  </doc-content-layout>
37
29
  </template>
@@ -1,12 +1,6 @@
1
- import { LightningElement, api, track } from "lwc";
1
+ import { LightningElement, api } from "lwc";
2
2
  import { toJson } from "dxUtils/normalizers";
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";
3
+ import type { OptionWithLink, TreeNode } from "typings/custom";
10
4
 
11
5
  /**
12
6
  * Per-topic type emitted by the docs content-type parser
@@ -16,38 +10,61 @@ import type { DocPhaseInfo, OptionWithLink, TreeNode } from "typings/custom";
16
10
  */
17
11
  const TOPIC_TYPE_SPEC = "spec";
18
12
 
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
+
19
39
  /**
20
40
  * Translates per-topic `topicType` into the generic `showForwardArrow` flag
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.
41
+ * that `dx-tree-tile` reads (spec topics get the forward arrow icon for Redoc),
42
+ * and redirects content-less parent topics whose first child is a content page
26
43
  */
27
- function decorateTopicsWithForwardArrow(
28
- topics:
29
- | Array<TreeNode & { topicType?: string; versions?: unknown }>
30
- | undefined
44
+ function decorateTopics(
45
+ topics: Array<TreeNode & { topicType?: string }> | undefined
31
46
  ): TreeNode[] | undefined {
32
47
  return topics?.map((topic) => {
33
- const { topicType, versions, ...decorated } = topic;
48
+ const { topicType, ...decorated } = topic;
34
49
  if (topicType === TOPIC_TYPE_SPEC) {
35
50
  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 (versions) {
39
- decorated.versions = versions;
40
51
  }
41
52
  if (decorated.children) {
42
- decorated.children = decorateTopicsWithForwardArrow(
43
- decorated.children
44
- );
53
+ decorated.children = decorateTopics(decorated.children);
45
54
  }
46
55
 
47
- // Flag a parent with no page of its own. Leave its link empty so the
48
- // child's URL stays indexed to the child.
49
- if (!!decorated.children?.length && !decorated.link?.href) {
56
+ /** Redirect a parent that has no content of its own to its first child
57
+ * but only when that first child is itself a content page
58
+ */
59
+ const isContentlessParent =
60
+ !!decorated.children?.length && !decorated.link?.href;
61
+
62
+ if (isContentlessParent) {
50
63
  decorated.redirectToChild = true;
64
+ const firstChild = firstChildContentPage(topic);
65
+ if (firstChild?.link) {
66
+ decorated.link = { ...firstChild.link };
67
+ }
51
68
  }
52
69
 
53
70
  return decorated;
@@ -84,9 +101,6 @@ export default class UnifiedContentLayout extends LightningElement {
84
101
 
85
102
  private _docPhaseInfo: string | null = null;
86
103
  private _sidebarContent: unknown = null;
87
- private _oldVersionInfo: DocPhaseInfo | null = null;
88
-
89
- @track showVersionBanner = false;
90
104
 
91
105
  @api
92
106
  get docPhaseInfo(): string | null {
@@ -103,40 +117,7 @@ export default class UnifiedContentLayout extends LightningElement {
103
117
  }
104
118
 
105
119
  set sidebarContent(value: string) {
106
- const topics = decorateTopicsWithForwardArrow(toJson(value)?.topics);
107
- this._sidebarContent = topics;
108
- this.updateTopicVersionBanner(topics as VersionedNode[] | undefined);
109
- }
110
-
111
- get oldVersionInfo(): DocPhaseInfo | null {
112
- return this._oldVersionInfo;
113
- }
114
-
115
- handleDismissVersionBanner(): void {
116
- this.showVersionBanner = false;
117
- }
118
-
119
- /**
120
- * Same banner references use when the reader is on an older version.
121
- * Topic versions are not a separate page property: the sidebar tree
122
- * carries each version's switching URL, and the current pathname says
123
- * which one is open.
124
- */
125
- private updateTopicVersionBanner(
126
- topics: VersionedNode[] | undefined
127
- ): void {
128
- const match = findTopicVersionForCurrentPage(topics);
129
- const latest = match?.node.versions?.[0];
130
- const latestHref = latestHrefForCurrentPage(match?.node.versions);
131
-
132
- if (match && latest && match.version.id !== latest.id && latestHref) {
133
- this._oldVersionInfo = oldVersionDocInfo(latestHref);
134
- this.showVersionBanner = true;
135
- return;
136
- }
137
-
138
- this._oldVersionInfo = null;
139
- this.showVersionBanner = false;
120
+ this._sidebarContent = decorateTopics(toJson(value)?.topics);
140
121
  }
141
122
 
142
123
  private get enableFooter(): boolean {
@@ -2,69 +2,28 @@
2
2
 
3
3
  /* NOTE: doc-version-picker-width width variable is used by both dx-button and dx-dropdown to maintain a consistent width. */
4
4
  :host {
5
- /* Always positioned so the popover's containing block stays the picker.
6
- Toggling position with aria-expanded lets the menu jump to the sidebar
7
- (top of the ToC) for a frame before LWC hides it. */
8
- position: relative;
9
-
10
5
  --dx-c-dropdown-option-font-weight: normal;
11
- --dx-c-dropdown-option-font-size: var(--dx-g-text-base);
12
6
  --dx-c-dropdown-option-label-color: var(--dx-g-gray-10);
13
- --dx-c-dropdown-option-active-label-color: var(--dx-g-gray-10);
14
- --dx-c-dropdown-option-padding: var(--dx-g-spacing-sm)
15
- var(--dx-g-spacing-lg);
16
- --dx-c-popover-padding: var(--dx-g-spacing-sm) 0;
17
7
  --popover-container-open-transform: translateY(4px);
18
- --dx-c-version-picker-focus-ring: 0 0 0 2px white,
19
- 0 0 0 4px var(--dx-g-blue-vibrant-60);
20
- }
21
-
22
- /* Open menus must stack above later sibling pickers in the sidebar. */
23
- :host(:has([aria-expanded="true"])) {
24
- z-index: 2;
25
8
  }
26
9
 
27
10
  .version-picker-container {
28
- /* Override --doc-version-picker-padding to change the inset (e.g. when the
29
- picker sits inside an already-padded container). */
30
- padding: var(
31
- --doc-version-picker-padding,
32
- var(--dx-g-spacing-sm) var(--dx-g-spacing-lg) var(--dx-g-spacing-sm)
33
- var(--dx-g-global-header-padding-horizontal)
34
- );
35
-
36
- /* Override --doc-version-picker-divider (e.g. `none`) to restyle dividers. */
37
- border-top: var(
38
- --doc-version-picker-divider,
39
- 1px solid var(--dx-g-gray-90)
40
- );
41
- border-bottom: var(
42
- --doc-version-picker-divider,
43
- 1px solid var(--dx-g-gray-90)
44
- );
45
- }
46
-
47
- /* Inline sidebar variant: drop the header-slot chrome so the picker sits
48
- beside a tree node without extra padding or divider lines. */
49
- .version-picker-container-small {
50
- display: flex;
51
- align-items: center;
52
- padding: 0;
53
- border: none;
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);
54
15
  }
55
16
 
56
17
  .version-picker-button {
57
18
  display: flex;
58
- width: 100%;
59
- overflow: visible;
60
-
61
- --dx-c-button-horizontal-spacing: var(--dx-g-spacing-sm);
62
- --dx-g-button-icon-color: var(--dx-g-gray-50);
19
+ width: var(--doc-version-picker-width, 296px);
63
20
  }
64
21
 
65
22
  .version-picker-button:hover,
66
- .version-picker-button[aria-expanded="true"] {
67
- --dx-g-button-icon-color: var(--dx-g-blue-vibrant-20);
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);
68
27
  }
69
28
 
70
29
  /**
@@ -76,57 +35,6 @@ dx-button::part(content) {
76
35
  overflow: hidden;
77
36
  }
78
37
 
79
- /* Border width stays 1px in every state. Hover, open, and focus paint the
80
- 2px blue stroke with an inset shadow so the box does not grow.
81
- Tertiary's hover border is overridden. */
82
- .version-picker-button::part(container) {
83
- box-sizing: border-box;
84
- background: white;
85
- border: 1px solid var(--dx-g-gray-50);
86
- border-radius: var(--dx-g-spacing-xs);
87
- box-shadow: none;
88
- color: var(--dx-g-gray-10);
89
- outline: none;
90
- transition: var(--dx-g-transition-hue-1x), box-shadow 0.15s linear;
91
- }
92
-
93
- /* Hover only (not open): 2px #032D60 on #EEF4FF, no ring.
94
- Border color matches the fill so the 1px border does not add a third
95
- pixel around the inset stroke.
96
- :focus-visible is included so click-open + Escape (which upgrades the
97
- trigger to keyboard focus) still looks like hover while the pointer is on
98
- the picker. */
99
- .version-picker-button:hover:not([aria-expanded="true"])::part(container),
100
- .version-picker-button:hover:not([aria-expanded="true"])::part(
101
- container
102
- ):focus-visible {
103
- background: var(--dx-g-blue-vibrant-95);
104
- border: 1px solid var(--dx-g-blue-vibrant-95);
105
- box-shadow: inset 0 0 0 2px var(--dx-g-blue-vibrant-20);
106
- }
107
-
108
- /* Open keeps the fill and the 2px stroke. The focus ring is keyboard-only,
109
- on the closed picker below. */
110
- .version-picker-button[aria-expanded="true"]::part(container) {
111
- background: var(--dx-g-blue-vibrant-95);
112
- border: 1px solid var(--dx-g-blue-vibrant-95);
113
- border-radius: var(--dx-g-spacing-xs);
114
- box-shadow: inset 0 0 0 2px var(--dx-g-blue-vibrant-20);
115
- }
116
-
117
- /* Keyboard focus while closed. */
118
- .version-picker-button:not([aria-expanded="true"])::part(
119
- container
120
- ):focus-visible {
121
- --dx-g-button-icon-color: var(--dx-g-blue-vibrant-20);
122
-
123
- background: var(--dx-g-blue-vibrant-95);
124
- border: 1px solid var(--dx-g-blue-vibrant-95);
125
- border-radius: var(--dx-g-spacing-xs);
126
- box-shadow: inset 0 0 0 2px var(--dx-g-blue-vibrant-20),
127
- var(--dx-c-version-picker-focus-ring);
128
- }
129
-
130
38
  .selected-version {
131
39
  display: flex;
132
40
  flex-direction: row;
@@ -141,111 +49,16 @@ dx-button::part(content) {
141
49
  white-space: nowrap;
142
50
  }
143
51
 
144
- dx-type-badge.latest-badge,
145
- dx-type-badge.not-latest-badge {
146
- margin-left: var(--dx-g-spacing-sm);
147
- }
148
-
149
- /* ------------------------------------------------------------------ *
150
- * Small "dot" variant (opt-in via `small`). Additive
151
- * ------------------------------------------------------------------ */
152
-
153
- /* Menu is capped at the ToC width (296px), not the 104px trigger, so options
154
- keep the same 16px / 8px 24px / gray-10 type as the default picker. */
155
- .version-picker-dropdown-small {
156
- --dx-c-dropdown-option-font-size: var(--dx-g-text-base);
157
- --dx-c-dropdown-option-padding: var(--dx-g-spacing-sm)
158
- var(--dx-g-spacing-lg);
159
- --dx-c-dropdown-option-label-color: var(--dx-g-gray-10);
160
- --dx-c-dropdown-option-border-radius: 0;
161
- --dx-c-popover-border: none;
162
-
163
- /* Hug the labels (down to the shortest) but never wider than the ToC
164
- content: 296px on desktop, and on the smallest breakpoint the sidebar
165
- variable grows with the viewport up to 720px. Long labels wrap inside
166
- that cap. */
167
- --dx-c-dropdown-menu-max-width: var(--doc-version-picker-width, 296px);
168
- --dx-c-dropdown-fit-white-space: normal;
169
- --dx-c-dropdown-fit-overflow: hidden;
170
- --dx-c-dropdown-fit-text-overflow: clip;
171
- --dx-c-dropdown-option-overflow-wrap: anywhere;
172
- }
173
-
174
- .version-picker-button-small {
175
- width: fit-content;
176
- max-width: 104px;
177
-
178
- --dx-c-button-font-size: var(--dx-g-text-xs);
179
- --dx-c-button-font-weight: var(--dx-g-font-normal);
180
- --dx-c-button-line-height: var(--dx-g-spacing-lg);
181
- --dx-c-button-icon-gap: var(--dx-g-spacing-2xs);
182
- }
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);
183
55
 
184
- /* min-width: 0 on each flex ancestor lets the label truncate: a flex item's
185
- default min-width: auto refuses to shrink below its content and overrides the
186
- host's max-width, so without this the trigger overflows instead. */
187
- .version-picker-button-small::part(content) {
188
- display: flex;
189
- flex: 1;
190
- min-width: 0;
191
- width: auto;
192
- overflow: hidden;
193
- }
194
-
195
- /* width:100% re-ties to the 104px-capped host (container is width:inherit,
196
- which copies width but not max-width). Border/bg/states are shared above. */
197
- .version-picker-button-small::part(container) {
198
- width: 100%;
199
- height: var(--dx-g-spacing-lg);
200
- padding: 0 var(--dx-g-spacing-xs);
201
- }
202
-
203
- .selected-version-small {
204
- flex: 1;
205
- min-width: 0;
206
- }
207
-
208
- .version-picker-dot {
209
- flex: 0 0 auto;
210
- width: var(--dx-g-spacing-sm);
211
- height: var(--dx-g-spacing-sm);
212
- margin-right: var(--dx-g-spacing-xs);
213
- border-radius: 50%;
214
- }
215
-
216
- .version-picker-dot-latest {
217
- background: var(--dx-g-green-vibrant-60);
218
- }
219
-
220
- .version-picker-dot-not-latest {
221
- background: var(--dx-g-yellow-vibrant-80);
56
+ margin-left: var(--dx-g-spacing-sm);
222
57
  }
223
58
 
224
- /* inline-block (not flex) so the label can truncate; line-height centers it. */
225
- .version-picker-readonly {
226
- box-sizing: border-box;
227
- display: inline-block;
228
- width: 100%;
229
- height: var(--dx-g-spacing-xl);
230
- margin: 0;
231
- padding: 0 var(--dx-g-spacing-sm);
232
- border: 1px solid var(--dx-g-gray-80);
233
- border-radius: var(--dx-g-spacing-xs);
234
- overflow: hidden;
235
- color: var(--dx-g-gray-10);
236
- text-overflow: ellipsis;
237
- white-space: nowrap;
238
- font: var(--dx-g-font-normal) var(--dx-g-text-sm) / var(--dx-g-spacing-xl)
239
- var(--dx-g-font-sans),
240
- sans-serif;
241
- }
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);
242
62
 
243
- .version-picker-readonly-small {
244
- width: fit-content;
245
- max-width: 104px;
246
- height: var(--dx-g-spacing-lg);
247
- padding: 0 var(--dx-g-spacing-xs);
248
- font: var(--dx-g-font-normal) var(--dx-g-text-xs) / var(--dx-g-spacing-lg)
249
- var(--dx-g-font-sans),
250
- sans-serif;
63
+ margin-left: var(--dx-g-spacing-sm);
251
64
  }
@@ -1,70 +1,37 @@
1
1
  <template>
2
- <div lwc:if={showVersionPicker} class={containerClass}>
3
- <!-- Small read-only: plain value, no dropdown -->
4
- <p
5
- lwc:if={readOnly}
6
- class={readOnlyClass}
7
- title={selectedVersion.label}
8
- >
9
- {selectedVersion.label}
10
- </p>
11
-
2
+ <div lwc:if={showVersionPicker} class="version-picker-container">
12
3
  <dx-dropdown
13
- lwc:else
14
- class={dropdownClass}
15
4
  options={versions}
16
5
  analytics-event="custEv_docVersionSelect"
17
6
  analytics-payload={analyticsPayload}
18
7
  value={selectedVersion.id}
19
- width-mode={dropdownWidthMode}
8
+ width="var(--doc-version-picker-width)"
20
9
  onchange={onVersionChange}
21
10
  >
22
11
  <dx-button
23
- class={triggerClass}
12
+ class="version-picker-button"
24
13
  variant="tertiary"
25
14
  size="small"
26
- font="sans"
27
15
  icon-symbol="chevrondown"
28
- icon-size={triggerIconSize}
29
- aria-label={triggerAriaLabel}
16
+ icon-size="medium"
30
17
  >
31
- <div class={selectedVersionClass}>
32
- <!-- Small: leading colored dot -->
33
- <template lwc:if={small}>
34
- <template lwc:if={showLatestTag}>
35
- <span class={dotClass} aria-hidden="true"></span>
36
- </template>
37
- <p
38
- class="selected-version-label"
39
- title={selectedVersion.label}
40
- >
41
- {selectedVersion.label}
42
- </p>
43
- </template>
44
- <!-- Default: trailing Latest/Not-Latest badge -->
45
- <template lwc:else>
46
- <p
47
- class="selected-version-label"
48
- title={selectedVersion.label}
49
- >
50
- {selectedVersion.label}
51
- </p>
52
- <template lwc:if={showLatestTag}>
53
- <dx-type-badge
54
- class="latest-badge"
55
- lwc:if={latestVersion}
56
- variant="status-success"
57
- value="Latest"
58
- size="small"
59
- ></dx-type-badge>
60
- <dx-type-badge
61
- class="not-latest-badge"
62
- lwc:else
63
- variant="status-warning"
64
- value="Not Latest"
65
- size="small"
66
- ></dx-type-badge>
67
- </template>
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>
68
35
  </template>
69
36
  </div>
70
37
  </dx-button>
@@ -1,5 +1,4 @@
1
1
  import { LightningElement, api, track } from "lwc";
2
- import cx from "classnames";
3
2
 
4
3
  import { AnalyticsPayload, OptionWithNested } from "typings/custom";
5
4
 
@@ -13,8 +12,6 @@ export default class VersionPicker extends LightningElement {
13
12
  private _selectedVersion?: OptionWithNested;
14
13
  private _latestVersion: boolean = false;
15
14
  private _hideBadge: boolean = false;
16
- private _small: boolean = false;
17
- private _readOnly: boolean = false;
18
15
 
19
16
  @api
20
17
  get versions() {
@@ -54,103 +51,14 @@ export default class VersionPicker extends LightningElement {
54
51
  this._hideBadge = normalizeBoolean(value);
55
52
  }
56
53
 
57
- // Opt-in compact "dot" variant (24px, abbreviated label). Off by default so
58
- // existing consumers render the default trigger unchanged.
59
- @api
60
- get small() {
61
- return this._small;
62
- }
63
-
64
- set small(value) {
65
- this._small = normalizeBoolean(value);
66
- }
67
-
68
- // Opt-in read-only state: plain value, no dropdown menu.
69
- @api
70
- get readOnly() {
71
- return this._readOnly;
72
- }
73
-
74
- set readOnly(value) {
75
- this._readOnly = normalizeBoolean(value);
76
- }
77
-
78
54
  private get showVersionPicker() {
79
55
  return this._versions && this._versions.length !== 0;
80
56
  }
81
57
 
82
- private get containerClass(): string {
83
- return this.small
84
- ? "version-picker-container-small"
85
- : "version-picker-container";
86
- }
87
-
88
58
  private get showLatestTag(): boolean {
89
59
  return !this.hideBadge;
90
60
  }
91
61
 
92
- private get readOnlyClass(): string {
93
- return cx(
94
- "version-picker-readonly",
95
- this.small && "version-picker-readonly-small"
96
- );
97
- }
98
-
99
- private get dotClass(): string {
100
- return `version-picker-dot ${
101
- this.latestVersion
102
- ? "version-picker-dot-latest"
103
- : "version-picker-dot-not-latest"
104
- }`;
105
- }
106
-
107
- // Accessible name for the small trigger: includes the latest state so it
108
- // isn't conveyed by the dot's color alone (WCAG 1.4.1). Omits the state
109
- // when the indicator is hidden.
110
- private get smallTriggerAriaLabel(): string {
111
- const label = this.selectedVersion?.label ?? "";
112
- if (!this.showLatestTag) {
113
- return label;
114
- }
115
- return `${label}, ${this.latestVersion ? "Latest" : "Not Latest"}`;
116
- }
117
-
118
- // --- Per-variant values for the shared dropdown/button markup below. The
119
- // small variant opts into extra classes and a compact chevron.
120
-
121
- // Not cx(): the default must have NO class attribute (cx returns "", which
122
- // would render class="" and break the frozen consumer snapshots).
123
- private get dropdownClass(): string | undefined {
124
- return this.small ? "version-picker-dropdown-small" : undefined;
125
- }
126
-
127
- // "full" matches the trigger (ToC width). "fit-end" sizes to the labels,
128
- // caps at the ToC width, and opens inward.
129
- private get dropdownWidthMode(): "full" | "fit-end" {
130
- return this.small ? "fit-end" : "full";
131
- }
132
-
133
- private get triggerClass(): string {
134
- return cx(
135
- "version-picker-button",
136
- this.small && "version-picker-button-small"
137
- );
138
- }
139
-
140
- private get triggerIconSize(): string {
141
- return this.small ? "xsmall" : "medium";
142
- }
143
-
144
- // Default returns "" (dx-button's own default) so the trigger's rendered
145
- // aria-label is unchanged for the default variant.
146
- private get triggerAriaLabel(): string {
147
- return this.small ? this.smallTriggerAriaLabel : "";
148
- }
149
-
150
- private get selectedVersionClass(): string {
151
- return cx("selected-version", this.small && "selected-version-small");
152
- }
153
-
154
62
  private onVersionChange(e: CustomEvent) {
155
63
  this.dispatchEvent(new CustomEvent("change", { detail: e.detail }));
156
64
  }
@@ -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,28 +1,10 @@
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
-
20
3
  export const oldVersionDocInfo = (latestVersionLink: string) => {
21
- const safeLink = toSafeHref(latestVersionLink);
22
4
  return {
23
5
  title: "Newer Version Available",
24
- body: `This content describes an older version of this product.
25
- <a style="font-weight: bold;" href="${safeLink}">View Latest</a>`
6
+ body: `This content describes an older version of this product.
7
+ <a style="font-weight: bold;" href="${latestVersionLink}">View Latest</a>`
26
8
  };
27
9
  };
28
10