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

package/.eslintrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  root: true,
+  extends: require.resolve('@hashicorp/platform-cli/config/.eslintrc.js'),
+}

package/.stylelintrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['@hashicorp/platform-cli/config/stylelint.config']
+}

package/.test/setup-vitest.js

@@ -0,0 +1 @@
+import '@testing-library/jest-dom'

package/README.md

@@ -0,0 +1,3 @@
+# `@hashicorp/react-components`
+
+This package contains React components that are built using HDS guidelines that don't align with existing HDS components.

package/global.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+/// <reference types="@hashicorp/platform-types" />

package/package.json

@@ -0,0 +1,30 @@
+{
+	"name": "@hashicorp/react-components",
+	"version": "0.0.0-canary.0299c5d",
+	"main": "src/index.ts",
+	"scripts": {
+		"lint": "next-hashicorp lint",
+		"test": "vitest run",
+		"test:watch": "vitest watch"
+	},
+	"dependencies": {
+		"@hashicorp/flight-icons": "^3.7.0",
+		"@hashicorp/platform-product-meta": "^0.1.1",
+		"@hashicorp/platform-util": "^0.2.0",
+		"@hashicorp/web-mktg-logos": "*",
+		"@radix-ui/react-navigation-menu": "^1.2.0",
+		"@radix-ui/react-visually-hidden": "^1.1.0",
+		"@vercel/fetch": "^7.0.0",
+		"@vercel/stega": "^0.1.2",
+		"posthog-js": "^1.195.0",
+		"classnames": "^2.3.2"
+	},
+	"devDependencies": {
+		"@hashicorp/platform-cli": "^2.8.0",
+		"@hashicorp/platform-types": "^0.4.0",
+		"@testing-library/jest-dom": "^6.4.2",
+		"@vitejs/plugin-react": "^4.2.1",
+		"nock": "^14.0.0-beta.5",
+		"vitest": "^1.4.0"
+	}
+}

package/postcss.config.js

@@ -0,0 +1,21 @@
+// Next.js allows for plugins to be specified as an array of arrays, but this
+// isn't supported by Vitest, so use a helper function to convert the array of
+// arrays to an object.
+function standardSyntax(plugins) {
+	const _plugins = {}
+	plugins.forEach((p) => {
+		if (Array.isArray(p)) {
+			_plugins[p[0]] = p[1]
+		} else {
+			_plugins[p] = {}
+		}
+	})
+	return _plugins
+}
+
+const baseConfig = require('@hashicorp/platform-postcss-config')
+
+module.exports = {
+	...baseConfig,
+	plugins: standardSyntax(baseConfig.plugins),
+}

package/src/components/nav-panel/components/flight-icon/index.tsx

@@ -0,0 +1,51 @@
+import svgSprite from '@hashicorp/flight-icons/svg-sprite/svg-sprite.svg'
+import classNames from 'classnames'
+import { useId, type SVGProps } from 'react'
+import s from './style.module.css'
+
+interface Props extends SVGProps<SVGSVGElement> {
+	/**
+	 * The name of the icon you wish to use. If the value does not match an
+	 * existing icon name, an error will be thrown. Search for existing icon
+	 * names in the Icon library.
+	 */
+	name: string
+
+	/**
+	 * The `color` prop can be used to change the color. It works by setting
+	 * the value of the icon SVG’s fill property.
+	 */
+	color?: string
+
+	className?: string
+}
+
+// When an SVG file is imported in Next.js, it is an object with a `src`
+// property. However, tools like Webpack and Vite default to returning a URL.
+// This runtime check allows the component to work in all of these cases.
+const svgSpriteSrc =
+	typeof svgSprite === 'string' ? svgSprite : (svgSprite as { src: string }).src
+
+export default function FlightIcon({
+	name,
+	color = 'currentColor',
+	className,
+	...rest
+}: Props) {
+	const iconId = useId()
+	return (
+		<svg
+			className={classNames(s['flight-icon'], className)}
+			{...rest}
+			aria-hidden="true"
+			fill={color}
+			id={iconId}
+			width={16}
+			height={16}
+			viewBox="0 0 16 16"
+			xmlns="http://www.w3.org/2000/svg"
+		>
+			<use href={`${svgSpriteSrc}#flight-${name}-16`}></use>
+		</svg>
+	)
+}

