@hashicorp/react-components 0.0.0 → 1.0.1

package/src/components/card/partner-card/index.tsx

@@ -0,0 +1,69 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+import Image, { type ImageProps } from 'next/image'
+import Badge from '@hashicorp/react-design-system-components/src/components/badge'
+import FlightIcon from '@hashicorp/react-design-system-components/src/components/flight-icon'
+import { TextPlus } from '@hashicorp/react-design-system-components/src/components/text'
+import * as CardPrimitives from '../primitives'
+import type { CardProps } from '../types'
+import s from './style.module.css'
+
+export interface PartnerCardProps {
+	heading: string
+	description: string
+	meta: string[]
+	link: string
+	productBadges?: CardProps['productBadges']
+	competencyBadges?: string[]
+	logo: ImageProps
+	className?: string
+}
+
+export function PartnerCard({
+	heading,
+	description,
+	meta,
+	link,
+	productBadges,
+	competencyBadges,
+	logo,
+	className,
+}: PartnerCardProps) {
+	const hasProductBadges = productBadges && productBadges.length > 0
+	const hasCompetencyBadges = competencyBadges && competencyBadges.length > 0
+
+	return (
+		<CardPrimitives.Card
+			heading={heading}
+			link={link}
+			withArrow={false}
+			isExternal={false}
+			className={className}
+		>
+			<div className={s.logoContainer}>
+				<Image {...logo} alt={logo.alt} className={s.logo} />
+			</div>
+			<CardPrimitives.Content>
+				<CardPrimitives.Meta items={meta} />
+				<TextPlus.Body tag="p" size="200" className={s.description}>
+					{description}
+				</TextPlus.Body>
+				{hasProductBadges || hasCompetencyBadges ? (
+					<CardPrimitives.ProductBadges badges={productBadges || []}>
+						{hasCompetencyBadges &&
+							competencyBadges.map((competencyBadge, stableIdx) => (
+								<Badge
+									key={stableIdx}
+									text={competencyBadge}
+									icon={<FlightIcon name="dot" stretched />}
+								/>
+							))}
+					</CardPrimitives.ProductBadges>
+				) : null}
+			</CardPrimitives.Content>
+		</CardPrimitives.Card>
+	)
+}

package/src/components/card/partner-card/style.module.css

@@ -0,0 +1,24 @@
+.description {
+	-webkit-box-orient: vertical;
+	display: -webkit-box;
+	-webkit-line-clamp: 4;
+	max-width: 100%;
+	overflow: hidden;
+}
+
+.logoContainer {
+	position: relative;
+	display: flex;
+	aspect-ratio: 16 / 9;
+	overflow: hidden;
+	align-items: center;
+	justify-content: center;
+	background: var(--token-color-surface-faint);
+}
+
+.logo {
+	max-width: 232px;
+	max-height: 64px;
+	height: auto;
+	width: auto;
+}

package/src/components/card/person-card/index.test.tsx

@@ -0,0 +1,71 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+import { render, screen } from '@testing-library/react'
+import { PersonCard } from './index'
+
+const defaultProps = {
+	link: 'https://hashicorp.com',
+	name: 'Example name',
+	bio: 'Example bio',
+	location: 'Example location',
+	meta: ['August 15, 2022', 'Category'],
+	thumbnail: {
+		src: 'https://www.datocms-assets.com/19447/1648680074-screenshot-2022-03-31-at-00-40-47.png',
+		alt: 'HashiConf Europe 2022 Recap',
+	},
+}
+
+describe('<PersonCard />', () => {
+	// Prop tests
+	it('should render the provided name prop', () => {
+		render(<PersonCard {...defaultProps} />)
+
+		const name = screen.getByText(defaultProps.name)
+		expect(name.tagName).toBe('H2')
+	})
+
+	it('should render the provided bio prop', () => {
+		render(<PersonCard {...defaultProps} />)
+
+		const bio = screen.getByText(defaultProps.bio)
+		expect(bio.tagName).toBe('P')
+	})
+
+	it('should render the provided location prop', () => {
+		render(<PersonCard {...defaultProps} />)
+
+		const location = screen.getByText(defaultProps.location)
+		expect(location.tagName).toBe('P')
+	})
+
+	it('should render the correct thumbnail icon based on the provided link prop', () => {
+		const links = {
+			github: 'https://github.com',
+			twitter: 'https://twitter.com',
+			linkedin: 'https://linkedin.com',
+			link: 'https://example.com',
+			mail: 'mailto:name@example.com',
+		}
+
+		render(
+			<>
+				{Object.keys(links).map((platform) => (
+					<PersonCard key={platform} {...defaultProps} link={links[platform]} />
+				))}
+			</>
+		)
+
+		Object.keys(links).forEach((platform) => {
+			screen.getByTestId(`wpl-personcard-${platform}-icon`)
+		})
+	})
+
+	it('should not render a thumbnail icon when link is on hashicorp.com', () => {
+		render(<PersonCard {...defaultProps} link="https://hashicorp.com" />)
+
+		expect(screen.queryByTestId('wpl-personcard-link-icon')).toBeNull()
+	})
+})

