@hashicorp/react-components 0.0.0-nightly.c8285f7 → 0.0.0-nightly.ccaa529

package/src/components/subnav/index.tsx

@@ -18,6 +18,7 @@ import traverse, { isObject } from './helpers/traverse'
 import { areBasePathsMatching } from './helpers/areBasePathsMatching'
 import * as NavigationMenu from '@radix-ui/react-navigation-menu'
 import s from './style.module.css'
+import { getLocalizedHref } from '@web/utils/get-localized-href'
 
 const productAllowList = {
 	consul: 'consul',
@@ -46,6 +47,7 @@ type SubnavDropdown = {
 type MenuItem = SubnavLink | SubnavDropdown | 'divider'
 
 export interface SubnavInnerProps {
+	locale?: string
 	hasOverflow?: boolean
 	titleLink: { text: string; url: string }
 	product?: Products
@@ -61,6 +63,7 @@ export interface SubnavInnerProps {
 }
 
 function SubnavInner({
+	locale,
 	hasOverflow,
 	titleLink,
 	product,
@@ -109,17 +112,20 @@ function SubnavInner({
 			>
 				<NavigationMenu.Link asChild>
 					<TitleLink
+						locale={locale}
 						text={titleLink.text}
-						url={titleLink.url}
+						url={getLocalizedHref(titleLink.url)}
 						product={product}
 						theme={theme}
 					/>
 				</NavigationMenu.Link>
+
 				{!hasOverflow && (
 					<div className={s.subNavRight}>
 						<MenuItemsDefault
 							menuItems={menuItemsWithActive}
 							activatePanel={activatePanel}
+							locale={locale}
 						/>
 						{ctaLinks?.length > 0 && (
 							<CtaLinks
@@ -164,6 +170,10 @@ function Subnav({ className, theme = 'light', ...restProps }: SubnavProps) {
 		setActivePanel(panel)
 	}
 
+	const ariaLabel = restProps?.titleLink?.text
+		? `${restProps.titleLink.text} pages`
+		: 'Subnav pages'
+
 	return (
 		<>
 			{/**
@@ -179,7 +189,7 @@ function Subnav({ className, theme = 'light', ...restProps }: SubnavProps) {
 					[s.hasOverflow]: hasOverflow,
 					'hdsplus-dark-mode': theme === 'dark',
 				})}
-				aria-label={`${product} website navigation`}
+				aria-label={ariaLabel}
 				onValueChange={activatePanel}
 				value={activePanel}
 				delayDuration={0}

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

@@ -3,19 +3,20 @@
  * SPDX-License-Identifier: MPL-2.0
  */
 
-import Button, {
-	type ButtonProps,
-} from '@hashicorp/react-design-system-components/src/components/button'
-import FlightIcon from '@hashicorp/react-design-system-components/src/components/flight-icon'
+import {
+	HDSPlusButton,
+	type HDSPlusButtonProps,
+} from '@hashicorp/react-mds/src/hds-plus/button'
+import FlightIcon from '@hashicorp/react-hds/src/components/flight-icon'
 import type { Products } from '@hashicorp/platform-product-meta'
-import type { ToggleButtonProps } from '@hashicorp/react-design-system-components/src/components/dropdown/toggle/button'
-import * as Dropdown from '@hashicorp/react-design-system-components/src/components/dropdown'
+import type { ToggleButtonProps } from '@hashicorp/react-hds/src/components/dropdown/toggle/button'
+import * as Dropdown from '@hashicorp/react-hds/src/components/dropdown'
 import GithubStarsLink from './github-stars-link'
 import classNames from 'classnames'
 import * as NavigationMenu from '@radix-ui/react-navigation-menu'
 import s from './style.module.css'
 
-type CtaLink = ButtonProps & { href: string; __typename?: string }
+type CtaLink = HDSPlusButtonProps & { href: string; __typename?: string }
 
 type CtaDropdown = {
 	__typename?: string
@@ -83,7 +84,7 @@ function CtaLinks({
 						const isLastButton = stableIdx === links.length - 1
 
 						return (
-							<Button
+							<HDSPlusButton
 								key={href}
 								text={text}
 								href={href}

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

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: MPL-2.0
  */
 
-import FlightIcon from '@hashicorp/react-design-system-components/src/components/flight-icon'
+import FlightIcon from '@hashicorp/react-hds/src/components/flight-icon'
 import NavItemText from '../nav-item-text'
 import * as NavigationMenu from '@radix-ui/react-navigation-menu'
 import s from './style.module.css'

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

@@ -9,7 +9,8 @@ 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-design-system-components/src/components/flight-icon'
+import FlightIcon from '@hashicorp/react-hds/src/components/flight-icon'
+import { getLocalizedHref } from '@web/utils/get-localized-href'
 
 interface MenuItemsDefaultProps {
 	menuItems: (
@@ -27,10 +28,11 @@ interface MenuItemsDefaultProps {
 		| '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) => {
@@ -47,6 +49,7 @@ function MenuItemsDefault(props: MenuItemsDefaultProps) {
 						text={text}
 						submenu={submenu}
 						activatePanel={activatePanel}
+						locale={locale}
 					/>
 				) : (
 					<NavLink
@@ -56,6 +59,7 @@ function MenuItemsDefault(props: MenuItemsDefaultProps) {
 						text={text}
 						url={url}
 						isActive={_isActiveUrl}
+						locale={locale}
 					/>
 				)
 			})}
@@ -75,14 +79,19 @@ 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}
+					href={getLocalizedHref(url, locale)}
+					hrefLang={props.locale ? props.locale : undefined}
+				>
 					<NavItemText isActive={isActive} text={text} />
 				</Link>
 			</NavigationMenu.Link>
@@ -94,6 +103,7 @@ interface NavLinkWithDropdownProps {
 	text: string
 	submenu: { icon: string; text: string; url: string; _isActiveUrl: string }[]
 	activatePanel: (panel: string) => void
+	locale?: string
 }
 
 interface NavLinkWithDropdownState {
@@ -105,7 +115,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 = () => {
@@ -139,7 +149,11 @@ class NavLinkWithDropdown extends React.Component<
 									// 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}
+												href={getLocalizedHref(url, locale)}
+												hrefLang={locale ? locale : undefined}
+											>
 												{icon ? <FlightIcon name={icon} /> : null}
 												{text}
 											</Link>

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

@@ -12,7 +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-design-system-components/src/components/flight-icon'
+import FlightIcon from '@hashicorp/react-hds/src/components/flight-icon'
+import { getLocalizedHref } from '@web/utils/get-localized-href'
 
 interface MenuItemsOverflowProps {
 	menuItems: (
@@ -29,6 +30,7 @@ interface MenuItemsOverflowProps {
 	menuText: string
 	constrainWidth?: boolean
 	activatePanel: (panel: string) => void
+	locale?: string
 }
 
 interface MenuItemsOverflowState {
@@ -48,6 +50,7 @@ class MenuItemsOverflow extends React.Component<
 			menuText,
 			constrainWidth,
 			activatePanel,
+			locale,
 		} = this.props
 
 		const handleFocusOutside = () => {
@@ -91,6 +94,7 @@ class MenuItemsOverflow extends React.Component<
 													url={subItem.url}
 													text={subItem.text}
 													icon={subItem.icon}
+													locale={locale}
 												/>
 											))}
 											<hr className={s.divider} />
@@ -125,13 +129,19 @@ interface SubmenuItemProps {
 	icon?: string
 	url: string
 	text: string
+	locale?: string
 }
 
-function SubmenuItem({ icon, url, text }: SubmenuItemProps) {
+function SubmenuItem({ icon, url, text, locale }: SubmenuItemProps) {
 	return (
 		<li>
 			<NavigationMenu.Link asChild>
-				<Link className={s.submenuItem} href={url} title={vercelSplit(text)}>
+				<Link
+					className={s.submenuItem}
+					href={getLocalizedHref(url, locale)}
+					title={vercelSplit(text)}
+					hrefLang={locale ? locale : undefined}
+				>
 					{icon ? <FlightIcon name={icon} /> : null}
 					{text}
 				</Link>

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

@@ -41,6 +41,7 @@ const logoDict = {
 }
 
 interface TitleLinkProps {
+	locale?: string
 	text: string
 	url: string
 	product?: string
@@ -80,7 +81,7 @@ function getLogo(
 }
 
 const TitleLink = forwardRef<HTMLAnchorElement, TitleLinkProps>(
-	({ text, url, product, theme }, ref) => {
+	({ text, url, product, theme, locale }, ref) => {
 		const parsedText = vercelSplit(text)
 		const Logo = getLogo(parsedText, theme)
 
@@ -94,6 +95,7 @@ const TitleLink = forwardRef<HTMLAnchorElement, TitleLinkProps>(
 				href={url}
 				title={parsedText}
 				ref={ref}
+				hrefLang={locale ? locale : undefined}
 			>
 				{Logo ? (
 					<Image

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

@@ -44,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;

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)
@@ -28,8 +34,36 @@ 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)
+	})
+})

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

@@ -1,9 +1,47 @@
+export const hashicorpDestinations: string[] = [
+	'app.terraform.io',
+	'boundaryproject.io',
+	'cloud.hashicorp.com',
+	'consul.io',
+	'developer.hashicorp.com',
+	'hashicorp.com',
+	'nomadproject.io',
+	'packer.io',
+	'portal.cloud.hashicorp.com',
+	'registry.terraform.io',
+	'terraform.io',
+	'vagrantup.com',
+	'vaultproject.io',
+	'waypointproject.io',
+] as const
+
+const containsHashiCorpDestination = (str: string): boolean =>
+	hashicorpDestinations.some(function (destination) {
+		return str.indexOf(destination) >= 0
+	})
+
+/**
+ * This function determines if a `url` is a HashiCorp link (relative URLs, hashes,
+ * or a url with a HashiCorp domain) or a  non-HashiCorp link.
+ *
+ * @param {string | undefined} url - The URL to be parsed. It may be a relative URL, an anchor, or a full external/internal URL.
+ *
+ * @returns {{ linkType: 'inbound' | 'outbound', href: string }}
+ *   An object with two properties:
+ *     - `linkType`: Indicates whether the URL is 'inbound' or 'outbound'. Can be used to conditionally
+ * 		     render the value of the target attribute.
+ *     - `href`: The parsed href (may include pathname, search, and hash for internal URLs).
+ *
+ * @throws {Error} Throws an error if the URL is undefined or invalid.
+ */
+
 export function parseUrl(url: string | undefined): {
-	linkType: 'inbound' | 'outbound'
+	linkType: 'inbound' | 'outbound' | ''
 	href: string
 } {
 	if (!url) {
-		throw new Error('url is required')
+		console.log('No url to parse, returning empty string')
+		return { linkType: '', href: '' }
 	}
 
 	if (isRelative(url) || isAnchor(url)) {
@@ -12,21 +50,50 @@ export function parseUrl(url: string | undefined): {
 
 	if (isInternal(url)) {
 		try {
-			const { pathname, search } = new URL(url)
-			const href = pathname + search
+			const { pathname, search, hash } = new URL(url)
+			const href = pathname + search + hash
 			return { linkType: 'inbound', href }
 		} catch (error) {
-			throw new Error(`Invalid href: ${url}`)
+			console.log(`Invalid href: ${url}`)
+			return { linkType: '', href: '' }
 		}
 	}
 
 	return { linkType: 'outbound', href: url }
 }
 
-const isRelative = (url) => url.startsWith('/')
-const isAnchor = (url) => url.startsWith('#')
+const isRelative = (url: string) => url.startsWith('/')
+const isAnchor = (url: string) => url.startsWith('#')
+
+/**
+ * Determines whether the provided url uses hashicorp.com or www.hashicorp.com as the hostname.
+ *
+ * @param {string} url - The URL to check.
+ * @returns {boolean} - Returns true if the link uses a HashiCorp domain, otherwise false.
+ */
 
-export const isInternal = (url) => {
+export const isInternal = (url: string): boolean => {
 	const hostname = new URL(url).hostname
-	return hostname === 'hashicorp.com'
+	return hostname === 'hashicorp.com' || hostname === 'www.hashicorp.com'
+}
+
+/**
+ * Determines whether the provided url uses a HashiCorp hostname. This is used in several
+ * components to open a new tab for non-HashiCorp links.
+ *
+ * @param {string} url - The URL to check.
+ * @returns {boolean} - Returns true if the link uses a HashiCorp domain, otherwise false.
+ */
+
+export const hasHashiCorpDestination = (url: string): boolean => {
+	// Fast return in case a relative URL or anchor is passed in
+	if (isRelative(url) || isAnchor(url)) return true
+	try {
+		const hostname = new URL(url).hostname
+		const isHashiCorpDestination = containsHashiCorpDestination(hostname)
+		return isHashiCorpDestination
+	} catch (e) {
+		console.error('Error: `url` is not a valid URL', e)
+		return false
+	}
 }

package/src/components/consent-manager/README.md

@@ -1,73 +0,0 @@
-# Consent Manager
-
-A GDPR-compliant consent manager.
-
-### Props
-
-- `version` (integer) - version number, bump up to override previous consent preferences
-- `container` (string) - id of container where the consent manager should live
-- `companyName` (string) - your company name to be inserted in various copy
-- `privacyPolicyLink` (string) - link to your company's privacy policy
-- `segmentWriteKey` (string) - your production segment write key
-- `segmentServices` (array of objects) - use this to override the category or description of a service provided by Segment
-  - `name` - name of the Segment integration, must match the integration you are overriding
-  - `category` _[optional]_ - new category name
-  - `description` _[optional]_ - new description
-- `categories` (array) - State of toggle
-  - `name` - name of category
-  - `description` - description for the category
-- `additionalServices` (array of objects) - additional integrations outside of Segment that you wish to include in the consent manager
-  - `name` - name of service
-  - `description` - description of service
-  - `category` - category of service
-  - `body` _[optional]_ - javascript body associated with service _If present, overrides `url` below_
-  - `url` _[optional]_ - url of js file associated with service
-  - `async` (bool) _[optional]_ - add `async` property to script element
-  - `addToBody` (bool) _[optional]_ - inject script before closing `<body>` tag
-  - `dataAttrs` (arr) _[optional]_ - array of `data-` attributes to add to script tag
-    - `name` (str) - name of data attribute (`data-name`)
-    - `value` (str) - value of `data` attribute to set
-- `showDialog` (bool) - whether or not the dialog `open` attribute is true
-
-
-## `SegmentPreloadScript`
-
-In `v9.0.0`, ConsentManager now exports a `SegmentPreloadScript` component. Why? ConsentManager uses a very similar Segment script to the current preloading script that we use in our `_document.tsx/js` files.
-
-Now that we're updating both with a custom Segment AJS URL and CDN hostname, it makes sense for the two to be co-located.
-
-Expect the new change to look like the following:
-
-```diff
-// pages/_document.tsx
-
-
-  import Document, { Html, Head, Main, NextScript } from 'next/document'
-  import HashiHead from '@hashicorp/react-head'
-+ import { SegmentPreloadScript } from '@web/react-components/src/components/consent-manager/scripts/segment'
-  // other imports
-
-  export default class MyDocument extends Document {
-    static async getInitialProps(ctx) {
-      const initialProps = await Document.getInitialProps(ctx)
-      return { ...initialProps }
-    }
-
-    render() {
-      return (
-        <Html lang="en">
-          <Head>
-            <HashiHead />
-          </Head>
-          <body>
--           <script
--             dangerouslySetInnerHTML={{
--               __html: `!function(){var analytics=window... ... ...`
--             }}
--           />
-+           <SegmentPreloadScript />
-
-// etc...
-```
-
-No additional updates are necessary!

package/src/components/consent-manager/components/banner/banner.module.css

@@ -1,23 +0,0 @@
-.root {
-	background-color: var(--token-color-surface-strong);
-	width: 100%;
-	padding: 10px 15px;
-	position: fixed;
-	bottom: 0;
-	left: 0;
-	z-index: 10;
-	font-size: 0.9rem;
-}
-
-.innerContainer {
-	composes: g-grid-container from global;
-	display: flex;
-	justify-content: space-between;
-	align-items: center;
-	gap: var(--hdsplus-spacing-01);
-	flex-direction: column;
-
-	@media (min-width: 1350px) {
-		flex-direction: row;
-	}
-}

package/src/components/consent-manager/components/banner/banner.test.tsx

@@ -1,31 +0,0 @@
-import { render, screen, fireEvent } from '@testing-library/react'
-import ConsentBanner from './banner'
-
-test('should display the correct privacy policy url', () => {
-	const testValue = 'test'
-	render(<ConsentBanner privacyPolicyLink={testValue} />)
-	expect(screen.getByTestId('privacy-policy')).toHaveAttribute(
-		'href',
-		testValue
-	)
-})
-
-test('should display the correct cookie policy url', () => {
-	const testValue = 'test'
-	render(<ConsentBanner cookiePolicyLink={testValue} />)
-	expect(screen.getByTestId('cookie-policy')).toHaveAttribute('href', testValue)
-})
-
-test('should run the onManagePreferences function when the correct button is clicked', () => {
-	const mock = vi.fn()
-	render(<ConsentBanner onManagePreferences={mock} />)
-	fireEvent.click(screen.getByTestId('manage-preferences'))
-	expect(mock).toHaveBeenCalled()
-})
-
-test('should run the onAccept function when the correct button is clicked', () => {
-	const mock = vi.fn()
-	render(<ConsentBanner onAccept={mock} />)
-	fireEvent.click(screen.getByTestId('accept'))
-	expect(mock).toHaveBeenCalled()
-})

package/src/components/consent-manager/components/banner/banner.tsx

@@ -1,73 +0,0 @@
-import Link from 'next/link'
-import Button from '@hashicorp/react-design-system-components/src/components/button'
-import ButtonSet from '@hashicorp/react-design-system-components/src/components/button-set'
-import Text from '@hashicorp/react-design-system-components/src/components/text'
-import s from './banner.module.css'
-
-interface ConsentBannerProps {
-	preferences?: { loadAll?: boolean }
-	privacyPolicyLink?: string
-	cookiePolicyLink?: string
-	onManagePreferences?: () => void
-	onAccept?: () => void
-}
-
-export default function ConsentBanner({
-	preferences,
-	privacyPolicyLink,
-	cookiePolicyLink,
-	onManagePreferences,
-	onAccept,
-}: ConsentBannerProps) {
-	return (
-		<div className={s.root} data-testid="consent-banner">
-			<div className={s.innerContainer}>
-				<Text.Body color="primary">
-					We use cookies & other similar technology to collect data to improve
-					your experience on our site, as described in our{' '}
-					<Link
-						href={
-							privacyPolicyLink ?? 'https://www.hashicorp.com/trust/privacy'
-						}
-						className={s.link}
-						target="_blank"
-						rel="noopener noreferrer"
-						data-testid="privacy-policy"
-					>
-						Privacy Policy
-					</Link>{' '}
-					and{' '}
-					<Link
-						href={
-							cookiePolicyLink ??
-							'https://www.hashicorp.com/trust/privacy/cookies'
-						}
-						className={s.link}
-						target="_blank"
-						rel="noopener noreferrer"
-						data-testid="cookie-policy"
-					>
-						Cookie Policy
-					</Link>
-					.
-				</Text.Body>
-				<div>
-					<ButtonSet>
-						<Button
-							onClick={onManagePreferences}
-							color="secondary"
-							data-testid="manage-preferences"
-							text="Manage Preferences"
-						/>
-						<Button
-							onClick={onAccept}
-							color="primary"
-							data-testid="accept"
-							text={preferences?.loadAll ? 'Dismiss' : 'Accept'}
-						/>
-					</ButtonSet>
-				</div>
-			</div>
-		</div>
-	)
-}