@hashicorp/react-components 0.0.0-canary.f090ec2 → 0.0.0-canary.f4b4be1

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

@@ -1,16 +1,17 @@
+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 '@hashicorp/react-design-system-components/src/components/flight-icon'
-import { TextPlus } from '@hashicorp/react-design-system-components/src/components/text'
-import { parseUrl } from '../../../lib/parse-url'
+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-color'],
+	['Terraform', 'terraform-fill'],
 	['Packer', 'packer-fill-color'],
 	['Vault', 'vault-fill-color'],
 	['Boundary', 'boundary-fill-color'],
@@ -18,9 +19,18 @@ const PRODUCT_LOGO_MAP = new Map([
 	['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?: {
@@ -32,27 +42,44 @@ export interface ProductsPanelProps {
 			url: string
 		}[]
 	}
+	isPromoOnTop?: boolean
 }
 
 const ProductPanel = ({
+	locale,
 	productCategories,
 	promo,
 	sidePanel,
+	isPromoOnTop = false,
 }: ProductsPanelProps) => {
 	return (
-		<NavPanel.Root className={s.productPanel}>
+		<NavPanel.Root
+			className={classNames(s.productPanel, {
+				[s.hasSide]: sidePanel,
+				[s.noSide]: !sidePanel,
+				[s.topPromo]: isPromoOnTop,
+			})}
+			hasSidePanel={Boolean(sidePanel)}
+		>
 			<div className={s.mainPanel}>
-				<NavPanel.Column>
+				{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}>
-									<TextPlus.Body className={s.eyebrow}>{title}</TextPlus.Body>
+									<Text className={s.eyebrow}>{title}</Text>
 									<ul className={s.productList}>
 										{products.map((product) => {
 											return (
 												<li key={product.url}>
-													<NavProduct {...product} />
+													<NavProduct locale={locale} {...product} />
 												</li>
 											)
 										})}
@@ -62,30 +89,46 @@ const ProductPanel = ({
 						})}
 					</ul>
 				</NavPanel.Column>
-				{promo ? <Promo {...promo} /> : null}
+				{promo && !isPromoOnTop ? (
+					<Promo {...promo} hasSidePanel={Boolean(sidePanel)} />
+				) : null}
 			</div>
 
 			{sidePanel ? (
 				<NavPanel.Column className={s.sidePanel}>
-					<TextPlus.Body size="200" weight="semibold">
+					<Text size="200" weight="semibold" className={s.sidePanelText}>
 						{sidePanel.label}
-					</TextPlus.Body>
+					</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 href={parseUrl(url).href} className={s.sidePanelItem}>
+									<Link
+										aria-label={`${title} - ${description}`}
+										{...getLocalizedLinkProps(url, locale)}
+										locale={locale ? locale : undefined}
+										className={classNames(s.sidePanelItem, s.focusIndicator)}
+									>
 										<div className={s.iconBackground}>
 											<FlightIcon
-												size={16}
 												name={icon}
 												color="var(--token-color-foreground-faint)"
 											/>
 										</div>
 										<div className={s.sidePanelItemContent}>
-											<TextPlus.Body size="200" weight="semibold" tag="span">
+											<Text
+												size="200"
+												weight="semibold"
+												className={s.sidePanelText}
+											>
 												{title}
-											</TextPlus.Body>
+											</Text>
 											<span className={s.sidePanelItemDesc}>{description}</span>
 										</div>
 									</Link>
@@ -100,16 +143,19 @@ const ProductPanel = ({
 }
 
 export interface NavProductProps {
+	locale?: string
 	url: string
 	product: Products | string
 	description: string
 }
 
-function NavProduct({ url, product, description }: NavProductProps) {
+function NavProduct({ locale, url, product, description }: NavProductProps) {
 	return (
 		<NavigationMenu.Link asChild>
 			<Link
-				href={parseUrl(url).href}
+				aria-label={`${product} - ${description}`}
+				{...getLocalizedLinkProps(url, locale)}
+				locale={locale ? locale : undefined}
 				onClickCapture={() => {
 					trackNavClickEvent(product, url, 'products')
 				}}
@@ -119,6 +165,11 @@ function NavProduct({ url, product, description }: NavProductProps) {
 					<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}>

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

@@ -1,11 +1,47 @@
+@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;
+
 	@media (--large) {
-		display: grid;
-		grid-template-rows: 1fr;
-		grid-template-columns: max-content max-content;
-		padding: 0;
+		&.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;
+		}
 	}
 }
 
@@ -13,10 +49,22 @@
 	list-style: none;
 	padding: 0;
 	display: grid;
-	margin: var(--hdsplus-spacing-06) 0 0;
+	margin: var(--mds-spacing-07) 0 0;
+
+	@nest .topPromo & {
+		margin-bottom: var(--mds-spacing-07);
+	}
 
 	@media (--large) {
-		margin: 0;
+		@nest .noSide & {
+			margin: 0;
+		}
+	}
+
+	@media (--dev-dot-viewport) {
+		@nest .hasSide & {
+			margin: 0;
+		}
 	}
 }
 
@@ -27,18 +75,28 @@
 
 	&:first-child {
 		border-bottom: 1px solid var(--token-color-border-primary);
-		margin-bottom: var(--hdsplus-spacing-05);
-		padding-bottom: var(--hdsplus-spacing-05);
+		margin-bottom: var(--mds-spacing-05);
+		padding-bottom: var(--mds-spacing-05);
 	}
 }
 
 .eyebrow {
-	padding-bottom: var(--hdsplus-spacing-04);
+	padding-bottom: var(--mds-spacing-04);
 	color: var(--token-color-foreground-strong);
-	font-weight: var(--font-weight-semi-bold);
+	font-weight: var(--mds-typography-font-weight-semibold);
 
 	@media (--large) {
-		padding: 0 0 var(--hdsplus-spacing-01) var(--hdsplus-spacing-04);
+		@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);
+		}
 	}
 }
 
@@ -50,10 +108,29 @@
 	padding: 0;
 
 	@media (--large) {
-		grid-auto-flow: row;
-		grid-template-columns: repeat(2, 300px);
-		grid-template-rows: repeat(2, max-content);
-		gap: 0;
+		@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;
+		}
 	}
 }
 
