@hashicorp/react-components 0.0.0-nightly.ad81ac2 → 0.0.0-nightly.b154bf4

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

@@ -0,0 +1,34 @@
+import classNames from 'classnames'
+import { type ReactNode, type HTMLAttributes } from 'react'
+
+type TextSize = '200' | '300' | '400'
+type TextWeight = 'regular' | 'medium' | 'semibold' | 'bold'
+
+interface TextProps extends HTMLAttributes<HTMLSpanElement> {
+	size?: TextSize
+	weight?: TextWeight
+	children: ReactNode
+}
+
+const Text = ({
+	size = '300',
+	weight,
+	children,
+	className,
+	...rest
+}: TextProps) => {
+	return (
+		<span
+			className={classNames(
+				`mds-typography-body-${size}`,
+				weight && `mds-typography-font-weight-${weight}`,
+				className
+			)}
+			{...rest}
+		>
+			{children}
+		</span>
+	)
+}
+
+export { Text }

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

@@ -2,12 +2,14 @@ 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-hds/src/components/flight-icon'
-import { TextPlus } from '@hashicorp/react-hds/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 { LinkListProps } from '../components/link-list'
+import NavLink from '../components/link'
 import s from './style.module.css'
 
 const PRODUCT_LOGO_MAP = new Map([
@@ -29,8 +31,15 @@ const PRODUCT_LOGO_EXCEPTION_CLASSNAMES = {
 	'HCP Vault Radar': 'hcpVaultRadar',
 }
 
+export type ProductCategoriesProps = Array<{
+	title: string
+	group?: LinkListProps['links'][0]
+	products: NavProductProps[]
+}>
+
 export interface ProductsPanelProps {
-	productCategories: any
+	locale?: string
+	productCategories: ProductCategoriesProps
 	promo?: PromoProps
 	sidePanel?: {
 		label: string
@@ -41,33 +50,53 @@ export interface ProductsPanelProps {
 			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 }) => {
+						{productCategories.map(({ group, title, products }) => {
 							return (
-								<li key={title} className={s.productCategory}>
-									<TextPlus.Body className={s.eyebrow}>{title}</TextPlus.Body>
+								<li
+									key={title}
+									className={classNames(s.productCategory, {
+										[s.productCategoryHasGroup]: group,
+									})}
+								>
+									{group ? (
+										<NavLink {...group} className={s.productGroupLink} />
+									) : (
+										<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>
 											)
 										})}
@@ -77,14 +106,16 @@ const ProductPanel = ({
 						})}
 					</ul>
 				</NavPanel.Column>
-				{promo ? <Promo {...promo} hasSidePanel={Boolean(sidePanel)} /> : 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 
@@ -97,20 +128,24 @@ const ProductPanel = ({
 								<li key={title}>
 									<Link
 										aria-label={`${title} - ${description}`}
-										href={parseUrl(url).href}
+										{...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>
@@ -125,17 +160,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
 				aria-label={`${product} - ${description}`}
-				href={parseUrl(url).href}
+				{...getLocalizedLinkProps(url, locale)}
+				locale={locale ? locale : undefined}
 				onClickCapture={() => {
 					trackNavClickEvent(product, url, 'products')
 				}}

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

@@ -3,6 +3,29 @@
 .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) {
 		&.noSide {
 			display: grid;
@@ -26,7 +49,11 @@
 	list-style: none;
 	padding: 0;
 	display: grid;
-	margin: var(--hdsplus-spacing-07) 0 0;
+	margin: var(--mds-spacing-07) 0 0;
+
+	@nest .topPromo & {
+		margin-bottom: var(--mds-spacing-07);
+	}
 
 	@media (--large) {
 		@nest .noSide & {
@@ -48,27 +75,27 @@
 
 	&: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) {
 		@nest .noSide & {
 			padding-bottom: 0;
-			padding-left: var(--hdsplus-spacing-06);
+			padding-left: var(--mds-spacing-06);
 		}
 	}
 
 	@media (--dev-dot-viewport) {
 		@nest .hasSide & {
 			padding-bottom: 0;
-			padding-left: var(--hdsplus-spacing-06);
+			padding-left: var(--mds-spacing-06);
 		}
 	}
 }
@@ -82,8 +109,7 @@
 
 	@media (--large) {
 		@nest .noSide & {
-			padding: var(--hdsplus-spacing-06) var(--hdsplus-spacing-05)
-				var(--hdsplus-spacing-04);
+			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);
@@ -93,8 +119,7 @@
 
 	@media (--dev-dot-viewport) {
 		@nest .hasSide & {
-			padding: var(--hdsplus-spacing-06) var(--hdsplus-spacing-05)
-				var(--hdsplus-spacing-04);
+			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);
@@ -113,29 +138,29 @@
 
 .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) {
 		@nest .noSide & {
-			padding: var(--hdsplus-spacing-03) var(--hdsplus-spacing-05);
+			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);
+				border-radius: var(--mds-spacing-01);
 			}
 		}
 	}
 
 	@media (--dev-dot-viewport) {
 		@nest .hasSide & {
-			padding: var(--hdsplus-spacing-03) var(--hdsplus-spacing-05);
+			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);
+				border-radius: var(--mds-spacing-01);
 			}
 		}
 	}
@@ -152,8 +177,8 @@
 	@nest .noSide & {
 		& svg {
 			@media (--large) {
-				height: var(--hdsplus-spacing-08);
-				width: var(--hdsplus-spacing-08);
+				height: var(--mds-spacing-08);
+				width: var(--mds-spacing-08);
 			}
 		}
 	}
@@ -161,8 +186,8 @@
 	@nest .hasSide & {
 		& svg {
 			@media (--dev-dot-viewport) {
-				height: var(--hdsplus-spacing-08);
-				width: var(--hdsplus-spacing-08);
+				height: var(--mds-spacing-08);
+				width: var(--mds-spacing-08);
 			}
 		}
 	}
@@ -195,17 +220,29 @@
 	justify-content: space-between;
 	flex-direction: column;
 
+	@nest .topPromo & {
+		justify-content: flex-start;
+	}
+
 	@media (--large) {
 		@nest .noSide & {
-			padding: var(--hdsplus-spacing-07) 0 var(--hdsplus-spacing-09)
-				var(--hdsplus-spacing-04);
+			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(--hdsplus-spacing-07) 0 var(--hdsplus-spacing-09)
-				var(--hdsplus-spacing-04);
+			padding: var(--mds-spacing-07) 0 var(--mds-spacing-09)
+				var(--mds-spacing-04);
+		}
+
+		@nest .topPromo & {
+			padding-bottom: var(--mds-spacing-04);
 		}
 	}
 }
@@ -215,10 +252,10 @@
 	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-07) var(--hdsplus-spacing-04)
-		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 {
@@ -227,24 +264,24 @@
 	padding: 0;
 	display: grid;
 	grid-template-columns: 1fr;
-	gap: var(--hdsplus-spacing-07);
+	gap: var(--mds-spacing-07);
 
 	@media (--dev-dot-viewport) {
-		gap: var(--hdsplus-spacing-05);
+		gap: var(--mds-spacing-05);
 	}
 }
 
 /* Lifted from .productWrapper */
 .sidePanelItem {
 	display: flex;
-	gap: var(--hdsplus-spacing-05);
+	gap: var(--mds-spacing-05);
 
 	@media (--dev-dot-viewport) {
-		padding: var(--hdsplus-spacing-03) var(--hdsplus-spacing-05);
+		padding: var(--mds-spacing-03) var(--mds-spacing-05);
 
 		&:hover {
 			background-color: var(--token-color-surface-interactive-hover);
-			border-radius: var(--hdsplus-spacing-01);
+			border-radius: var(--mds-spacing-01);
 		}
 	}
 }
@@ -253,8 +290,8 @@
 packages/react-components/src/components/nav-panel/components/link-list/style.module.css  */
 .iconBackground {
 	background: var(--token-color-foreground-high-contrast);
-	height: var(--hdsplus-spacing-08);
-	width: var(--hdsplus-spacing-08);
+	height: var(--mds-spacing-08);
+	width: var(--mds-spacing-08);
 	display: flex;
 	align-items: center;
 	justify-content: center;
@@ -301,7 +338,7 @@ packages/react-components/src/components/nav-panel/components/link-list/style.mo
 */
 .hcpVaultSecrets,
 .hcpVaultRadar {
-	padding: var(--hdsplus-spacing-01);
+	padding: var(--mds-spacing-01);
 	border: 2px solid var(--token-color-vault-brand);
 	border-radius: 3px;
 
@@ -313,3 +350,46 @@ packages/react-components/src/components/nav-panel/components/link-list/style.mo
 		fill: inherit;
 	}
 }
+
+.sidePanelText {
+	font-weight: var(--mds-typography-font-weight-semibold);
+}
+
+.productCategoryHasGroup {
+	& .productList {
+		padding-left: 0;
+		padding-right: 0;
+		padding-top: 0;
+	}
+
+	& .productWrapper {
+		gap: var(--mds-spacing-04);
+
+		@media (--small) {
+			padding: var(--mds-spacing-03) var(--mds-spacing-05);
+		}
+	}
+
+	& .productLogo {
+		margin-top: 3px;
+		height: 32px;
+		width: 32px;
+		min-width: 32px;
+
+		& svg {
+			width: 100%;
+			height: 100%;
+		}
+	}
+
+	& .terraform {
+		width: 100%;
+		height: 100%;
+	}
+}
+
+.productGroupLink {
+	min-width: 100%;
+	max-width: 100%;
+	margin-bottom: var(--mds-spacing-03);
+}

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-07);
+	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.ts

@@ -34,13 +34,11 @@ const containsHashiCorpDestination = (str: string): boolean =>
  *
  * @throws {Error} Throws an error if the URL is undefined or invalid.
  */
-
 export function parseUrl(url: string | undefined): {
 	linkType: 'inbound' | 'outbound' | ''
 	href: string
 } {
 	if (!url) {
-		console.log('No url to parse, returning empty string')
 		return { linkType: '', href: '' }
 	}
 

package/src/lib/send-posthog-event/index.ts

@@ -0,0 +1,22 @@
+import posthog from 'posthog-js'
+
+/**
+ * A custom hook to send a custom event to PostHog.
+ *
+ * @param {string} eventName - The name of the custom event to be tracked in PostHog.
+ * @param {Record<string, any>} properties - A key-value object containing properties associated with the event.
+ *
+ * @example
+ * const MyComponent = () => {
+ *   sendPosthogEvent('button_click', { buttonId: 'submit', action: 'clicked' });
+ *   return <button id="submit">Submit</button>;
+ * };
+ */
+const sendPosthogEvent = (
+	eventName: string,
+	properties: Record<string, any>
+) => {
+	posthog.capture(eventName, properties)
+}
+
+export default sendPosthogEvent

package/src/lib/supported-locales/index.ts

@@ -0,0 +1,10 @@
+export const allSupportedLocales = [
+	'en',
+	'de',
+	'es',
+	'fr',
+	'ja',
+	'ko',
+	'pt',
+	'id',
+]

package/src/lib/track-nav-click-event/index.ts

@@ -1,8 +1,8 @@
-import va from '@vercel/analytics'
+import sendPosthogEvent from '../send-posthog-event'
 
 /**
- * Pushes a 'Nav link click' custom event to Vercel Analytics.
- * A wrapper around the Vercel Analytics track method.
+ * Pushes a 'Nav link click' custom event to PostHog.
+ * A wrapper around the PostHog custom event method.
  *
  * @param {string} name - The name of the nav link
  * @param {string} href - The href for the nav link
@@ -14,7 +14,7 @@ export const trackNavClickEvent = (
 	href: string,
 	section: string
 ) => {
-	va.track('Nav link click', {
+	sendPosthogEvent('Nav link click', {
 		name,
 		href,
 		section,