Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

feat(templates): add Shell — Top Nav page template (#3245)

Ernest3f6481f315e5
diff --git a/apps/docsite/src/components/templateComponents.ts b/apps/docsite/src/components/templateComponents.ts
index 228539bdd3..3c3af96448 100644
--- a/apps/docsite/src/components/templateComponents.ts
+++ b/apps/docsite/src/components/templateComponents.ts
@@ -117,6 +117,9 @@ export const TEMPLATE_COMPONENTS: Record<
'side-gallery': lazy(
() => import('../../../../packages/cli/templates/pages/side-gallery/page'),
),
+ 'shell-top-nav': lazy(
+ () => import('../../../../packages/cli/templates/pages/shell-top-nav/page'),
+ ),
table: lazy(
() => import('../../../../packages/cli/templates/pages/table/page'),
),
diff --git a/packages/cli/templates/pages/shell-top-nav/page.tsx b/packages/cli/templates/pages/shell-top-nav/page.tsx
new file mode 100644
index 0000000000..df7a28e30d
--- /dev/null
+++ b/packages/cli/templates/pages/shell-top-nav/page.tsx
@@ -0,0 +1,224 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+'use client';
+
+import * as stylex from '@stylexjs/stylex';
+import {AppShell} from '@astryxdesign/core/AppShell';
+import {
+ TopNav,
+ TopNavHeading,
+ TopNavItem,
+ TopNavMegaMenu,
+ TopNavMegaMenuItem,
+ TopNavMegaMenuFeaturedCard,
+} from '@astryxdesign/core/TopNav';
+import {NavIcon} from '@astryxdesign/core/NavIcon';
+import {Icon} from '@astryxdesign/core/Icon';
+import type {IconType} from '@astryxdesign/core/Icon';
+import {IconButton} from '@astryxdesign/core/IconButton';
+import {Button} from '@astryxdesign/core/Button';
+import {Badge} from '@astryxdesign/core/Badge';
+import {Card} from '@astryxdesign/core/Card';
+import {Grid} from '@astryxdesign/core/Grid';
+import {Stack, VStack} from '@astryxdesign/core/Stack';
+import {
+ ShoppingBagIcon,
+ ShoppingCartIcon,
+ MagnifyingGlassIcon,
+ SparklesIcon,
+ SwatchIcon,
+ TagIcon,
+ HomeModernIcon,
+ FaceSmileIcon,
+ ReceiptPercentIcon,
+ GiftIcon,
+ CloudIcon,
+ BoltIcon,
+ SunIcon,
+ StarIcon,
+ FireIcon,
+ GlobeAltIcon,
+ MoonIcon,
+} from '@heroicons/react/24/outline';
+
+const styles = stylex.create({
+ // Cap + center the page body so wide screens show whitespace gutters.
+ contentMax: {maxWidth: 1100, marginInline: 'auto'},
+ // Lock both mega-menu panels to an identical size. Without this, Shop and
+ // Brands size to their own content (different widths); since both anchor to
+ // the centered nav, switching between them resizes the panel — which reads
+ // as flashing/jumping. Fixed item + featured widths make the panels
+ // pixel-identical so the transition is seamless.
+ megaItems: {gridColumn: '1 / -1', width: 520},
+ megaFeatured: {width: 240},
+});
+
+type MegaItem = {name: string; tagline: string; icon: IconType};
+
+// Shop and Brands each render 8 items — the mega menu's built-in 2-column grid
+// lays them out as 2 columns × 4 rows, alongside a featured card.
+const SHOP_ITEMS: MegaItem[] = [
+ {name: 'New Arrivals', tagline: 'The latest drops', icon: SparklesIcon},
+ {name: 'Womenswear', tagline: 'Dresses, knitwear & more', icon: SwatchIcon},
+ {name: 'Menswear', tagline: 'Shirts, tailoring & more', icon: TagIcon},
+ {name: 'Home', tagline: 'Bedding, lighting & décor', icon: HomeModernIcon},
+ {
+ name: 'Beauty',
+ tagline: 'Skincare, fragrance & makeup',
+ icon: FaceSmileIcon,
+ },
+ {
+ name: 'Accessories',
+ tagline: 'Bags, hats & sunglasses',
+ icon: ShoppingBagIcon,
+ },
+ {name: 'Sale', tagline: 'Up to 50% off', icon: ReceiptPercentIcon},
+ {name: 'Gift Cards', tagline: 'The perfect present', icon: GiftIcon},
+];
+
+const BRAND_ITEMS: MegaItem[] = [
+ {name: 'Aether', tagline: 'Performance essentials', icon: SparklesIcon},
+ {name: 'Northwind', tagline: 'Outdoor & technical', icon: CloudIcon},
+ {name: 'Loomwell', tagline: 'Everyday knitwear', icon: BoltIcon},
+ {name: 'Verdant', tagline: 'Sustainable basics', icon: SunIcon},
+ {name: 'Studio Mara', tagline: 'Modern tailoring', icon: StarIcon},
+ {name: 'Atelier Kos', tagline: 'Limited ateliers', icon: FireIcon},
+ {name: 'Rue & Co', tagline: 'City streetwear', icon: GlobeAltIcon},
+ {name: 'Halden', tagline: 'Minimal staples', icon: MoonIcon},
+];
+
+const CATEGORY_TILES = [
+ 'New Arrivals',
+ 'Womenswear',
+ 'Menswear',
+ 'Home & Living',
+ 'Beauty',
+ 'Accessories',
+];
+
+// Wraps the 8 items in a fixed-width 2-column grid so every mega menu's item
+// area is exactly the same width regardless of its content.
+function MegaItems({items}: {items: MegaItem[]}) {
+ return (
+ <Stack xstyle={styles.megaItems}>
+ <Grid columns={2} gap={2}>
+ {items.map(item => (
+ <TopNavMegaMenuItem
+ key={item.name}
+ title={item.name}
+ description={item.tagline}
+ icon={<Icon icon={item.icon} size="md" color="secondary" />}
+ href="#"
+ />
+ ))}
+ </Grid>
+ </Stack>
+ );
+}
+
+// Pins the featured card to a fixed width so both panels match exactly.
+function MegaFeatured(props: {
+ title: string;
+ description: string;
+ image: string;
+ imageAlt: string;
+ linkLabel: string;
+ linkHref: string;
+}) {
+ return (
+ <Stack xstyle={styles.megaFeatured}>
+ <TopNavMegaMenuFeaturedCard {...props} />
+ </Stack>
+ );
+}
+
+export default function ShellTopNav() {
+ return (
+ <AppShell
+ variant="surface"
+ contentPadding={6}
+ topNav={
+ <TopNav
+ label="Lumen storefront navigation"
+ heading={
+ <TopNavHeading
+ heading="Lumen"
+ logo={
+ <NavIcon icon={<Icon icon={ShoppingBagIcon} size="sm" />} />
+ }
+ href="#"
+ />
+ }
+ centerContent={
+ <>
+ <TopNavMegaMenu
+ label="Shop"
+ items={<MegaItems items={SHOP_ITEMS} />}
+ featured={
+ <MegaFeatured
+ title="The Autumn Edit"
+ description="Layering staples in warm, earthy tones."
+ image="https://lookaside.facebook.com/assets/astryx/texture-beige-horizontal-1.png"
+ imageAlt="Autumn collection lookbook"
+ linkLabel="Shop the edit"
+ linkHref="#autumn-edit"
+ />
+ }
+ />
+ <TopNavMegaMenu
+ label="Brands"
+ items={<MegaItems items={BRAND_ITEMS} />}
+ featured={
+ <MegaFeatured
+ title="Meet Studio Mara"
+ description="Modern tailoring, made to last."
+ image="https://lookaside.facebook.com/assets/astryx/texture-beige-horizontal-2.png"
+ imageAlt="Studio Mara lookbook"
+ linkLabel="Discover the label"
+ linkHref="#studio-mara"
+ />
+ }
+ />
+ <TopNavItem label="Sale" href="#" />
+ <TopNavItem label="Service" href="#" />
+ </>
+ }
+ endContent={
+ <>
+ <IconButton
+ label="Search products"
+ tooltip="Search"
+ variant="ghost"
+ icon={<Icon icon={MagnifyingGlassIcon} size="sm" />}
+ />
+ <Button label="Sign in" variant="ghost" />
+ <Button
+ label="Checkout"
+ variant="primary"
+ icon={<Icon icon={ShoppingCartIcon} size="sm" />}
+ endContent={<Badge label={3} />}
+ />
+ </>
+ }
+ />
+ }>
+ <VStack gap={10} xstyle={styles.contentMax}>
+ <Card variant="muted" padding={0} width="100%" height={360} />
+
+ {[0, 1, 2].map(section => (
+ <VStack key={section} gap={4}>
+ <Card variant="muted" padding={0} width={200} height={24} />
+ <Grid minChildWidth={160} gap={4}>
+ {CATEGORY_TILES.map(tile => (
+ <VStack key={tile} gap={2}>
+ <Card variant="muted" padding={0} width="100%" height={120} />
+ <Card variant="muted" padding={0} width="60%" height={14} />
+ </VStack>
+ ))}
+ </Grid>
+ </VStack>
+ ))}
+ </VStack>
+ </AppShell>
+ );
+}
diff --git a/packages/cli/templates/pages/shell-top-nav/template.doc.mjs b/packages/cli/templates/pages/shell-top-nav/template.doc.mjs
new file mode 100644
index 0000000000..10dbba35c2
--- /dev/null
+++ b/packages/cli/templates/pages/shell-top-nav/template.doc.mjs
@@ -0,0 +1,12 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/** @type {import('../../../../core/src/docs-types').TemplateDoc} */
+export const doc = {
+ type: 'page',
+ name: 'Top Nav',
+ displayName: 'Top Nav',
+ description:
+ 'A top-nav app shell with a centered TopNav — Shop and Brands mega menus (a 2x4 item grid plus a featured card each), Sale/Service links, and a Checkout button — over static grey-card hero and category sections.',
+ isReady: true,
+ category: 'Shell - Top Nav',
+};