@@ -61,16 +138,30 @@
 
 .productWrapper {
 	display: flex;
-	margin-bottom: var(--hdsplus-spacing-05);
-	gap: var(--hdsplus-spacing-05);
+	margin-bottom: var(--mds-spacing-05);
+	gap: var(--mds-spacing-05);
 
 	@media (--large) {
-		padding: var(--hdsplus-spacing-05);
-		margin-bottom: 0;
+		@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(--hdsplus-spacing-01);
+			&: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);
+			}
 		}
 	}
 }
@@ -81,10 +172,23 @@
 	& svg {
 		height: 42px;
 		width: 42px;
+	}
 
-		@media (--large) {
-			height: var(--hdsplus-spacing-08);
-			width: var(--hdsplus-spacing-08);
+	@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);
+			}
 		}
 	}
 }
@@ -116,21 +220,42 @@
 	justify-content: space-between;
 	flex-direction: column;
 
+	@nest .topPromo & {
+		justify-content: flex-start;
+	}
+
 	@media (--large) {
-		padding: var(--hdsplus-spacing-05) 0 var(--hdsplus-spacing-05)
-			var(--hdsplus-spacing-04);
+		@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-strong);
+	background: var(--token-color-surface-faint);
 	display: flex;
 	flex-direction: column;
-	gap: var(--hdsplus-spacing-05);
+	gap: var(--mds-spacing-05);
 	margin: 0;
