@f5-sales-demo/docs-theme 4.4.10 → 4.4.12

package/components/SharedHeader.astro

@@ -0,0 +1,122 @@
+---
+import LanguageSelect from 'virtual:starlight/components/LanguageSelect';
+import Search from 'virtual:starlight/components/Search';
+import SiteTitle from 'virtual:starlight/components/SiteTitle';
+import SocialIcons from 'virtual:starlight/components/SocialIcons';
+import ThemeSelect from 'virtual:starlight/components/ThemeSelect';
+import config from 'virtual:starlight/user-config';
+import MegaMenu from './SharedMegaMenu.tsx';
+import MegaMenuMobile from './SharedMegaMenuMobile.tsx';
+
+/**
+ * Render the `Search` component if Pagefind is enabled or the default search component has been overridden.
+ */
+const shouldRenderSearch = config.pagefind || config.components.Search !== '@astrojs/starlight/components/Search.astro';
+---
+
+<div class="header sl-mega-menu-header">
+	<div class="title-wrapper sl-flex">
+		<SiteTitle />
+	</div>
+	<nav class="smm-desktop-nav">
+		<MegaMenu client:only="react" />
+	</nav>
+	<div class="sl-flex print:hidden">
+		{shouldRenderSearch && <Search />}
+	</div>
+	<div class="sl-hidden md:sl-flex print:hidden right-group">
+		<div class="sl-flex social-icons">
+			<SocialIcons />
+		</div>
+		<ThemeSelect />
+		<LanguageSelect />
+	</div>
+	<div class="smm-mobile-toggle">
+		<MegaMenuMobile client:only="react" />
+	</div>
+</div>
+
+<style>
+	@layer starlight.core {
+		.header {
+			display: flex;
+			gap: var(--sl-nav-gap);
+			justify-content: space-between;
+			align-items: center;
+			height: 100%;
+		}
+
+		.title-wrapper {
+			/* Prevent long titles overflowing and covering the search and menu buttons on narrow viewports. */
+			overflow: clip;
+			/* Avoid clipping focus ring around link inside title wrapper. */
+			padding: 0.25rem;
+			margin: -0.25rem;
+			min-width: 0;
+		}
+
+		.right-group,
+		.social-icons {
+			gap: 1rem;
+			align-items: center;
+		}
+		.social-icons::after {
+			content: '';
+			height: 2rem;
+			border-inline-end: 1px solid var(--sl-color-gray-5);
+		}
+
+		/* Desktop nav is hidden on small screens */
+		.smm-desktop-nav {
+			display: none;
+		}
+
+		/* Mobile toggle is visible on small screens */
+		.smm-mobile-toggle {
+			display: flex;
+			align-items: center;
+		}
+
+		@media (min-width: 50rem) {
+			:global(:root[data-has-sidebar]) {
+				--__sidebar-pad: calc(2 * var(--sl-nav-pad-x));
+			}
+			:global(:root:not([data-has-toc])) {
+				--__toc-width: 0rem;
+			}
+			.header {
+				--__sidebar-width: max(0rem, var(--sl-content-inline-start, 0rem) - var(--sl-nav-pad-x));
+				--__main-column-fr: calc(
+					(
+							100% + var(--__sidebar-pad, 0rem) - var(--__toc-width, var(--sl-sidebar-width)) -
+								(2 * var(--__toc-width, var(--sl-nav-pad-x))) - var(--sl-content-inline-start, 0rem) -
+								var(--sl-content-width)
+						) / 2
+				);
+				display: grid;
+				grid-template-columns:
+					/* 1 (site title) */
+					auto
+					/* 2 (mega-menu nav) */
+					1fr
+					/* 3 (search box) */
+					auto
+					/* 4 (right items) */
+					auto;
+				align-content: center;
+			}
+
+			/* Show desktop nav, hide mobile toggle */
+			.smm-desktop-nav {
+				display: flex;
+				align-items: center;
+				justify-content: center;
+				min-width: 0;
+			}
+
+			.smm-mobile-toggle {
+				display: none;
+			}
+		}
+	}
+</style>

