@nypl/design-system-react-components 1.0.2 → 1.0.3-beta

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 (282) hide show
  1. package/README.md +0 -2
  2. package/dist/components/Slider/Slider.d.ts +1 -2
  3. package/dist/components/TextInput/TextInput.d.ts +2 -1
  4. package/dist/design-system-react-components.cjs.development.js +33 -10
  5. package/dist/design-system-react-components.cjs.development.js.map +1 -1
  6. package/dist/design-system-react-components.cjs.production.min.js +1 -1
  7. package/dist/design-system-react-components.cjs.production.min.js.map +1 -1
  8. package/dist/design-system-react-components.esm.js +33 -10
  9. package/dist/design-system-react-components.esm.js.map +1 -1
  10. package/dist/hooks/{tests → __tests__}/useCarouselStyles.test.d.ts +0 -0
  11. package/dist/theme/components/global.d.ts +1 -1
  12. package/dist/theme/components/radio.d.ts +8 -0
  13. package/dist/theme/components/template.d.ts +4 -1
  14. package/package.json +2 -3
  15. package/CHANGELOG.md +0 -1430
  16. package/src/__tests__/fileMock.ts +0 -6
  17. package/src/__tests__/setup.ts +0 -27
  18. package/src/__tests__/utils/utils.test.ts +0 -18
  19. package/src/components/AccessibilityGuide/SkipNavigation.stories.mdx +0 -42
  20. package/src/components/Accordion/Accordion.stories.mdx +0 -333
  21. package/src/components/Accordion/Accordion.test.tsx +0 -237
  22. package/src/components/Accordion/Accordion.tsx +0 -137
  23. package/src/components/Accordion/__snapshots__/Accordion.test.tsx.snap +0 -734
  24. package/src/components/Autosuggest/Autosuggest.stories.mdx +0 -75
  25. package/src/components/Autosuggest/Autosuggest.stories.tsx +0 -211
  26. package/src/components/Autosuggest/_Autosuggest.scss +0 -51
  27. package/src/components/Breadcrumbs/Breadcrumbs.stories.mdx +0 -231
  28. package/src/components/Breadcrumbs/Breadcrumbs.test.tsx +0 -144
  29. package/src/components/Breadcrumbs/Breadcrumbs.tsx +0 -98
  30. package/src/components/Breadcrumbs/__snapshots__/Breadcrumbs.test.tsx.snap +0 -695
  31. package/src/components/Button/Button.stories.mdx +0 -320
  32. package/src/components/Button/Button.test.tsx +0 -184
  33. package/src/components/Button/Button.tsx +0 -95
  34. package/src/components/Button/__snapshots__/Button.test.tsx.snap +0 -106
  35. package/src/components/ButtonGroup/ButtonGroup.stories.mdx +0 -178
  36. package/src/components/ButtonGroup/ButtonGroup.test.tsx +0 -141
  37. package/src/components/ButtonGroup/ButtonGroup.tsx +0 -100
  38. package/src/components/ButtonGroup/__snapshots__/ButtonGroup.test.tsx.snap +0 -117
  39. package/src/components/Card/Card.stories.mdx +0 -1041
  40. package/src/components/Card/Card.test.tsx +0 -388
  41. package/src/components/Card/Card.tsx +0 -346
  42. package/src/components/Card/__snapshots__/Card.test.tsx.snap +0 -568
  43. package/src/components/Chakra/Box.stories.mdx +0 -52
  44. package/src/components/Chakra/Center.stories.mdx +0 -96
  45. package/src/components/Chakra/Flex.stories.mdx +0 -111
  46. package/src/components/Chakra/Grid.stories.mdx +0 -89
  47. package/src/components/Chakra/Stack.stories.mdx +0 -109
  48. package/src/components/Checkbox/Checkbox.stories.mdx +0 -243
  49. package/src/components/Checkbox/Checkbox.test.tsx +0 -350
  50. package/src/components/Checkbox/Checkbox.tsx +0 -152
  51. package/src/components/Checkbox/__snapshots__/Checkbox.test.tsx.snap +0 -661
  52. package/src/components/CheckboxGroup/CheckboxGroup.stories.mdx +0 -462
  53. package/src/components/CheckboxGroup/CheckboxGroup.test.tsx +0 -492
  54. package/src/components/CheckboxGroup/CheckboxGroup.tsx +0 -173
  55. package/src/components/CheckboxGroup/__snapshots__/CheckboxGroup.test.tsx.snap +0 -1842
  56. package/src/components/ComponentWrapper/ComponentWrapper.test.tsx +0 -163
  57. package/src/components/ComponentWrapper/ComponentWrapper.tsx +0 -76
  58. package/src/components/ComponentWrapper/__snapshots__/ComponentWrapper.test.tsx.snap +0 -103
  59. package/src/components/DatePicker/DatePicker.stories.mdx +0 -452
  60. package/src/components/DatePicker/DatePicker.test.tsx +0 -940
  61. package/src/components/DatePicker/DatePicker.tsx +0 -450
  62. package/src/components/DatePicker/_DatePicker.scss +0 -100
  63. package/src/components/DatePicker/__snapshots__/DatePicker.test.tsx.snap +0 -908
  64. package/src/components/Fieldset/Fieldset.stories.mdx +0 -96
  65. package/src/components/Fieldset/Fieldset.test.tsx +0 -155
  66. package/src/components/Fieldset/Fieldset.tsx +0 -55
  67. package/src/components/Fieldset/__snapshots__/Fieldset.test.tsx.snap +0 -89
  68. package/src/components/Form/Form.stories.mdx +0 -426
  69. package/src/components/Form/Form.test.tsx +0 -234
  70. package/src/components/Form/Form.tsx +0 -124
  71. package/src/components/Form/__snapshots__/Form.test.tsx.snap +0 -115
  72. package/src/components/Grid/SimpleGrid.stories.mdx +0 -336
  73. package/src/components/Grid/SimpleGrid.test.tsx +0 -79
  74. package/src/components/Grid/SimpleGrid.tsx +0 -49
  75. package/src/components/Grid/__snapshots__/SimpleGrid.test.tsx.snap +0 -23
  76. package/src/components/Heading/Heading.stories.mdx +0 -187
  77. package/src/components/Heading/Heading.test.tsx +0 -171
  78. package/src/components/Heading/Heading.tsx +0 -104
  79. package/src/components/Heading/__snapshots__/Heading.test.tsx.snap +0 -90
  80. package/src/components/HelperErrorText/HelperErrorText.stories.mdx +0 -172
  81. package/src/components/HelperErrorText/HelperErrorText.test.tsx +0 -114
  82. package/src/components/HelperErrorText/HelperErrorText.tsx +0 -62
  83. package/src/components/HelperErrorText/__snapshots__/HelperErrorText.test.tsx.snap +0 -93
  84. package/src/components/Hero/Hero.stories.mdx +0 -378
  85. package/src/components/Hero/Hero.test.tsx +0 -611
  86. package/src/components/Hero/Hero.tsx +0 -203
  87. package/src/components/Hero/__snapshots__/Hero.test.tsx.snap +0 -379
  88. package/src/components/HorizontalRule/HorizontalRule.stories.mdx +0 -73
  89. package/src/components/HorizontalRule/HorizontalRule.test.tsx +0 -54
  90. package/src/components/HorizontalRule/HorizontalRule.tsx +0 -27
  91. package/src/components/HorizontalRule/__snapshots__/HorizontalRule.test.tsx.snap +0 -44
  92. package/src/components/Icons/Icon.stories.mdx +0 -413
  93. package/src/components/Icons/Icon.test.tsx +0 -120
  94. package/src/components/Icons/Icon.tsx +0 -187
  95. package/src/components/Icons/IconSvgs.tsx +0 -64
  96. package/src/components/Icons/__snapshots__/Icon.test.tsx.snap +0 -129
  97. package/src/components/Image/Image.stories.mdx +0 -332
  98. package/src/components/Image/Image.test.tsx +0 -155
  99. package/src/components/Image/Image.tsx +0 -171
  100. package/src/components/Image/__snapshots__/Image.test.tsx.snap +0 -269
  101. package/src/components/Label/Label.stories.mdx +0 -100
  102. package/src/components/Label/Label.test.tsx +0 -116
  103. package/src/components/Label/Label.tsx +0 -55
  104. package/src/components/Label/__snapshots__/Label.test.tsx.snap +0 -45
  105. package/src/components/Link/Link.stories.mdx +0 -249
  106. package/src/components/Link/Link.test.tsx +0 -224
  107. package/src/components/Link/Link.tsx +0 -178
  108. package/src/components/Link/__snapshots__/Link.test.tsx.snap +0 -286
  109. package/src/components/List/List.stories.mdx +0 -393
  110. package/src/components/List/List.test.tsx +0 -265
  111. package/src/components/List/List.tsx +0 -156
  112. package/src/components/List/__snapshots__/List.test.tsx.snap +0 -213
  113. package/src/components/Logo/Logo.stories.mdx +0 -295
  114. package/src/components/Logo/Logo.test.tsx +0 -116
  115. package/src/components/Logo/Logo.tsx +0 -151
  116. package/src/components/Logo/LogoSvgs.tsx +0 -90
  117. package/src/components/Logo/__snapshots__/Logo.test.tsx.snap +0 -142
  118. package/src/components/Modal/Modal.stories.mdx +0 -294
  119. package/src/components/Modal/Modal.test.tsx +0 -157
  120. package/src/components/Modal/Modal.tsx +0 -154
  121. package/src/components/Modal/__snapshots__/Modal.test.tsx.snap +0 -25
  122. package/src/components/Notification/Notification.stories.mdx +0 -358
  123. package/src/components/Notification/Notification.test.tsx +0 -279
  124. package/src/components/Notification/Notification.tsx +0 -224
  125. package/src/components/Notification/__snapshots__/Notification.test.tsx.snap +0 -525
  126. package/src/components/Pagination/Pagination.stories.mdx +0 -184
  127. package/src/components/Pagination/Pagination.test.tsx +0 -419
  128. package/src/components/Pagination/Pagination.tsx +0 -269
  129. package/src/components/Pagination/__snapshots__/Pagination.test.tsx.snap +0 -544
  130. package/src/components/Placeholder/Placeholder.tsx +0 -19
  131. package/src/components/ProgressIndicator/ProgressIndicator.stories.mdx +0 -360
  132. package/src/components/ProgressIndicator/ProgressIndicator.test.tsx +0 -298
  133. package/src/components/ProgressIndicator/ProgressIndicator.tsx +0 -132
  134. package/src/components/ProgressIndicator/__snapshots__/ProgressIndicator.test.tsx.snap +0 -434
  135. package/src/components/Radio/Radio.stories.mdx +0 -216
  136. package/src/components/Radio/Radio.test.tsx +0 -247
  137. package/src/components/Radio/Radio.tsx +0 -119
  138. package/src/components/Radio/__snapshots__/Radio.test.tsx.snap +0 -451
  139. package/src/components/RadioGroup/RadioGroup.stories.mdx +0 -479
  140. package/src/components/RadioGroup/RadioGroup.test.tsx +0 -471
  141. package/src/components/RadioGroup/RadioGroup.tsx +0 -171
  142. package/src/components/RadioGroup/__snapshots__/RadioGroup.test.tsx.snap +0 -1550
  143. package/src/components/SearchBar/SearchBar.stories.mdx +0 -518
  144. package/src/components/SearchBar/SearchBar.test.tsx +0 -435
  145. package/src/components/SearchBar/SearchBar.tsx +0 -210
  146. package/src/components/SearchBar/__snapshots__/SearchBar.test.tsx.snap +0 -1049
  147. package/src/components/Select/Select.stories.mdx +0 -439
  148. package/src/components/Select/Select.test.tsx +0 -358
  149. package/src/components/Select/Select.tsx +0 -183
  150. package/src/components/Select/__snapshots__/Select.test.tsx.snap +0 -895
  151. package/src/components/SkeletonLoader/SkeletonLoader.stories.mdx +0 -142
  152. package/src/components/SkeletonLoader/SkeletonLoader.test.tsx +0 -116
  153. package/src/components/SkeletonLoader/SkeletonLoader.tsx +0 -123
  154. package/src/components/SkeletonLoader/__snapshots__/SkeletonLoader.test.tsx.snap +0 -898
  155. package/src/components/SkipNavigation/SkipNavigation.stories.mdx +0 -90
  156. package/src/components/SkipNavigation/SkipNavigation.test.tsx +0 -63
  157. package/src/components/SkipNavigation/SkipNavigation.tsx +0 -51
  158. package/src/components/SkipNavigation/__snapshots__/SkipNavigation.test.tsx.snap +0 -130
  159. package/src/components/Slider/Slider.stories.mdx +0 -628
  160. package/src/components/Slider/Slider.test.tsx +0 -736
  161. package/src/components/Slider/Slider.tsx +0 -322
  162. package/src/components/Slider/__snapshots__/Slider.test.tsx.snap +0 -2186
  163. package/src/components/StatusBadge/StatusBadge.stories.mdx +0 -109
  164. package/src/components/StatusBadge/StatusBadge.test.tsx +0 -70
  165. package/src/components/StatusBadge/StatusBadge.tsx +0 -35
  166. package/src/components/StatusBadge/__snapshots__/StatusBadge.test.tsx.snap +0 -47
  167. package/src/components/StructuredContent/StructuredContent.stories.mdx +0 -567
  168. package/src/components/StructuredContent/StructuredContent.test.tsx +0 -435
  169. package/src/components/StructuredContent/StructuredContent.tsx +0 -139
  170. package/src/components/StructuredContent/__snapshots__/StructuredContent.test.tsx.snap +0 -368
  171. package/src/components/StyleGuide/Bidirectionality.stories.mdx +0 -206
  172. package/src/components/StyleGuide/Breakpoints.stories.mdx +0 -55
  173. package/src/components/StyleGuide/Buttons.stories.mdx +0 -194
  174. package/src/components/StyleGuide/ColorCard.tsx +0 -43
  175. package/src/components/StyleGuide/Colors.stories.mdx +0 -201
  176. package/src/components/StyleGuide/DesignTokens.stories.mdx +0 -193
  177. package/src/components/StyleGuide/Forms.stories.mdx +0 -94
  178. package/src/components/StyleGuide/Iconography.stories.mdx +0 -142
  179. package/src/components/StyleGuide/Spacing.stories.mdx +0 -116
  180. package/src/components/StyleGuide/Typography.stories.mdx +0 -419
  181. package/src/components/Table/Table.stories.mdx +0 -272
  182. package/src/components/Table/Table.test.tsx +0 -241
  183. package/src/components/Table/Table.tsx +0 -152
  184. package/src/components/Table/__snapshots__/Table.test.tsx.snap +0 -1703
  185. package/src/components/Tabs/Tabs.stories.mdx +0 -338
  186. package/src/components/Tabs/Tabs.test.tsx +0 -298
  187. package/src/components/Tabs/Tabs.tsx +0 -264
  188. package/src/components/Tabs/__snapshots__/Tabs.test.tsx.snap +0 -584
  189. package/src/components/Template/Template.stories.mdx +0 -695
  190. package/src/components/Template/Template.test.tsx +0 -309
  191. package/src/components/Template/Template.tsx +0 -326
  192. package/src/components/Template/__snapshots__/Template.test.tsx.snap +0 -342
  193. package/src/components/Text/Text.stories.mdx +0 -103
  194. package/src/components/Text/Text.test.tsx +0 -63
  195. package/src/components/Text/Text.tsx +0 -50
  196. package/src/components/Text/__snapshots__/Text.test.tsx.snap +0 -50
  197. package/src/components/TextInput/TextInput.stories.mdx +0 -268
  198. package/src/components/TextInput/TextInput.test.tsx +0 -451
  199. package/src/components/TextInput/TextInput.tsx +0 -240
  200. package/src/components/TextInput/__snapshots__/TextInput.test.tsx.snap +0 -274
  201. package/src/components/Toggle/Toggle.stories.mdx +0 -237
  202. package/src/components/Toggle/Toggle.test.tsx +0 -170
  203. package/src/components/Toggle/Toggle.tsx +0 -128
  204. package/src/components/Toggle/__snapshots__/Toggle.test.tsx.snap +0 -470
  205. package/src/components/VideoPlayer/VideoPlayer.stories.mdx +0 -212
  206. package/src/components/VideoPlayer/VideoPlayer.test.tsx +0 -308
  207. package/src/components/VideoPlayer/VideoPlayer.tsx +0 -188
  208. package/src/components/VideoPlayer/__snapshots__/VideoPlayer.test.tsx.snap +0 -192
  209. package/src/docs/Chakra.stories.mdx +0 -563
  210. package/src/docs/Welcome.stories.mdx +0 -148
  211. package/src/helpers/types.ts +0 -1
  212. package/src/hooks/tests/useCarouselStyles.test.ts +0 -140
  213. package/src/hooks/tests/useNYPLTheme.test.tsx +0 -36
  214. package/src/hooks/useCarouselStyles.stories.mdx +0 -30
  215. package/src/hooks/useCarouselStyles.ts +0 -35
  216. package/src/hooks/useNYPLTheme.stories.mdx +0 -98
  217. package/src/hooks/useNYPLTheme.ts +0 -91
  218. package/src/hooks/useWindowSize.stories.mdx +0 -23
  219. package/src/hooks/useWindowSize.ts +0 -40
  220. package/src/index.ts +0 -136
  221. package/src/resources.scss +0 -6
  222. package/src/styles/base/_01-breakpoints.scss +0 -27
  223. package/src/styles/base/_02-mixins.scss +0 -103
  224. package/src/styles/base/_place-holder.scss +0 -33
  225. package/src/styles/space/_space-inline.scss +0 -79
  226. package/src/styles/space/_space-inset.scss +0 -57
  227. package/src/styles/space/_space-stack.scss +0 -116
  228. package/src/styles.scss +0 -23
  229. package/src/theme/components/accordion.ts +0 -25
  230. package/src/theme/components/breadcrumb.ts +0 -94
  231. package/src/theme/components/button.ts +0 -133
  232. package/src/theme/components/buttonGroup.ts +0 -10
  233. package/src/theme/components/card.ts +0 -237
  234. package/src/theme/components/checkbox.ts +0 -110
  235. package/src/theme/components/checkboxGroup.ts +0 -10
  236. package/src/theme/components/componentWrapper.ts +0 -14
  237. package/src/theme/components/customTable.ts +0 -77
  238. package/src/theme/components/datePicker.ts +0 -17
  239. package/src/theme/components/fieldset.ts +0 -23
  240. package/src/theme/components/global.ts +0 -91
  241. package/src/theme/components/globalMixins.ts +0 -24
  242. package/src/theme/components/heading.ts +0 -79
  243. package/src/theme/components/helperErrorText.ts +0 -14
  244. package/src/theme/components/hero.ts +0 -238
  245. package/src/theme/components/horizontalRule.ts +0 -17
  246. package/src/theme/components/icon.ts +0 -88
  247. package/src/theme/components/image.ts +0 -136
  248. package/src/theme/components/label.ts +0 -15
  249. package/src/theme/components/link.ts +0 -63
  250. package/src/theme/components/list.ts +0 -88
  251. package/src/theme/components/logo.ts +0 -58
  252. package/src/theme/components/notification.ts +0 -132
  253. package/src/theme/components/pagination.ts +0 -17
  254. package/src/theme/components/progressIndicator.ts +0 -67
  255. package/src/theme/components/radio.ts +0 -103
  256. package/src/theme/components/radioGroup.ts +0 -10
  257. package/src/theme/components/searchBar.ts +0 -19
  258. package/src/theme/components/select.ts +0 -72
  259. package/src/theme/components/skeletonLoader.ts +0 -113
  260. package/src/theme/components/skipNavigation.ts +0 -29
  261. package/src/theme/components/slider.ts +0 -95
  262. package/src/theme/components/statusBadge.ts +0 -26
  263. package/src/theme/components/structuredContent.ts +0 -149
  264. package/src/theme/components/tabs.ts +0 -109
  265. package/src/theme/components/template.ts +0 -114
  266. package/src/theme/components/text.ts +0 -38
  267. package/src/theme/components/textInput.ts +0 -65
  268. package/src/theme/components/toggle.ts +0 -109
  269. package/src/theme/components/videoPlayer.ts +0 -47
  270. package/src/theme/foundations/breakpoints.ts +0 -24
  271. package/src/theme/foundations/colors.ts +0 -212
  272. package/src/theme/foundations/global.ts +0 -43
  273. package/src/theme/foundations/radii.ts +0 -7
  274. package/src/theme/foundations/shadows.ts +0 -5
  275. package/src/theme/foundations/spacing.ts +0 -136
  276. package/src/theme/foundations/typography.ts +0 -107
  277. package/src/theme/index.ts +0 -131
  278. package/src/theme/provider.tsx +0 -9
  279. package/src/theme/types.ts +0 -1
  280. package/src/utils/componentCategories.ts +0 -152
  281. package/src/utils/interfaces.ts +0 -5
  282. package/src/utils/utils.ts +0 -84