package/src/components/card/person-card/index.tsx

@@ -0,0 +1,93 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+import { memo, type ReactNode } from 'react'
+import { TextPlus } from '@hashicorp/react-design-system-components/src/components/text'
+import { IconGithub16 } from '@hashicorp/flight-icons/svg-react/github-16'
+import { IconTwitter16 } from '@hashicorp/flight-icons/svg-react/twitter-16'
+import { IconLinkedin16 } from '@hashicorp/flight-icons/svg-react/linkedin-16'
+import { IconLink16 } from '@hashicorp/flight-icons/svg-react/link-16'
+import { IconMail16 } from '@hashicorp/flight-icons/svg-react/mail-16'
+import type { ProductBadgesProps, ThumbnailProps } from '../types'
+import * as CardPrimitives from '../primitives'
+import s from './style.module.css'
+
+export interface PersonCardProps {
+	thumbnail: ThumbnailProps
+	link: string
+	name: string
+	location?: string
+	bio?: string
+	productBadges?: ProductBadgesProps['badges']
+}
+
+// Map of hostnames to icons.
+/* eslint-disable react/jsx-key */
+const iconMap = new Map<string, ReactNode>([
+	// null signals that we don't want to render any icon
+	['hashicorp.com', null],
+	[
+		'twitter.com',
+		<IconTwitter16 data-testid={'wpl-personcard-twitter-icon'} />,
+	],
+	['github.com', <IconGithub16 data-testid={'wpl-personcard-github-icon'} />],
+	[
+		'linkedin.com',
+		<IconLinkedin16 data-testid={'wpl-personcard-linkedin-icon'} />,
+	],
+	['mailto:', <IconMail16 data-testid={'wpl-personcard-mail-icon'} />],
+])
+/* eslint-enable react/jsx-key */
+
+const Icon = memo(function Icon({ url }: { url: string }) {
+	const { protocol, host } = new URL(url)
+	const icon = iconMap.get(protocol === 'mailto:' ? 'mailto:' : host)
+
+	// If the icon value is null, don't render an icon
+	if (icon === null) {
+		return null
+	}
+
+	// Render the icon or the default icon if the icon value is undefined
+	return (
+		<div className={s.thumbnailIcon}>
+			{icon ?? <IconLink16 data-testid={'wpl-personcard-link-icon'} />}
+		</div>
+	)
+})
+
+export function PersonCard({
+	link,
+	thumbnail,
+	name,
+	location,
+	bio,
+	productBadges,
+}: PersonCardProps) {
+	return (
+		<CardPrimitives.Card heading={name} link={link} withArrow={false}>
+			<div className={s.thumbnailContainer}>
+				<CardPrimitives.PersonThumbnail {...thumbnail} />
+				<Icon url={link} />
+			</div>
+			<CardPrimitives.Content>
+				<div>
+					<CardPrimitives.Heading>{name}</CardPrimitives.Heading>
+					{location ? (
+						<TextPlus.Body tag="p" size="200" className={s.location}>
+							{location}
+						</TextPlus.Body>
+					) : null}
+				</div>
+				{bio ? (
+					<CardPrimitives.Description>{bio}</CardPrimitives.Description>
+				) : null}
+				{productBadges && productBadges?.length > 0 ? (
+					<CardPrimitives.ProductBadges badges={productBadges} />
+				) : null}
+			</CardPrimitives.Content>
+		</CardPrimitives.Card>
+	)
+}

package/src/components/card/person-card/style.module.css

