@hashicorp/react-components 0.0.0-canary.23632af → 0.0.0-canary.32599ff

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

@@ -9,22 +9,30 @@ import NavItemText from '../nav-item-text'
 import DropdownTrigger from '../DropdownTrigger'
 import * as NavigationMenu from '@radix-ui/react-navigation-menu'
 import s from './style.module.css'
+import FlightIcon from '@hashicorp/react-mds/src/hds/components/flight-icon'
+import { getLocalizedLinkProps } from '../../../../lib/get-localized-link-props'
 
 interface MenuItemsDefaultProps {
 	menuItems: (
 		| {
 				text: string
 				url: string
-				submenu: { text: string; url: string; _isActiveUrl: string }[]
+				submenu: {
+					icon: string
+					text: string
+					url: string
+					_isActiveUrl: string
+				}[]
 				_isActiveUrl: boolean
 		  }
 		| 'divider'
 	)[]
 	activatePanel: (panel: string) => void
+	locale?: string
 }
 
 function MenuItemsDefault(props: MenuItemsDefaultProps) {
-	const { menuItems, activatePanel } = props
+	const { menuItems, activatePanel, locale } = props
 	return (
 		<NavigationMenu.List className={s.root}>
 			{menuItems.map((menuItem, stableIdx) => {
@@ -41,6 +49,7 @@ function MenuItemsDefault(props: MenuItemsDefaultProps) {
 						text={text}
 						submenu={submenu}
 						activatePanel={activatePanel}
+						locale={locale}
 					/>
 				) : (
 					<NavLink
@@ -50,6 +59,7 @@ function MenuItemsDefault(props: MenuItemsDefaultProps) {
 						text={text}
 						url={url}
 						isActive={_isActiveUrl}
+						locale={locale}
 					/>
 				)
 			})}
@@ -69,14 +79,15 @@ interface NavLinkProps {
 	text: string
 	url: string
 	isActive: boolean
+	locale?: string
 }
 
 function NavLink(props: NavLinkProps) {
-	const { text, url, isActive } = props
+	const { text, url, isActive, locale } = props
 	return (
 		<NavigationMenu.Item className={s.listItem}>
 			<NavigationMenu.Link asChild>
-				<Link className={s.navLink} href={url}>
+				<Link className={s.navLink} {...getLocalizedLinkProps(url, locale)}>
 					<NavItemText isActive={isActive} text={text} />
 				</Link>
 			</NavigationMenu.Link>
@@ -86,8 +97,9 @@ function NavLink(props: NavLinkProps) {
 
 interface NavLinkWithDropdownProps {
 	text: string
-	submenu: { text: string; url: string; _isActiveUrl: string }[]
+	submenu: { icon: string; text: string; url: string; _isActiveUrl: string }[]
 	activatePanel: (panel: string) => void
+	locale?: string
 }
 
 interface NavLinkWithDropdownState {
@@ -99,7 +111,7 @@ class NavLinkWithDropdown extends React.Component<
 	NavLinkWithDropdownState
 > {
 	render() {
-		const { text, submenu, activatePanel } = this.props
+		const { text, submenu, activatePanel, locale } = this.props
 		const hasActiveChild = submenu.some((s) => s._isActiveUrl)
 
 		const handleFocusOutside = () => {
@@ -128,12 +140,16 @@ class NavLinkWithDropdown extends React.Component<
 					<NavigationMenu.Sub>
 						<NavigationMenu.List className={s.dropdownList}>
 							{submenu.map((submenuItem, stableIdx) => {
-								const { text, url } = submenuItem
+								const { icon, text, url } = submenuItem
 								return (
 									// eslint-disable-next-line react/no-array-index-key
 									<NavigationMenu.Item key={stableIdx}>
 										<NavigationMenu.Link asChild>
-											<Link className={s.submenuItem} href={url}>
+											<Link
+												className={s.submenuItem}
+												{...getLocalizedLinkProps(url, locale)}
+											>
+												{icon ? <FlightIcon name={icon} /> : null}
 												{text}
 											</Link>
 										</NavigationMenu.Link>

package/src/components/subnav/partials/MenuItemsDefault/style.module.css

@@ -3,11 +3,9 @@
  * SPDX-License-Identifier: MPL-2.0
  */
 
-/* Note: consumes from theme.module.css, as marked */
-
 .root {
 	display: flex;
-	padding: 0 0 0 var(--hdsplus-spacing-08);
+	padding: 0 0 0 var(--mds-spacing-08);
 	margin: 0;
 	align-items: center;
 	justify-content: flex-end;
@@ -16,23 +14,22 @@
 
 .listItem {
 	position: relative;
-	white-space: nowrap;
 	margin: 0;
 	padding: 0;
 }
 
 .navLink {
-	composes: hds-typography-body-200 from global;
-	composes: hds-font-weight-medium from global;
+	composes: token-typography-body-200 from global;
+	composes: mds-typography-font-weight-medium from global;
 	position: relative;
-	padding: var(--hdsplus-spacing-04);
+	padding: var(--mds-spacing-04);
 	display: flex;
 	align-items: center;
 	white-space: nowrap;
 
 	&:hover {
-		background-color: var(--menu-item-hover-color);
-		border-radius: var(--hdsplus-spacing-01);
+		background-color: var(--token-color-surface-interactive-hover);
+		border-radius: var(--mds-spacing-01);
 	}
 
 	&:focus {
@@ -42,43 +39,58 @@
 }
 
 .submenuItem {
-	composes: hds-typography-body-200 from global;
-	composes: hds-font-weight-medium from global;
-	display: block;
-	color: var(--menu-item-text-color); /* from theme.module.css */
+	--submenu-item-background-color: transparent;
+
+	position: relative;
+	composes: token-typography-body-200 from global;
+	composes: mds-typography-font-weight-medium from global;
+	color: var(--token-color-foreground-primary);
+	display: flex;
+	gap: var(--mds-spacing-04);
+	padding: var(--mds-spacing-03);
+	min-width: 190px;
+	align-items: center;
+
+	&::before {
+		content: "";
+		position: absolute;
+		z-index: -1;
+		inset: 2px 0;
+		border-radius: var(--mds-spacing-01);
+		background-color: var(--submenu-item-background-color);
+	}
 
 	&:hover {
-		text-decoration: underline;
+		--submenu-item-background-color: var(--token-color-surface-interactive-hover);
+	}
+
+	@media (--large) {
+		max-width: 416px;
+	}
+
+	&:focus {
+		outline: 2px solid var(--token-color-focus-action-internal);
+		outline-style: auto;
 	}
 }
 
 .submenuModal {
-	border-radius: 4px;
-	box-shadow: var(--token-elevation-high-box-shadow); /* from theme.module.css */
-	background: var(--dropdown-background-color); /* from theme.module.css */
+	border-radius: var(--mds-spacing-03);
+	border: 1px solid var(--token-color-border-primary);
+	box-shadow: var(--token-elevation-high-box-shadow);
+	background: var(--token-color-surface-primary);
 	z-index: 1;
-	display: block;
 	position: absolute;
 	top: 100%;
-	margin: 8px 0 0 0;
-	padding: 24px;
+	margin: var(--mds-spacing-03) 0 0 0;
+	padding: var(--mds-spacing-04);
 	left: 100%;
 	transform: translateX(-100%);
 	list-style: none;
-
-	& li {
-		& a:hover .text {
-			text-decoration: underline;
-		}
-
-		& + li {
-			margin-top: 6px;
-		}
-	}
 }
 
 .verticalDivider {
-	background: var(--border-color); /* from theme.module.css */
+	background: var(--token-color-border-primary);
 	height: 1.75rem;
 	width: 1px;
 	margin: 0 8px;
@@ -86,6 +98,7 @@
 }
 
 .dropdownList {
+	min-width: max-content;
 	list-style: none;
 	padding: 0;
 }

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

@@ -4,7 +4,7 @@
  */
 
 import React from 'react'
-import { v } from '../../../../lib/v'
+import { vercelSplit } from '../../../../lib/v'
 import Link from 'next/link'
 import type { Products } from '@hashicorp/platform-product-meta'
 import CtaLinks, { type CtaLinkProps } from '../CtaLinks'
@@ -12,6 +12,8 @@ import DropdownTrigger from '../DropdownTrigger'
 import * as NavigationMenu from '@radix-ui/react-navigation-menu'
 import classNames from 'classnames'
 import s from './style.module.css'
+import FlightIcon from '@hashicorp/react-mds/src/hds/components/flight-icon'
+import { getLocalizedLinkProps } from '../../../../lib/get-localized-link-props'
 
 interface MenuItemsOverflowProps {
 	menuItems: (
@@ -19,7 +21,7 @@ interface MenuItemsOverflowProps {
 		| {
 				text: string
 				url: string
-				submenu: { url: string; text: string }[]
+				submenu: { icon: string; url: string; text: string }[]
 		  }
 	)[]
 	ctaLinks: CtaLinkProps
@@ -28,6 +30,7 @@ interface MenuItemsOverflowProps {
 	menuText: string
 	constrainWidth?: boolean
 	activatePanel: (panel: string) => void
+	locale?: string
 }
 
 interface MenuItemsOverflowState {
@@ -47,6 +50,7 @@ class MenuItemsOverflow extends React.Component<
 			menuText,
 			constrainWidth,
 			activatePanel,
+			locale,
 		} = this.props
 
 		const handleFocusOutside = () => {
@@ -89,6 +93,8 @@ class MenuItemsOverflow extends React.Component<
 													key={subStableIdx}
 													url={subItem.url}
 													text={subItem.text}
+													icon={subItem.icon}
+													locale={locale}
 												/>
 											))}
 											<hr className={s.divider} />
@@ -120,15 +126,22 @@ class MenuItemsOverflow extends React.Component<
 }
 
 interface SubmenuItemProps {
+	icon?: string
 	url: string
 	text: string
+	locale?: string
 }
 
-function SubmenuItem({ url, text }: SubmenuItemProps) {
+function SubmenuItem({ icon, url, text, locale }: SubmenuItemProps) {
 	return (
 		<li>
 			<NavigationMenu.Link asChild>
-				<Link className={s.submenuItem} href={url} title={v(text)}>
+				<Link
+					className={s.submenuItem}
+					title={vercelSplit(text)}
+					{...getLocalizedLinkProps(url, locale)}
+				>
+					{icon ? <FlightIcon name={icon} /> : null}
 					{text}
 				</Link>
 			</NavigationMenu.Link>

package/src/components/subnav/partials/MenuItemsOverflow/style.module.css

@@ -3,8 +3,6 @@
  * SPDX-License-Identifier: MPL-2.0
  */
 
-/* Note: consumes from theme.module.css, as marked */
-
 .root {
 	position: relative;
 	display: flex;
@@ -12,18 +10,18 @@
 }
 
 .dropdown {
-	background: var(--dropdown-background-color); /* from theme.module.css */
-	border-radius: 4px;
+	background: var(--token-color-surface-primary);
+	border-radius: var(--mds-spacing-03);
 	box-shadow: var(--token-elevation-high-box-shadow);
-	border: 1px solid var(--border-color);
+	border: 1px solid var(--token-color-border-primary);
 	margin-top: 8px;
 	max-height: calc(100vh - 300%);
 	overflow-y: auto;
-	padding: var(--hdsplus-spacing-04) var(--hdsplus-spacing-07);
+	padding: var(--mds-spacing-04);
 	position: absolute;
 	right: 0;
 	top: 100%;
-	width: calc(100vw - var(--hdsplus-spacing-08));
+	width: calc(100vw - var(--mds-spacing-08));
 	z-index: 1;
 
 	@nest :global(.hashidaysConference) & {
@@ -32,7 +30,7 @@
 
 	&.constrained {
 		max-width: 568px;
-		width: calc(100vw - var(--hdsplus-spacing-10));
+		width: calc(100vw - var(--mds-spacing-10));
 
 		@media (--medium-up) {
 			width: max-content;
@@ -52,27 +50,35 @@
 
 .submenuTitle {
 	composes: g-type-label from global;
-	margin: 12px 0 8px 0;
-	color: var(--menu-item-heading-text-color); /* from theme.module.css */
+	margin: var(--mds-spacing-04) var(--mds-spacing-03) 8px;
+	color: var(--token-color-foreground-faint);
 }
 
 .divider {
-	margin: 12px 0;
+	margin: var(--mds-spacing-04) var(--mds-spacing-03);
 	border: 0;
 	padding: 0;
 	height: 1px;
-	background: var(--border-color); /* from theme.module.css */
+	background: var(--token-color-border-primary);
 }
 
 .submenuItem {
-	display: block;
-	padding: 4px 0;
-	color: var(--menu-item-text-color); /* from theme.module.css */
-	font-weight: var(--font-weight-semi-bold);
-	font-size: var(--token-typography-body-300-font-size);
+	composes: token-typography-body-300 from global;
+	composes: mds-typography-font-weight-semibold from global;
+	display: flex;
+	gap: var(--mds-spacing-04);
+	padding: var(--mds-spacing-02) var(--mds-spacing-03);
+	color: var(--token-color-foreground-primary);
+	border-radius: var(--mds-spacing-01);
+	align-items: center;
 
 	&:hover {
-		text-decoration: underline;
+		background-color: var(--token-color-surface-interactive-hover);
+	}
+
+	&:focus {
+		outline: 2px solid var(--token-color-focus-action-internal);
+		outline-style: auto;
 	}
 }
 

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 '../../../../lib/v'
+import { vercelSplit } 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'
@@ -22,6 +22,7 @@ import WaypointLogoAttrOnDark from '@hashicorp/web-mktg-logos/src/waypoint/hashi
 import HCPTerraformLogoOnLight from '@hashicorp/web-mktg-logos/src/terraform/hcp-terraform/hcp-terraform_on-light.svg'
 import HCPTerraformLogoOnDark from '@hashicorp/web-mktg-logos/src/terraform/hcp-terraform/hcp-terraform_on-dark.svg'
 import s from './style.module.css'
+import { getLocalizedLinkProps } from '../../../../lib/get-localized-link-props'
 
 const logoDict = {
 	light: {
@@ -41,6 +42,7 @@ const logoDict = {
 }
 
 interface TitleLinkProps {
+	locale?: string
 	text: string
 	url: string
 	product?: string
@@ -80,8 +82,8 @@ function getLogo(
 }
 
 const TitleLink = forwardRef<HTMLAnchorElement, TitleLinkProps>(
-	({ text, url, product, theme }, ref) => {
-		const parsedText = v(text)
+	({ text, url, product, theme, locale }, ref) => {
+		const parsedText = vercelSplit(text)
 		const Logo = getLogo(parsedText, theme)
 
 		return (
@@ -91,9 +93,9 @@ const TitleLink = forwardRef<HTMLAnchorElement, TitleLinkProps>(
 					s[`brand-${product}`],
 					s[camelCase(parsedText)]
 				)}
-				href={url}
 				title={parsedText}
 				ref={ref}
+				{...getLocalizedLinkProps(url, locale)}
 			>
 				{Logo ? (
 					<Image

package/src/components/subnav/partials/TitleLink/mktg-logos/all-community-product-logos_on-dark.ts

@@ -5,5 +5,6 @@ import packer from '@hashicorp/web-mktg-logos/src/packer/packer-community/packer
 import terraform from '@hashicorp/web-mktg-logos/src/terraform/terraform-community/terraform-community_on-dark.svg'
 import vagrant from '@hashicorp/web-mktg-logos/src/vagrant/vagrant-community/vagrant-community_on-dark.svg'
 import vault from '@hashicorp/web-mktg-logos/src/vault/vault-community/vault-community_on-dark.svg'
+import waypoint from '@hashicorp/web-mktg-logos/src/waypoint/hashicorp-waypoint-attributed/hashicorp-waypoint_on-dark.svg'
 
-export { boundary, consul, nomad, packer, terraform, vagrant, vault }
+export { boundary, consul, nomad, packer, terraform, vagrant, vault, waypoint }

package/src/components/subnav/partials/TitleLink/mktg-logos/all-community-product-logos_on-light.ts

@@ -5,5 +5,6 @@ import packer from '@hashicorp/web-mktg-logos/src/packer/packer-community/packer
 import terraform from '@hashicorp/web-mktg-logos/src/terraform/terraform-community/terraform-community_on-light.svg'
 import vagrant from '@hashicorp/web-mktg-logos/src/vagrant/vagrant-community/vagrant-community_on-light.svg'
 import vault from '@hashicorp/web-mktg-logos/src/vault/vault-community/vault-community_on-light.svg'
+import waypoint from '@hashicorp/web-mktg-logos/src/waypoint/hashicorp-waypoint-attributed/hashicorp-waypoint_on-light.svg'
 
-export { boundary, consul, nomad, packer, terraform, vagrant, vault }
+export { boundary, consul, nomad, packer, terraform, vagrant, vault, waypoint }

package/src/components/subnav/partials/TitleLink/style.module.css

@@ -8,9 +8,9 @@
 .root {
 	position: relative;
 	display: inline-flex;
-	padding-block: var(--hdsplus-spacing-04);
-	font-weight: var(--font-weight-bold);
-	color: var(--title-text-color); /* from theme.module.css */
+	padding-block: var(--mds-spacing-04);
+	font-weight: var(--mds-typography-font-weight-bold);
+	color: var(--token-color-foreground-primary); /* from theme.module.css */
 	font-size: 1.25rem;
 	line-height: 1.35rem;
 

package/src/components/subnav/partials/nav-item-text/style.module.css

@@ -3,13 +3,11 @@
  * SPDX-License-Identifier: MPL-2.0
  */
 
-/* Note: consumes from theme.module.css, as marked */
-
 .root {
-	color: var(--menu-item-text-color); /* from theme.module.css */
+	color: var(--token-color-foreground-primary);
 	position: relative;
 
 	&.isActive {
-		color: var(--menu-item-text-color-active);
+		color: var(--token-color-foreground-strong);
 	}
 }

package/src/components/subnav/style.module.css

@@ -3,19 +3,17 @@
  * SPDX-License-Identifier: MPL-2.0
  */
 
-/* Note: consumes from theme.module.css, as marked */
-
 .root {
 	position: sticky;
 	top: -1px;
 	z-index: 900;
-	background: var(--background-color); /* from theme.module.css */
-	border-top: 1px solid var(--border-color); /* from theme.module.css */
+	background: var(--token-color-surface-primary);
+	border-top: 1px solid var(--token-color-border-faint);
 	border-bottom: 1px solid transparent;
 	transition: border-bottom-color 0.8s;
 
 	&.isSticky {
-		border-bottom-color: var(--border-color); /* from theme.module.css */
+		border-bottom-color: var(--token-color-border-faint);
 	}
 
 	/*
@@ -46,7 +44,7 @@
 
 .subnavInner {
 	display: grid;
-	grid-template-columns: minmax(max-content, 1fr) min-content;
+	grid-template-columns: max-content min-content;
 	align-items: center;
 	justify-content: space-between;
 	min-height: 62px;
@@ -58,7 +56,7 @@
 
 	&.notConstrained {
 		/* This padding should always match the horizontal padding of the main nav */
-		padding: 0 var(--hdsplus-spacing-05);
+		padding: 0 var(--mds-spacing-05);
 	}
 }
 

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