@@ -1,567 +0,0 @@
1
- import {
2
- ArgsTable,
3
- Canvas,
4
- Description,
5
- Meta,
6
- Story,
7
- } from "@storybook/addon-docs";
8
- import { withDesign } from "storybook-addon-designs";
9
-
10
- import StructuredContent from "./StructuredContent";
11
- import DSProvider from "../../theme/provider";
12
- import { getCategory } from "../../utils/componentCategories";
13
-
14
- <Meta
15
- title={getCategory("StructuredContent")}
16
- component={StructuredContent}
17
- decorators={[withDesign]}
18
- parameters={{
19
- design: {
20
- type: "figma",
21
- url: "https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Main?node-id=36818%3A24923",
22
- },
23
- jest: ["StructuredContent.test.tsx"],
24
- }}
25
- argTypes={{
26
- className: { control: false },
27
- id: { control: false },
28
- "imageProps.aspectRatio": {
29
- table: {
30
- defaultValue: { summary: "square" },
31
- },
32
- },
33
- "imageProps.component": { control: false },
34
- "imageProps.position": {
35
- table: {
36
- defaultValue: { summary: "left" },
37
- },
38
- },
39
- "imageProps.size": {
40
- table: {
41
- defaultValue: { summary: "medium" },
42
- },
43
- },
44
- }}
45
- />
46
-
47
- # StructuredContent
48
-
49
- | Component Version | DS Version |
50
- | ----------------- | ---------- |
51
- | Added | `0.25.9` |
52
- | Latest | `0.28.0` |
53
-
54
- ## Table of Contents
55
-
56
- - [Overview](#overview)
57
- - [Component Props](#component-props)
58
- - [Accessibility](#accessibility)
59
- - [With HTML String Text Content](#with-html-string-text-content)
60
- - [With HTML Element Text Content](#with-html-element-text-content)
61
- - [Examples](#examples)
62
-
63
- ## Overview
64
-
65
- <Description of={StructuredContent} />
66
-
67
- ## Component Props
68
-
69
- <Canvas withToolbar>
70
- <Story
71
- name="StructuredContent with Controls"
72
- args={{
73
- bodyContent:
74
- "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod" +
75
- " tempor incididunt ut labore et dolore magna aliqua. Pellentesque massa" +
76
- " placerat duis ultricies lacus sed turpis tincidunt. Porttitor eget " +
77
- "dolor morbi non arcu risus quis varius. Faucibus in ornare quam viverra" +
78
- " orci sagittis. Nisl vel pretium lectus quam id leo in. Etiam dignissim" +
79
- " diam quis enim lobortis scelerisque fermentum. Diam maecenas sed enim" +
80
- " ut sem viverra. Diam quam nulla porttitor massa id neque. Sed " +
81
- "faucibus turpis in eu mi. Ornare lectus sit amet est placerat in. " +
82
- "Quis blandit turpis cursus in. Aliquam ut porttitor leo a diam " +
83
- "sollicitudin tempor id eu. Pellentesque eu tincidunt tortor aliquam " +
84
- "nulla facilisi cras fermentum. Porttitor leo a diam sollicitudin " +
85
- "tempor id eu nisl nunc. Feugiat nisl pretium fusce id velit ut tortor. " +
86
- "Mauris nunc congue nisi vitae suscipit tellus mauris a diam. Purus " +
87
- "gravida quis blandit turpis cursus in hac. Morbi tempus iaculis urna id " +
88
- "volutpat. Lectus nulla at volutpat diam ut venenatis. Donec ac odio " +
89
- "tempor orci dapibus ultrices in iaculis. Dui vivamus arcu felis " +
90
- "bibendum ut tristique. Cras semper auctor neque vitae tempus quam " +
91
- "pellentesque. Placerat orci nulla pellentesque dignissim enim sit " +
92
- "amet. Feugiat pretium nibh ipsum consequat. Placerat orci nulla " +
93
- "pellentesque dignissim. Suspendisse faucibus interdum posuere lorem. " +
94
- "Nullam non nisi est sit. Turpis egestas integer eget aliquet nibh " +
95
- "praesent. Tortor at risus viverra adipiscing at. Eu augue ut lectus " +
96
- "arcu bibendum at varius vel pharetra.",
97
- calloutText: "This is the callout text",
98
- className: undefined,
99
- headingText: "Heading text",
100
- id: "structured-content",
101
- "imageProps.alt": "Image alt text",
102
- "imageProps.aspectRatio": "square",
103
- "imageProps.caption": "Image caption",
104
- "imageProps.component": undefined,
105
- "imageProps.credit": "Image credit",
106
- "imageProps.position": "left",
107
- "imageProps.size": "medium",
108
- "imageProps.src": "https://placeimg.com/400/300/animals",
109
- }}
110
- >
111
- {(args) => (
112
- <StructuredContent
113
- bodyContent={args.bodyContent}
114
- calloutText={args.calloutText}
115
- className={args.className}
116
- headingText={args.headingText}
117
- id={args.id}
118
- imageProps={{
119
- alt: args["imageProps.alt"],
120
- aspectRatio: args["imageProps.aspectRatio"],
121
- caption: args["imageProps.caption"],
122
- credit: args["imageProps.credit"],
123
- position: args["imageProps.position"],
124
- size: args["imageProps.size"],
125
- src: args["imageProps.src"],
126
- }}
127
- />
128
- )}
129
- </Story>
130
- </Canvas>
131
-
132
- <ArgsTable story="StructuredContent with Controls" />
133
-
134
- ## Accessibility
135
-
136
- The `StructuredContent` component is a structured container around a specific
137
- set of content. While the main image can be controlled through the `imageProps`
138
- prop, the content will not always be controlled. If the content that is being
139
- passed is coming from a CMS, the content can contain any set of HTML elements that
140
- are _not_ controlled through Reservoir DS components. While this component
141
- attempts to style the added elements, we cannot guarantee that the content will
142
- be accessible. Please review your content and make sure that:
143
-
144
- - The content's font-size to be scaled to 200% without content overlapping.
145
- - Any additional images have descriptive (but not too lengthy) alt text.
146
- - Any additional heading levels should not be skipped. Meaning, a `<h2>` should
147
- not be followed by a `<h4>`.
148
- - Any links or text with colors should have a 4.5:1 contrast ratio.
149
-
150
- ## With HTML String Text Content
151
-
152
- The following body content is passed as a string to the `bodyContent` prop. It
153
- includes HTML tags in the string.
154
-
155
- <Canvas>
156
- <Story name="With HTML String Text Content">
157
- <StructuredContent
158
- calloutText="This is the callout text"
159
- headingText="Heading text"
160
- imageProps={{
161
- alt: "Image alt text",
162
- aspectRatio: "original",
163
- caption: "Image caption",
164
- credit: "Image credit",
165
- position: "left",
166
- size: "medium",
167
- src: "https://placeimg.com/400/300/animals",
168
- }}
169
- bodyContent={
170
- "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do " +
171
- "eiusmod tempor incididunt ut labore et dolore magna aliqua. " +
172
- "Pellentesque massa placerat duis ultricies lacus sed turpis tincidunt. " +
173
- "<a href='#'>Porttitor eget dolor</a> morbi non arcu risus quis varius. " +
174
- "Faucibus in ornare quam viverra orci sagittis.</p><p>Nisl vel pretium " +
175
- "lectus quam id leo in. Etiam dignissim diam quis enim lobortis " +
176
- "scelerisque fermentum. Diam maecenas sed enim ut sem viverra. <b>Diam " +
177
- "quam nulla porttitor massa id neque. Sed faucibus turpis in eu mi. " +
178
- "</b></p><p>Ornare lectus sit amet est placerat in. Quis blandit turpis " +
179
- "cursus in. Aliquam ut porttitor leo a diam sollicitudin tempor id eu. " +
180
- "Pellentesque eu tincidunt tortor aliquam nulla facilisi cras fermentum. " +
181
- "Porttitor leo a diam sollicitudin tempor id eu nisl nunc. Feugiat" +
182
- "nisl pretium fusce id velit ut tortor. Porttitor leo a diam sollicitudin " +
183
- "tempor id eu nisl nunc.</p><ul><li>one</li><li>two</li>" +
184
- "<li>three</li><li>four</li></ul><p><i>Mauris nunc congue nisi vitae suscipit" +
185
- "tellus mauris a diam. Purus gravida quis blandit turpis cursus in hac." +
186
- "Morbi tempus iaculis urna id volutpat. Lectus nulla at volutpat diam ut" +
187
- "venenatis. Donec ac odio tempor orci dapibus ultrices in iaculis. Dui vivamus" +
188
- "arcu felis bibendum ut tristique. Cras semper auctor neque vitae tempus" +
189
- "quam pellentesque. Placerat orci nulla pellentesque dignissim enim sit" +
190
- "amet. Feugiat pretium nibh ipsum consequat. Placerat orci nulla pellentesque" +
191
- "dignissim. Suspendisse faucibus interdum posuere lorem. Nullam non nisi" +
192
- "est sit. Turpis egestas integer eget aliquet nibh praesent. Tortor at risus" +
193
- "viverra adipiscing at. Eu augue ut lectus arcu bibendum at varius vel" +
194
- "pharetra.</i></p>"
195
- }
196
- />
197
- </Story>
198
- </Canvas>
199
-
200
- ## With HTML Element Text Content
201
-
202
- The following content is passed as HTML DOM elements to the `bodyContent` prop.
203
-
204
- <Canvas>
205
- <Story name="With HTML Element Text Content">
206
- <StructuredContent
207
- calloutText="This is the callout text"
208
- headingText="Heading text"
209
- imageProps={{
210
- alt: "Image alt text",
211
- aspectRatio: "original",
212
- caption: "Image caption",
213
- credit: "Image credit",
214
- position: "left",
215
- size: "medium",
216
- src: "https://placeimg.com/400/300/animals",
217
- }}
218
- bodyContent={
219
- <>
220
- <p>
221
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
222
- eiusmod tempor incididunt ut labore et dolore magna aliqua.
223
- Pellentesque massa placerat duis ultricies lacus sed turpis
224
- tincidunt. <a href="#">Porttitor eget dolor</a> morbi non arcu risus
225
- quis varius. Faucibus in ornare quam viverra orci sagittis.
226
- </p>
227
- <p>
228
- Nisl vel pretium lectus quam id leo in. Etiam dignissim diam quis
229
- enim lobortis scelerisque fermentum. Diam maecenas sed enim ut sem
230
- viverra.{" "}
231
- <b>
232
- Diam quam nulla porttitor massa id neque. Sed faucibus turpis in
233
- eu mi.
234
- </b>
235
- </p>
236
- <p>
237
- Ornare lectus sit amet est placerat in. Quis blandit turpis cursus
238
- in. Aliquam ut porttitor leo a diam sollicitudin tempor id eu.
239
- Pellentesque eu tincidunt tortor aliquam nulla facilisi cras
240
- fermentum. Porttitor leo a diam sollicitudin tempor id eu nisl nunc.
241
- Feugiat nisl pretium fusce id velit ut tortor. Porttitor leo a diam
242
- sollicitudin tempor id eu nisl nunc.
243
- </p>
244
- <h3 id="dates-times">Dates and Times</h3>
245
- <table role="table" id="times-table">
246
- <thead>
247
- <tr role="row">
248
- <th scope="col">Day</th>
249
- <th scope="col">Time</th>
250
- <th scope="col">Presentation</th>
251
- <th scope="col">Topic</th>
252
- </tr>
253
- </thead>
254
- <tbody>
255
- <tr role="row">
256
- <td>Sunday</td>
257
- <td>7:00 PM</td>
258
- <td>Tom Nook</td>
259
- <td>Manhattan</td>
260
- </tr>
261
- <tr role="row">
262
- <td>Monday</td>
263
- <td>7:00 PM</td>
264
- <td>Tom Nook</td>
265
- <td>The Bronx</td>
266
- </tr>
267
- <tr role="row">
268
- <td>Tuesday</td>
269
- <td>7:00 PM</td>
270
- <td>Tom Nook</td>
271
- <td>Queens</td>
272
- </tr>
273
- <tr role="row">
274
- <td>Wednesday</td>
275
- <td>7:00 PM</td>
276
- <td>Tom Nook</td>
277
- <td>Staten Island</td>
278
- </tr>
279
- <tr role="row">
280
- <td>Thursday</td>
281
- <td>7:00 PM</td>
282
- <td>Tom Nook</td>
283
- <td>Brooklyn</td>
284
- </tr>
285
- <tr role="row">
286
- <td>Friday</td>
287
- <td>7:00 PM</td>
288
- <td>Tom Nook</td>
289
- <td>Long Island</td>
290
- </tr>
291
- <tr role="row">
292
- <td>Saturday</td>
293
- <td>7:00 PM</td>
294
- <td>Tom Nook</td>
295
- <td>Upstate</td>
296
- </tr>
297
- </tbody>
298
- </table>
299
- <h3 id="parting-thoughts">Parting Thoughts</h3>
300
- <ol id="thoughts-list">
301
- <li>All text was read</li>
302
- <li>The two videos were watched</li>
303
- <li>All images were reviewed</li>
304
- <li>Notes were taken on a small notepad</li>
305
- <li>You enjoyed yourself</li>
306
- </ol>
307
- <p>
308
- <i>
309
- Mauris nunc congue nisi vitae suscipit tellus mauris a diam. Purus
310
- gravida quis blandit turpis cursus in hac. Morbi tempus iaculis
311
- urna id volutpat. Lectus nulla at volutpat diam ut venenatis.
312
- Donec ac odio tempor orci dapibus ultrices in iaculis. Dui vivamus
313
- arcu felis bibendum ut tristique. Cras semper auctor neque vitae
314
- tempus quam pellentesque. Placerat orci nulla pellentesque
315
- dignissim enim sit amet. Feugiat pretium nibh ipsum consequat.
316
- Placerat orci nulla pellentesque dignissim. Suspendisse faucibus
317
- interdum posuere lorem. Nullam non nisi est sit. Turpis egestas
318
- integer eget aliquet nibh praesent. Tortor at risus 'viverra
319
- adipiscing at. Eu augue ut lectus arcu bibendum at varius vel'
320
- pharetra.
321
- </i>
322
- </p>
323
- <section id="definition-doc-list">
324
- <h2>Episode Forty-Two: Readings and Resources</h2>
325
- <dl>
326
- <dt>Hillary Ballon and Kenneth T. Jackson, eds.</dt>
327
- <dd>
328
- <em>
329
- <a
330
- id="link-10"
331
- href="https://www.nypl.org/research/research-catalog/bib/b22154388"
332
- >
333
- Robert Moses and the Modern City: The Transformation of New
334
- York
335
- </a>
336
- </em>{" "}
337
- (W.W. Norton &amp; Co., 2007).
338
- </dd>
339
- <dt>The Brooklyn Battery Bridge</dt>
340
- <dd>
341
- "
342
- <a
343
- id="link-11"
344
- href="https://www.nypap.org/preservation-history/brooklyn-battery-bridge/"
345
- >
346
- The Brooklyn Battery Bridge
347
- </a>
348
- ," New York Preservation Archives Project.
349
- </dd>
350
- <dt>Robert Caro</dt>
351
- <dd>
352
- <em>
353
- <a
354
- id="link-12"
355
- href="https://www.nypl.org/research/research-catalog/bib/b21586756"
356
- >
357
- The Power Broker: Robert Moses and the Fall of New York
358
- </a>
359
- </em>{" "}
360
- (Vintage Books, 1975).&nbsp;
361
- </dd>
362
- <dt>Anthony Flint</dt>
363
- <dd>
364
- <em>
365
- <a
366
- id="link-13"
367
- href="https://www.nypl.org/research/research-catalog/bib/b20538453"
368
- >
369
- Wrestling with Moses: How Jane Jacobs Took on New York's
370
- Master Builder and Transformed the American City
371
- </a>
372
- </em>{" "}
373
- (Random House, 2009).
374
- </dd>
375
- </dl>
376
- </section>
377
- </>
378
- }
379
- />
380
- </Story>
381
- </Canvas>
382
-
383
- ## Examples
384
-
385
- The following has two `StructuredContent` components. The first one has an image
386
- but no callout content. The second component does not have an image.
387
-
388
- <Canvas>
389
- <DSProvider>
390
- <StructuredContent
391
- headingText="Heading text"
392
- imageProps={{
393
- alt: "Image alt text",
394
- aspectRatio: "original",
395
- caption: "Image caption",
396
- credit: "Image credit",
397
- position: "left",
398
- size: "medium",
399
- src: "https://placeimg.com/400/300/animals",
400
- }}
401
- bodyContent={
402
- "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do " +
403
- "eiusmod tempor incididunt ut labore et dolore magna aliqua. " +
404
- "Pellentesque massa placerat duis ultricies lacus sed turpis tincidunt. " +
405
- "<a href='#'>Porttitor eget dolor</a> morbi non arcu risus quis varius. " +
406
- "Faucibus in ornare quam viverra orci sagittis.</p><p>Nisl vel pretium " +
407
- "lectus quam id leo in. Etiam dignissim diam quis enim lobortis " +
408
- "scelerisque fermentum. Diam maecenas sed enim ut sem viverra. <b>Diam " +
409
- "quam nulla porttitor massa id neque. Sed faucibus turpis in eu mi. " +
410
- "</b></p><p>Ornare lectus sit amet est placerat in. Quis blandit turpis " +
411
- "cursus in. Aliquam ut porttitor leo a diam sollicitudin tempor id eu. " +
412
- "Pellentesque eu tincidunt tortor aliquam nulla facilisi cras fermentum. " +
413
- "Porttitor leo a diam sollicitudin tempor id eu nisl nunc. Feugiat" +
414
- "nisl pretium fusce id velit ut tortor. Porttitor leo a diam sollicitudin " +
415
- "tempor id eu nisl nunc.</p><ul><li>one</li><li>two</li>" +
416
- "<li>three</li><li>four</li></ul><p><i>Mauris nunc congue nisi vitae suscipit" +
417
- "tellus mauris a diam. Purus gravida quis blandit turpis cursus in hac." +
418
- "Morbi tempus iaculis urna id volutpat. Lectus nulla at volutpat diam ut" +
419
- "venenatis. Donec ac odio tempor orci dapibus ultrices in iaculis. Dui vivamus" +
420
- "arcu felis bibendum ut tristique. Cras semper auctor neque vitae tempus" +
421
- "quam pellentesque. Placerat orci nulla pellentesque dignissim enim sit" +
422
- "amet. Feugiat pretium nibh ipsum consequat. Placerat orci nulla pellentesque" +
423
- "dignissim. Suspendisse faucibus interdum posuere lorem. Nullam non nisi" +
424
- "est sit. Turpis egestas integer eget aliquet nibh praesent. Tortor at risus" +
425
- "viverra adipiscing at. Eu augue ut lectus arcu bibendum at varius vel" +
426
- "pharetra.</i></p>"
427
- }
428
- />
429
- <StructuredContent
430
- calloutText="This is the callout text"
431
- headingText="Heading text"
432
- bodyContent={
433
- "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do " +
434
- "eiusmod tempor incididunt ut labore et dolore magna aliqua. " +
435
- "Pellentesque massa placerat duis ultricies lacus sed turpis tincidunt. " +
436
- "<a href='#'>Porttitor eget dolor</a> morbi non arcu risus quis varius. " +
437
- "Faucibus in ornare quam viverra orci sagittis.</p><p>Nisl vel pretium " +
438
- "lectus quam id leo in. Etiam dignissim diam quis enim lobortis " +
439
- "scelerisque fermentum. Diam maecenas sed enim ut sem viverra. <b>Diam " +
440
- "quam nulla porttitor massa id neque. Sed faucibus turpis in eu mi.</b></p>"
441
- }
442
- />
443
- </DSProvider>
444
- </Canvas>
445
-
446
- The following has three `StructuredContent` components. The first one only has
447
- the callout content. The second has no callout content but an image and text content.
448
- The third one does not contain an image.
449
-
450
- <Canvas>
451
- <DSProvider>
452
- <StructuredContent
453
- calloutText="This is the callout text"
454
- headingText="Heading text"
455
- />
456
- <StructuredContent
457
- headingText="Heading text"
458
- imageProps={{
459
- alt: "Image alt text",
460
- aspectRatio: "original",
461
- caption: "Image caption",
462
- credit: "Image credit",
463
- position: "left",
464
- size: "medium",
465
- src: "https://placeimg.com/400/300/animals",
466
- }}
467
- bodyContent={
468
- "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do " +
469
- "eiusmod tempor incididunt ut labore et dolore magna aliqua. " +
470
- "Pellentesque massa placerat duis ultricies lacus sed turpis tincidunt. " +
471
- "<a href='#'>Porttitor eget dolor</a> morbi non arcu risus quis varius. " +
472
- "Faucibus in ornare quam viverra orci sagittis.</p><p>Nisl vel pretium " +
473
- "lectus quam id leo in. Etiam dignissim diam quis enim lobortis " +
474
- "scelerisque fermentum. Diam maecenas sed enim ut sem viverra. <b>Diam " +
475
- "quam nulla porttitor massa id neque. Sed faucibus turpis in eu mi. " +
476
- "</b></p><p>Ornare lectus sit amet est placerat in. Quis blandit turpis " +
477
- "cursus in. Aliquam ut porttitor leo a diam sollicitudin tempor id eu. " +
478
- "Pellentesque eu tincidunt tortor aliquam nulla facilisi cras fermentum. " +
479
- "Porttitor leo a diam sollicitudin tempor id eu nisl nunc. Feugiat nisl " +
480
- "pretium fusce id velit ut tortor. </p><p><i>Mauris nunc congue nisi " +
481
- "vitae suscipit tellus mauris a diam. Purus gravida quis blandit turpis " +
482
- "cursus in hac. Morbi tempus iaculis urna id volutpat. Lectus nulla at " +
483
- "volutpat diam ut venenatis. Donec ac odio tempor orci dapibus ultrices " +
484
- "in iaculis. Dui vivamus arcu felis bibendum ut tristique. Cras semper " +
485
- "auctor neque vitae tempus quam pellentesque. Placerat orci nulla " +
486
- "pellentesque dignissim enim sit amet. Feugiat pretium nibh ipsum " +
487
- "consequat. Placerat orci nulla pellentesque dignissim. Suspendisse " +
488
- "faucibus interdum posuere lorem. Nullam non nisi est sit. Turpis " +
489
- "egestas integer eget aliquet nibh praesent. Tortor at risus viverra " +
490
- "sadipiscing at. Eu augue ut lectus arcu bibendum at varius vel" +
491
- "pharetra.</i></p>"
492
- }
493
- />
494
- <StructuredContent
495
- calloutText="This is the callout text"
496
- headingText="Heading text"
497
- bodyContent={
498
- "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do " +
499
- "eiusmod tempor incididunt ut labore et dolore magna aliqua." +
500
- "Pellentesque massa placerat duis ultricies lacus sed turpis tincidunt. " +
501
- "<a href='#'>Porttitor eget dolor</a> morbi non arcu risus quis varius. " +
502
- "Faucibus in ornare quam viverra orci sagittis.</p><p>Nisl vel pretium " +
503
- "lectus quam id leo in. Etiam dignissim diam quis enim lobortis " +
504
- "scelerisque fermentum. Diam maecenas sed enim ut sem viverra. <b>Diam " +
505
- "quam nulla porttitor massa id neque. Sed faucibus turpis in eu mi.</b></p>"
506
- }
507
- />
508
- </DSProvider>
509
- </Canvas>
510
-
511
- The following has two `StructuredContent` components. The first one only displays
512
- text content. The second one has a callout content and image spanning full width.
513
-
514
- <Canvas>
515
- <DSProvider>
516
- <StructuredContent
517
- bodyContent={
518
- "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do " +
519
- "eiusmod tempor incididunt ut labore et dolore magna aliqua." +
520
- "Pellentesque massa placerat duis ultricies lacus sed turpis tincidunt. " +
521
- "<a href='#'>Porttitor eget dolor</a> morbi non arcu risus quis varius. " +
522
- "Faucibus in ornare quam viverra orci sagittis.</p><p>Nisl vel pretium " +
523
- "lectus quam id leo in. Etiam dignissim diam quis enim lobortis " +
524
- "scelerisque fermentum. Diam maecenas sed enim ut sem viverra. <b>Diam " +
525
- "quam nulla porttitor massa id neque. Sed faucibus turpis in eu mi.</b></p>"
526
- }
527
- />
528
- <StructuredContent
529
- calloutText="This is the callout text"
530
- headingText="Heading text"
531
- imageProps={{
532
- alt: "Image alt text",
533
- aspectRatio: "original",
534
- position: "center",
535
- size: "medium",
536
- src: "https://placeimg.com/400/300/animals",
537
- }}
538
- bodyContent={
539
- "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do " +
540
- "eiusmod tempor incididunt ut labore et dolore magna aliqua." +
541
- "Pellentesque massa placerat duis ultricies lacus sed turpis tincidunt. " +
542
- "<a href='#'>Porttitor eget dolor</a> morbi non arcu risus quis varius. " +
543
- "Faucibus in ornare quam viverra orci sagittis.</p><p>Nisl vel pretium " +
544
- "lectus quam id leo in. Etiam dignissim diam quis enim lobortis " +
545
- "scelerisque fermentum. Diam maecenas sed enim ut sem viverra. <b>Diam " +
546
- "quam nulla porttitor massa id neque. Sed faucibus turpis in eu mi. " +
547
- "</b></p><p>Ornare lectus sit amet est placerat in. Quis blandit turpis " +
548
- "cursus in. Aliquam ut porttitor leo a diam sollicitudin tempor id eu. " +
549
- "Pellentesque eu tincidunt tortor aliquam nulla facilisi cras fermentum. " +
550
- "Porttitor leo a diam sollicitudin tempor id eu nisl nunc. Feugiat nisl " +
551
- "pretium fusce id velit ut tortor. Porttitor leo a diam sollicitudin " +
552
- "tempor id eu nisl nunc.</p><ul><li>one</li><li>two</li><li>three</li>" +
553
- "<li>four</li></ul><p><i>Mauris nunc congue nisi vitae suscipit" +
554
- "tellus mauris a diam. Purus gravida quis blandit turpis cursus in hac." +
555
- "Morbi tempus iaculis urna id volutpat. Lectus nulla at volutpat diam ut" +
556
- "venenatis. Donec ac odio tempor orci dapibus ultrices in iaculis. Dui " +
557
- "vivamus arcu felis bibendum ut tristique. Cras semper auctor neque " +
558
- "vitae tempus quam pellentesque. Placerat orci nulla pellentesque " +
559
- "dignissim enim sit amet. Feugiat pretium nibh ipsum consequat. " +
560
- "Placerat orci nulla pellentesque dignissim. Suspendisse faucibus " +
561
- "interdum posuere lorem. Nullam non nisi est sit. Turpis egestas " +
562
- "integer eget aliquet nibh praesent. Tortor at risus viverra adipiscing " +
563
- "at. Eu augue ut lectus arcu bibendum at varius vel pharetra.</i></p>"
564
- }
565
- />
566
- </DSProvider>
567
- </Canvas>