@hashicorp/react-components 0.0.0-canary.f1f8354 → 0.0.0-canary.fa24a72

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hashicorp/react-components",
-	"version": "0.0.0-canary.f1f8354",
+	"version": "0.0.0-canary.fa24a72",
 	"main": "src/index.ts",
 	"scripts": {
 		"lint": "next-hashicorp lint",
@@ -8,7 +8,7 @@
 		"test:watch": "vitest watch"
 	},
 	"dependencies": {
-		"@hashicorp/flight-icons": "^2.15.0",
+		"@hashicorp/flight-icons": "^3.5.0",
 		"@hashicorp/platform-product-meta": "^0.1.1",
 		"@hashicorp/platform-util": "^0.2.0",
 		"@hashicorp/react-design-system-components": "*",

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/panel/column/index.tsx

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

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

@@ -1,3 +1,5 @@
+@custom-media --dev-dot-viewport (min-width: 1210px);
+
 .column {
 	position: relative;
 	display: flex;
@@ -9,6 +11,14 @@
 	border-radius: var(--hdsplus-spacing-03);
 
 	@media (--large) {
-		margin: 0;
+		&:not(.hasSide) {
+			margin: 0;
+		}
+	}
+
+	@media (--dev-dot-viewport) {
+		&.hasSide {
+			margin: 0;
+		}
 	}
 }

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

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

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

@@ -1,3 +1,5 @@
+@custom-media --dev-dot-viewport (min-width: 1210px);
+
 .root {
 	width: 100%;
 	display: flex;
@@ -7,9 +9,22 @@
 	min-height: calc(100dvh - var(--hdsplus-spacing-12));
 
 	@media (--large) {
-		justify-content: flex-start;
-		height: 100%;
-		min-height: fit-content;
-		gap: var(--hdsplus-spacing-04);
+		&:not(.hasSide) {
+			justify-content: flex-start;
+			height: 100%;
+			min-height: fit-content;
+			padding: var(--hdsplus-spacing-05) var(--hdsplus-spacing-04);
+			gap: var(--hdsplus-spacing-04);
+		}
+	}
+
+	@media (--dev-dot-viewport) {
+		&.hasSide {
+			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

@@ -16,6 +16,7 @@ export interface PromoProps {
 	slug?: string
 	icon?: string
 	theme: string
+	hasSidePanel?: boolean
 }
 
 export default function Promo({
@@ -26,6 +27,7 @@ export default function Promo({
 	slug,
 	icon,
 	theme,
+	hasSidePanel,
 }: PromoProps) {
 	const handleClick = useCallback((title, linkUrl, linkTitle, slug) => {
 		if (window && window.analytics) {
@@ -40,7 +42,12 @@ export default function Promo({
 	}, [])
 
 	return (
-		<div className={s.promo}>
+		<div
+			className={classNames(s.promo, {
+				[s.hasSide]: hasSidePanel,
+				[s.noSide]: !hasSidePanel,
+			})}
+		>
 			{icon && (
 				<div
 					className={classNames(s.icon, {

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

@@ -1,3 +1,5 @@
+@custom-media --dev-dot-viewport (min-width: 1210px);
+
 .promo {
 	display: flex;
 	border-radius: var(--hdsplus-spacing-01);
@@ -10,9 +12,19 @@
 	margin: var(--hdsplus-spacing-05);
 
 	@media (--large) {
-		margin: 0;
-		width: min-content;
-		min-width: 100%;
+		&.noSide {
+			margin: 0;
+			width: min-content;
+			min-width: 100%;
+		}
+	}
+
+	@media (--dev-dot-viewport) {
+		&.hasSide {
+			margin: 0;
+			width: min-content;
+			min-width: 100%;
+		}
 	}
 }
 
@@ -38,8 +50,17 @@
 	display: none;
 
 	@media (--large) {
-		display: block;
-		margin-top: 3px;
+		@nest .noSide & {
+			display: block;
+			margin-top: 3px;
+		}
+	}
+
+	@media (--dev-dot-viewport) {
+		@nest .hasSide & {
+			display: block;
+			margin-top: 3px;
+		}
 	}
 }
 

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

@@ -8,6 +8,7 @@ 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'
+import classNames from 'classnames'
 
 const PRODUCT_LOGO_MAP = new Map([
 	['Terraform', 'terraform-fill-color'],
@@ -18,37 +19,102 @@ 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={classNames(s.productPanel, {
+				[s.hasSide]: sidePanel,
+				[s.noSide]: !sidePanel,
+			})}
+			hasSidePanel={Boolean(sidePanel)}
+		>
+			<div className={s.mainPanel}>
+				<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>
+									<ul className={s.productList}>
+										{products.map((product) => {
+											return (
+												<li key={product.url}>
+													<NavProduct {...product} />
+												</li>
+											)
+										})}
+									</ul>
+								</li>
+							)
+						})}
+					</ul>
+				</NavPanel.Column>
+				{promo ? <Promo {...promo} hasSidePanel={Boolean(sidePanel)} /> : 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 +139,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,27 @@
+@custom-media --dev-dot-viewport (min-width: 1210px);
+
+.productPanel {
+	height: 100%;
+
+	@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;
@@ -5,7 +29,15 @@
 	margin: var(--hdsplus-spacing-06) 0 0;
 
 	@media (--large) {
-		margin: 0;
+		@nest .noSide & {
+			margin: 0;
+		}
+	}
+
+	@media (--dev-dot-viewport) {
+		@nest .hasSide & {
+			margin: 0;
+		}
 	}
 }
 
@@ -27,7 +59,17 @@
 	font-weight: var(--font-weight-semi-bold);
 
 	@media (--large) {
-		padding: 0 0 var(--hdsplus-spacing-01) var(--hdsplus-spacing-04);
+		@nest .noSide & {
+			padding-bottom: 0;
+		  	padding-left: var(--hdsplus-spacing-06);
+		}
+	}
+
+	@media (--dev-dot-viewport) {
+		@nest .hasSide & {
+			padding-bottom: 0;
+		  	padding-left: var(--hdsplus-spacing-06);
+		}
 	}
 }
 
@@ -39,10 +81,25 @@
 	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(--hdsplus-spacing-06) var(--hdsplus-spacing-05)
+			  var(--hdsplus-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(--hdsplus-spacing-06) var(--hdsplus-spacing-05)
+			  var(--hdsplus-spacing-04);
+		  	grid-auto-flow: row;
+		  	grid-template-columns: repeat(2, 300px);
+		  	grid-template-rows: repeat(2, max-content);
+		  	gap: 0;
+		}
 	}
 }
 
@@ -54,12 +111,26 @@
 	gap: var(--hdsplus-spacing-05);
 
 	@media (--large) {
-		padding: var(--hdsplus-spacing-05);
-		margin-bottom: 0;
+		@nest .noSide & {
+			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);
+			&:hover {
+				background-color: var(--token-color-surface-interactive-hover);
+				border-radius: var(--hdsplus-spacing-01);
+			}
+		}
+	}
+
+	@media (--dev-dot-viewport) {
+		@nest .hasSide & {
+			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);
+			}
 		}
 	}
 }
@@ -70,10 +141,23 @@
 	& svg {
 		height: 42px;
 		width: 42px;
+	}
+
+	@nest .noSide & {
+		& svg {
+			@media (--large) {
+				height: var(--hdsplus-spacing-08);
+				width: var(--hdsplus-spacing-08);
+			}
+		}
+	}
 
-		@media (--large) {
-			height: var(--hdsplus-spacing-08);
-			width: var(--hdsplus-spacing-08);
+	@nest .hasSide & {
+		& svg {
+			@media (--dev-dot-viewport) {
+				height: var(--hdsplus-spacing-08);
+				width: var(--hdsplus-spacing-08);
+			}
 		}
 	}
 }
@@ -98,3 +182,115 @@
 		outline-style: auto;
 	}
 }
+
+.mainPanel {
+	height: 100%;
+	display: flex;
+	justify-content: space-between;
+	flex-direction: column;
+
+	@media (--large) {
+		@nest .noSide & {
+			padding: var(--hdsplus-spacing-07) 0 var(--hdsplus-spacing-05)
+			  var(--hdsplus-spacing-04);
+		}
+	}
+
+	@media (--dev-dot-viewport) {
+		@nest .hasSide & {
+			padding: var(--hdsplus-spacing-07) 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-07) var(--hdsplus-spacing-04)
+		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 (--dev-dot-viewport) {
+		gap: var(--hdsplus-spacing-05);
+	}
+}
+
+/* Lifted from .productWrapper */
+.sidePanelItem {
+	display: flex;
+	margin-bottom: var(--hdsplus-spacing-05);
+	gap: var(--hdsplus-spacing-05);
+
+	@media (--dev-dot-viewport) {
+		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/lib/parse-url/index.test.ts

@@ -1,27 +1,27 @@
 import { parseUrl } from '.'
 
 describe('parseUrl', () => {
-	it('handles internal urls', () => {
+	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('handles external urls', () => {
+	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('handles relative urls', () => {
+	it('detects relative URLs as internal', () => {
 		const relativeUrl = '/resources'
 		const url = parseUrl(relativeUrl)
 		expect(url.href).toBe(relativeUrl)
 		expect(url.linkType).toBe('inbound')
 	})
 
-	it('handles search params', () => {
+	it('leaves URL search params intact', () => {
 		const url = parseUrl(
 			'https://hashicorp.com/resources?type=case-study&products=terraform'
 		)

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

@@ -1,4 +1,4 @@
-export function parseUrl(url: string): {
+export function parseUrl(url: string | undefined): {
 	linkType: 'inbound' | 'outbound'
 	href: string
 } {
@@ -27,5 +27,4 @@ const isRelative = (url) => url.startsWith('/')
 const isAnchor = (url) => url.startsWith('#')
 
 export const isInternal = (url) =>
-	url.startsWith('https://hashicorp.com') ||
-	url.startsWith('https://www.hashicorp.com')
+	new URL(url).hostname.includes('hashicorp.com')

package/src/lib/v/index.ts

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