@nypl/design-system-react-components 1.0.2 → 1.0.4

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 (309) hide show
  1. package/CHANGELOG.md +53 -0
  2. package/README.md +171 -135
  3. package/dist/__tests__/mediaMatchMock.d.ts +79 -0
  4. package/dist/components/Card/Card.d.ts +8 -6
  5. package/dist/components/Heading/Heading.d.ts +6 -0
  6. package/dist/components/Icons/Icon.d.ts +1 -1
  7. package/dist/components/Icons/IconSvgs.d.ts +10 -0
  8. package/dist/components/Logo/Logo.d.ts +1 -1
  9. package/dist/components/Logo/LogoSvgs.d.ts +3 -0
  10. package/dist/components/Slider/Slider.d.ts +1 -2
  11. package/dist/components/Table/Table.d.ts +3 -2
  12. package/dist/components/Text/Text.d.ts +6 -0
  13. package/dist/components/TextInput/TextInput.d.ts +2 -1
  14. package/dist/design-system-react-components.cjs.development.js +1700 -878
  15. package/dist/design-system-react-components.cjs.development.js.map +1 -1
  16. package/dist/design-system-react-components.cjs.production.min.js +1 -1
  17. package/dist/design-system-react-components.cjs.production.min.js.map +1 -1
  18. package/dist/design-system-react-components.esm.js +1672 -881
  19. package/dist/design-system-react-components.esm.js.map +1 -1
  20. package/dist/hooks/{tests → __tests__}/useCarouselStyles.test.d.ts +0 -0
  21. package/dist/hooks/__tests__/useNYPLBreakpoints.test.d.ts +1 -0
  22. package/dist/hooks/useNYPLBreakpoints.d.ts +13 -0
  23. package/dist/index.d.ts +2 -1
  24. package/dist/resources.scss +0 -4
  25. package/dist/styles.css +3 -2
  26. package/dist/theme/components/button.d.ts +7 -2
  27. package/dist/theme/components/checkbox.d.ts +1 -0
  28. package/dist/theme/components/customTable.d.ts +522 -34
  29. package/dist/theme/components/datePicker.d.ts +1 -0
  30. package/dist/theme/components/global.d.ts +5 -2
  31. package/dist/theme/components/heading.d.ts +5 -1
  32. package/dist/theme/components/image.d.ts +18 -0
  33. package/dist/theme/components/radio.d.ts +9 -0
  34. package/dist/theme/components/searchBar.d.ts +6 -0
  35. package/dist/theme/components/select.d.ts +4 -5
  36. package/dist/theme/components/structuredContent.d.ts +117 -17
  37. package/dist/theme/components/template.d.ts +4 -1
  38. package/dist/theme/components/text.d.ts +5 -1
  39. package/dist/theme/components/textInput.d.ts +4 -0
  40. package/dist/theme/components/toggle.d.ts +1 -0
  41. package/dist/theme/provider.d.ts +2 -1
  42. package/package.json +16 -16
  43. package/src/__tests__/fileMock.ts +0 -6
  44. package/src/__tests__/setup.ts +0 -27
  45. package/src/__tests__/utils/utils.test.ts +0 -18
  46. package/src/components/AccessibilityGuide/SkipNavigation.stories.mdx +0 -42
  47. package/src/components/Accordion/Accordion.stories.mdx +0 -333
  48. package/src/components/Accordion/Accordion.test.tsx +0 -237
  49. package/src/components/Accordion/Accordion.tsx +0 -137
  50. package/src/components/Accordion/__snapshots__/Accordion.test.tsx.snap +0 -734
  51. package/src/components/Autosuggest/Autosuggest.stories.mdx +0 -75
  52. package/src/components/Autosuggest/Autosuggest.stories.tsx +0 -211
  53. package/src/components/Autosuggest/_Autosuggest.scss +0 -51
  54. package/src/components/Breadcrumbs/Breadcrumbs.stories.mdx +0 -231
  55. package/src/components/Breadcrumbs/Breadcrumbs.test.tsx +0 -144
  56. package/src/components/Breadcrumbs/Breadcrumbs.tsx +0 -98
  57. package/src/components/Breadcrumbs/__snapshots__/Breadcrumbs.test.tsx.snap +0 -695
  58. package/src/components/Button/Button.stories.mdx +0 -320
  59. package/src/components/Button/Button.test.tsx +0 -184
  60. package/src/components/Button/Button.tsx +0 -95
  61. package/src/components/Button/__snapshots__/Button.test.tsx.snap +0 -106
  62. package/src/components/ButtonGroup/ButtonGroup.stories.mdx +0 -178
  63. package/src/components/ButtonGroup/ButtonGroup.test.tsx +0 -141
  64. package/src/components/ButtonGroup/ButtonGroup.tsx +0 -100
  65. package/src/components/ButtonGroup/__snapshots__/ButtonGroup.test.tsx.snap +0 -117
  66. package/src/components/Card/Card.stories.mdx +0 -1041
  67. package/src/components/Card/Card.test.tsx +0 -388
  68. package/src/components/Card/Card.tsx +0 -346
  69. package/src/components/Card/__snapshots__/Card.test.tsx.snap +0 -568
  70. package/src/components/Chakra/Box.stories.mdx +0 -52
  71. package/src/components/Chakra/Center.stories.mdx +0 -96
  72. package/src/components/Chakra/Flex.stories.mdx +0 -111
  73. package/src/components/Chakra/Grid.stories.mdx +0 -89
  74. package/src/components/Chakra/Stack.stories.mdx +0 -109
  75. package/src/components/Checkbox/Checkbox.stories.mdx +0 -243
  76. package/src/components/Checkbox/Checkbox.test.tsx +0 -350
  77. package/src/components/Checkbox/Checkbox.tsx +0 -152
  78. package/src/components/Checkbox/__snapshots__/Checkbox.test.tsx.snap +0 -661
  79. package/src/components/CheckboxGroup/CheckboxGroup.stories.mdx +0 -462
  80. package/src/components/CheckboxGroup/CheckboxGroup.test.tsx +0 -492
  81. package/src/components/CheckboxGroup/CheckboxGroup.tsx +0 -173
  82. package/src/components/CheckboxGroup/__snapshots__/CheckboxGroup.test.tsx.snap +0 -1842
  83. package/src/components/ComponentWrapper/ComponentWrapper.test.tsx +0 -163
  84. package/src/components/ComponentWrapper/ComponentWrapper.tsx +0 -76
  85. package/src/components/ComponentWrapper/__snapshots__/ComponentWrapper.test.tsx.snap +0 -103
  86. package/src/components/DatePicker/DatePicker.stories.mdx +0 -452
  87. package/src/components/DatePicker/DatePicker.test.tsx +0 -940
  88. package/src/components/DatePicker/DatePicker.tsx +0 -450
  89. package/src/components/DatePicker/_DatePicker.scss +0 -100
  90. package/src/components/DatePicker/__snapshots__/DatePicker.test.tsx.snap +0 -908
  91. package/src/components/Fieldset/Fieldset.stories.mdx +0 -96
  92. package/src/components/Fieldset/Fieldset.test.tsx +0 -155
  93. package/src/components/Fieldset/Fieldset.tsx +0 -55
  94. package/src/components/Fieldset/__snapshots__/Fieldset.test.tsx.snap +0 -89
  95. package/src/components/Form/Form.stories.mdx +0 -426
  96. package/src/components/Form/Form.test.tsx +0 -234
  97. package/src/components/Form/Form.tsx +0 -124
  98. package/src/components/Form/__snapshots__/Form.test.tsx.snap +0 -115
  99. package/src/components/Grid/SimpleGrid.stories.mdx +0 -336
  100. package/src/components/Grid/SimpleGrid.test.tsx +0 -79
  101. package/src/components/Grid/SimpleGrid.tsx +0 -49
  102. package/src/components/Grid/__snapshots__/SimpleGrid.test.tsx.snap +0 -23
  103. package/src/components/Heading/Heading.stories.mdx +0 -187
  104. package/src/components/Heading/Heading.test.tsx +0 -171
  105. package/src/components/Heading/Heading.tsx +0 -104
  106. package/src/components/Heading/__snapshots__/Heading.test.tsx.snap +0 -90
  107. package/src/components/HelperErrorText/HelperErrorText.stories.mdx +0 -172
  108. package/src/components/HelperErrorText/HelperErrorText.test.tsx +0 -114
  109. package/src/components/HelperErrorText/HelperErrorText.tsx +0 -62
  110. package/src/components/HelperErrorText/__snapshots__/HelperErrorText.test.tsx.snap +0 -93
  111. package/src/components/Hero/Hero.stories.mdx +0 -378
  112. package/src/components/Hero/Hero.test.tsx +0 -611
  113. package/src/components/Hero/Hero.tsx +0 -203
  114. package/src/components/Hero/__snapshots__/Hero.test.tsx.snap +0 -379
  115. package/src/components/HorizontalRule/HorizontalRule.stories.mdx +0 -73
  116. package/src/components/HorizontalRule/HorizontalRule.test.tsx +0 -54
  117. package/src/components/HorizontalRule/HorizontalRule.tsx +0 -27
  118. package/src/components/HorizontalRule/__snapshots__/HorizontalRule.test.tsx.snap +0 -44
  119. package/src/components/Icons/Icon.stories.mdx +0 -413
  120. package/src/components/Icons/Icon.test.tsx +0 -120
  121. package/src/components/Icons/Icon.tsx +0 -187
  122. package/src/components/Icons/IconSvgs.tsx +0 -64
  123. package/src/components/Icons/__snapshots__/Icon.test.tsx.snap +0 -129
  124. package/src/components/Image/Image.stories.mdx +0 -332
  125. package/src/components/Image/Image.test.tsx +0 -155
  126. package/src/components/Image/Image.tsx +0 -171
  127. package/src/components/Image/__snapshots__/Image.test.tsx.snap +0 -269
  128. package/src/components/Label/Label.stories.mdx +0 -100
  129. package/src/components/Label/Label.test.tsx +0 -116
  130. package/src/components/Label/Label.tsx +0 -55
  131. package/src/components/Label/__snapshots__/Label.test.tsx.snap +0 -45
  132. package/src/components/Link/Link.stories.mdx +0 -249
  133. package/src/components/Link/Link.test.tsx +0 -224
  134. package/src/components/Link/Link.tsx +0 -178
  135. package/src/components/Link/__snapshots__/Link.test.tsx.snap +0 -286
  136. package/src/components/List/List.stories.mdx +0 -393
  137. package/src/components/List/List.test.tsx +0 -265
  138. package/src/components/List/List.tsx +0 -156
  139. package/src/components/List/__snapshots__/List.test.tsx.snap +0 -213
  140. package/src/components/Logo/Logo.stories.mdx +0 -295
  141. package/src/components/Logo/Logo.test.tsx +0 -116
  142. package/src/components/Logo/Logo.tsx +0 -151
  143. package/src/components/Logo/LogoSvgs.tsx +0 -90
  144. package/src/components/Logo/__snapshots__/Logo.test.tsx.snap +0 -142
  145. package/src/components/Modal/Modal.stories.mdx +0 -294
  146. package/src/components/Modal/Modal.test.tsx +0 -157
  147. package/src/components/Modal/Modal.tsx +0 -154
  148. package/src/components/Modal/__snapshots__/Modal.test.tsx.snap +0 -25
  149. package/src/components/Notification/Notification.stories.mdx +0 -358
  150. package/src/components/Notification/Notification.test.tsx +0 -279
  151. package/src/components/Notification/Notification.tsx +0 -224
  152. package/src/components/Notification/__snapshots__/Notification.test.tsx.snap +0 -525
  153. package/src/components/Pagination/Pagination.stories.mdx +0 -184
  154. package/src/components/Pagination/Pagination.test.tsx +0 -419
  155. package/src/components/Pagination/Pagination.tsx +0 -269
  156. package/src/components/Pagination/__snapshots__/Pagination.test.tsx.snap +0 -544
  157. package/src/components/Placeholder/Placeholder.tsx +0 -19
  158. package/src/components/ProgressIndicator/ProgressIndicator.stories.mdx +0 -360
  159. package/src/components/ProgressIndicator/ProgressIndicator.test.tsx +0 -298
  160. package/src/components/ProgressIndicator/ProgressIndicator.tsx +0 -132
  161. package/src/components/ProgressIndicator/__snapshots__/ProgressIndicator.test.tsx.snap +0 -434
  162. package/src/components/Radio/Radio.stories.mdx +0 -216
  163. package/src/components/Radio/Radio.test.tsx +0 -247
  164. package/src/components/Radio/Radio.tsx +0 -119
  165. package/src/components/Radio/__snapshots__/Radio.test.tsx.snap +0 -451
  166. package/src/components/RadioGroup/RadioGroup.stories.mdx +0 -479
  167. package/src/components/RadioGroup/RadioGroup.test.tsx +0 -471
  168. package/src/components/RadioGroup/RadioGroup.tsx +0 -171
  169. package/src/components/RadioGroup/__snapshots__/RadioGroup.test.tsx.snap +0 -1550
  170. package/src/components/SearchBar/SearchBar.stories.mdx +0 -518
  171. package/src/components/SearchBar/SearchBar.test.tsx +0 -435
  172. package/src/components/SearchBar/SearchBar.tsx +0 -210
  173. package/src/components/SearchBar/__snapshots__/SearchBar.test.tsx.snap +0 -1049
  174. package/src/components/Select/Select.stories.mdx +0 -439
  175. package/src/components/Select/Select.test.tsx +0 -358
  176. package/src/components/Select/Select.tsx +0 -183
  177. package/src/components/Select/__snapshots__/Select.test.tsx.snap +0 -895
  178. package/src/components/SkeletonLoader/SkeletonLoader.stories.mdx +0 -142
  179. package/src/components/SkeletonLoader/SkeletonLoader.test.tsx +0 -116
  180. package/src/components/SkeletonLoader/SkeletonLoader.tsx +0 -123
  181. package/src/components/SkeletonLoader/__snapshots__/SkeletonLoader.test.tsx.snap +0 -898
  182. package/src/components/SkipNavigation/SkipNavigation.stories.mdx +0 -90
  183. package/src/components/SkipNavigation/SkipNavigation.test.tsx +0 -63
  184. package/src/components/SkipNavigation/SkipNavigation.tsx +0 -51
  185. package/src/components/SkipNavigation/__snapshots__/SkipNavigation.test.tsx.snap +0 -130
  186. package/src/components/Slider/Slider.stories.mdx +0 -628
  187. package/src/components/Slider/Slider.test.tsx +0 -736
  188. package/src/components/Slider/Slider.tsx +0 -322
  189. package/src/components/Slider/__snapshots__/Slider.test.tsx.snap +0 -2186
  190. package/src/components/StatusBadge/StatusBadge.stories.mdx +0 -109
  191. package/src/components/StatusBadge/StatusBadge.test.tsx +0 -70
  192. package/src/components/StatusBadge/StatusBadge.tsx +0 -35
  193. package/src/components/StatusBadge/__snapshots__/StatusBadge.test.tsx.snap +0 -47
  194. package/src/components/StructuredContent/StructuredContent.stories.mdx +0 -567
  195. package/src/components/StructuredContent/StructuredContent.test.tsx +0 -435
  196. package/src/components/StructuredContent/StructuredContent.tsx +0 -139
  197. package/src/components/StructuredContent/__snapshots__/StructuredContent.test.tsx.snap +0 -368
  198. package/src/components/StyleGuide/Bidirectionality.stories.mdx +0 -206
  199. package/src/components/StyleGuide/Breakpoints.stories.mdx +0 -55
  200. package/src/components/StyleGuide/Buttons.stories.mdx +0 -194
  201. package/src/components/StyleGuide/ColorCard.tsx +0 -43
  202. package/src/components/StyleGuide/Colors.stories.mdx +0 -201
  203. package/src/components/StyleGuide/DesignTokens.stories.mdx +0 -193
  204. package/src/components/StyleGuide/Forms.stories.mdx +0 -94
  205. package/src/components/StyleGuide/Iconography.stories.mdx +0 -142
  206. package/src/components/StyleGuide/Spacing.stories.mdx +0 -116
  207. package/src/components/StyleGuide/Typography.stories.mdx +0 -419
  208. package/src/components/Table/Table.stories.mdx +0 -272
  209. package/src/components/Table/Table.test.tsx +0 -241
  210. package/src/components/Table/Table.tsx +0 -152
  211. package/src/components/Table/__snapshots__/Table.test.tsx.snap +0 -1703
  212. package/src/components/Tabs/Tabs.stories.mdx +0 -338
  213. package/src/components/Tabs/Tabs.test.tsx +0 -298
  214. package/src/components/Tabs/Tabs.tsx +0 -264
  215. package/src/components/Tabs/__snapshots__/Tabs.test.tsx.snap +0 -584
  216. package/src/components/Template/Template.stories.mdx +0 -695
  217. package/src/components/Template/Template.test.tsx +0 -309
  218. package/src/components/Template/Template.tsx +0 -326
  219. package/src/components/Template/__snapshots__/Template.test.tsx.snap +0 -342
  220. package/src/components/Text/Text.stories.mdx +0 -103
  221. package/src/components/Text/Text.test.tsx +0 -63
  222. package/src/components/Text/Text.tsx +0 -50
  223. package/src/components/Text/__snapshots__/Text.test.tsx.snap +0 -50
  224. package/src/components/TextInput/TextInput.stories.mdx +0 -268
  225. package/src/components/TextInput/TextInput.test.tsx +0 -451
  226. package/src/components/TextInput/TextInput.tsx +0 -240
  227. package/src/components/TextInput/__snapshots__/TextInput.test.tsx.snap +0 -274
  228. package/src/components/Toggle/Toggle.stories.mdx +0 -237
  229. package/src/components/Toggle/Toggle.test.tsx +0 -170
  230. package/src/components/Toggle/Toggle.tsx +0 -128
  231. package/src/components/Toggle/__snapshots__/Toggle.test.tsx.snap +0 -470
  232. package/src/components/VideoPlayer/VideoPlayer.stories.mdx +0 -212
  233. package/src/components/VideoPlayer/VideoPlayer.test.tsx +0 -308
  234. package/src/components/VideoPlayer/VideoPlayer.tsx +0 -188
  235. package/src/components/VideoPlayer/__snapshots__/VideoPlayer.test.tsx.snap +0 -192
  236. package/src/docs/Chakra.stories.mdx +0 -563
  237. package/src/docs/Welcome.stories.mdx +0 -148
  238. package/src/helpers/types.ts +0 -1
  239. package/src/hooks/tests/useCarouselStyles.test.ts +0 -140
  240. package/src/hooks/tests/useNYPLTheme.test.tsx +0 -36
  241. package/src/hooks/useCarouselStyles.stories.mdx +0 -30
  242. package/src/hooks/useCarouselStyles.ts +0 -35
  243. package/src/hooks/useNYPLTheme.stories.mdx +0 -98
  244. package/src/hooks/useNYPLTheme.ts +0 -91
  245. package/src/hooks/useWindowSize.stories.mdx +0 -23
  246. package/src/hooks/useWindowSize.ts +0 -40
  247. package/src/index.ts +0 -136
  248. package/src/resources.scss +0 -6
  249. package/src/styles/base/_01-breakpoints.scss +0 -27
  250. package/src/styles/base/_02-mixins.scss +0 -103
  251. package/src/styles/base/_place-holder.scss +0 -33
  252. package/src/styles/space/_space-inline.scss +0 -79
  253. package/src/styles/space/_space-inset.scss +0 -57
  254. package/src/styles/space/_space-stack.scss +0 -116
  255. package/src/styles.scss +0 -23
  256. package/src/theme/components/accordion.ts +0 -25
  257. package/src/theme/components/breadcrumb.ts +0 -94
  258. package/src/theme/components/button.ts +0 -133
  259. package/src/theme/components/buttonGroup.ts +0 -10
  260. package/src/theme/components/card.ts +0 -237
  261. package/src/theme/components/checkbox.ts +0 -110
  262. package/src/theme/components/checkboxGroup.ts +0 -10
  263. package/src/theme/components/componentWrapper.ts +0 -14
  264. package/src/theme/components/customTable.ts +0 -77
  265. package/src/theme/components/datePicker.ts +0 -17
  266. package/src/theme/components/fieldset.ts +0 -23
  267. package/src/theme/components/global.ts +0 -91
  268. package/src/theme/components/globalMixins.ts +0 -24
  269. package/src/theme/components/heading.ts +0 -79
  270. package/src/theme/components/helperErrorText.ts +0 -14
  271. package/src/theme/components/hero.ts +0 -238
  272. package/src/theme/components/horizontalRule.ts +0 -17
  273. package/src/theme/components/icon.ts +0 -88
  274. package/src/theme/components/image.ts +0 -136
  275. package/src/theme/components/label.ts +0 -15
  276. package/src/theme/components/link.ts +0 -63
  277. package/src/theme/components/list.ts +0 -88
  278. package/src/theme/components/logo.ts +0 -58
  279. package/src/theme/components/notification.ts +0 -132
  280. package/src/theme/components/pagination.ts +0 -17
  281. package/src/theme/components/progressIndicator.ts +0 -67
  282. package/src/theme/components/radio.ts +0 -103
  283. package/src/theme/components/radioGroup.ts +0 -10
  284. package/src/theme/components/searchBar.ts +0 -19
  285. package/src/theme/components/select.ts +0 -72
  286. package/src/theme/components/skeletonLoader.ts +0 -113
  287. package/src/theme/components/skipNavigation.ts +0 -29
  288. package/src/theme/components/slider.ts +0 -95
  289. package/src/theme/components/statusBadge.ts +0 -26
  290. package/src/theme/components/structuredContent.ts +0 -149
  291. package/src/theme/components/tabs.ts +0 -109
  292. package/src/theme/components/template.ts +0 -114
  293. package/src/theme/components/text.ts +0 -38
  294. package/src/theme/components/textInput.ts +0 -65
  295. package/src/theme/components/toggle.ts +0 -109
  296. package/src/theme/components/videoPlayer.ts +0 -47
  297. package/src/theme/foundations/breakpoints.ts +0 -24
  298. package/src/theme/foundations/colors.ts +0 -212
  299. package/src/theme/foundations/global.ts +0 -43
  300. package/src/theme/foundations/radii.ts +0 -7
  301. package/src/theme/foundations/shadows.ts +0 -5
  302. package/src/theme/foundations/spacing.ts +0 -136
  303. package/src/theme/foundations/typography.ts +0 -107
  304. package/src/theme/index.ts +0 -131
  305. package/src/theme/provider.tsx +0 -9
  306. package/src/theme/types.ts +0 -1
  307. package/src/utils/componentCategories.ts +0 -152
  308. package/src/utils/interfaces.ts +0 -5
  309. package/src/utils/utils.ts +0 -84
