@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,368 +0,0 @@
1
- // Jest Snapshot v1, https://goo.gl/fbAQLP
2
-
3
- exports[`StructuredContent renders the UI snapshot 1`] = `
4
- <div
5
- className="css-1xdhyk6"
6
- id="withHTMLStringContent"
7
- >
8
- <h2
9
- className="chakra-heading css-1xdhyk6"
10
- id="withHTMLStringContent-heading"
11
- >
12
- Heading text
13
- </h2>
14
- <h3
15
- className="chakra-heading css-1xdhyk6"
16
- id="withHTMLStringContent-callout"
17
- >
18
- This is the callout text
19
- </h3>
20
- <figure
21
- className="css-0"
22
- >
23
- <img
24
- alt="Image alt text"
25
- className="css-0"
26
- src="https://placeimg.com/400/300/animals"
27
- />
28
- <figcaption
29
- className="css-0"
30
- >
31
- <div
32
- className="css-0"
33
- >
34
- Image caption
35
- </div>
36
- <div
37
- className="css-0"
38
- >
39
- Image credit
40
- </div>
41
- </figcaption>
42
- </figure>
43
- <div
44
- className="structuredcontent-body"
45
- dangerouslySetInnerHTML={
46
- Object {
47
- "__html": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed doeiusmod tempor incididunt ut labore et dolore magna aliqua.Pellentesque massa placerat duis ultricies lacus sed turpis tincidunt. <a href='#'>Porttitor eget dolor</a> morbi non arcu risus quis varius.Faucibus in ornare quam viverra orci sagittis.</p><p>Nisl vel pretium lectusquam id leo in. Etiam dignissim diam quis enim lobortis scelerisque fermentum.Diam maecenas sed enim ut sem viverra. <b>Diam quam nulla porttitor massaid neque. Sed faucibus turpis in eu mi.</b></p><p>Ornare lectus sit amet est placeratin. Quis blandit turpis cursus in. Aliquam ut porttitor leo a diam sollicitudintempor id eu. Pellentesque eu tincidunt tortor aliquam nulla facilisi crasfermentum. Porttitor leo a diam sollicitudin tempor id eu nisl nunc. Feugiatnisl pretium fusce id velit ut tortor. Porttitor leo a diam sollicitudin tempor id eu nisl nunc.</p><ul><li>one</li><li>two</li><li>three</li><li>four</li></ul><p><i>Mauris nunc congue nisi vitae suscipittellus mauris a diam. Purus gravida quis blandit turpis cursus in hac.Morbi tempus iaculis urna id volutpat. Lectus nulla at volutpat diam utvenenatis. Donec ac odio tempor orci dapibus ultrices in iaculis. Dui vivamusarcu felis bibendum ut tristique. Cras semper auctor neque vitae tempusquam pellentesque. Placerat orci nulla pellentesque dignissim enim sitamet. Feugiat pretium nibh ipsum consequat. Placerat orci nulla pellentesquedignissim. Suspendisse faucibus interdum posuere lorem. Nullam non nisiest sit. Turpis egestas integer eget aliquet nibh praesent. Tortor at risusviverra adipiscing at. Eu augue ut lectus arcu bibendum at varius velpharetra.</i></p>",
48
- }
49
- }
50
- />
51
- </div>
52
- `;
53
-
54
- exports[`StructuredContent renders the UI snapshot 2`] = `
55
- <div
56
- className="css-1xdhyk6"
57
- id="withHTMLDOMContent"
58
- >
59
- <h2
60
- className="chakra-heading css-1xdhyk6"
61
- id="withHTMLDOMContent-heading"
62
- >
63
- Heading text
64
- </h2>
65
- <h3
66
- className="chakra-heading css-1xdhyk6"
67
- id="withHTMLDOMContent-callout"
68
- >
69
- This is the callout text
70
- </h3>
71
- <figure
72
- className="css-0"
73
- >
74
- <img
75
- alt="Image alt text"
76
- className="css-0"
77
- src="https://placeimg.com/400/300/animals"
78
- />
79
- <figcaption
80
- className="css-0"
81
- >
82
- <div
83
- className="css-0"
84
- >
85
- Image caption
86
- </div>
87
- <div
88
- className="css-0"
89
- >
90
- Image credit
91
- </div>
92
- </figcaption>
93
- </figure>
94
- <div
95
- className="structuredcontent-body css-0"
96
- >
97
- <p>
98
- Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Pellentesque massa placerat duis ultricies lacus sed turpis tincidunt.
99
- <a
100
- href="http://nypl.org"
101
- >
102
- Porttitor eget dolor
103
- </a>
104
- morbi non arcu risus quis varius. Faucibus in ornare quam viverra orci sagittis.
105
- </p>
106
- <p>
107
- Nisl vel pretium lectus quam id leo in. Etiam dignissim diam quis enim lobortis scelerisque fermentum. Diam maecenas sed enim ut sem viverra.
108
-
109
- <b>
110
- Diam quam nulla porttitor massa id neque. Sed faucibus turpis in eu mi.
111
- </b>
112
- </p>
113
- <p>
114
- Ornare lectus sit amet est placerat in. Quis blandit turpis cursus in. Aliquam ut porttitor leo a diam sollicitudin tempor id eu. Pellentesque eu tincidunt tortor aliquam nulla facilisi cras fermentum. Porttitor leo a diam sollicitudin tempor id eu nisl nunc. Feugiat nisl pretium fusce id velit ut tortor. Porttitor leo a diam sollicitudin tempor id eu nisl nunc.
115
- </p>
116
- <ul>
117
- <li>
118
- one
119
- </li>
120
- <li>
121
- two
122
- </li>
123
- <li>
124
- three
125
- </li>
126
- <li>
127
- four
128
- </li>
129
- </ul>
130
- <p>
131
- <i>
132
- Mauris nunc congue nisi vitae suscipit tellus mauris a diam. Purus gravida quis blandit turpis cursus in hac. Morbi tempus iaculis urna id volutpat. Lectus nulla at volutpat diam ut venenatis. Donec ac odio tempor orci dapibus ultrices in iaculis. Dui vivamus arcu felis bibendum ut tristique. Cras semper auctor neque vitae tempus quam pellentesque. Placerat orci nulla pellentesque dignissim enim sit amet. Feugiat pretium nibh ipsum consequat. Placerat orci nulla pellentesque dignissim. Suspendisse faucibus interdum posuere lorem. Nullam non nisi est sit. Turpis egestas integer eget aliquet nibh praesent. Tortor at risus 'viverra adipiscing at. Eu augue ut lectus arcu bibendum at varius vel' pharetra.
133
- </i>
134
- </p>
135
- </div>
136
- </div>
137
- `;
138
-
139
- exports[`StructuredContent renders the UI snapshot 3`] = `
140
- <div
141
- className="css-1xdhyk6"
142
- id="withoutAnImage"
143
- >
144
- <h2
145
- className="chakra-heading css-1xdhyk6"
146
- id="withoutAnImage-heading"
147
- >
148
- Heading text
149
- </h2>
150
- <h3
151
- className="chakra-heading css-1xdhyk6"
152
- id="withoutAnImage-callout"
153
- >
154
- This is the callout text
155
- </h3>
156
- <div
157
- className="structuredcontent-body"
158
- dangerouslySetInnerHTML={
159
- Object {
160
- "__html": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed doeiusmod tempor incididunt ut labore et dolore magna aliqua.Pellentesque massa placerat duis ultricies lacus sed turpis tincidunt. <a href='#'>Porttitor eget dolor</a> morbi non arcu risus quis varius.Faucibus in ornare quam viverra orci sagittis.</p><p>Nisl vel pretium lectusquam id leo in. Etiam dignissim diam quis enim lobortis scelerisque fermentum.Diam maecenas sed enim ut sem viverra. <b>Diam quam nulla porttitor massaid neque. Sed faucibus turpis in eu mi.</b></p><p>Ornare lectus sit amet est placeratin. Quis blandit turpis cursus in. Aliquam ut porttitor leo a diam sollicitudintempor id eu. Pellentesque eu tincidunt tortor aliquam nulla facilisi crasfermentum. Porttitor leo a diam sollicitudin tempor id eu nisl nunc. Feugiatnisl pretium fusce id velit ut tortor. Porttitor leo a diam sollicitudin tempor id eu nisl nunc.</p><ul><li>one</li><li>two</li><li>three</li><li>four</li></ul><p><i>Mauris nunc congue nisi vitae suscipittellus mauris a diam. Purus gravida quis blandit turpis cursus in hac.Morbi tempus iaculis urna id volutpat. Lectus nulla at volutpat diam utvenenatis. Donec ac odio tempor orci dapibus ultrices in iaculis. Dui vivamusarcu felis bibendum ut tristique. Cras semper auctor neque vitae tempusquam pellentesque. Placerat orci nulla pellentesque dignissim enim sitamet. Feugiat pretium nibh ipsum consequat. Placerat orci nulla pellentesquedignissim. Suspendisse faucibus interdum posuere lorem. Nullam non nisiest sit. Turpis egestas integer eget aliquet nibh praesent. Tortor at risusviverra adipiscing at. Eu augue ut lectus arcu bibendum at varius velpharetra.</i></p>",
161
- }
162
- }
163
- />
164
- </div>
165
- `;
166
-
167
- exports[`StructuredContent renders the UI snapshot 4`] = `
168
- <div
169
- className="css-1xdhyk6"
170
- id="withImageWithoutCaptionOrCredit"
171
- >
172
- <h2
173
- className="chakra-heading css-1xdhyk6"
174
- id="withImageWithoutCaptionOrCredit-heading"
175
- >
176
- Heading text
177
- </h2>
178
- <h3
179
- className="chakra-heading css-1xdhyk6"
180
- id="withImageWithoutCaptionOrCredit-callout"
181
- >
182
- This is the callout text
183
- </h3>
184
- <img
185
- alt="Image alt text"
186
- className="css-0"
187
- src="https://placeimg.com/400/300/animals"
188
- />
189
- <div
190
- className="structuredcontent-body"
191
- dangerouslySetInnerHTML={
192
- Object {
193
- "__html": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed doeiusmod tempor incididunt ut labore et dolore magna aliqua.Pellentesque massa placerat duis ultricies lacus sed turpis tincidunt. <a href='#'>Porttitor eget dolor</a> morbi non arcu risus quis varius.Faucibus in ornare quam viverra orci sagittis.</p><p>Nisl vel pretium lectusquam id leo in. Etiam dignissim diam quis enim lobortis scelerisque fermentum.Diam maecenas sed enim ut sem viverra. <b>Diam quam nulla porttitor massaid neque. Sed faucibus turpis in eu mi.</b></p><p>Ornare lectus sit amet est placeratin. Quis blandit turpis cursus in. Aliquam ut porttitor leo a diam sollicitudintempor id eu. Pellentesque eu tincidunt tortor aliquam nulla facilisi crasfermentum. Porttitor leo a diam sollicitudin tempor id eu nisl nunc. Feugiatnisl pretium fusce id velit ut tortor. Porttitor leo a diam sollicitudin tempor id eu nisl nunc.</p><ul><li>one</li><li>two</li><li>three</li><li>four</li></ul><p><i>Mauris nunc congue nisi vitae suscipittellus mauris a diam. Purus gravida quis blandit turpis cursus in hac.Morbi tempus iaculis urna id volutpat. Lectus nulla at volutpat diam utvenenatis. Donec ac odio tempor orci dapibus ultrices in iaculis. Dui vivamusarcu felis bibendum ut tristique. Cras semper auctor neque vitae tempusquam pellentesque. Placerat orci nulla pellentesque dignissim enim sitamet. Feugiat pretium nibh ipsum consequat. Placerat orci nulla pellentesquedignissim. Suspendisse faucibus interdum posuere lorem. Nullam non nisiest sit. Turpis egestas integer eget aliquet nibh praesent. Tortor at risusviverra adipiscing at. Eu augue ut lectus arcu bibendum at varius velpharetra.</i></p>",
194
- }
195
- }
196
- />
197
- </div>
198
- `;
199
-
200
- exports[`StructuredContent renders the UI snapshot 5`] = `
201
- <div
202
- className="css-1xdhyk6"
203
- id="withoutHeading"
204
- >
205
- <h3
206
- className="chakra-heading css-1xdhyk6"
207
- id="withoutHeading-callout"
208
- >
209
- This is the callout text
210
- </h3>
211
- <figure
212
- className="css-0"
213
- >
214
- <img
215
- alt="Image alt text"
216
- className="css-0"
217
- src="https://placeimg.com/400/300/animals"
218
- />
219
- <figcaption
220
- className="css-0"
221
- >
222
- <div
223
- className="css-0"
224
- >
225
- Image caption
226
- </div>
227
- <div
228
- className="css-0"
229
- >
230
- Image credit
231
- </div>
232
- </figcaption>
233
- </figure>
234
- <div
235
- className="structuredcontent-body"
236
- dangerouslySetInnerHTML={
237
- Object {
238
- "__html": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed doeiusmod tempor incididunt ut labore et dolore magna aliqua.Pellentesque massa placerat duis ultricies lacus sed turpis tincidunt. <a href='#'>Porttitor eget dolor</a> morbi non arcu risus quis varius.Faucibus in ornare quam viverra orci sagittis.</p><p>Nisl vel pretium lectusquam id leo in. Etiam dignissim diam quis enim lobortis scelerisque fermentum.Diam maecenas sed enim ut sem viverra. <b>Diam quam nulla porttitor massaid neque. Sed faucibus turpis in eu mi.</b></p><p>Ornare lectus sit amet est placeratin. Quis blandit turpis cursus in. Aliquam ut porttitor leo a diam sollicitudintempor id eu. Pellentesque eu tincidunt tortor aliquam nulla facilisi crasfermentum. Porttitor leo a diam sollicitudin tempor id eu nisl nunc. Feugiatnisl pretium fusce id velit ut tortor. Porttitor leo a diam sollicitudin tempor id eu nisl nunc.</p><ul><li>one</li><li>two</li><li>three</li><li>four</li></ul><p><i>Mauris nunc congue nisi vitae suscipittellus mauris a diam. Purus gravida quis blandit turpis cursus in hac.Morbi tempus iaculis urna id volutpat. Lectus nulla at volutpat diam utvenenatis. Donec ac odio tempor orci dapibus ultrices in iaculis. Dui vivamusarcu felis bibendum ut tristique. Cras semper auctor neque vitae tempusquam pellentesque. Placerat orci nulla pellentesque dignissim enim sitamet. Feugiat pretium nibh ipsum consequat. Placerat orci nulla pellentesquedignissim. Suspendisse faucibus interdum posuere lorem. Nullam non nisiest sit. Turpis egestas integer eget aliquet nibh praesent. Tortor at risusviverra adipiscing at. Eu augue ut lectus arcu bibendum at varius velpharetra.</i></p>",
239
- }
240
- }
241
- />
242
- </div>
243
- `;
244
-
245
- exports[`StructuredContent renders the UI snapshot 6`] = `
246
- <div
247
- className="css-1xdhyk6"
248
- id="withoutCalloutText"
249
- >
250
- <h2
251
- className="chakra-heading css-1xdhyk6"
252
- id="withoutCalloutText-heading"
253
- >
254
- Heading text
255
- </h2>
256
- <div
257
- className="structuredcontent-body"
258
- dangerouslySetInnerHTML={
259
- Object {
260
- "__html": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed doeiusmod tempor incididunt ut labore et dolore magna aliqua.Pellentesque massa placerat duis ultricies lacus sed turpis tincidunt. <a href='#'>Porttitor eget dolor</a> morbi non arcu risus quis varius.Faucibus in ornare quam viverra orci sagittis.</p><p>Nisl vel pretium lectusquam id leo in. Etiam dignissim diam quis enim lobortis scelerisque fermentum.Diam maecenas sed enim ut sem viverra. <b>Diam quam nulla porttitor massaid neque. Sed faucibus turpis in eu mi.</b></p><p>Ornare lectus sit amet est placeratin. Quis blandit turpis cursus in. Aliquam ut porttitor leo a diam sollicitudintempor id eu. Pellentesque eu tincidunt tortor aliquam nulla facilisi crasfermentum. Porttitor leo a diam sollicitudin tempor id eu nisl nunc. Feugiatnisl pretium fusce id velit ut tortor. Porttitor leo a diam sollicitudin tempor id eu nisl nunc.</p><ul><li>one</li><li>two</li><li>three</li><li>four</li></ul><p><i>Mauris nunc congue nisi vitae suscipittellus mauris a diam. Purus gravida quis blandit turpis cursus in hac.Morbi tempus iaculis urna id volutpat. Lectus nulla at volutpat diam utvenenatis. Donec ac odio tempor orci dapibus ultrices in iaculis. Dui vivamusarcu felis bibendum ut tristique. Cras semper auctor neque vitae tempusquam pellentesque. Placerat orci nulla pellentesque dignissim enim sitamet. Feugiat pretium nibh ipsum consequat. Placerat orci nulla pellentesquedignissim. Suspendisse faucibus interdum posuere lorem. Nullam non nisiest sit. Turpis egestas integer eget aliquet nibh praesent. Tortor at risusviverra adipiscing at. Eu augue ut lectus arcu bibendum at varius velpharetra.</i></p>",
261
- }
262
- }
263
- />
264
- </div>
265
- `;
266
-
267
- exports[`StructuredContent renders the UI snapshot 7`] = `
268
- <div
269
- className="css-kle7zy"
270
- id="withChakraProps"
271
- >
272
- <h2
273
- className="chakra-heading css-1xdhyk6"
274
- id="withChakraProps-heading"
275
- >
276
- Heading text
277
- </h2>
278
- <h3
279
- className="chakra-heading css-1xdhyk6"
280
- id="withChakraProps-callout"
281
- >
282
- This is the callout text
283
- </h3>
284
- <figure
285
- className="css-0"
286
- >
287
- <img
288
- alt="Image alt text"
289
- className="css-0"
290
- src="https://placeimg.com/400/300/animals"
291
- />
292
- <figcaption
293
- className="css-0"
294
- >
295
- <div
296
- className="css-0"
297
- >
298
- Image caption
299
- </div>
300
- <div
301
- className="css-0"
302
- >
303
- Image credit
304
- </div>
305
- </figcaption>
306
- </figure>
307
- <div
308
- className="structuredcontent-body"
309
- dangerouslySetInnerHTML={
310
- Object {
311
- "__html": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed doeiusmod tempor incididunt ut labore et dolore magna aliqua.Pellentesque massa placerat duis ultricies lacus sed turpis tincidunt. <a href='#'>Porttitor eget dolor</a> morbi non arcu risus quis varius.Faucibus in ornare quam viverra orci sagittis.</p><p>Nisl vel pretium lectusquam id leo in. Etiam dignissim diam quis enim lobortis scelerisque fermentum.Diam maecenas sed enim ut sem viverra. <b>Diam quam nulla porttitor massaid neque. Sed faucibus turpis in eu mi.</b></p><p>Ornare lectus sit amet est placeratin. Quis blandit turpis cursus in. Aliquam ut porttitor leo a diam sollicitudintempor id eu. Pellentesque eu tincidunt tortor aliquam nulla facilisi crasfermentum. Porttitor leo a diam sollicitudin tempor id eu nisl nunc. Feugiatnisl pretium fusce id velit ut tortor. Porttitor leo a diam sollicitudin tempor id eu nisl nunc.</p><ul><li>one</li><li>two</li><li>three</li><li>four</li></ul><p><i>Mauris nunc congue nisi vitae suscipittellus mauris a diam. Purus gravida quis blandit turpis cursus in hac.Morbi tempus iaculis urna id volutpat. Lectus nulla at volutpat diam utvenenatis. Donec ac odio tempor orci dapibus ultrices in iaculis. Dui vivamusarcu felis bibendum ut tristique. Cras semper auctor neque vitae tempusquam pellentesque. Placerat orci nulla pellentesque dignissim enim sitamet. Feugiat pretium nibh ipsum consequat. Placerat orci nulla pellentesquedignissim. Suspendisse faucibus interdum posuere lorem. Nullam non nisiest sit. Turpis egestas integer eget aliquet nibh praesent. Tortor at risusviverra adipiscing at. Eu augue ut lectus arcu bibendum at varius velpharetra.</i></p>",
312
- }
313
- }
314
- />
315
- </div>
316
- `;
317
-
318
- exports[`StructuredContent renders the UI snapshot 8`] = `
319
- <div
320
- className="css-1xdhyk6"
321
- data-testid="props"
322
- id="withOtherProps"
323
- >
324
- <h2
325
- className="chakra-heading css-1xdhyk6"
326
- id="withOtherProps-heading"
327
- >
328
- Heading text
329
- </h2>
330
- <h3
331
- className="chakra-heading css-1xdhyk6"
332
- id="withOtherProps-callout"
333
- >
334
- This is the callout text
335
- </h3>
336
- <figure
337
- className="css-0"
338
- >
339
- <img
340
- alt="Image alt text"
341
- className="css-0"
342
- src="https://placeimg.com/400/300/animals"
343
- />
344
- <figcaption
345
- className="css-0"
346
- >
347
- <div
348
- className="css-0"
349
- >
350
- Image caption
351
- </div>
352
- <div
353
- className="css-0"
354
- >
355
- Image credit
356
- </div>
357
- </figcaption>
358
- </figure>
359
- <div
360
- className="structuredcontent-body"
361
- dangerouslySetInnerHTML={
362
- Object {
363
- "__html": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed doeiusmod tempor incididunt ut labore et dolore magna aliqua.Pellentesque massa placerat duis ultricies lacus sed turpis tincidunt. <a href='#'>Porttitor eget dolor</a> morbi non arcu risus quis varius.Faucibus in ornare quam viverra orci sagittis.</p><p>Nisl vel pretium lectusquam id leo in. Etiam dignissim diam quis enim lobortis scelerisque fermentum.Diam maecenas sed enim ut sem viverra. <b>Diam quam nulla porttitor massaid neque. Sed faucibus turpis in eu mi.</b></p><p>Ornare lectus sit amet est placeratin. Quis blandit turpis cursus in. Aliquam ut porttitor leo a diam sollicitudintempor id eu. Pellentesque eu tincidunt tortor aliquam nulla facilisi crasfermentum. Porttitor leo a diam sollicitudin tempor id eu nisl nunc. Feugiatnisl pretium fusce id velit ut tortor. Porttitor leo a diam sollicitudin tempor id eu nisl nunc.</p><ul><li>one</li><li>two</li><li>three</li><li>four</li></ul><p><i>Mauris nunc congue nisi vitae suscipittellus mauris a diam. Purus gravida quis blandit turpis cursus in hac.Morbi tempus iaculis urna id volutpat. Lectus nulla at volutpat diam utvenenatis. Donec ac odio tempor orci dapibus ultrices in iaculis. Dui vivamusarcu felis bibendum ut tristique. Cras semper auctor neque vitae tempusquam pellentesque. Placerat orci nulla pellentesque dignissim enim sitamet. Feugiat pretium nibh ipsum consequat. Placerat orci nulla pellentesquedignissim. Suspendisse faucibus interdum posuere lorem. Nullam non nisiest sit. Turpis egestas integer eget aliquet nibh praesent. Tortor at risusviverra adipiscing at. Eu augue ut lectus arcu bibendum at varius velpharetra.</i></p>",
364
- }
365
- }
366
- />
367
- </div>
368
- `;
@@ -1,206 +0,0 @@
1
- import { Canvas, Meta } from "@storybook/addon-docs";
2
-
3
- import Button from "../Button/Button";
4
- import HelperErrorText from "../HelperErrorText/HelperErrorText";
5
- import Icon from "../Icons/Icon";
6
- import SearchBar from "../SearchBar/SearchBar";
7
- import { getCategory } from "../../utils/componentCategories";
8
- import DSProvider from "../../theme/provider";
9
-
10
- <Meta title={getCategory("Bidirectionality")} />
11
-
12
- # Bidirectionality
13
-
14
- When building UIs, we think in terms of left to right for layout direction. This
15
- is because the default language we build UIs for is English. At NYPL, we serve
16
- patrons who speak a variety of languages including languages such as Arabic or
17
- Hebrew which are right to left languages.
18
-
19
- To correctly render these languages, UIs should be mirrored to accomodate navigation
20
- and the passage of time, for example. Check out Material Design's
21
- [Bidirectionality documentation](https://material.io/design/usability/bidirectionality.html)
22
- for more information on layout mirroring.
23
-
24
- ## Terms
25
-
26
- - LTR = left to right
27
- - RTL = right to left
28
-
29
- ## Background
30
-
31
- While the majority of applications at NYPL will have a LTR direction, some applications
32
- will introduce internationalization through different means. While the Reservoir Design
33
- System (DS) has _no preference_ in how an application is internationalized, DS
34
- components should work appropriately in RTL configurations in any browser.
35
-
36
- ## Application Implementation
37
-
38
- Components in the DS will support layout and component mirroring, but application
39
- directionality should be implemented at the application level. The following are
40
- general guidelines on how to set up directionality but implementation will be up
41
- to the application and its architecture.
42
-
43
- ### `dir` HTML attribute
44
-
45
- The `dir` HTML attribute can be added to elements to indicate its directionality.
46
- The default direction is `"ltr"` or left to right. For languages, such as Arabic
47
- or Hebrew, the correct direction is right to left and the proper attribute
48
- implementation is `dir="rtl"`.
49
-
50
- The placement of this attribute can be added at the root `<html>` element but can
51
- also be placed in specific DOM elements within a page to target specific page sections.
52
- For example, if you only want to target NYPL DS components within your top-level
53
- `app` class, the `dir` attribute can be added to that element:
54
-
55
- ```jsx
56
- <div className="app" dir="rtl">
57
- ...
58
- </div>
59
- ```
60
-
61
- An anti-pattern is to add `dir` to all the elements you want to change directionality
62
- in. This HTML rule cascades down to its children elements so there is no need to
63
- do the following:
64
-
65
- ```jsx
66
- // don't do this
67
- <div className="app" dir="rtl">
68
- <div dir="rtl">
69
- <p dir="rtl">
70
- Some text <button dir="rtl">Button</button>
71
- </p>
72
- </div>
73
- </div>
74
- ```
75
-
76
- The `dir` HTML attribute is the recommended way to change directionality, but note
77
- that this attribute is not supported in Internet Explorer.
78
-
79
- - [MDN dir Documentation](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir)
80
- - [W3C internationalization dir QA](https://www.w3.org/International/questions/qa-html-dir)
81
-
82
- ### `direction` CSS rule
83
-
84
- Another option to change text and UI directionality is through the CSS `direction`
85
- rule. The default value for all elements is `direction: ltr;`. This rule is
86
- supported by all major browsers and can target specific elements through CSS rules:
87
-
88
- ```css
89
- .rightToLeft {
90
- direction: rtl;
91
- }
92
-
93
- .leftToRight {
94
- direction: ltr;
95
- }
96
- ```
97
-
98
- - [MDN direction Documentation](https://developer.mozilla.org/en-US/docs/Web/CSS/direction)
99
- - [CSS Tricks direction](https://css-tricks.com/almanac/properties/d/direction/)
100
-
101
- ### Examples using `dir` and `direction`
102
-
103
- For the following examples, the main element we are targeting is a div wrapper
104
- that sets a 400px width container for a `SearchBar` component. Notice that in both
105
- RTL examples (#2 and #3), it's not just the text that aligns right but the element
106
- itself that aligns right. This is why using the CSS rule `text-align: right;` is
107
- not the proper way to handle RTL languages since the UI needs to be mirrored (see above).
108
-
109
- In both RTL (#2 and #3) examples, the directionality changes for the div wrapper
110
- and there is no significant difference, but implementing both in a real application
111
- won't hurt.
112
-
113
- #1 - Left to right default
114
-
115
- <Canvas>
116
- <DSProvider>
117
- <div style={{ width: "400px" }}>
118
- <SearchBar
119
- helperText="Use a keyword or phrase to search!"
120
- id="example1"
121
- isRequired
122
- textInputProps={{
123
- labelText: "Item Search",
124
- name: "textInputName",
125
- placeholder: "Item Search",
126
- }}
127
- />
128
- </div>
129
- </DSProvider>
130
- </Canvas>
131
-
132
- #2 - Right to left using `dir="rtl"`. Click on "Show code" in the following
133
- block to see its code implementation.
134
-
135
- <Canvas>
136
- <DSProvider>
137
- <div dir="rtl">
138
- <div style={{ width: "400px" }}>
139
- <SearchBar
140
- helperText="استخدم كلمة رئيسية أو عبارة للبحث!"
141
- id="example2"
142
- isRequired
143
- textInputProps={{
144
- labelText: "Item Search",
145
- name: "textInputName",
146
- placeholder: "Item Search",
147
- }}
148
- />
149
- </div>
150
- </div>
151
- </DSProvider>
152
- </Canvas>
153
-
154
- #3 - Right to left using `direction: rtl;`. Click on "Show code" in the following
155
- block to see its code implementation.
156
-
157
- <Canvas>
158
- <DSProvider>
159
- <div style={{ direction: "rtl" }}>
160
- <div style={{ width: "400px" }}>
161
- <SearchBar
162
- helperText="استخدم كلمة رئيسية أو عبارة للبحث!"
163
- id="example3"
164
- isRequired
165
- textInputProps={{
166
- labelText: "Item Search",
167
- name: "textInputName",
168
- placeholder: "Item Search",
169
- }}
170
- />
171
- </div>
172
- </div>
173
- </DSProvider>
174
- </Canvas>
175
-
176
- ## Component Updates
177
-
178
- You may have noticed in the above RTL examples that in the `Button` component
179
- there is no space between the text and the icon. Although this may be difficult
180
- to see in the Arabic language example, it's more noticeable in the English examples
181
- below. The lack of space happens because the icon has a `margin-right` rule
182
- which works well in the default LTR display but does not apply well in the RTL
183
- display. No audit has been made to see what components need an update but in
184
- general, specifying an equal margin or padding to both sides of an element may
185
- help reduce any visual mistakes.
186
-
187
- <Canvas>
188
- <DSProvider>
189
- <div style={{ display: "flex", flexDirection: "column" }}>
190
- <div style={{ width: "300px" }}>
191
- A regular button:
192
- <Button id="button-ex4" type="submit">
193
- <Icon name="search" size="small" align="left" />
194
- Search
195
- </Button>
196
- <div dir="rtl">
197
- An RTL button:
198
- <Button id="button-ex5" type="submit">
199
- <Icon name="search" size="small" align="left" />
200
- Search
201
- </Button>
202
- </div>
203
- </div>
204
- </div>
205
- </DSProvider>
206
- </Canvas>
@@ -1,55 +0,0 @@
1
- import { Meta } from "@storybook/addon-docs";
2
-
3
- import Heading from "../Heading/Heading";
4
- import { getCategory } from "../../utils/componentCategories";
5
-
6
- <Meta title={getCategory("Breakpoints")} />
7
-
8
- # Breakpoints
9
-
10
- | Table of Contents |
11
- | ---------------------------------------------- |
12
- | 1. [General Information](#general-information) |
13
- | 2. [CSS Variables](#css-variables) |
14
- | 3. [Figma Reference](#figma-reference) |
15
-
16
- ## General Information
17
-
18
- The Reservoir Design System (DS) adheres to four global breakpoints for
19
- responsive layouts and typography.
20
-
21
- - Mobile: 320px
22
- - Tablet Portrait: 600px
23
- - Tablet Landscape: 960px
24
- - Desktop: 1280px
25
-
26
- ## CSS Variables
27
-
28
- The following CSS variables are available through the DS.
29
-
30
- ```css
31
- --nypl-breakpoint-small: 320px;
32
- --nypl-breakpoint-medium: 600px;
33
- --nypl-breakpoint-large: 960px;
34
- --nypl-breakpoint-xl: 1280px;
35
- ```
36
-
37
- ## SCSS Variables
38
-
39
- If you are using SCSS and imported the DS `/dist/resources.scss` file, then you
40
- can use the following SCSS variables in your media queries or SCSS `breakpoint`
41
- function (if used).
42
-
43
- ```scss
44
- $nypl-breakpoint-small: 320px;
45
- $nypl-breakpoint-medium: 600px;
46
- $nypl-breakpoint-large: 960px;
47
- $nypl-breakpoint-xl: 1280px;
48
- $nypl-max-width: $nypl-breakpoint-xl;
49
- ```
50
-
51
- ## Figma Reference
52
-
53
- For additional spacing information, please refer to the Figma Main file.
54
-
55
- - https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Master?node-id=17983%3A60146