@hashicorp/react-components 1.0.1 → 1.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hashicorp/react-components",
-	"version": "1.0.1",
+	"version": "1.1.2",
 	"main": "src/index.ts",
 	"scripts": {
 		"lint": "next-hashicorp lint",
@@ -13,8 +13,11 @@
 		"@hashicorp/platform-util": "^0.2.0",
 		"@hashicorp/react-design-system-components": "*",
 		"@hashicorp/web-mktg-logos": "*",
-		"@radix-ui/react-visually-hidden": "^1.0.3",
+		"@radix-ui/react-navigation-menu": "^1.2.0",
+		"@radix-ui/react-visually-hidden": "^1.1.0",
+		"@vercel/analytics": "^1.3.1",
 		"@vercel/fetch": "^7.0.0",
+		"@vercel/stega": "^0.1.2",
 		"classnames": "^2.3.2",
 		"js-cookie": "^3.0.5",
 		"moize": "^6.1.3",

package/src/components/marketo-form/utils.ts

@@ -426,6 +426,10 @@ export const resolverErrors = (
  * @returns MarketoFormField[] with columnSplit property set
  */
 export function setFieldsColumnSplit(fieldsArr: MarketoFormField[]) {
+	if (!fieldsArr) {
+		return []
+	}
+
 	return fieldsArr.map((f) => {
 		const columnSplit = getFieldColumnSplit(fieldsArr, f)
 		return { ...f, columnSplit }

package/src/components/nav-panel/components/link-list/index.tsx

@@ -1,6 +1,6 @@
 import Link from 'next/link'
-import { parseUrl } from '../../../../../../../apps/www/lib/parseUrl'
-import { v } from '@web/cms'
+import { parseUrl } from '../../../../lib/parse-url'
+import { v } from '../../../../lib/v'
 import FlightIcon from '@hashicorp/react-design-system-components/src/components/flight-icon'
 import * as NavigationMenu from '@radix-ui/react-navigation-menu'
 import s from './style.module.css'

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

@@ -1,9 +1,11 @@
+import classNames from 'classnames'
 import s from './style.module.css'
 
 export interface NavColumnProps {
+	className?: string
 	children: React.ReactNode
 }
 
-export default function Column({ children }: NavColumnProps) {
-	return <div className={s.column}>{children}</div>
+export default function Column({ className, children }: NavColumnProps) {
+	return <div className={classNames(s.column, className)}>{children}</div>
 }

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

@@ -1,9 +1,11 @@
+import classNames from 'classnames'
 import s from './style.module.css'
 
 interface RootProps {
+	className?: string
 	children: React.ReactNode
 }
 
-export default function Root({ children }: RootProps) {
-	return <div className={s.root}>{children}</div>
+export default function Root({ className, children }: RootProps) {
+	return <div className={classNames(s.root, className)}>{children}</div>
 }

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

@@ -10,6 +10,7 @@
 		justify-content: flex-start;
 		height: 100%;
 		min-height: fit-content;
+		padding: var(--hdsplus-spacing-05) var(--hdsplus-spacing-04);
 		gap: var(--hdsplus-spacing-04);
 	}
 }

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

@@ -1,9 +1,9 @@
 import { useCallback } from 'react'
-import { trackNavClickEvent } from '../../../../../../../apps/www/layouts/standard/nav'
-import { v } from '@web/cms'
-import Link from 'next/link'
 import classNames from 'classnames'
-import { parseUrl } from '../../../../../../../apps/www/lib/parseUrl'
+import { v } from '../../../../lib/v'
+import Link from 'next/link'
+import { parseUrl } from '../../../../lib/parse-url'
+import { trackNavClickEvent } from '../../../../lib/track-nav-click-event'
 import FlightIcon from '@hashicorp/react-design-system-components/src/components/flight-icon'
 import * as NavigationMenu from '@radix-ui/react-navigation-menu'
 import s from './style.module.css'

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

@@ -4,8 +4,8 @@ import Promo, { type PromoProps } from '../components/promo'
 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 '../../../../../../apps/www/lib/parseUrl'
-import { trackNavClickEvent } from '../../../../../../apps/www/layouts/standard/nav'
+import { parseUrl } from '../../../lib/parse-url'
+import { trackNavClickEvent } from '../../../lib/track-nav-click-event'
 import * as NavigationMenu from '@radix-ui/react-navigation-menu'
 import s from './style.module.css'
 
@@ -18,37 +18,96 @@ 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'],
 ])
 
-interface ProductsPanelProps {
+const PRODUCT_LOGO_EXCEPTION_CLASSNAMES = {
+	'HCP Vault Secrets': 'hcpVaultSecrets',
+	'HCP Vault Radar': 'hcpVaultRadar',
+}
+
+export interface ProductsPanelProps {
 	productCategories: any
 	promo?: PromoProps
+	sidePanel?: {
+		label: string
+		navItems: {
+			icon: string
+			title: string
+			description: string
+			url: string
+		}[]
+	}
 }
 
-const ProductPanel = ({ productCategories, promo }: ProductsPanelProps) => {
+const ProductPanel = ({
+	productCategories,
+	promo,
+	sidePanel,
+}: ProductsPanelProps) => {
 	return (
-		<NavPanel.Root>
-			<NavPanel.Column>
-				<ul className={s.productCategories}>
-					{productCategories.map(({ title, products }) => {
-						return (
-							<li key={title} className={s.productCategory}>
-								<TextPlus.Body className={s.eyebrow}>{title}</TextPlus.Body>
-								<ul className={s.productList}>
-									{products.map((product) => {
-										return (
-											<li key={product.url}>
-												<NavProduct {...product} />
-											</li>
-										)
-									})}
-								</ul>
-							</li>
-						)
-					})}
-				</ul>
-			</NavPanel.Column>
-			{promo ? <Promo {...promo} /> : null}
+		<NavPanel.Root className={s.productPanel}>
+			<div className={s.mainPanel}>
+				<NavPanel.Column>
+					<ul className={s.productCategories}>
+						{productCategories.map(({ title, products }) => {
+							return (
+								<li key={title} className={s.productCategory}>
+									<TextPlus.Body className={s.eyebrow}>{title}</TextPlus.Body>
+									<ul className={s.productList}>
+										{products.map((product) => {
+											return (
+												<li key={product.url}>
+													<NavProduct {...product} />
+												</li>
+											)
+										})}
+									</ul>
+								</li>
+							)
+						})}
+					</ul>
+				</NavPanel.Column>
+				{promo ? <Promo {...promo} /> : null}
+			</div>
+
+			{sidePanel ? (
+				<NavPanel.Column className={s.sidePanel}>
+					<TextPlus.Body size="200" weight="semibold">
+						{sidePanel.label}
+					</TextPlus.Body>
+
+					{/* ! 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}>
+										<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">
+												{title}
+											</TextPlus.Body>
+											<span className={s.sidePanelItemDesc}>{description}</span>
+										</div>
+									</Link>
+								</li>
+							)
+						})}
+					</ul>
+				</NavPanel.Column>
+			) : null}
 		</NavPanel.Root>
 	)
 }
@@ -73,6 +132,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,3 +1,14 @@
+.productPanel {
+	height: 100%;
+
+	@media (--large) {
+		display: grid;
+		grid-template-rows: 1fr;
+		grid-template-columns: max-content max-content;
+		padding: 0;
+	}
+}
+
 .productCategories {
 	list-style: none;
 	padding: 0;
@@ -98,3 +109,106 @@
 		outline-style: auto;
 	}
 }
+
+.mainPanel {
+	height: 100%;
+	display: flex;
+	justify-content: space-between;
+	flex-direction: column;
+
+	@media (--large) {
+		padding: var(--hdsplus-spacing-05) 0 var(--hdsplus-spacing-05)
+			var(--hdsplus-spacing-04);
+	}
+}
+
+.sidePanel {
+	height: 100%;
+	background: var(--token-color-surface-faint);
+	display: flex;
+	flex-direction: column;
+	gap: var(--hdsplus-spacing-05);
+	margin: 0;
+	padding: var(--hdsplus-spacing-05) var(--hdsplus-spacing-07)
+		var(--hdsplus-spacing-09) var(--hdsplus-spacing-07);
+}
+
+.sidePanelItems {
+	list-style: none;
+	margin: 0;
+	padding: 0;
+	display: grid;
+	grid-template-columns: 1fr;
+	gap: var(--hdsplus-spacing-07);
+
+	@media (--large) {
+		gap: var(--hdsplus-spacing-05);
+	}
+}
+
+/* Lifted from .productWrapper */
+.sidePanelItem {
+	display: flex;
+	margin-bottom: var(--hdsplus-spacing-05);
+	gap: var(--hdsplus-spacing-05);
+
+	@media (--large) {
+		padding: var(--hdsplus-spacing-03) var(--hdsplus-spacing-05);
+		margin-bottom: 0;
+
+		&:hover {
+			background-color: var(--token-color-surface-interactive-hover);
+			border-radius: var(--hdsplus-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(--hdsplus-spacing-08);
+	width: var(--hdsplus-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 */
+
+/* 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(--hdsplus-spacing-01);
+	border: 2px solid var(--token-color-vault-brand);
+	border-radius: 3px;
+
+	& use {
+		fill: var(--token-color-foreground-strong);
+	}
+
+	& path {
+		fill: inherit;
+	}
+}

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

@@ -1,4 +1,4 @@
-import { trackNavClickEvent } from '../../../../../../apps/www/layouts/standard/nav'
+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'

package/src/components/subnav/partials/MenuItemsOverflow/index.tsx

@@ -4,7 +4,7 @@
  */
 
 import React from 'react'
-import { v } from '@web/cms'
+import { v } from '../../../../lib/v'
 import Link from 'next/link'
 import type { Products } from '@hashicorp/platform-product-meta'
 import CtaLinks, { type CtaLinkProps } from '../CtaLinks'

package/src/components/subnav/partials/TitleLink/index.tsx

@@ -7,7 +7,7 @@ import { forwardRef } from 'react'
 import { camelCase } from 'camel-case'
 import Link from 'next/link'
 import Image from 'next/image'
-import { v } from '@web/cms'
+import { v } from '../../../../lib/v'
 import classNames from 'classnames'
 import * as CommunityProductLogosOnDark from './mktg-logos/all-community-product-logos_on-dark'
 import * as CommunityProductLogosOnLight from './mktg-logos/all-community-product-logos_on-light'

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

@@ -0,0 +1,30 @@
+import { parseUrl } from '.'
+
+describe('parseUrl', () => {
+	it('detects hashicorp.com URLs as internal', () => {
+		const url = parseUrl('https://hashicorp.com/example')
+		expect(url.href).toBe('/example')
+		expect(url.linkType).toBe('inbound')
+	})
+
+	it('detects URLs not containing hashicorp.com as external', () => {
+		const externalUrl = 'https://google.com/example'
+		const url = parseUrl(externalUrl)
+		expect(url.href).toBe(externalUrl)
+		expect(url.linkType).toBe('outbound')
+	})
+
+	it('detects relative URLs as internal', () => {
+		const relativeUrl = '/resources'
+		const url = parseUrl(relativeUrl)
+		expect(url.href).toBe(relativeUrl)
+		expect(url.linkType).toBe('inbound')
+	})
+
+	it('leaves URL search params intact', () => {
+		const url = parseUrl(
+			'https://hashicorp.com/resources?type=case-study&products=terraform'
+		)
+		expect(url.href).toBe('/resources?type=case-study&products=terraform')
+	})
+})

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

@@ -0,0 +1,30 @@
+export function parseUrl(url: string | undefined): {
+	linkType: 'inbound' | 'outbound'
+	href: string
+} {
+	if (!url) {
+		throw new Error('url is required')
+	}
+
+	if (isRelative(url) || isAnchor(url)) {
+		return { linkType: 'inbound', href: url }
+	}
+
+	if (isInternal(url)) {
+		try {
+			const { pathname, search } = new URL(url)
+			const href = pathname + search
+			return { linkType: 'inbound', href }
+		} catch (error) {
+			throw new Error(`Invalid href: ${url}`)
+		}
+	}
+
+	return { linkType: 'outbound', href: url }
+}
+
+const isRelative = (url) => url.startsWith('/')
+const isAnchor = (url) => url.startsWith('#')
+
+export const isInternal = (url) =>
+	new URL(url).hostname.includes('hashicorp.com')

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

@@ -0,0 +1,22 @@
+import va from '@vercel/analytics'
+
+/**
+ * Pushes a 'Nav link click' custom event to Vercel Analytics.
+ * A wrapper around the Vercel Analytics track method.
+ *
+ * @param {string} name - The name of the nav link
+ * @param {string} href - The href for the nav link
+ * @param {string} [section] - The name of the section of the nav. Top-level links do not have a section.
+ */
+
+export const trackNavClickEvent = (
+	name: string,
+	href: string,
+	section: string
+) => {
+	va.track('Nav link click', {
+		name,
+		href,
+		section,
+	})
+}

package/src/lib/v/index.ts

@@ -0,0 +1,11 @@
+import { vercelStegaSplit } from '@vercel/stega'
+
+/**
+ * Takes in a Vercel Visual Editing string and returns the string without
+ * hidden data.
+ */
+export function v<VercelVEString extends string>(
+	s: VercelVEString
+): VercelVEString {
+	return vercelStegaSplit(s).cleaned as VercelVEString
+}