@hashicorp/react-components 0.0.0-canary.0299c5d

package/src/components/nav-panel/product-panel/index.tsx

@@ -0,0 +1,185 @@
+import classNames from 'classnames'
+import Link from 'next/link'
+import * as NavPanel from '../components/panel'
+import Promo, { type PromoProps } from '../components/promo'
+import { getLocalizedLinkProps } from '../../../lib/get-localized-link-props'
+import { Products } from '@hashicorp/platform-product-meta'
+import FlightIcon from '../components/flight-icon'
+import { Text } from '../components/text'
+import { trackNavClickEvent } from '../../../lib/track-nav-click-event'
+import * as NavigationMenu from '@radix-ui/react-navigation-menu'
+import s from './style.module.css'
+
+const PRODUCT_LOGO_MAP = new Map([
+	['Terraform', 'terraform-fill'],
+	['Packer', 'packer-fill-color'],
+	['Vault', 'vault-fill-color'],
+	['Boundary', 'boundary-fill-color'],
+	['Consul', 'consul-fill-color'],
+	['Nomad', 'nomad-fill-color'],
+	['Waypoint', 'waypoint-fill-color'],
+	['Vagrant', 'vagrant-fill-color'],
+	['HCP Vault Secrets', 'vault-secrets'],
+	['HCP Vault Radar', 'vault-radar'],
+])
+
+const PRODUCT_LOGO_EXCEPTION_CLASSNAMES = {
+	Terraform: 'terraform',
+	'HCP Vault Secrets': 'hcpVaultSecrets',
+	'HCP Vault Radar': 'hcpVaultRadar',
+}
+
+export interface ProductsPanelProps {
+	locale?: string
+	productCategories: any
+	promo?: PromoProps
+	sidePanel?: {
+		label: string
+		navItems: {
+			icon: string
+			title: string
+			description: string
+			url: string
+		}[]
+	}
+	isPromoOnTop?: boolean
+}
+
+const ProductPanel = ({
+	locale,
+	productCategories,
+	promo,
+	sidePanel,
+	isPromoOnTop = false,
+}: ProductsPanelProps) => {
+	return (
+		<NavPanel.Root
+			className={classNames(s.productPanel, {
+				[s.hasSide]: sidePanel,
+				[s.noSide]: !sidePanel,
+				[s.topPromo]: isPromoOnTop,
+			})}
+			hasSidePanel={Boolean(sidePanel)}
+		>
+			<div className={s.mainPanel}>
+				{promo && isPromoOnTop ? (
+					<Promo
+						{...promo}
+						hasSidePanel={Boolean(sidePanel)}
+						isPromoOnTop={isPromoOnTop}
+					/>
+				) : null}
+				<NavPanel.Column hasSidePanel={Boolean(sidePanel)}>
+					<ul className={s.productCategories}>
+						{productCategories.map(({ title, products }) => {
+							return (
+								<li key={title} className={s.productCategory}>
+									<Text className={s.eyebrow}>{title}</Text>
+									<ul className={s.productList}>
+										{products.map((product) => {
+											return (
+												<li key={product.url}>
+													<NavProduct locale={locale} {...product} />
+												</li>
+											)
+										})}
+									</ul>
+								</li>
+							)
+						})}
+					</ul>
+				</NavPanel.Column>
+				{promo && !isPromoOnTop ? (
+					<Promo {...promo} hasSidePanel={Boolean(sidePanel)} />
+				) : null}
+			</div>
+
+			{sidePanel ? (
+				<NavPanel.Column className={s.sidePanel}>
+					<Text size="200" weight="semibold" className={s.sidePanelText}>
+						{sidePanel.label}
+					</Text>
+
+					{/* ! TODO Replace the below list with the <LinkList /> component, 
+						That component will require a refactor to support greater customization 
+						Ticket:
+						https://app.asana.com/0/1206176289707208/1208162145034615/f
+						*/}
+					<ul className={s.sidePanelItems}>
+						{sidePanel.navItems.map(({ icon, title, description, url }) => {
+							return (
+								<li key={title}>
+									<Link
+										aria-label={`${title} - ${description}`}
+										{...getLocalizedLinkProps(url, locale)}
+										locale={locale ? locale : undefined}
+										className={classNames(s.sidePanelItem, s.focusIndicator)}
+									>
+										<div className={s.iconBackground}>
+											<FlightIcon
+												name={icon}
+												color="var(--token-color-foreground-faint)"
+											/>
+										</div>
+										<div className={s.sidePanelItemContent}>
+											<Text
+												size="200"
+												weight="semibold"
+												className={s.sidePanelText}
+											>
+												{title}
+											</Text>
+											<span className={s.sidePanelItemDesc}>{description}</span>
+										</div>
+									</Link>
+								</li>
+							)
+						})}
+					</ul>
+				</NavPanel.Column>
+			) : null}
+		</NavPanel.Root>
+	)
+}
+
+export interface NavProductProps {
+	locale?: string
+	url: string
+	product: Products | string
+	description: string
+}
+
+function NavProduct({ locale, url, product, description }: NavProductProps) {
+	return (
+		<NavigationMenu.Link asChild>
+			<Link
+				aria-label={`${product} - ${description}`}
+				{...getLocalizedLinkProps(url, locale)}
+				locale={locale ? locale : undefined}
+				onClickCapture={() => {
+					trackNavClickEvent(product, url, 'products')
+				}}
+				className={s.focusIndicator}
+			>
+				<div className={s.productWrapper}>
+					<div className={s.productLogo}>
+						<FlightIcon
+							name={PRODUCT_LOGO_MAP.get(product) ?? 'hashicorp-fill-color'}
+							className={
+								PRODUCT_LOGO_EXCEPTION_CLASSNAMES[product]
+									? s[PRODUCT_LOGO_EXCEPTION_CLASSNAMES[product]]
+									: undefined
+							}
+						/>
+					</div>
+					<div className={s.productTextContent}>
+						<span>{product}</span>
+						<span className={s.productDesc}>{description}</span>
+					</div>
+				</div>
+			</Link>
+		</NavigationMenu.Link>
+	)
+}
+
+export default ProductPanel

