@hashicorp/react-components 0.0.0-nightly.f535c63 → 0.0.0-nightly.f8bc604

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 (160) hide show
  1. package/package.json +3 -7
  2. package/src/components/nav-panel/components/flight-icon/index.tsx +51 -0
  3. package/src/components/nav-panel/components/flight-icon/style.module.css +3 -0
  4. package/src/components/nav-panel/components/link-list/index.tsx +9 -4
  5. package/src/components/nav-panel/components/link-list/style.module.css +10 -10
  6. package/src/components/nav-panel/components/panel/column/style.module.css +2 -2
  7. package/src/components/nav-panel/components/panel/root/style.module.css +5 -5
  8. package/src/components/nav-panel/components/promo/index.tsx +9 -3
  9. package/src/components/nav-panel/components/promo/style.module.css +22 -12
  10. package/src/components/nav-panel/components/text/index.tsx +34 -0
  11. package/src/components/nav-panel/product-panel/index.tsx +30 -14
  12. package/src/components/nav-panel/product-panel/style.module.css +63 -36
  13. package/src/components/nav-panel/standard-panel/index.tsx +3 -0
  14. package/src/components/nav-panel/standard-panel/style.module.css +2 -2
  15. package/src/lib/get-localized-link-props/index.test.ts +30 -0
  16. package/src/lib/get-localized-link-props/index.ts +45 -0
  17. package/src/lib/parse-url/index.test.ts +35 -1
  18. package/src/lib/parse-url/index.ts +75 -9
  19. package/src/lib/send-posthog-event/index.ts +22 -0
  20. package/src/lib/supported-locales/index.ts +1 -0
  21. package/src/lib/track-nav-click-event/index.ts +4 -4
  22. package/src/components/actions/index.tsx +0 -107
  23. package/src/components/actions/style.module.css +0 -28
  24. package/src/components/actions/types.ts +0 -73
  25. package/src/components/call-to-action/index.tsx +0 -205
  26. package/src/components/call-to-action/styles/variant-centered.module.css +0 -93
  27. package/src/components/call-to-action/styles/variant-compact-grid.module.css +0 -88
  28. package/src/components/call-to-action/styles/variant-compact.module.css +0 -91
  29. package/src/components/call-to-action/styles/variant-links.module.css +0 -85
  30. package/src/components/card/README.md +0 -11
  31. package/src/components/card/card.tsx +0 -45
  32. package/src/components/card/index.test.tsx +0 -69
  33. package/src/components/card/index.tsx +0 -14
  34. package/src/components/card/newsroom-card/index.test.tsx +0 -39
  35. package/src/components/card/newsroom-card/index.tsx +0 -37
  36. package/src/components/card/newsroom-card/style.module.css +0 -12
  37. package/src/components/card/partner-card/index.test.tsx +0 -57
  38. package/src/components/card/partner-card/index.tsx +0 -69
  39. package/src/components/card/partner-card/style.module.css +0 -24
  40. package/src/components/card/person-card/index.test.tsx +0 -71
  41. package/src/components/card/person-card/index.tsx +0 -93
  42. package/src/components/card/person-card/style.module.css +0 -33
  43. package/src/components/card/primitives.tsx +0 -177
  44. package/src/components/card/promo-card/index.tsx +0 -51
  45. package/src/components/card/resource-card/index.test.tsx +0 -48
  46. package/src/components/card/resource-card/index.tsx +0 -37
  47. package/src/components/card/style.module.css +0 -145
  48. package/src/components/card/types.ts +0 -66
  49. package/src/components/card/unified-card/index.tsx +0 -58
  50. package/src/components/consent-manager/README.md +0 -73
  51. package/src/components/consent-manager/components/banner/banner.module.css +0 -23
  52. package/src/components/consent-manager/components/banner/banner.test.tsx +0 -31
  53. package/src/components/consent-manager/components/banner/banner.tsx +0 -73
  54. package/src/components/consent-manager/components/dialog/dialog.module.css +0 -145
  55. package/src/components/consent-manager/components/dialog/dialog.test.tsx +0 -194
  56. package/src/components/consent-manager/components/dialog/dialog.tsx +0 -339
  57. package/src/components/consent-manager/img/icn_close.tsx +0 -19
  58. package/src/components/consent-manager/index.test.tsx +0 -334
  59. package/src/components/consent-manager/index.tsx +0 -186
  60. package/src/components/consent-manager/loader/README.md +0 -29
  61. package/src/components/consent-manager/loader/categories.ts +0 -22
  62. package/src/components/consent-manager/loader/index.tsx +0 -94
  63. package/src/components/consent-manager/loader/presets/enterprise.ts +0 -12
  64. package/src/components/consent-manager/loader/presets/oss.ts +0 -10
  65. package/src/components/consent-manager/loader/services.ts +0 -45
  66. package/src/components/consent-manager/scripts/custom.tsx +0 -59
  67. package/src/components/consent-manager/scripts/segment.tsx +0 -87
  68. package/src/components/consent-manager/style.module.css +0 -9
  69. package/src/components/consent-manager/types.ts +0 -55
  70. package/src/components/consent-manager/util/cookies.test.ts +0 -75
  71. package/src/components/consent-manager/util/cookies.ts +0 -70
  72. package/src/components/consent-manager/util/integrations.test.ts +0 -115
  73. package/src/components/consent-manager/util/integrations.ts +0 -110
  74. package/src/components/intro/index.tsx +0 -82
  75. package/src/components/intro/style.module.css +0 -67
  76. package/src/components/intro/types.ts +0 -44
  77. package/src/components/marketo-form/CHANGELOG.md +0 -122
  78. package/src/components/marketo-form/README.md +0 -1
  79. package/src/components/marketo-form/contexts/FormMetadata.ts +0 -11
  80. package/src/components/marketo-form/docs.mdx +0 -197
  81. package/src/components/marketo-form/fixtures/index.ts +0 -185
  82. package/src/components/marketo-form/form/index.tsx +0 -369
  83. package/src/components/marketo-form/index.test.tsx +0 -320
  84. package/src/components/marketo-form/index.ts +0 -11
  85. package/src/components/marketo-form/package.original.json +0 -30
  86. package/src/components/marketo-form/partials/error-message/index.tsx +0 -12
  87. package/src/components/marketo-form/partials/error-message/style.module.css +0 -13
  88. package/src/components/marketo-form/partials/field/index.tsx +0 -90
  89. package/src/components/marketo-form/partials/field-wrapper/index.tsx +0 -26
  90. package/src/components/marketo-form/partials/fields/checkbox-field/index.tsx +0 -32
  91. package/src/components/marketo-form/partials/fields/email-field/index.tsx +0 -35
  92. package/src/components/marketo-form/partials/fields/form-page-url-field/index.tsx +0 -21
  93. package/src/components/marketo-form/partials/fields/hidden-field/index.tsx +0 -37
  94. package/src/components/marketo-form/partials/fields/htmltext-field/index.tsx +0 -21
  95. package/src/components/marketo-form/partials/fields/htmltext-field/style.module.css +0 -18
  96. package/src/components/marketo-form/partials/fields/name-field/index.tsx +0 -19
  97. package/src/components/marketo-form/partials/fields/name-field/style.module.css +0 -13
  98. package/src/components/marketo-form/partials/fields/radio-buttons-field/index.tsx +0 -48
  99. package/src/components/marketo-form/partials/fields/select-field/index.tsx +0 -39
  100. package/src/components/marketo-form/partials/fields/select-field/style.module.css +0 -5
  101. package/src/components/marketo-form/partials/fields/telephone-field/index.tsx +0 -30
  102. package/src/components/marketo-form/partials/fields/text-field/index.tsx +0 -30
  103. package/src/components/marketo-form/partials/fields/textarea-field/index.tsx +0 -29
  104. package/src/components/marketo-form/partials/label/index.tsx +0 -24
  105. package/src/components/marketo-form/partials/label/style.module.css +0 -12
  106. package/src/components/marketo-form/partials/visibility-rule/index.tsx +0 -84
  107. package/src/components/marketo-form/props.js +0 -66
  108. package/src/components/marketo-form/server/api-routes.ts +0 -109
  109. package/src/components/marketo-form/server/client.ts +0 -98
  110. package/src/components/marketo-form/server/index.ts +0 -8
  111. package/src/components/marketo-form/types.ts +0 -268
  112. package/src/components/marketo-form/utils.test.tsx +0 -103
  113. package/src/components/marketo-form/utils.ts +0 -449
  114. package/src/components/next-steps/index.tsx +0 -137
  115. package/src/components/next-steps/style.module.css +0 -270
  116. package/src/components/next-steps/types.ts +0 -63
  117. package/src/components/product-badge/index.test.tsx +0 -11
  118. package/src/components/product-badge/index.tsx +0 -42
  119. package/src/components/product-badge/style.module.css +0 -76
  120. package/src/components/products-used/index.tsx +0 -84
  121. package/src/components/products-used/style.module.css +0 -87
  122. package/src/components/products-used/types.ts +0 -31
  123. package/src/components/related-content/index.test.tsx +0 -74
  124. package/src/components/related-content/index.tsx +0 -56
  125. package/src/components/related-content/style.module.css +0 -89
  126. package/src/components/related-content/types.ts +0 -21
  127. package/src/components/subnav/helpers/areBasePathsMatching.ts +0 -13
  128. package/src/components/subnav/helpers/traverse/index.ts +0 -42
  129. package/src/components/subnav/helpers/useHeightRef.ts +0 -42
  130. package/src/components/subnav/helpers/useNavRef.ts +0 -30
  131. package/src/components/subnav/helpers/useOverflowRef.ts +0 -85
  132. package/src/components/subnav/helpers/useStuckRef.ts +0 -51
  133. package/src/components/subnav/index.tsx +0 -199
  134. package/src/components/subnav/partials/CtaLinks/github-stars-link/formatStarCount/index.test.ts +0 -26
  135. package/src/components/subnav/partials/CtaLinks/github-stars-link/formatStarCount/index.ts +0 -22
  136. package/src/components/subnav/partials/CtaLinks/github-stars-link/index.tsx +0 -87
  137. package/src/components/subnav/partials/CtaLinks/github-stars-link/parseGithubUrl/index.test.ts +0 -29
  138. package/src/components/subnav/partials/CtaLinks/github-stars-link/parseGithubUrl/index.ts +0 -32
  139. package/src/components/subnav/partials/CtaLinks/github-stars-link/style.module.css +0 -81
  140. package/src/components/subnav/partials/CtaLinks/icons/github-logo.js +0 -20
  141. package/src/components/subnav/partials/CtaLinks/icons/github.svg.js +0 -7
  142. package/src/components/subnav/partials/CtaLinks/icons/star.js +0 -20
  143. package/src/components/subnav/partials/CtaLinks/index.tsx +0 -130
  144. package/src/components/subnav/partials/CtaLinks/style.module.css +0 -45
  145. package/src/components/subnav/partials/DropdownTrigger/index.tsx +0 -35
  146. package/src/components/subnav/partials/DropdownTrigger/style.module.css +0 -39
  147. package/src/components/subnav/partials/MenuItemsDefault/index.tsx +0 -158
  148. package/src/components/subnav/partials/MenuItemsDefault/style.module.css +0 -104
  149. package/src/components/subnav/partials/MenuItemsOverflow/index.tsx +0 -143
  150. package/src/components/subnav/partials/MenuItemsOverflow/style.module.css +0 -88
  151. package/src/components/subnav/partials/TitleLink/index.tsx +0 -113
  152. package/src/components/subnav/partials/TitleLink/mktg-logos/all-community-product-logos_on-dark.ts +0 -10
  153. package/src/components/subnav/partials/TitleLink/mktg-logos/all-community-product-logos_on-light.ts +0 -10
  154. package/src/components/subnav/partials/TitleLink/mktg-logos/all-primary-logos_on-dark.ts +0 -23
  155. package/src/components/subnav/partials/TitleLink/mktg-logos/all-primary-logos_on-light.ts +0 -23
  156. package/src/components/subnav/partials/TitleLink/style.module.css +0 -43
  157. package/src/components/subnav/partials/nav-item-text/index.tsx +0 -37
  158. package/src/components/subnav/partials/nav-item-text/style.module.css +0 -13
  159. package/src/components/subnav/style.module.css +0 -66
  160. package/src/components/subnav/subnav-consts.ts +0 -1