@@ -1,470 +0,0 @@
1
- // Jest Snapshot v1, https://goo.gl/fbAQLP
2
-
3
- exports[`Toggle Renders the UI snapshot correctly 1`] = `
4
- <div
5
- className="css-1u8qly9"
6
- id="inputID-wrapper"
7
- >
8
- <div
9
- className="css-0"
10
- >
11
- <label
12
- className="chakra-switch css-18x0has"
13
- onClick={[Function]}
14
- >
15
- <input
16
- aria-disabled={false}
17
- aria-invalid={false}
18
- checked={false}
19
- className="chakra-switch__input"
20
- disabled={false}
21
- id="inputID"
22
- name="default"
23
- onBlur={[Function]}
24
- onChange={[Function]}
25
- onFocus={[Function]}
26
- onKeyDown={[Function]}
27
- onKeyUp={[Function]}
28
- required={false}
29
- style={
30
- Object {
31
- "border": "0px",
32
- "clip": "rect(0px, 0px, 0px, 0px)",
33
- "height": "1px",
34
- "margin": "-1px",
35
- "overflow": "hidden",
36
- "padding": "0px",
37
- "position": "absolute",
38
- "whiteSpace": "nowrap",
39
- "width": "1px",
40
- }
41
- }
42
- type="checkbox"
43
- />
44
- <span
45
- aria-hidden={true}
46
- className="chakra-switch__track css-14qxnv8"
47
- onMouseDown={[Function]}
48
- onMouseEnter={[Function]}
49
- onMouseLeave={[Function]}
50
- onMouseUp={[Function]}
51
- >
52
- <span
53
- className="chakra-switch__thumb css-0"
54
- />
55
- </span>
56
- <span
57
- className="chakra-switch__label css-1y8kf23"
58
- onMouseDown={[Function]}
59
- onTouchStart={[Function]}
60
- >
61
- Test Label
62
- </span>
63
- </label>
64
- </div>
65
- </div>
66
- `;
67
-
68
- exports[`Toggle Renders the UI snapshot correctly 2`] = `
69
- <div
70
- className="css-1u8qly9"
71
- id="Toggle-checked-wrapper"
72
- >
73
- <div
74
- className="css-0"
75
- >
76
- <label
77
- className="chakra-switch css-18x0has"
78
- data-checked=""
79
- onClick={[Function]}
80
- >
81
- <input
82
- aria-disabled={false}
83
- aria-invalid={false}
84
- checked={true}
85
- className="chakra-switch__input"
86
- disabled={false}
87
- id="Toggle-checked"
88
- name="default"
89
- onBlur={[Function]}
90
- onChange={[Function]}
91
- onFocus={[Function]}
92
- onKeyDown={[Function]}
93
- onKeyUp={[Function]}
94
- required={false}
95
- style={
96
- Object {
97
- "border": "0px",
98
- "clip": "rect(0px, 0px, 0px, 0px)",
99
- "height": "1px",
100
- "margin": "-1px",
101
- "overflow": "hidden",
102
- "padding": "0px",
103
- "position": "absolute",
104
- "whiteSpace": "nowrap",
105
- "width": "1px",
106
- }
107
- }
108
- type="checkbox"
109
- />
110
- <span
111
- aria-hidden={true}
112
- className="chakra-switch__track css-14qxnv8"
113
- data-checked=""
114
- onMouseDown={[Function]}
115
- onMouseEnter={[Function]}
116
- onMouseLeave={[Function]}
117
- onMouseUp={[Function]}
118
- >
119
- <span
120
- className="chakra-switch__thumb css-0"
121
- data-checked=""
122
- />
123
- </span>
124
- <span
125
- className="chakra-switch__label css-1y8kf23"
126
- data-checked=""
127
- onMouseDown={[Function]}
128
- onTouchStart={[Function]}
129
- >
130
- Test Label
131
- </span>
132
- </label>
133
- </div>
134
- </div>
135
- `;
136
-
137
- exports[`Toggle Renders the UI snapshot correctly 3`] = `
138
- <div
139
- className="css-1u8qly9"
140
- id="Toggle-invalid-wrapper"
141
- >
142
- <div
143
- className="css-0"
144
- >
145
- <label
146
- className="chakra-switch css-18x0has"
147
- data-invalid=""
148
- onClick={[Function]}
149
- >
150
- <input
151
- aria-disabled={false}
152
- aria-invalid={true}
153
- checked={false}
154
- className="chakra-switch__input"
155
- disabled={false}
156
- id="Toggle-invalid"
157
- name="default"
158
- onBlur={[Function]}
159
- onChange={[Function]}
160
- onFocus={[Function]}
161
- onKeyDown={[Function]}
162
- onKeyUp={[Function]}
163
- required={false}
164
- style={
165
- Object {
166
- "border": "0px",
167
- "clip": "rect(0px, 0px, 0px, 0px)",
168
- "height": "1px",
169
- "margin": "-1px",
170
- "overflow": "hidden",
171
- "padding": "0px",
172
- "position": "absolute",
173
- "whiteSpace": "nowrap",
174
- "width": "1px",
175
- }
176
- }
177
- type="checkbox"
178
- />
179
- <span
180
- aria-hidden={true}
181
- className="chakra-switch__track css-14qxnv8"
182
- data-invalid=""
183
- onMouseDown={[Function]}
184
- onMouseEnter={[Function]}
185
- onMouseLeave={[Function]}
186
- onMouseUp={[Function]}
187
- >
188
- <span
189
- className="chakra-switch__thumb css-0"
190
- />
191
- </span>
192
- <span
193
- className="chakra-switch__label css-1y8kf23"
194
- data-invalid=""
195
- onMouseDown={[Function]}
196
- onTouchStart={[Function]}
197
- >
198
- Test Label
199
- </span>
200
- </label>
201
- </div>
202
- </div>
203
- `;
204
-
205
- exports[`Toggle Renders the UI snapshot correctly 4`] = `
206
- <div
207
- className="css-1u8qly9"
208
- id="Toggle-disabled-wrapper"
209
- >
210
- <div
211
- className="css-0"
212
- >
213
- <label
214
- className="chakra-switch css-18x0has"
215
- data-disabled=""
216
- onClick={[Function]}
217
- >
218
- <input
219
- aria-disabled={true}
220
- aria-invalid={false}
221
- checked={false}
222
- className="chakra-switch__input"
223
- disabled={true}
224
- id="Toggle-disabled"
225
- name="default"
226
- onBlur={[Function]}
227
- onChange={[Function]}
228
- onFocus={[Function]}
229
- onKeyDown={[Function]}
230
- onKeyUp={[Function]}
231
- required={false}
232
- style={
233
- Object {
234
- "border": "0px",
235
- "clip": "rect(0px, 0px, 0px, 0px)",
236
- "height": "1px",
237
- "margin": "-1px",
238
- "overflow": "hidden",
239
- "padding": "0px",
240
- "position": "absolute",
241
- "whiteSpace": "nowrap",
242
- "width": "1px",
243
- }
244
- }
245
- type="checkbox"
246
- />
247
- <span
248
- aria-hidden={true}
249
- className="chakra-switch__track css-14qxnv8"
250
- data-disabled=""
251
- onMouseDown={[Function]}
252
- onMouseEnter={[Function]}
253
- onMouseLeave={[Function]}
254
- onMouseUp={[Function]}
255
- >
256
- <span
257
- className="chakra-switch__thumb css-0"
258
- />
259
- </span>
260
- <span
261
- className="chakra-switch__label css-1y8kf23"
262
- data-disabled=""
263
- onMouseDown={[Function]}
264
- onTouchStart={[Function]}
265
- >
266
- Test Label
267
- </span>
268
- </label>
269
- </div>
270
- </div>
271
- `;
272
-
273
- exports[`Toggle Renders the UI snapshot correctly 5`] = `
274
- <div
275
- className="css-1u8qly9"
276
- id="Toggle-disabled-wrapper"
277
- >
278
- <div
279
- className="css-0"
280
- >
281
- <label
282
- className="chakra-switch css-18x0has"
283
- data-disabled=""
284
- onClick={[Function]}
285
- >
286
- <input
287
- aria-disabled={true}
288
- aria-invalid={false}
289
- checked={false}
290
- className="chakra-switch__input"
291
- disabled={true}
292
- id="Toggle-disabled"
293
- name="default"
294
- onBlur={[Function]}
295
- onChange={[Function]}
296
- onFocus={[Function]}
297
- onKeyDown={[Function]}
298
- onKeyUp={[Function]}
299
- required={false}
300
- style={
301
- Object {
302
- "border": "0px",
303
- "clip": "rect(0px, 0px, 0px, 0px)",
304
- "height": "1px",
305
- "margin": "-1px",
306
- "overflow": "hidden",
307
- "padding": "0px",
308
- "position": "absolute",
309
- "whiteSpace": "nowrap",
310
- "width": "1px",
311
- }
312
- }
313
- type="checkbox"
314
- />
315
- <span
316
- aria-hidden={true}
317
- className="chakra-switch__track css-14qxnv8"
318
- data-disabled=""
319
- onMouseDown={[Function]}
320
- onMouseEnter={[Function]}
321
- onMouseLeave={[Function]}
322
- onMouseUp={[Function]}
323
- >
324
- <span
325
- className="chakra-switch__thumb css-0"
326
- />
327
- </span>
328
- <span
329
- className="chakra-switch__label css-1y8kf23"
330
- data-disabled=""
331
- onMouseDown={[Function]}
332
- onTouchStart={[Function]}
333
- >
334
- Test Label
335
- </span>
336
- </label>
337
- </div>
338
- </div>
339
- `;
340
-
341
- exports[`Toggle Renders the UI snapshot correctly 6`] = `
342
- <div
343
- className="css-7zjd3y"
344
- id="chakra-wrapper"
345
- >
346
- <div
347
- className="css-0"
348
- >
349
- <label
350
- className="chakra-switch css-18x0has"
351
- onClick={[Function]}
352
- >
353
- <input
354
- aria-disabled={false}
355
- aria-invalid={false}
356
- checked={false}
357
- className="chakra-switch__input"
358
- disabled={false}
359
- id="chakra"
360
- name="default"
361
- onBlur={[Function]}
362
- onChange={[Function]}
363
- onFocus={[Function]}
364
- onKeyDown={[Function]}
365
- onKeyUp={[Function]}
366
- required={false}
367
- style={
368
- Object {
369
- "border": "0px",
370
- "clip": "rect(0px, 0px, 0px, 0px)",
371
- "height": "1px",
372
- "margin": "-1px",
373
- "overflow": "hidden",
374
- "padding": "0px",
375
- "position": "absolute",
376
- "whiteSpace": "nowrap",
377
- "width": "1px",
378
- }
379
- }
380
- type="checkbox"
381
- />
382
- <span
383
- aria-hidden={true}
384
- className="chakra-switch__track css-14qxnv8"
385
- onMouseDown={[Function]}
386
- onMouseEnter={[Function]}
387
- onMouseLeave={[Function]}
388
- onMouseUp={[Function]}
389
- >
390
- <span
391
- className="chakra-switch__thumb css-0"
392
- />
393
- </span>
394
- <span
395
- className="chakra-switch__label css-1y8kf23"
396
- onMouseDown={[Function]}
397
- onTouchStart={[Function]}
398
- >
399
- Test Label
400
- </span>
401
- </label>
402
- </div>
403
- </div>
404
- `;
405
-
406
- exports[`Toggle Renders the UI snapshot correctly 7`] = `
407
- <div
408
- className="css-1u8qly9"
409
- data-testid="props"
410
- id="props-wrapper"
411
- >
412
- <div
413
- className="css-0"
414
- >
415
- <label
416
- className="chakra-switch css-18x0has"
417
- onClick={[Function]}
418
- >
419
- <input
420
- aria-disabled={false}
421
- aria-invalid={false}
422
- checked={false}
423
- className="chakra-switch__input"
424
- disabled={false}
425
- id="props"
426
- name="default"
427
- onBlur={[Function]}
428
- onChange={[Function]}
429
- onFocus={[Function]}
430
- onKeyDown={[Function]}
431
- onKeyUp={[Function]}
432
- required={false}
433
- style={
434
- Object {
435
- "border": "0px",
436
- "clip": "rect(0px, 0px, 0px, 0px)",
437
- "height": "1px",
438
- "margin": "-1px",
439
- "overflow": "hidden",
440
- "padding": "0px",
441
- "position": "absolute",
442
- "whiteSpace": "nowrap",
443
- "width": "1px",
444
- }
445
- }
446
- type="checkbox"
447
- />
448
- <span
449
- aria-hidden={true}
450
- className="chakra-switch__track css-14qxnv8"
451
- onMouseDown={[Function]}
452
- onMouseEnter={[Function]}
453
- onMouseLeave={[Function]}
454
- onMouseUp={[Function]}
455
- >
456
- <span
457
- className="chakra-switch__thumb css-0"
458
- />
459
- </span>
460
- <span
461
- className="chakra-switch__label css-1y8kf23"
462
- onMouseDown={[Function]}
463
- onTouchStart={[Function]}
464
- >
465
- Test Label
466
- </span>
467
- </label>
468
- </div>
469
- </div>
470
- `;
@@ -1,212 +0,0 @@
1
- import { action } from "@storybook/addon-actions";
2
- import {
3
- ArgsTable,
4
- Canvas,
5
- Description,
6
- Meta,
7
- Story,
8
- } from "@storybook/addon-docs";
9
- import { withDesign } from "storybook-addon-designs";
10
-
11
- import VideoPlayer from "./VideoPlayer";
12
- import { getCategory } from "../../utils/componentCategories";
13
- import DSProvider from "../../theme/provider";
14
-
15
- <Meta
16
- title={getCategory("VideoPlayer")}
17
- component={VideoPlayer}
18
- decorators={[withDesign]}
19
- parameters={{
20
- design: {
21
- type: "figma",
22
- url: "https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Main?node-id=10968%3A3680",
23
- },
24
- jest: ["VideoPlayer.test.tsx"],
25
- }}
26
- argTypes={{
27
- aspectRatio: {
28
- table: {
29
- defaultValue: { summary: "sixteenByNine" },
30
- },
31
- },
32
- className: { control: false },
33
- id: { control: false },
34
- showHelperInvalidText: {
35
- table: { defaultValue: { summary: true } },
36
- },
37
- videoType: {},
38
- }}
39
- />
40
-
41
- # Video Player
42
-
43
- | Component Version | DS Version |
44
- | ----------------- | ---------- |
45
- | Added | `0.23.2` |
46
- | Latest | `0.28.0` |
47
-
48
- ## Table of Contents
49
-
50
- - [Overview](#overview)
51
- - [Component Props](#component-props)
52
- - [Accessibility](#accessibility)
53
- - [Extracting Video IDs](#extracting-video-ids)
54
- - [Example Embed Code Snippets](#example-embed-code-snippets)
55
- - [Errored](#errored)
56
- - [HTML in Helper Text](#html-in-helper-text)
57
-
58
- ## Overview
59
-
60
- <Description of={VideoPlayer} />
61
-
62
- The `VideoPlayer` component is used to embed a `Vimeo` or `YouTube` video player
63
- on a page. The component requires the `embedCode` prop or both the `videoType`
64
- and `videoId` props. The component will not function properly if you try to set
65
- all of them.
66
-
67
- You can extract the videoId from the video's URL. **IMPORTANT:** Do not try to
68
- enter the full video URL as the `videoId` value.
69
-
70
- The `aspectRatio` prop is used to control the sizing of the space allotted for
71
- the video rendering. Ultimately, the `aspectRatio` prop should be set to match
72
- the aspect ratio of the video that is being rendered. The default aspect ratio
73
- is `16:9`.
74
-
75
- ## Component Props
76
-
77
- <Canvas withToolbar>
78
- <Story
79
- name="VideoPlayer"
80
- args={{
81
- aspectRatio: "sixteenByNine",
82
- className: undefined,
83
- descriptionText:
84
- "Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.",
85
- embedCode: `<iframe src="https://player.vimeo.com/video/421404144?h=5467db7edd" width="640" height="360" frameborder="0" allow="autoplay; fullscreen; picture-in-picture" allowfullscreen></iframe>`,
86
- headingText: "NYPL Video",
87
- helperText:
88
- "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.",
89
- id: "videoPlayer-id",
90
- iframeTitle: undefined,
91
- showHelperInvalidText: true,
92
- videoId: undefined,
93
- videoType: undefined,
94
- }}
95
- >
96
- {(args) => (
97
- <VideoPlayer
98
- {...args}
99
- aspectRatio={args.aspectRatio}
100
- embedCode={args.embedCode}
101
- videoId={args.videoId && args.videoId}
102
- videoType={args.videoType && args.videoType}
103
- />
104
- )}
105
- </Story>
106
- </Canvas>
107
-
108
- <ArgsTable story="VideoPlayer" />
109
-
110
- **Example Vimeo IDs:** `474719268`, `491405018`, `493795778` (square)<br />
111
- **Example YouTube IDs:** `PfqgDG1qrKg`, `roi5V8ppi7Y`, `nm-dD2tx6bk`
112
-
113
- ## Accessibility
114
-
115
- The `VideoPlayer` component renders an `iframe` element with either a Vimeo or
116
- YouTube video. `iframe`s can be accessible if a `title` attribute is provided.
117
- When passing in a video type and a video `id`, make sure to pass a title. Otherwise,
118
- the title must already be provided in the embed code value that is passed to the
119
- `embedCode` prop. A default one is provided but a custom one is recommended.
120
-
121
- Not all the Vimeo or YouTube videos passed to the `VideoPlayer` component will
122
- be owned by The New York Public Library. Because these videos are hosted on a
123
- third-party platform, we cannot guarantee that the video will be accessible.
124
- Besides setting the `title` in the embedded `iframe`, there are _some_ ways we
125
- can reduce accessibility issues.
126
-
127
- - Never use autoplay on videos; a user must click the play button to start the
128
- video.
129
- - Always show all the video player's controls for the user to interact with
130
- the video.
131
- - Keep the full screen option available.
132
-
133
- Resources:
134
-
135
- - [W3C Making Audio and Video Media Accessible](https://www.w3.org/WAI/media/av/)
136
- - [WebAIM Creating Accessible Frames and Iframes](https://webaim.org/techniques/frames/)
137
- - [MDN iframe: The Inline Frame element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe)
138
- - [Deque University Be Sure to Provide Titles for Iframes](https://dequeuniversity.com/tips/provide-iframe-titles)
139
-
140
- ## Extracting Video IDs
141
-
142
- ### Vimeo
143
-
144
- ```
145
- https://vimeo.com/[VIDEO_ID]
146
- https://vimeo.com/474719268
147
- ```
148
-
149
- ### YouTube
150
-
151
- ```
152
- https://www.youtube.com/watch?v=[VIDEO_ID]
153
- https://www.youtube.com/watch?v=nm-dD2tx6bk
154
- ```
155
-
156
- ## Example Embed Code Snippets
157
-
158
- The examples below are shown with precise HTML formatting. However, often the
159
- embed code snippets provided by 3rd party video services are delivered as one
160
- long string.
161
-
162
- ### Vimeo
163
-
164
- ```html
165
- <iframe
166
- src="https://player.vimeo.com/video/421404144?h=5467db7edd"
167
- width="640"
168
- height="360"
169
- frameborder="0"
170
- allow="autoplay; fullscreen; picture-in-picture"
171
- allowfullscreen
172
- ></iframe>
173
- ```
174
-
175
- ### YouTube
176
-
177
- ```html
178
- <iframe
179
- width="560"
180
- height="315"
181
- src="https://www.youtube.com/embed/nm-dD2tx6bk"
182
- title="YouTube video player"
183
- frameborder="0"
184
- allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
185
- allowfullscreen
186
- ></iframe>
187
- ```
188
-
189
- ## Errored
190
-
191
- If the necessary props are not passed to the `VideoPlayer` component, the
192
- component UI will display an error message.
193
-
194
- <Canvas>
195
- <DSProvider>
196
- <VideoPlayer videoId="https://vimeo.com/474719268" videoType="vimeo" />
197
- </DSProvider>
198
- </Canvas>
199
-
200
- ## HTML in Helper Text
201
-
202
- It's possible to include HTML in the `helperText` prop.
203
-
204
- <Canvas>
205
- <DSProvider>
206
- <VideoPlayer
207
- helperText="This helper text <b>contains HTML</b>."
208
- videoId="474719268"
209
- videoType="vimeo"
210
- />
211
- </DSProvider>
212
- </Canvas>