package/src/components/nav-panel/product-panel/style.module.css

@@ -0,0 +1,355 @@
+@custom-media --dev-dot-viewport (min-width: 924px);
+
+.productPanel {
+	height: 100%;
+
+	/* Temporarily included for devdot compatability
+	   https://app.asana.com/1/90955849329269/project/1209320521286316/task/1210514680913728?focus=true */
+	--mds-spacing-01: 0.25rem;
+	--mds-spacing-02: 0.375rem;
+	--mds-spacing-03: 0.5rem;
+	--mds-spacing-04: 0.75rem;
+	--mds-spacing-05: 1rem;
+	--mds-spacing-06: 1.25rem;
+	--mds-spacing-07: 1.5rem;
+	--mds-spacing-08: 2rem;
+	--mds-spacing-09: 2.5rem;
+	--mds-spacing-10: 3rem;
+	--mds-spacing-11: 3.5rem;
+	--mds-spacing-12: 4rem;
+	--mds-spacing-13: 4.5rem;
+	--mds-spacing-14: 5.5rem;
+	--mds-spacing-15: 6rem;
+	--mds-spacing-16: 8rem;
+	--mds-spacing-17: 8.5rem;
+	--mds-typography-body-200-font-size: 0.875rem;
+	--mds-typography-font-weight-regular: 400;
+	--mds-typography-font-weight-semibold: 600;
+	--mds-typography-font-stack-text: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif;
+	--mds-typography-body-200-line-height: 1.7142857142857142; /* 20px */
+
+	@media (--large) {
+		&.noSide {
+			display: grid;
+			grid-template-rows: 1fr;
+			grid-template-columns: max-content max-content;
+			padding: 0;
+		}
+	}
+
+	@media (--dev-dot-viewport) {
+		&.hasSide {
+			display: grid;
+			grid-template-rows: 1fr;
+			grid-template-columns: max-content max-content;
+			padding: 0;
+		}
+	}
+}
+
+.productCategories {
+	list-style: none;
+	padding: 0;
+	display: grid;
+	margin: var(--mds-spacing-07) 0 0;
+
+	@nest .topPromo & {
+		margin-bottom: var(--mds-spacing-07);
+	}
+
+	@media (--large) {
+		@nest .noSide & {
+			margin: 0;
+		}
+	}
+
+	@media (--dev-dot-viewport) {
+		@nest .hasSide & {
+			margin: 0;
+		}
+	}
+}
+
+.productCategory {
+	display: flex;
+	flex-direction: column;
+	min-width: 160px;
+
+	&:first-child {
+		border-bottom: 1px solid var(--token-color-border-primary);
+		margin-bottom: var(--mds-spacing-05);
+		padding-bottom: var(--mds-spacing-05);
+	}
+}
+
+.eyebrow {
+	padding-bottom: var(--mds-spacing-04);
+	color: var(--token-color-foreground-strong);
+	font-weight: var(--mds-typography-font-weight-semibold);
+
+	@media (--large) {
+		@nest .noSide & {
+			padding-bottom: 0;
+			padding-left: var(--mds-spacing-06);
+		}
+	}
+
+	@media (--dev-dot-viewport) {
+		@nest .hasSide & {
+			padding-bottom: 0;
+			padding-left: var(--mds-spacing-06);
+		}
+	}
+}
+
+.productList {
+	display: grid;
+	grid-template-columns: 1fr;
+	list-style: none;
+	margin: 0;
+	padding: 0;
+
+	@media (--large) {
+		@nest .noSide & {
+			padding: var(--mds-spacing-06) var(--mds-spacing-05) var(--mds-spacing-04);
+			grid-auto-flow: row;
+			grid-template-columns: repeat(2, 300px);
+			grid-template-rows: repeat(2, max-content);
+			gap: 0;
+		}
+	}
+
+	@media (--dev-dot-viewport) {
+		@nest .hasSide & {
+			padding: var(--mds-spacing-06) var(--mds-spacing-05) var(--mds-spacing-04);
+			grid-auto-flow: row;
+			grid-template-columns: repeat(2, 300px);
+			grid-template-rows: repeat(2, max-content);
+			gap: 0;
+		}
+	}
+
+	& li:last-child {
+		& .productWrapper {
+			margin-bottom: 0;
+		}
+	}
+}
+
+/* NavProduct styles */
+
+.productWrapper {
+	display: flex;
+	margin-bottom: var(--mds-spacing-05);
+	gap: var(--mds-spacing-05);
+
+	@media (--large) {
+		@nest .noSide & {
+			padding: var(--mds-spacing-03) var(--mds-spacing-05);
+			margin-bottom: 0;
+
+			&:hover {
+				background-color: var(--token-color-surface-interactive-hover);
+				border-radius: var(--mds-spacing-01);
+			}
+		}
+	}
+
+	@media (--dev-dot-viewport) {
+		@nest .hasSide & {
+			padding: var(--mds-spacing-03) var(--mds-spacing-05);
+			margin-bottom: 0;
+
+			&:hover {
+				background-color: var(--token-color-surface-interactive-hover);
+				border-radius: var(--mds-spacing-01);
+			}
+		}
+	}
+}
+
+.productLogo {
+	margin-top: 3px;
+
+	& svg {
+		height: 42px;
+		width: 42px;
+	}
+
+	@nest .noSide & {
+		& svg {
+			@media (--large) {
+				height: var(--mds-spacing-08);
+				width: var(--mds-spacing-08);
+			}
+		}
+	}
+
+	@nest .hasSide & {
+		& svg {
+			@media (--dev-dot-viewport) {
+				height: var(--mds-spacing-08);
+				width: var(--mds-spacing-08);
+			}
+		}
+	}
+}
+
+.productTextContent {
+	display: flex;
+	flex-direction: column;
+	color: var(--token-color-foreground-strong);
+}
+
+.productDesc {
+	font-weight: 400;
+	font-size: 14px;
+	line-height: 20px;
+	letter-spacing: 0.0125em;
+	color: var(--token-color-foreground-faint);
+}
+
+.focusIndicator {
+	&:focus {
+		outline: 2px solid var(--token-color-focus-action-internal);
+		outline-style: auto;
+	}
+}
+
+.mainPanel {
+	height: 100%;
+	display: flex;
+	justify-content: space-between;
+	flex-direction: column;
+
+	@media (--large) {
+		@nest .noSide & {
+			padding: var(--mds-spacing-07) 0 var(--mds-spacing-09)
+				var(--mds-spacing-04);
+		}
+
+		@nest .topPromo & {
+			padding-bottom: var(--mds-spacing-04);
+		}
+	}
+
+	@media (--dev-dot-viewport) {
+		@nest .hasSide & {
+			padding: var(--mds-spacing-07) 0 var(--mds-spacing-09)
+				var(--mds-spacing-04);
+		}
+
+		@nest .topPromo & {
+			padding-bottom: var(--mds-spacing-04);
+		}
+	}
+}
+
+.sidePanel {
+	height: 100%;
+	background: var(--token-color-surface-faint);
+	display: flex;
+	flex-direction: column;
+	gap: var(--mds-spacing-05);
+	margin: 0;
+	padding: var(--mds-spacing-07) var(--mds-spacing-04) var(--mds-spacing-09)
+		var(--mds-spacing-07);
+}
+
+.sidePanelItems {
+	list-style: none;
+	margin: 0;
+	padding: 0;
+	display: grid;
+	grid-template-columns: 1fr;
+	gap: var(--mds-spacing-07);
+
+	@media (--dev-dot-viewport) {
+		gap: var(--mds-spacing-05);
+	}
+}
+
+/* Lifted from .productWrapper */
+.sidePanelItem {
+	display: flex;
+	gap: var(--mds-spacing-05);
+
+	@media (--dev-dot-viewport) {
+		padding: var(--mds-spacing-03) var(--mds-spacing-05);
+
+		&:hover {
+			background-color: var(--token-color-surface-interactive-hover);
+			border-radius: var(--mds-spacing-01);
+		}
+	}
+}
+
+/* Lifted from:
+packages/react-components/src/components/nav-panel/components/link-list/style.module.css  */
+.iconBackground {
+	background: var(--token-color-foreground-high-contrast);
+	height: var(--mds-spacing-08);
+	width: var(--mds-spacing-08);
+	display: flex;
+	align-items: center;
+	justify-content: center;
+	border-radius: 3px;
+	flex: none;
+	margin-top: 3px;
+	border: 1px solid var(--token-color-border-primary);
+}
+
+/* Lifted from .productTextContent */
+.sidePanelItemContent {
+	display: flex;
+	flex-direction: column;
+	color: var(--token-color-foreground-strong);
+}
+
+.sidePanelItemDesc {
+	font-weight: 400;
+	font-size: 13px;
+	line-height: 18px;
+	color: var(--token-color-foreground-primary);
+}
+
+/* Branding exception classnames */
+
+/* Allows switching to a dark-mode-specific color for Terraform */
+.terraform {
+	& use {
+		fill: var(--token-color-terraform-brand);
+
+		@nest [data-theme='dark'] & {
+			fill: var(--token-color-terraform-foreground);
+		}
+	}
+
+	& path {
+		fill: inherit;
+	}
+}
+
+/* Styles for HCP Vault mimic the spec for `product-square` icons,
+	while allowing the symbol inside the icon border to change color
+	based on the site's theme
+*/
+.hcpVaultSecrets,
+.hcpVaultRadar {
+	padding: var(--mds-spacing-01);
+	border: 2px solid var(--token-color-vault-brand);
+	border-radius: 3px;
+
+	& use {
+		fill: var(--token-color-foreground-strong);
+	}
+
+	& path {
+		fill: inherit;
+	}
+}
+
+/* Copied from packages/mds-tokens/src/helper-classes/typography.css */
+.sidePanelText {
+	font-weight: var(--mds-typography-font-weight-semibold);
+}