package/components/SharedMegaMenu.tsx

@@ -0,0 +1,5 @@
+import config from 'virtual:starlight-mega-menu/config';
+import MegaMenu from '@f5-sales-demo/starlight-mega-menu/components/MegaMenu.tsx';
+export default function SharedMegaMenu() {
+  return <MegaMenu config={config} />;
+}

package/components/SharedMegaMenuMobile.tsx

@@ -0,0 +1,5 @@
+import config from 'virtual:starlight-mega-menu/config';
+import MegaMenuMobile from '@f5-sales-demo/starlight-mega-menu/components/MegaMenuMobile.tsx';
+export default function SharedMegaMenuMobile() {
+  return <MegaMenuMobile config={config} />;
+}

package/index.ts

@@ -24,6 +24,7 @@ export default function f5xcDocsTheme(): StarlightPlugin {
           ],
           components: {
             ...config.components,
+            Header: '@f5-sales-demo/docs-theme/components/SharedHeader.astro',
             ...(process.env.DOCS_PROFILE === 'canonical-provider'
               ? {
                   Sidebar: '@f5-sales-demo/docs-theme/components/ProviderSidebar.astro',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@f5-sales-demo/docs-theme",
-  "version": "4.4.10",
+  "version": "4.4.12",
   "description": "F5 Distributed Cloud branded Starlight documentation theme",
   "type": "module",
   "engines": {
@@ -43,7 +43,8 @@
     "./src/utils/localize-ecosystem-href.ts": "./src/utils/localize-ecosystem-href.ts",
     "./canonical-route-middleware": "./canonical-route-middleware.ts",
     "./components/ProviderSidebar.astro": "./components/ProviderSidebar.astro",
-    "./components/ProviderHeader.astro": "./components/ProviderHeader.astro"
+    "./components/ProviderHeader.astro": "./components/ProviderHeader.astro",
+    "./components/SharedHeader.astro": "./components/SharedHeader.astro"
   },
   "files": [
     "index.ts",

package/src/utils/localize-ecosystem-href.test.ts

@@ -79,3 +79,10 @@ describe('localizeEcosystemHref', () => {
     );
   });
 });
+
+it('leaves the single-locale mvp menu destination unlocalized', () => {
+  for (const locale of ['en', 'fr'])
+    expect(localizeEcosystemHref('https://f5-sales-demo.github.io/mvp/', locale)).toBe(
+      'https://f5-sales-demo.github.io/mvp/',
+    );
+});

package/src/utils/localize-ecosystem-href.ts

@@ -5,7 +5,7 @@ const ECOSYSTEM_HOST = 'f5-sales-demo.github.io';
 // Ecosystem sites published as a single locale (no `/<locale>/` path segment).
 // Injecting a locale slug into links to these produces a 404
 // (e.g. `/terraform-provider-xcsh/en/`), so they are left unlocalized.
-const NON_LOCALIZED_ECOSYSTEM_SLUGS = new Set(['terraform-provider-xcsh', 'docs-control', 'html-to-markdown']);
+const NON_LOCALIZED_ECOSYSTEM_SLUGS = new Set(['terraform-provider-xcsh', 'docs-control', 'html-to-markdown', 'mvp']);
 
 export const langToSlug = bcp47ToSlug;
 

package/src/utils/shared-header.test.ts

@@ -0,0 +1,14 @@
+import { readFileSync } from 'node:fs';
+import { expect, it } from 'vitest';
+
+it('bundles menu config in shared clients instead of serialized island props', () => {
+  const header = readFileSync(new URL('../../components/SharedHeader.astro', import.meta.url), 'utf8');
+  expect(header).not.toContain('config={');
+  expect(header).toContain('<ThemeSelect');
+  expect(header).toContain('<LanguageSelect');
+  expect(header).toContain('<SocialIcons');
+  for (const name of ['SharedMegaMenu', 'SharedMegaMenuMobile']) {
+    const client = readFileSync(new URL(`../../components/${name}.tsx`, import.meta.url), 'utf8');
+    expect(client).toContain('virtual:starlight-mega-menu/config');
+  }
+});