@hashicorp/react-components 0.0.0-nightly.546d10f → 0.0.0-nightly.57c5289

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/package.json +2 -2
  2. package/src/components/card/index.test.tsx +1 -1
  3. package/src/components/card/newsroom-card/index.test.tsx +1 -1
  4. package/src/components/card/primitives.tsx +14 -13
  5. package/src/components/card/resource-card/index.test.tsx +1 -1
  6. package/src/components/card/types.ts +2 -2
  7. package/src/components/card/unified-card/index.spec.tsx +40 -0
  8. package/src/components/card/unified-card/index.tsx +4 -10
  9. package/src/components/nav-panel/components/link-list/index.tsx +6 -5
  10. package/src/components/nav-panel/components/promo/index.tsx +6 -6
  11. package/src/components/subnav/index.tsx +5 -1
  12. package/src/components/subnav/partials/MenuItemsOverflow/index.tsx +2 -2
  13. package/src/components/subnav/partials/TitleLink/index.tsx +2 -2
  14. package/src/lib/v/index.ts +4 -5
  15. package/src/components/consent-manager/README.md +0 -73
  16. package/src/components/consent-manager/components/banner/banner.module.css +0 -23
  17. package/src/components/consent-manager/components/banner/banner.test.tsx +0 -31
  18. package/src/components/consent-manager/components/banner/banner.tsx +0 -73
  19. package/src/components/consent-manager/components/dialog/dialog.module.css +0 -145
  20. package/src/components/consent-manager/components/dialog/dialog.test.tsx +0 -194
  21. package/src/components/consent-manager/components/dialog/dialog.tsx +0 -339
  22. package/src/components/consent-manager/img/icn_close.tsx +0 -19
  23. package/src/components/consent-manager/index.test.tsx +0 -334
  24. package/src/components/consent-manager/index.tsx +0 -186
  25. package/src/components/consent-manager/loader/README.md +0 -29
  26. package/src/components/consent-manager/loader/categories.ts +0 -22
  27. package/src/components/consent-manager/loader/index.tsx +0 -94
  28. package/src/components/consent-manager/loader/presets/enterprise.ts +0 -12
  29. package/src/components/consent-manager/loader/presets/oss.ts +0 -10
  30. package/src/components/consent-manager/loader/services.ts +0 -45
  31. package/src/components/consent-manager/scripts/custom.tsx +0 -59
  32. package/src/components/consent-manager/scripts/segment.tsx +0 -87
  33. package/src/components/consent-manager/style.module.css +0 -9
  34. package/src/components/consent-manager/types.ts +0 -55
  35. package/src/components/consent-manager/util/cookies.test.ts +0 -75
  36. package/src/components/consent-manager/util/cookies.ts +0 -70
  37. package/src/components/consent-manager/util/integrations.test.ts +0 -115
  38. package/src/components/consent-manager/util/integrations.ts +0 -110
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hashicorp/react-components",
3
- "version": "0.0.0-nightly.546d10f",
3
+ "version": "0.0.0-nightly.57c5289",
4
4
  "main": "src/index.ts",
5
5
  "scripts": {
6
6
  "lint": "next-hashicorp lint",
@@ -8,7 +8,7 @@
8
8
  "test:watch": "vitest watch"
9
9
  },