package/src/components/nav-panel/standard-panel/index.tsx

@@ -0,0 +1,47 @@
+import { trackNavClickEvent } from '../../../lib/track-nav-click-event'
+import * as NavPanel from '../components/panel'
+import LinkList, { type LinkListProps } from '../components/link-list'
+import Promo, { type PromoProps } from '../components/promo'
+import s from './style.module.css'
+
+export interface NavItem {
+	navItems: LinkListProps['links']
+}
+
+interface StandardPanelProps {
+	navData: NavItem[]
+	promo?: PromoProps
+	sectionName?: string
+	locale?: any
+}
+
+const StandardPanel = ({
+	navData,
+	promo,
+	sectionName = '',
+	locale,
+}: StandardPanelProps) => {
+	return (
+		<NavPanel.Root>
+			<div className={s.columns}>
+				{navData.map(({ navItems }, stableIdx) => {
+					return (
+						<NavPanel.Column key={stableIdx}>
+							<LinkList
+								locale={locale}
+								links={navItems}
+								linkClickHandler={(text, href) => {
+									trackNavClickEvent(text, href, sectionName)
+								}}
+							/>
+						</NavPanel.Column>
+					)
+				})}
+			</div>
+
+			{promo ? <Promo {...promo} /> : null}
+		</NavPanel.Root>
+	)
+}
+
+export default StandardPanel