package/src/components/nav-panel/components/flight-icon/style.module.css

@@ -0,0 +1,3 @@
+.flight-icon {
+	display: block;
+}

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

@@ -0,0 +1,94 @@
+import Link from 'next/link'
+import { vercelSplit } from '../../../../lib/v'
+import { getLocalizedLinkProps } from '../../../../lib/get-localized-link-props'
+import FlightIcon from '../flight-icon'
+import * as NavigationMenu from '@radix-ui/react-navigation-menu'
+import s from './style.module.css'
+
+export interface LinkListProps {
+	locale?: string
+	links: {
+		title: string
+		url: string
+		icon?: string
+		description?: string
+		iconGradient?: string
+	}[]
+	linkClickHandler?: (title: string, url: string) => void
+}
+
+const GRADIENT_VALUE_MAP = new Map([
+	[
+		'ILM',
+		{
+			iconGradient: 'var(--icon-gradient-infrastructure-lifecycle-management)',
+		},
+	],
+	[
+		'SLM',
+		{
+			iconGradient: 'var(--icon-gradient-security-lifecycle-management)',
+		},
+	],
+	[
+		'Cloud',
+		{
+			iconGradient: 'var(--icon-gradient-infrastructure-cloud)',
+		},
+	],
+])
+
+export default function LinkList({
+	locale,
+	links,
+	linkClickHandler,
+}: LinkListProps) {
+	return (
+		<ul className={s.linkList}>
+			{links.map((link) => {
+				let style
+				link.iconGradient
+					? (style = {
+							'--iconGradient': GRADIENT_VALUE_MAP.get(
+								vercelSplit(link.iconGradient)
+							)?.iconGradient,
+					  } as React.CSSProperties)
+					: (style = null)
+				return (
+					<li key={link.title}>
+						<NavigationMenu.Link asChild>
+							<Link
+								className={s.link}
+								{...getLocalizedLinkProps(link.url, locale)}
+								onClickCapture={() => {
+									linkClickHandler && linkClickHandler(link.title, link.url)
+								}}
+							>
+								{link.iconGradient && link.icon ? (
+									<div className={s.iconBackground} style={style}>
+										<FlightIcon name={vercelSplit(link.icon)} />
+									</div>
+								) : (
+									link.icon && (
+										<FlightIcon
+											name={vercelSplit(link.icon)}
+											color="var(--token-color-foreground-faint)"
+										/>
+									)
+								)}
+								<div>
+									<div className={link.iconGradient && s.boldTitle}>
+										{link.title}
+									</div>
+									{link.description && (
+										<div className={s.description}>{link.description}</div>
+									)}
+								</div>
+							</Link>
+						</NavigationMenu.Link>
+					</li>
+				)
+			})}
+		</ul>
+	)
+}

package/src/components/nav-panel/components/link-list/style.module.css

@@ -0,0 +1,57 @@
+.linkList {
+	display: flex;
+	list-style: none;
+	flex-direction: column;
+	gap: var(--mds-spacing-03);
+	margin: 0;
+	padding: 0;
+}
+
+.link {
+	color: var(--token-color-foreground-primary);
+	display: flex;
+	gap: var(--mds-spacing-04);
+	padding: var(--mds-spacing-03) var(--mds-spacing-04);
+	min-width: 190px;
+	align-items: center;
+
+	&:hover {
+		background-color: var(--token-color-surface-interactive-hover);
+		border-radius: var(--mds-spacing-01);
+	}
+
+	&:has(.iconBackground) {
+		align-items: flex-start;
+	}
+
+	@media (--large) {
+		max-width: 416px;
+	}
+
+	&:focus {
+		outline: 2px solid var(--token-color-focus-action-internal);
+		outline-style: auto;
+	}
+}
+
+.description {
+	font-size: var(--mds-typography-body-200-font-size);
+	font-weight: var(--mds-typography-font-weight-regular);
+	margin-top: var(--mds-spacing-02);
+}
+
+.iconBackground {
+	background: var(--iconGradient);
+	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;
+}
+
+.boldTitle {
+	font-weight: var(--mds-typography-font-weight-semibold);
+}

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