10
10
  "dependencies": {
11
- "@hashicorp/flight-icons": "^3.5.0",
11
+ "@hashicorp/flight-icons": "^3.7.0",
12
12
  "@hashicorp/platform-product-meta": "^0.1.1",
13
13
  "@hashicorp/platform-util": "^0.2.0",
14
14
  "@hashicorp/react-design-system-components": "*",
@@ -56,7 +56,7 @@ describe('<Card />', () => {
56
56
  const metaElement = screen.getByTestId('wpl-card-meta')
57
57
 
58
58
  cardMeta.forEach((item) => {
59
- expect(metaElement).toContainElement(screen.getByText(item))
59
+ expect(metaElement).toHaveTextContent(item)
60
60
  })
61
61
  expect(metaElement).toContainElement(screen.getByText('|'))
62
62
  })
@@ -26,7 +26,7 @@ describe('<NewsroomCard />', () => {
26
26
  const metaElement = screen.getByTestId('wpl-card-meta')
27
27
 
28
28
  expectedMeta.forEach((item) => {
29
- expect(metaElement).toContainElement(screen.getByText(item))
29
+ expect(metaElement).toHaveTextContent(item)
30
30
  })
31
31
 
32
32
  expect(metaElement).toContainElement(screen.queryByText('|'))
@@ -33,6 +33,7 @@ const Card = React.forwardRef<HTMLAnchorElement, CardPrimitiveProps>(
33
33
  hasBorder = true,
34
34
  children,
35
35
  className,
36
+ 'aria-label': ariaLabel,
36
37
  } = props
37
38
 
38
39
  const linkProps = isExternal
@@ -58,7 +59,7 @@ const Card = React.forwardRef<HTMLAnchorElement, CardPrimitiveProps>(
58
59
  href={link}
59
60
  ref={ref}
60
61
  className={s.link}
61
- aria-label={heading}
62
+ aria-label={ariaLabel ?? heading}
62
63
  onClickCapture={clickHandler}
63
64
  {...linkProps}
64
65
  />
@@ -100,23 +101,23 @@ function LogoThumbnail({ src, alt }: ThumbnailProps) {
100
101
 
101
102
  function Meta({ items }: MetaProps) {
102
103
  return (
103
- <ul className={s.meta} data-testid="wpl-card-meta">
104
- {items.map((item, stableIdx) => {
105
- return (
106
- // eslint-disable-next-line react/no-array-index-key
107
- <li key={stableIdx}>
108
- <TextPlus.Label>
104
+ <div className={s.meta} data-testid="wpl-card-meta">
105
+ <TextPlus.Label>
106
+ {items.map((item, stableIdx) => {
107
+ const isLastItem = stableIdx === items.length - 1
108
+ return (
109
+ <>
109
110
  {item}
110
- {stableIdx < items.length - 1 ? (
111
+ {!isLastItem ? (
111
112
  <span className={s.metaSeparator} aria-hidden={true}>
112
113
  |
113
114
  </span>
114
115
  ) : null}
115
- </TextPlus.Label>
116
- </li>
117
- )
118
- })}
119
- </ul>
116
+ </>
117
+ )
118
+ })}
119
+ </TextPlus.Label>
120
+ </div>
120
121
  )
121
122
  }
122
123
 
@@ -26,7 +26,7 @@ describe('<ResourceCard />', () => {
26
26
  const metaElement = screen.getByTestId('wpl-card-meta')
27
27
 
28
28
  expectedMeta.forEach((item) => {
29
- expect(metaElement).toContainElement(screen.getByText(item))
29
+ expect(metaElement).toHaveTextContent(item)
30
30
  })
31
31
 
32
32
  expect(metaElement).toContainElement(screen.getByText('|'))
@@ -10,14 +10,14 @@ import type { PersonCardProps } from './person-card'
10
10
  import type { ResourceCardProps } from './resource-card'
11
11
  import type { UnifiedCardProps } from './unified-card'
12
12
 
13
- export interface BaseCardProps {
13
+ export interface BaseCardProps
14
+ extends React.AnchorHTMLAttributes<HTMLAnchorElement> {
14
15
  withArrow?: boolean
15
16
  heading: string
16
17
  link: string
17
18
  clickHandler?: () => void
18
19
  isExternal?: boolean
19
20
  hasBorder?: boolean
20
- className?: string
21
21
  }
22
22
 
23
23
  export interface CardPrimitiveProps extends BaseCardProps {
@@ -0,0 +1,40 @@
1
+ /**
2
+ * Copyright (c) HashiCorp, Inc.
3
+ * SPDX-License-Identifier: MPL-2.0
4
+ */
5
+
6
+ import { render, screen } from '@testing-library/react'
7
+ import { UnifiedCard, UnifiedCardProps } from '.'
8
+
9
+ const defaultProps: UnifiedCardProps = {
10
+ link: 'https://hashicorp.com',
11
+ heading: 'Example heading',
12
+ thumbnail: {
13
+ src: 'https://www.datocms-assets.com/19447/1648680074-screenshot-2022-03-31-at-00-40-47.png',
14
+ alt: 'HashiConf Europe 2022 Recap',
15
+ },
16
+ } as const
17
+
18
+ describe(`<UnifiedCard />`, () => {
19
+ it('should render the provided meta with a separator if n > 1', () => {
20
+ const expectedMeta = ['Category', 'Hello']
21
+ render(<UnifiedCard {...defaultProps} meta={expectedMeta} />)
22
+
23
+ const metaElement = screen.getByTestId('wpl-card-meta')
24
+
25
+ expectedMeta.forEach((item) => {
26
+ expect(metaElement).toHaveTextContent(item)
27
+ })
28
+
29
+ expect(metaElement).toContainElement(screen.getByText('|'))
30
+ })
31
+
32
+ it('it should not render a separator if n === 1', () => {
33
+ render(<UnifiedCard {...defaultProps} meta={['Category']} />)
34
+ const metaElement = screen.getByTestId('wpl-card-meta')
35
+
36
+ expect(metaElement).toContainElement(screen.getByText('Category'))
37
+
38
+ expect(metaElement).not.toContainElement(screen.queryByText('|'))
39
+ })
40
+ })
@@ -6,18 +6,10 @@
6
6
  import type { ReactNode } from 'react'
7
7
  import Badge from '@hashicorp/react-design-system-components/src/components/badge'
8
8
  import * as CardPrimitives from '../primitives'
9
- import type { CardProps, ThumbnailProps } from '../types'
9
+ import type { CardProps } from '../types'
10
10
 
11
- export interface UnifiedCardProps {
12
- heading: string
13
- meta?: string[]
14
- link: string
15
- productBadges?: CardProps['productBadges']
11
+ export interface UnifiedCardProps extends CardProps {
16
12
  badges?: (string | [ReactNode, string])[]
17
- thumbnail?: ThumbnailProps
18
- withArrow?: boolean
19
- isExternal?: boolean
20
- className?: string
21
13
  }
22
14
 
23
15
  export function UnifiedCard({
@@ -30,6 +22,7 @@ export function UnifiedCard({
30
22
  withArrow = false,
31
23
  isExternal = false,
32
24
  className,
25
+ 'aria-label': ariaLabel,
33
26
  }: UnifiedCardProps) {
34
27
  return (
35
28
  <CardPrimitives.Card
@@ -38,6 +31,7 @@ export function UnifiedCard({
38
31
  withArrow={withArrow}
39
32
  isExternal={isExternal}
40
33
  className={className}
34
+ aria-label={ariaLabel ?? heading}
41
35
  >
42
36
  {thumbnail ? <CardPrimitives.Thumbnail {...thumbnail} /> : null}
43
37
  <CardPrimitives.Content>
@@ -1,6 +1,6 @@
1
1
  import Link from 'next/link'
2
2
  import { parseUrl } from '../../../../lib/parse-url'
3
- import { v } from '../../../../lib/v'
3
+ import { vercelSplit } from '../../../../lib/v'
4
4
  import FlightIcon from '@hashicorp/react-design-system-components/src/components/flight-icon'
5
5
  import * as NavigationMenu from '@radix-ui/react-navigation-menu'
6
6
  import s from './style.module.css'
@@ -44,8 +44,9 @@ export default function LinkList({ links, linkClickHandler }: LinkListProps) {
44
44
  let style
45
45
  link.iconGradient
46
46
  ? (style = {
47
- '--iconGradient': GRADIENT_VALUE_MAP.get(v(link.iconGradient))
48
- ?.iconGradient,
47
+ '--iconGradient': GRADIENT_VALUE_MAP.get(
48
+ vercelSplit(link.iconGradient)
49
+ )?.iconGradient,
49
50
  } as React.CSSProperties)
50
51
  : (style = null)
51
52
  return (
@@ -60,12 +61,12 @@ export default function LinkList({ links, linkClickHandler }: LinkListProps) {
60
61
  >
61
62
  {link.iconGradient && link.icon ? (
62
63
  <div className={s.iconBackground} style={style}>
63
- <FlightIcon name={v(link.icon)} />
64
+ <FlightIcon name={vercelSplit(link.icon)} />
64
65
  </div>
65
66
  ) : (
66
67
  link.icon && (
67
68
  <FlightIcon
68
- name={v(link.icon)}
69
+ name={vercelSplit(link.icon)}
69
70
  color="var(--token-color-foreground-faint)"
70
71
  />
71
72
  )
@@ -1,6 +1,6 @@
1
1
  import { useCallback } from 'react'
2
2
  import classNames from 'classnames'
3
- import { v } from '../../../../lib/v'
3
+ import { vercelSplit } from '../../../../lib/v'
4
4
  import Link from 'next/link'
5
5
  import { parseUrl } from '../../../../lib/parse-url'
6
6
  import { trackNavClickEvent } from '../../../../lib/track-nav-click-event'
@@ -51,19 +51,19 @@ export default function Promo({
51
51
  {icon && (
52
52
  <div
53
53
  className={classNames(s.icon, {
54
- [s.hashidays]: v(theme) === 'hashidays',
55
- [s.hashiconf]: v(theme) === 'hashiconf',
54
+ [s.hashidays]: vercelSplit(theme) === 'hashidays',
55
+ [s.hashiconf]: vercelSplit(theme) === 'hashiconf',
56
56
  })}
57
57
  >
58
- <FlightIcon name={v(icon)} />
58
+ <FlightIcon name={vercelSplit(icon)} />
59
59
  </div>
60
60
  )}
61
61
  <div className={s.rightContent}>
62
62
  <div>
63
63
  <div
64
64
  className={classNames(s.title, {
65
- [s.hashidays]: v(theme) === 'hashidays',
66
- [s.hashiconf]: v(theme) === 'hashiconf',
65
+ [s.hashidays]: vercelSplit(theme) === 'hashidays',
66
+ [s.hashiconf]: vercelSplit(theme) === 'hashiconf',
67
67
  })}
68
68
  >
69
69
  {title}
@@ -164,6 +164,10 @@ function Subnav({ className, theme = 'light', ...restProps }: SubnavProps) {
164
164
  setActivePanel(panel)
165
165
  }
166
166
 
167
+ const ariaLabel = restProps?.titleLink?.text
168
+ ? `${restProps.titleLink.text} pages`
169
+ : 'Subnav pages'
170
+
167
171
  return (
168
172
  <>
169
173
  {/**
@@ -179,7 +183,7 @@ function Subnav({ className, theme = 'light', ...restProps }: SubnavProps) {
179
183
  [s.hasOverflow]: hasOverflow,
180
184
  'hdsplus-dark-mode': theme === 'dark',
181
185
  })}
182
- aria-label={`${product} website navigation`}
186
+ aria-label={ariaLabel}
183
187
  onValueChange={activatePanel}
184
188
  value={activePanel}
185
189
  delayDuration={0}
@@ -4,7 +4,7 @@
4
4
  */
5
5
 
6
6
  import React from 'react'
7
- import { v } from '../../../../lib/v'
7
+ import { vercelSplit } from '../../../../lib/v'
8
8
  import Link from 'next/link'
9
9
  import type { Products } from '@hashicorp/platform-product-meta'
10
10
  import CtaLinks, { type CtaLinkProps } from '../CtaLinks'
@@ -131,7 +131,7 @@ function SubmenuItem({ icon, url, text }: SubmenuItemProps) {
131
131
  return (
132
132
  <li>
133
133
  <NavigationMenu.Link asChild>
134
- <Link className={s.submenuItem} href={url} title={v(text)}>
134
+ <Link className={s.submenuItem} href={url} title={vercelSplit(text)}>
135
135
  {icon ? <FlightIcon name={icon} /> : null}
136
136
  {text}
137
137
  </Link>
@@ -7,7 +7,7 @@ import { forwardRef } from 'react'
7
7
  import { camelCase } from 'camel-case'
8
8
  import Link from 'next/link'
9
9
  import Image from 'next/image'
10
- import { v } from '../../../../lib/v'
10
+ import { vercelSplit } from '../../../../lib/v'
11
11
  import classNames from 'classnames'
12
12
  import * as CommunityProductLogosOnDark from './mktg-logos/all-community-product-logos_on-dark'
13
13
  import * as CommunityProductLogosOnLight from './mktg-logos/all-community-product-logos_on-light'
@@ -81,7 +81,7 @@ function getLogo(
81
81
 
82
82
  const TitleLink = forwardRef<HTMLAnchorElement, TitleLinkProps>(
83
83
  ({ text, url, product, theme }, ref) => {
84
- const parsedText = v(text)
84
+ const parsedText = vercelSplit(text)
85
85
  const Logo = getLogo(parsedText, theme)
86
86
 
87
87
  return (
@@ -3,9 +3,8 @@ import { vercelStegaSplit } from '@vercel/stega'
3
3
  /**
4
4
  * Takes in a Vercel Visual Editing string and returns the string without
5
5
  * hidden data.
6
+ *
6
7
  */
7
- export function v<VercelVEString extends string>(
8
- s: VercelVEString
9
- ): VercelVEString {
10
- return vercelStegaSplit(s).cleaned as VercelVEString
11
- }
8
+ export const vercelSplit = <VercelString>(
9
+ original: VercelString
10
+ ): VercelString => vercelStegaSplit(original as string).cleaned as VercelString
@@ -1,73 +0,0 @@
1
- # Consent Manager
2
-
3
- A GDPR-compliant consent manager.
4
-
5
- ### Props
6
-
7
- - `version` (integer) - version number, bump up to override previous consent preferences
8
- - `container` (string) - id of container where the consent manager should live
9
- - `companyName` (string) - your company name to be inserted in various copy
10
- - `privacyPolicyLink` (string) - link to your company's privacy policy
11
- - `segmentWriteKey` (string) - your production segment write key
12
- - `segmentServices` (array of objects) - use this to override the category or description of a service provided by Segment
13
- - `name` - name of the Segment integration, must match the integration you are overriding
14
- - `category` _[optional]_ - new category name
15
- - `description` _[optional]_ - new description
16
- - `categories` (array) - State of toggle
17
- - `name` - name of category
18
- - `description` - description for the category
19
- - `additionalServices` (array of objects) - additional integrations outside of Segment that you wish to include in the consent manager
20
- - `name` - name of service
21
- - `description` - description of service
22
- - `category` - category of service
23
- - `body` _[optional]_ - javascript body associated with service _If present, overrides `url` below_
24
- - `url` _[optional]_ - url of js file associated with service
25
- - `async` (bool) _[optional]_ - add `async` property to script element
26
- - `addToBody` (bool) _[optional]_ - inject script before closing `<body>` tag
27
- - `dataAttrs` (arr) _[optional]_ - array of `data-` attributes to add to script tag
28
- - `name` (str) - name of data attribute (`data-name`)
29
- - `value` (str) - value of `data` attribute to set
30
- - `showDialog` (bool) - whether or not the dialog `open` attribute is true
31
-
32
-
33
- ## `SegmentPreloadScript`
34
-
35
- 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.
36
-
37
- 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.
38
-
39
- Expect the new change to look like the following:
40
-
41
- ```diff
42
- // pages/_document.tsx
43
-
44
-
45
- import Document, { Html, Head, Main, NextScript } from 'next/document'
46
- import HashiHead from '@hashicorp/react-head'
47
- + import { SegmentPreloadScript } from '@web/react-components/src/components/consent-manager/scripts/segment'
48
- // other imports
49
-
50
- export default class MyDocument extends Document {
51
- static async getInitialProps(ctx) {
52
- const initialProps = await Document.getInitialProps(ctx)
53
- return { ...initialProps }
54
- }
55
-
56
- render() {
57
- return (
58
- <Html lang="en">
59
- <Head>
60
- <HashiHead />
61
- </Head>
62
- <body>
63
- - <script
64
- - dangerouslySetInnerHTML={{
65
- - __html: `!function(){var analytics=window... ... ...`
66
- - }}
67
- - />
68
- + <SegmentPreloadScript />
69
-
70
- // etc...
71
- ```
72
-
73
- No additional updates are necessary!
@@ -1,23 +0,0 @@
1
- .root {
2
- background-color: var(--token-color-surface-strong);
3
- width: 100%;
4
- padding: 10px 15px;
5
- position: fixed;
6
- bottom: 0;
7
- left: 0;
8
- z-index: 10;
9
- font-size: 0.9rem;
10
- }
11
-
12
- .innerContainer {
13
- composes: g-grid-container from global;
14
- display: flex;
15
- justify-content: space-between;
16
- align-items: center;
17
- gap: var(--hdsplus-spacing-01);
18
- flex-direction: column;
19
-
20
- @media (min-width: 1350px) {
21
- flex-direction: row;
22
- }
23
- }
@@ -1,31 +0,0 @@
1
- import { render, screen, fireEvent } from '@testing-library/react'
2
- import ConsentBanner from './banner'
3
-
4
- test('should display the correct privacy policy url', () => {
5
- const testValue = 'test'
6
- render(<ConsentBanner privacyPolicyLink={testValue} />)
7
- expect(screen.getByTestId('privacy-policy')).toHaveAttribute(
8
- 'href',
9
- testValue
10
- )
11
- })
12
-
13
- test('should display the correct cookie policy url', () => {
14
- const testValue = 'test'
15
- render(<ConsentBanner cookiePolicyLink={testValue} />)
16
- expect(screen.getByTestId('cookie-policy')).toHaveAttribute('href', testValue)
17
- })
18
-
19
- test('should run the onManagePreferences function when the correct button is clicked', () => {
20
- const mock = vi.fn()
21
- render(<ConsentBanner onManagePreferences={mock} />)
22
- fireEvent.click(screen.getByTestId('manage-preferences'))
23
- expect(mock).toHaveBeenCalled()
24
- })
25
-
26
- test('should run the onAccept function when the correct button is clicked', () => {
27
- const mock = vi.fn()
28
- render(<ConsentBanner onAccept={mock} />)
29
- fireEvent.click(screen.getByTestId('accept'))
30
- expect(mock).toHaveBeenCalled()
31
- })
@@ -1,73 +0,0 @@
1
- import Link from 'next/link'
2
- import Button from '@hashicorp/react-design-system-components/src/components/button'
3
- import ButtonSet from '@hashicorp/react-design-system-components/src/components/button-set'
4
- import Text from '@hashicorp/react-design-system-components/src/components/text'
5
- import s from './banner.module.css'
6
-
7
- interface ConsentBannerProps {
8
- preferences?: { loadAll?: boolean }
9
- privacyPolicyLink?: string
10
- cookiePolicyLink?: string
11
- onManagePreferences?: () => void
12
- onAccept?: () => void
13
- }
14
-
15
- export default function ConsentBanner({
16
- preferences,
17
- privacyPolicyLink,
18
- cookiePolicyLink,
19
- onManagePreferences,
20
- onAccept,
21
- }: ConsentBannerProps) {
22
- return (
23
- <div className={s.root} data-testid="consent-banner">
24
- <div className={s.innerContainer}>
25
- <Text.Body color="primary">
26
- We use cookies & other similar technology to collect data to improve
27
- your experience on our site, as described in our{' '}
28
- <Link
29
- href={
30
- privacyPolicyLink ?? 'https://www.hashicorp.com/trust/privacy'
31
- }
32
- className={s.link}
33
- target="_blank"
34
- rel="noopener noreferrer"
35
- data-testid="privacy-policy"
36
- >
37
- Privacy Policy
38
- </Link>{' '}
39
- and{' '}
40
- <Link
41
- href={
42
- cookiePolicyLink ??
43
- 'https://www.hashicorp.com/trust/privacy/cookies'
44
- }
45
- className={s.link}
46
- target="_blank"
47
- rel="noopener noreferrer"
48
- data-testid="cookie-policy"
49
- >
50
- Cookie Policy
51
- </Link>
52
- .
53
- </Text.Body>
54
- <div>
55
- <ButtonSet>
56
- <Button
57
- onClick={onManagePreferences}
58
- color="secondary"
59
- data-testid="manage-preferences"
60
- text="Manage Preferences"
61
- />
62
- <Button
63
- onClick={onAccept}
64
- color="primary"
65
- data-testid="accept"
66
- text={preferences?.loadAll ? 'Dismiss' : 'Accept'}
67
- />
68
- </ButtonSet>
69
- </div>
70
- </div>
71
- </div>
72
- )
73
- }