package/src/components/nav-panel/standard-panel/style.module.css

@@ -0,0 +1,11 @@
+.columns {
+	display: flex;
+	gap: var(--mds-spacing-03);
+	flex-direction: column;
+	margin-top: var(--mds-spacing-07);
+
+	@media (--large) {
+		flex-direction: row;
+		margin-top: 0;
+	}
+}

package/src/lib/get-localized-link-props/index.test.ts

@@ -0,0 +1,30 @@
+import { getLocalizedLinkProps } from '.'
+
+describe('getLocalizedLinkProps', () => {
+	it('does not format localized homepage', () => {
+		const localizedLinkProps = getLocalizedLinkProps('/en', 'ja')
+		expect(localizedLinkProps.href).toBe('/en')
+		expect(localizedLinkProps.hrefLang).toBe('en')
+	})
+
+	it('does not format localized path hrefs', () => {
+		const localizedLinkProps = getLocalizedLinkProps('/ja/solutions', 'de')
+		expect(localizedLinkProps.href).toBe('/ja/solutions')
+		expect(localizedLinkProps.hrefLang).toBe('ja')
+	})
+
+	it('does format paths that start with a locale string', () => {
+		const localizedLinkProps = getLocalizedLinkProps(
+			'/deconstructing-cloud',
+			'en'
+		)
+		expect(localizedLinkProps.href).toBe('/en/deconstructing-cloud')
+		expect(localizedLinkProps.hrefLang).toBe('en')
+	})
+
+	it('does not format external paths', () => {
+		const localizedLinkProps = getLocalizedLinkProps('https://google.com', 'ja')
+		expect(localizedLinkProps.href).toBe('https://google.com')
+		expect(localizedLinkProps.hrefLang).toBe(undefined)
+	})
+})