-	padding: var(--hdsplus-spacing-05) var(--hdsplus-spacing-07)
-		var(--hdsplus-spacing-09) var(--hdsplus-spacing-07);
+	padding: var(--mds-spacing-07) var(--mds-spacing-04) var(--mds-spacing-09)
+		var(--mds-spacing-07);
 }
 
 .sidePanelItems {
@@ -139,26 +264,24 @@
 	padding: 0;
 	display: grid;
 	grid-template-columns: 1fr;
-	gap: var(--hdsplus-spacing-07);
+	gap: var(--mds-spacing-07);
 
-	@media (--large) {
-		gap: var(--hdsplus-spacing-05);
+	@media (--dev-dot-viewport) {
+		gap: var(--mds-spacing-05);
 	}
 }
 
 /* Lifted from .productWrapper */
 .sidePanelItem {
 	display: flex;
-	margin-bottom: var(--hdsplus-spacing-05);
-	gap: var(--hdsplus-spacing-05);
+	gap: var(--mds-spacing-05);
 
-	@media (--large) {
-		padding: var(--hdsplus-spacing-03) var(--hdsplus-spacing-05);
-		margin-bottom: 0;
+	@media (--dev-dot-viewport) {
+		padding: var(--mds-spacing-03) var(--mds-spacing-05);
 
 		&:hover {
-			background-color: var(--token-color-surface-interactive-active);
-			border-radius: var(--hdsplus-spacing-01);
+			background-color: var(--token-color-surface-interactive-hover);
+			border-radius: var(--mds-spacing-01);
 		}
 	}
 }
@@ -166,15 +289,16 @@
 /* Lifted from:
 packages/react-components/src/components/nav-panel/components/link-list/style.module.css  */
 .iconBackground {
-	background: var(--token-color-page-primary);
-	height: var(--hdsplus-spacing-08);
-	width: var(--hdsplus-spacing-08);
+	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 */
@@ -190,3 +314,43 @@ packages/react-components/src/components/nav-panel/components/link-list/style.mo
 	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;
+	}
+}
+
+.sidePanelText {
+	font-weight: var(--mds-typography-font-weight-semibold);
+}

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

@@ -12,12 +12,14 @@ interface StandardPanelProps {
 	navData: NavItem[]
 	promo?: PromoProps
 	sectionName?: string
+	locale?: any
 }
 
 const StandardPanel = ({
 	navData,
 	promo,
 	sectionName = '',
+	locale,
 }: StandardPanelProps) => {
 	return (
 		<NavPanel.Root>
@@ -26,6 +28,7 @@ const StandardPanel = ({
 					return (
 						<NavPanel.Column key={stableIdx}>
 							<LinkList
+								locale={locale}
 								links={navItems}
 								linkClickHandler={(text, href) => {
 									trackNavClickEvent(text, href, sectionName)

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

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

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,
+	}
+}

package/src/lib/parse-url/index.test.ts

@@ -1,4 +1,4 @@
-import { parseUrl } from '.'
+import { parseUrl, hasHashiCorpDestination } from '.'
 
 describe('parseUrl', () => {
 	it('detects hashicorp.com URLs as internal', () => {
@@ -7,6 +7,12 @@ describe('parseUrl', () => {
 		expect(url.linkType).toBe('inbound')
 	})
 
+	it('detects www.hashicorp.com URLs as internal', () => {
+		const url = parseUrl('https://hashicorp.com/foo')
+		expect(url.href).toBe('/foo')
+		expect(url.linkType).toBe('inbound')
+	})
+
 	it('detects URLs not containing hashicorp.com as external', () => {
 		const externalUrl = 'https://google.com/example'
 		const url = parseUrl(externalUrl)
@@ -27,4 +33,37 @@ describe('parseUrl', () => {
 		)
 		expect(url.href).toBe('/resources?type=case-study&products=terraform')
 	})
+
+	it('leaves URL hash intact', () => {
+		const url = parseUrl('https://hashicorp.com/about#leadership')
+		expect(url.href).toBe('/about#leadership')
+	})
+
+	it('leaves HashiCorp subdomain URLs intact', () => {
+		const url = parseUrl('https://developer.hashicorp.com/terraform')
+		expect(url.href).toBe('https://developer.hashicorp.com/terraform')
+	})
+})
+
+describe('hasHashiCorpDestination', () => {
+	it('returns true for supported hashicorp domains', () => {
+		const isHashiCorpDestination = hasHashiCorpDestination(
+			'https://portal.cloud.hashicorp.com/foo'
+		)
+		expect(isHashiCorpDestination).toBe(true)
+	})
+	it('returns false for external domains', () => {
+		const isHashiCorpDestination = hasHashiCorpDestination(
+			'https://foo.com/bar'
+		)
+		expect(isHashiCorpDestination).toBe(false)
+	})
+	it('returns true for relative links', () => {
+		const isHashiCorpDestination = hasHashiCorpDestination('/bar')
+		expect(isHashiCorpDestination).toBe(true)
+	})
+	it('returns true for hashes', () => {
+		const isHashiCorpDestination = hasHashiCorpDestination('#someHash')
+		expect(isHashiCorpDestination).toBe(true)
+	})
 })