@@ -0,0 +1,33 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+.location {
+	margin: 0;
+	color: var(--token-color-foreground-faint);
+}
+
+.thumbnailContainer {
+	position: relative;
+}
+
+.thumbnailIcon {
+	--size: 40px;
+
+	position: absolute;
+	bottom: 20px;
+	right: 20px;
+	width: var(--size);
+	height: var(--size);
+	display: grid;
+	place-items: center;
+	border-radius: 9999px;
+	overflow: hidden;
+	background-color: white;
+	opacity: 0.5;
+
+	& svg {
+		position: relative;
+	}
+}

package/src/components/card/primitives.tsx

@@ -0,0 +1,176 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+import * as React from 'react'
+import classNames from 'classnames'
+import Image from 'next/image'
+import Link from 'next/link'
+import HDSCard from '@hashicorp/react-design-system-components/src/components/card'
+import { TextPlus } from '@hashicorp/react-design-system-components/src/components/text'
+import { IconArrowRight24 } from '@hashicorp/flight-icons/svg-react/arrow-right-24'
+import ProductBadge from '../product-badge'
+import type {
+	CardPrimitiveProps,
+	ThumbnailProps,
+	MetaProps,
+	ContentProps,
+	HeadingProps,
+	ProductBadgesProps,
+	DescriptionProps,
+} from './types'
+import s from './style.module.css'
+
+const Card = React.forwardRef<HTMLAnchorElement, CardPrimitiveProps>(
+	(props, ref) => {
+		const {
+			withArrow = true,
+			heading,
+			link,
+			clickHandler,
+			isExternal,
+			hasBorder = true,
+			children,
+			className,
+		} = props
+
+		const linkProps = isExternal
+			? { target: '_blank', rel: 'noopener noreferrer' }
+			: {}
+
+		return (
+			<HDSCard
+				level="mid"
+				levelHover="high"
+				className={classNames(s.card, className)}
+				overflow="hidden"
+				hasBorder={hasBorder}
+			>
+				<div className={s.contentContainer}>
+					{children}
+
+					<div className={s.cta} data-testid="wpl-card-cta">
+						{withArrow ? <IconArrowRight24 /> : null}
+					</div>
+
+					<Link
+						href={link}
+						ref={ref}
+						className={s.link}
+						aria-label={heading}
+						onClickCapture={clickHandler}
+						{...linkProps}
+					/>
+				</div>
+			</HDSCard>
+		)
+	}
+)
+
+function Thumbnail({ src, alt }: ThumbnailProps) {
+	return (
+		<div className={s.thumbnail} data-testid="wpl-card-thumbnail">
+			<div className={s.image}>
+				<Image src={src} alt={alt} width={800} height={450} />
+			</div>
+		</div>
+	)
+}
+
+function PersonThumbnail({ src, alt }: ThumbnailProps) {
+	return (
+		<div className={s.personThumbnail} data-testid="wpl-card-thumbnail">
+			<div className={s.image}>
+				<Image src={src} alt={alt} width={800} height={450} />
+			</div>
+		</div>
+	)
+}
+
+function LogoThumbnail({ src, alt }: ThumbnailProps) {
+	return (
+		<div className={s.logoThumbnail} data-testid="wpl-card-logo-thumbnail">
+			<div className={s.image}>
+				<Image src={src} alt={alt} width={800} height={450} />
+			</div>
+		</div>
+	)
+}
+
+function Meta({ items }: MetaProps) {
+	return (
+		<ul className={s.meta} data-testid="wpl-card-meta">
+			{items.map((item, stableIdx) => {
+				return (
+					// eslint-disable-next-line react/no-array-index-key
+					<li key={stableIdx}>
+						<TextPlus.Label>
+							{item}
+							{stableIdx < items.length - 1 ? (
+								<span className={s.metaSeparator} aria-hidden={true}>
+									|
+								</span>
+							) : null}
+						</TextPlus.Label>
+					</li>
+				)
+			})}
+		</ul>
+	)
+}
+
+function Content({ children }: ContentProps) {
+	return (
+		<div className={s.content} data-testid="wpl-card-content">
+			{children}
+		</div>
+	)
+}
+
+function Heading({ as = 'h2', children }: HeadingProps) {
+	return (
+		<TextPlus.DisplayExpressive tag={as} size="200" className={s.heading}>
+			{children}
+		</TextPlus.DisplayExpressive>
+	)
+}
+
+function ProductBadges({ badges, children }: ProductBadgesProps) {
+	return (
+		<div className={s.productBadges} data-testid="wpl-card-badges">
+			{badges.map((badge, stableIdx) => {
+				return (
+					<ProductBadge
+						// eslint-disable-next-line react/no-array-index-key
+						key={`product-badge-${stableIdx}`}
+						productName={badge}
+						hasDot={true}
+					/>
+				)
+			})}
+			{children}
+		</div>
+	)
+}
+
+function Description({ children }: DescriptionProps) {
+	return (
+		<TextPlus.Body tag="p" size="200" className={s.description}>
+			{children}
+		</TextPlus.Body>
+	)
+}
+
+Card.displayName = 'Card'
+export {
+	Card,
+	Thumbnail,
+	PersonThumbnail,
+	LogoThumbnail,
+	Meta,
+	Content,
+	Heading,
+	Description,
+	ProductBadges,
+}