@@ -0,0 +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({
+	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

@@ -0,0 +1,24 @@
+@custom-media --dev-dot-viewport (min-width: 924px);
+
+.column {
+	position: relative;
+	display: flex;
+	flex-direction: column;
+	justify-content: flex-start;
+	min-width: 190px;
+	padding: 0;
+	margin: 0 var(--mds-spacing-07);
+	border-radius: var(--mds-spacing-03);
+
+	@media (--large) {
+		&:not(.hasSide) {
+			margin: 0;
+		}
+	}
+
+	@media (--dev-dot-viewport) {
+		&.hasSide {
+			margin: 0;
+		}
+	}
+}

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

@@ -0,0 +1,4 @@
+import Root from './root'
+import Column from './column'
+
+export { Root, Column }

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

@@ -0,0 +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({ 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

@@ -0,0 +1,30 @@
+@custom-media --dev-dot-viewport (min-width: 924px);
+
+.root {
+	width: 100%;
+	display: flex;
+	flex-direction: column;
+	justify-content: space-between;
+	/* stylelint-disable-next-line unit-no-unknown */
+	min-height: calc(100dvh - var(--mds-spacing-12));
+
+	@media (--large) {
+		&:not(.hasSide) {
+			justify-content: flex-start;
+			height: 100%;
+			min-height: fit-content;
+			padding: var(--mds-spacing-05) var(--mds-spacing-04);
+			gap: var(--mds-spacing-04);
+		}
+	}
+
+	@media (--dev-dot-viewport) {
+		&.hasSide {
+			justify-content: flex-start;
+			height: 100%;
+			min-height: fit-content;
+			padding: var(--mds-spacing-05) var(--mds-spacing-04);
+			gap: var(--mds-spacing-04);
+		}
+	}
+}

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

@@ -0,0 +1,92 @@
+import { useCallback } from 'react'
+import classNames from 'classnames'
+import { vercelSplit } from '../../../../lib/v'
+import Link from 'next/link'
+import { getLocalizedLinkProps } from '../../../../lib/get-localized-link-props'
+import { trackNavClickEvent } from '../../../../lib/track-nav-click-event'
+import FlightIcon from '../flight-icon'
+import * as NavigationMenu from '@radix-ui/react-navigation-menu'
+import s from './style.module.css'
+
+export interface PromoProps {
+	locale?: string
+	title: string
+	description: string
+	linkUrl: string
+	linkTitle: string
+	slug?: string
+	icon?: string
+	theme: string
+	hasSidePanel?: boolean
+	isPromoOnTop?: boolean
+}
+
+export default function Promo({
+	locale,
+	title,
+	description,
+	linkUrl,
+	linkTitle,
+	slug,
+	icon,
+	theme,
+	hasSidePanel,
+	isPromoOnTop = false,
+}: PromoProps) {
+	const handleClick = useCallback((title, linkUrl, linkTitle, slug) => {
+		if (window && window.analytics) {
+			window.analytics.track('Nav Promo', {
+				url: linkUrl,
+				title: title,
+				callout: linkTitle,
+			})
+
+			trackNavClickEvent(title, linkUrl, slug)
+		}
+	}, [])
+
+	return (
+		<div
+			className={classNames(s.promo, {
+				[s.hasSide]: hasSidePanel,
+				[s.noSide]: !hasSidePanel,
+				[s.topPromo]: isPromoOnTop,
+			})}
+		>
+			{icon && (
+				<div
+					className={classNames(s.icon, {
+						[s.hashidays]: vercelSplit(theme) === 'hashidays',
+						[s.hashiconf]: vercelSplit(theme) === 'hashiconf',
+					})}
+				>
+					<FlightIcon name={vercelSplit(icon)} />
+				</div>
+			)}
+			<div className={s.rightContent}>
+				<div>
+					<div
+						className={classNames(s.title, {
+							[s.hashidays]: vercelSplit(theme) === 'hashidays',
+							[s.hashiconf]: vercelSplit(theme) === 'hashiconf',
+						})}
+					>
+						{title}
+					</div>
+					<div className={s.description}>{description}</div>
+				</div>
+				<NavigationMenu.Link asChild>
+					<Link
+						locale={locale ? locale : undefined}
+						{...getLocalizedLinkProps(linkUrl, locale)}
+						className={s.link}
+						onClickCapture={() => handleClick(title, linkUrl, linkTitle, slug)}
+					>
+						{linkTitle}
+						<FlightIcon name="external-link" />
+					</Link>
+				</NavigationMenu.Link>
+			</div>
+		</div>
+	)
+}

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

@@ -0,0 +1,128 @@
+@custom-media --dev-dot-viewport (min-width: 924px);
+
+.promo {
+	display: flex;
+	border-radius: var(--mds-spacing-01);
+	border: 1px solid var(--token-color-border-faint);
+	background-color: var(--token-color-surface-faint);
+	padding: var(--mds-spacing-05) var(--mds-spacing-08) var(--mds-spacing-06)
+		var(--mds-spacing-08);
+	flex-direction: row;
+	gap: var(--mds-spacing-04);
+	margin: var(--mds-spacing-07);
+	margin-bottom: var(--mds-spacing-09);
+
+	@media (--large) {
+		&.topPromo {
+			margin-bottom: var(--mds-spacing-05);
+		}
+		&.noSide {
+			margin: 0;
+			width: min-content;
+			min-width: 100%;
+		}
+	}
+
+	@media (--dev-dot-viewport) {
+		&.topPromo {
+			margin-bottom: var(--mds-spacing-05);
+		}
+		&.hasSide {
+			&.topPromo {
+				margin-bottom: var(--mds-spacing-05);
+			}
+
+			margin: 0;
+			width: min-content;
+			min-width: 100%;
+		}
+	}
+}
+
+.topPromo {
+	margin-bottom: 0;
+}
+
+.rightContent {
+	display: flex;
+	flex-wrap: wrap;
+	gap: var(--mds-spacing-03);
+	width: 100%;
+	justify-content: space-between;
+}
+
+.title {
+	font-weight: var(--mds-typography-font-weight-semibold);
+}
+
+.description {
+	font-size: var(--mds-typography-body-200-font-size);
+	font-weight: var(--mds-typography-font-weight-regular);
+	margin-top: var(--mds-spacing-01);
+}
+
+.icon {
+	display: none;
+
+	@media (--large) {
+		@nest .noSide & {
+			display: block;
+			margin-top: 3px;
+		}
+	}
+
+	@media (--dev-dot-viewport) {
+		@nest .hasSide & {
+			display: block;
+			margin-top: 3px;
+		}
+	}
+}
+
+.link {
+	color: var(--token-color-foreground-strong);
+	display: flex;
+	flex-direction: row;
+	align-items: center;
+	gap: var(--mds-spacing-02);
+
+	&:hover {
+		text-decoration: underline;
+	}
+
+	&:focus {
+		outline: 2px solid var(--token-color-focus-action-internal);
+		outline-style: auto;
+	}
+}
+
+.hashidays {
+	background: linear-gradient(
+		90deg,
+		#7b54b6 0%,
+		#4c69d8 74.77%,
+		#60d0dc 115.93%
+	);
+	-webkit-background-clip: text;
+	-webkit-text-fill-color: transparent;
+	max-width: fit-content;
+
+	& svg {
+		color: #7956b9;
+	}
+}
+
+.hashiconf {
+	background: linear-gradient(
+		to right,
+		var(--token-color-terraform-foreground),
+		var(--token-color-vagrant-foreground)
+	);
+	-webkit-background-clip: text;
+	-webkit-text-fill-color: transparent;
+	max-width: fit-content;
+
+	& svg {
+		color: var(--token-color-terraform-foreground);
+	}
+}

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

@@ -0,0 +1,6 @@
+import ProductPanel, { type NavProductProps } from './product-panel'
+import StandardPanel, { type NavItem } from './standard-panel'
+import { PromoProps } from './components/promo'
+
+export { ProductPanel, StandardPanel }
+export type { NavProductProps, PromoProps, NavItem }