@@ -1,51 +0,0 @@
1
- /**
2
- * Copyright (c) HashiCorp, Inc.
3
- * SPDX-License-Identifier: MPL-2.0
4
- */
5
-
6
- import * as CardPrimitives from '../primitives'
7
- import type { ThumbnailProps } from '../types'
8
-
9
- export interface PromoCardProps {
10
- heading: string
11
- description?: string
12
- eyebrow?: string
13
- link: string
14
- clickHandler?: () => void
15
- thumbnail?: ThumbnailProps
16
- withArrow?: boolean
17
- isExternal?: boolean
18
- className?: string
19
- }
20
-
21
- export function PromoCard({
22
- heading,
23
- description,
24
- eyebrow,
25
- link,
26
- clickHandler,
27
- thumbnail,
28
- withArrow = false,
29
- isExternal = false,
30
- className,
31
- }: PromoCardProps) {
32
- return (
33
- <CardPrimitives.Card
34
- heading={heading}
35
- link={link}
36
- withArrow={withArrow}
37
- isExternal={isExternal}
38
- className={className}
39
- clickHandler={clickHandler}
40
- >
41
- {thumbnail ? <CardPrimitives.Thumbnail {...thumbnail} /> : null}
42
- <CardPrimitives.Content>
43
- {eyebrow ? <CardPrimitives.Meta items={[eyebrow]} /> : null}
44
- <CardPrimitives.Heading>{heading}</CardPrimitives.Heading>
45
- {description ? (
46
- <CardPrimitives.Description>{description}</CardPrimitives.Description>
47
- ) : null}
48
- </CardPrimitives.Content>
49
- </CardPrimitives.Card>
50
- )
51
- }
@@ -1,48 +0,0 @@
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 { ResourceCard } from '.'
8
-
9
- const defaultProps = {
10
- link: 'https://hashicorp.com',
11
- heading: 'Example heading',
12
- date: 'August 15, 2022',
13
- category: 'Category',
14
- thumbnail: {
15
- src: 'https://www.datocms-assets.com/19447/1648680074-screenshot-2022-03-31-at-00-40-47.png',
16
- alt: 'HashiConf Europe 2022 Recap',
17
- },
18
- }
19
-
20
- describe('<ResourceCard />', () => {
21
- it('should render the provided date and category with separator', () => {
22
- const expectedMeta = [defaultProps.date, defaultProps.category]
23
-
24
- render(<ResourceCard {...defaultProps} />)
25
-
26
- const metaElement = screen.getByTestId('wpl-card-meta')
27
-
28
- expectedMeta.forEach((item) => {
29
- expect(metaElement).toContainElement(screen.getByText(item))
30
- })
31
-
32
- expect(metaElement).toContainElement(screen.getByText('|'))
33
- })
34
-
35
- it('should not render the date if no date is provided', () => {
36
- const defaultPropsWithoutDate = { ...defaultProps, date: '' }
37
-
38
- render(<ResourceCard {...defaultPropsWithoutDate} />)
39
-
40
- const metaElement = screen.getByTestId('wpl-card-meta')
41
-
42
- expect(metaElement).toContainElement(
43
- screen.getByText(defaultProps.category)
44
- )
45
-
46
- expect(metaElement).not.toContainElement(screen.queryByText('|'))
47
- })
48
- })
@@ -1,37 +0,0 @@
1
- /**
2
- * Copyright (c) HashiCorp, Inc.
3
- * SPDX-License-Identifier: MPL-2.0
4
- */
5
-
6
- import type { CardProps, ThumbnailProps } from '../types'
7
- import { UnifiedCard } from '../unified-card'
8
-
9
- export interface ResourceCardProps {
10
- heading: string
11
- date?: string
12
- category: string
13
- link: string
14
- productBadges?: CardProps['productBadges']
15
- thumbnail: ThumbnailProps
16
- }
17
-
18
- export function ResourceCard({
19
- heading,
20
- date,
21
- category,
22
- link,
23
- productBadges,
24
- thumbnail,
25
- }: ResourceCardProps) {
26
- const meta: string[] = date ? [date, category] : [category]
27
-
28
- return (
29
- <UnifiedCard
30
- heading={heading}
31
- link={link}
32
- meta={meta}
33
- productBadges={productBadges}
34
- thumbnail={thumbnail}
35
- />
36
- )
37
- }
@@ -1,145 +0,0 @@
1
- /**
2
- * Copyright (c) HashiCorp, Inc.
3
- * SPDX-License-Identifier: MPL-2.0
4
- */
5
-
6
- .card {
7
- display: flex;
8
- flex-direction: column;
9
- flex-grow: 1;
10
- transition: 0.2s ease;
11
- transition-property: transform, box-shadow, border-color, background-color;
12
-
13
- &:hover {
14
- transform: translateY(-2px);
15
-
16
- & .cta svg {
17
- transform: translateX(2px);
18
- }
19
- }
20
-
21
- &.dark {
22
- & .thumbnail {
23
- border-bottom: 0;
24
- }
25
- }
26
-
27
- &:focus-within {
28
- outline-color: var(--token-color-focus-action-external);
29
- outline-width: 2px;
30
- outline-style: solid;
31
- outline-offset: 0;
32
- }
33
- }
34
-
35
- .contentContainer {
36
- display: flex;
37
- flex-direction: column;
38
- flex-grow: 1;
39
- overflow: hidden;
40
- position: relative;
41
- }
42
-
43
- .link {
44
- position: absolute;
45
- inset: 0;
46
- outline: none;
47
- }
48
-
49
- .thumbnail {
50
- & .image {
51
- position: relative;
52
- display: grid;
53
- aspect-ratio: 16 / 9;
54
- overflow: hidden;
55
-
56
- & img {
57
- object-fit: cover;
58
- object-position: center;
59
- width: 100%;
60
- height: 100%;
61
- }
62
- }
63
- }
64
-
65
- .personThumbnail {
66
- composes: thumbnail;
67
- & .image {
68
- aspect-ratio: 4 / 3;
69
- }
70
- }
71
-
72
- .logoThumbnail {
73
- composes: thumbnail;
74
- padding: var(--hdsplus-spacing-07);
75
-
76
- & .image {
77
- aspect-ratio: none;
78
-
79
- & img {
80
- aspect-ratio: 16 / 9;
81
- object-fit: contain;
82
- }
83
- }
84
- }
85
-
86
- .meta {
87
- color: var(--token-color-foreground-faint);
88
- text-transform: uppercase;
89
- margin: 0;
90
- display: flex;
91
- flex-wrap: wrap;
92
- list-style: none;
93
- padding: 0;
94
- }
95
-
96
- .metaSeparator {
97
- --padding-x: 12px;
98
-
99
- padding-left: var(--padding-x);
100
- padding-right: var(--padding-x);
101
- }
102
-
103
- .content {
104
- display: flex;
105
- flex-direction: column;
106
- flex-grow: 1;
107
- row-gap: 16px;
108
- padding: 20px 20px 0 20px;
109
- }
110
-
111
- .heading {
112
- font-weight: var(--token-typography-font-weight-bold);
113
- color: var(--token-color-foreground-strong);
114
- margin: 0;
115
- }
116
-
117
- .description {
118
- color: var(--token-color-foreground-primary);
119
- margin: 0;
120
- }
121
-
122
- .productBadges {
123
- margin-top: auto;
124
- display: flex;
125
- flex-wrap: wrap;
126
- gap: 8px;
127
- }
128
-
129
- .cta {
130
- display: flex;
131
- align-items: center;
132
- justify-content: flex-end;
133
- color: var(--token-color-foreground-primary);
134
- padding: 8px 20px 20px 20px;
135
- margin-top: auto;
136
- transition: color 0.25s ease;
137
-
138
- & svg {
139
- transition: transform 0.25s ease;
140
- }
141
-
142
- &:empty {
143
- padding-top: 0;
144
- }
145
- }
@@ -1,66 +0,0 @@
1
- /**
2
- * Copyright (c) HashiCorp, Inc.
3
- * SPDX-License-Identifier: MPL-2.0
4
- */
5
-
6
- import type { ReactNode } from 'react'
7
- import type { ProductBadgeProps } from '../product-badge'
8
- import type { NewsroomCardProps } from './newsroom-card'
9
- import type { PersonCardProps } from './person-card'
10
- import type { ResourceCardProps } from './resource-card'
11
- import type { UnifiedCardProps } from './unified-card'
12
-
13
- export interface BaseCardProps
14
- extends React.AnchorHTMLAttributes<HTMLAnchorElement> {
15
- withArrow?: boolean
16
- heading: string
17
- link: string
18
- clickHandler?: () => void
19
- isExternal?: boolean
20
- hasBorder?: boolean
21
- }
22
-
23
- export interface CardPrimitiveProps extends BaseCardProps {
24
- children: ReactNode
25
- }
26
-
27
- export interface ThumbnailProps {
28
- src: string
29
- alt: string
30
- }
31
-
32
- export interface MetaProps {
33
- items: Array<string | ReactNode>
34
- }
35
-
36
- export interface ContentProps {
37
- children: ReactNode
38
- }
39
-
40
- export interface HeadingProps {
41
- as?: 'h2' | 'h3' | 'h4'
42
- children: string
43
- }
44
-
45
- export interface ProductBadgesProps {
46
- badges: Array<ProductBadgeProps['productName']>
47
- children?: ReactNode
48
- }
49
-
50
- export interface DescriptionProps {
51
- children: string
52
- }
53
-
54
- export interface CardProps extends BaseCardProps {
55
- thumbnail?: ThumbnailProps
56
- meta?: MetaProps['items']
57
- description?: DescriptionProps['children']
58
- productBadges?: ProductBadgesProps['badges']
59
- }
60
-
61
- export {
62
- NewsroomCardProps,
63
- PersonCardProps,
64
- ResourceCardProps,
65
- UnifiedCardProps,
66
- }
@@ -1,58 +0,0 @@
1
- /**
2
- * Copyright (c) HashiCorp, Inc.
3
- * SPDX-License-Identifier: MPL-2.0
4
- */
5
-
6
- import type { ReactNode } from 'react'
7
- import Badge from '@hashicorp/react-design-system-components/src/components/badge'
8
- import * as CardPrimitives from '../primitives'
9
- import type { CardProps } from '../types'
10
-
11
- export interface UnifiedCardProps extends CardProps {
12
- badges?: (string | [ReactNode, string])[]
13
- }
14
-
15
- export function UnifiedCard({
16
- heading,
17
- meta,
18
- link,
19
- productBadges,
20
- badges,
21
- thumbnail,
22
- withArrow = false,
23
- isExternal = false,
24
- className,
25
- 'aria-label': ariaLabel,
26
- }: UnifiedCardProps) {
27
- return (
28
- <CardPrimitives.Card
29
- heading={heading}
30
- link={link}
31
- withArrow={withArrow}
32
- isExternal={isExternal}
33
- className={className}
34
- aria-label={ariaLabel ?? heading}
35
- >
36
- {thumbnail ? <CardPrimitives.Thumbnail {...thumbnail} /> : null}
37
- <CardPrimitives.Content>
38
- {meta && meta.length > 0 ? <CardPrimitives.Meta items={meta} /> : null}
39
- <CardPrimitives.Heading>{heading}</CardPrimitives.Heading>
40
- {productBadges && productBadges?.length > 0 ? (
41
- <CardPrimitives.ProductBadges badges={productBadges}>
42
- {badges && badges.length > 0
43
- ? badges.map((badge, stableIdx) => {
44
- if (Array.isArray(badge)) {
45
- return (
46
- <Badge key={stableIdx} icon={badge[0]} text={badge[1]} />
47
- )
48
- }
49
-
50
- return <Badge key={stableIdx} text={badge} />
51
- })
52
- : null}
53
- </CardPrimitives.ProductBadges>
54
- ) : null}
55
- </CardPrimitives.Content>
56
- </CardPrimitives.Card>
57
- )
58
- }
@@ -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
- }