package/src/components/card/promo-card/index.tsx

@@ -0,0 +1,51 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+import * as CardPrimitives from '../primitives'
+import type { ThumbnailProps } from '../types'
+
+export interface PromoCardProps {
+	heading: string
+	description?: string
+	eyebrow?: string
+	link: string
+	clickHandler?: () => void
+	thumbnail?: ThumbnailProps
+	withArrow?: boolean
+	isExternal?: boolean
+	className?: string
+}
+
+export function PromoCard({
+	heading,
+	description,
+	eyebrow,
+	link,
+	clickHandler,
+	thumbnail,
+	withArrow = false,
+	isExternal = false,
+	className,
+}: PromoCardProps) {
+	return (
+		<CardPrimitives.Card
+			heading={heading}
+			link={link}
+			withArrow={withArrow}
+			isExternal={isExternal}
+			className={className}
+			clickHandler={clickHandler}
+		>
+			{thumbnail ? <CardPrimitives.Thumbnail {...thumbnail} /> : null}
+			<CardPrimitives.Content>
+				{eyebrow ? <CardPrimitives.Meta items={[eyebrow]} /> : null}
+				<CardPrimitives.Heading>{heading}</CardPrimitives.Heading>
+				{description ? (
+					<CardPrimitives.Description>{description}</CardPrimitives.Description>
+				) : null}
+			</CardPrimitives.Content>
+		</CardPrimitives.Card>
+	)
+}

package/src/components/card/resource-card/index.test.tsx

@@ -0,0 +1,48 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+import { render, screen } from '@testing-library/react'
+import { ResourceCard } from '.'
+
+const defaultProps = {
+	link: 'https://hashicorp.com',
+	heading: 'Example heading',
+	date: 'August 15, 2022',
+	category: 'Category',
+	thumbnail: {
+		src: 'https://www.datocms-assets.com/19447/1648680074-screenshot-2022-03-31-at-00-40-47.png',
+		alt: 'HashiConf Europe 2022 Recap',
+	},
+}
+
+describe('<ResourceCard />', () => {
+	it('should render the provided date and category with separator', () => {
+		const expectedMeta = [defaultProps.date, defaultProps.category]
+
+		render(<ResourceCard {...defaultProps} />)
+
+		const metaElement = screen.getByTestId('wpl-card-meta')
+
+		expectedMeta.forEach((item) => {
+			expect(metaElement).toContainElement(screen.getByText(item))
+		})
+
+		expect(metaElement).toContainElement(screen.getByText('|'))
+	})
+
+	it('should not render the date if no date is provided', () => {
+		const defaultPropsWithoutDate = { ...defaultProps, date: '' }
+
+		render(<ResourceCard {...defaultPropsWithoutDate} />)
+
+		const metaElement = screen.getByTestId('wpl-card-meta')
+
+		expect(metaElement).toContainElement(
+			screen.getByText(defaultProps.category)
+		)
+
+		expect(metaElement).not.toContainElement(screen.queryByText('|'))
+	})
+})

package/src/components/card/resource-card/index.tsx

@@ -0,0 +1,37 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+import type { CardProps, ThumbnailProps } from '../types'
+import { UnifiedCard } from '../unified-card'
+
+export interface ResourceCardProps {
+	heading: string
+	date?: string
+	category: string
+	link: string
+	productBadges?: CardProps['productBadges']
+	thumbnail: ThumbnailProps
+}
+
+export function ResourceCard({
+	heading,
+	date,
+	category,
+	link,
+	productBadges,
+	thumbnail,
+}: ResourceCardProps) {
+	const meta: string[] = date ? [date, category] : [category]
+
+	return (
+		<UnifiedCard
+			heading={heading}
+			link={link}
+			meta={meta}
+			productBadges={productBadges}
+			thumbnail={thumbnail}
+		/>
+	)
+}