package/src/lib/get-localized-link-props/index.ts

@@ -0,0 +1,45 @@
+import { parseUrl } from '../parse-url'
+import { allSupportedLocales } from '../supported-locales'
+
+export const getLocalizedLinkProps = (
+	url: string,
+	locale?: string
+): {
+	href: string
+	hrefLang: string | undefined
+} => {
+	const parsedHref = parseUrl(url).href
+
+	// example: /en
+	const hrefIsLocalizedHomepage = allSupportedLocales.includes(
+		parsedHref.substring(1)
+	)
+
+	// true example: /en/solutions
+	// false example: /entry-point
+	const hrefIsLocalized =
+		allSupportedLocales.includes(parsedHref.substring(1, 3)) &&
+		parsedHref[3] === '/'
+
+	// If the href is already localized:
+	// - do not format the href
+	// - use the locale from the href for the hrefLang
+	if (hrefIsLocalizedHomepage || hrefIsLocalized) {
+		return {
+			href: parsedHref,
+			hrefLang: parsedHref.substring(1, 3),
+		}
+	}
+
+	if (parsedHref.startsWith('/') && locale) {
+		return {
+			href: `/${locale}${parsedHref}`,
+			hrefLang: locale,
+		}
+	}
+
+	return {
+		href: parsedHref,
+		hrefLang: undefined,
+	}
+}