@learningpool/ui 1.6.3 → 1.6.5

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 (424) hide show
  1. package/{dist/assets → assets}/Images.d.ts +0 -0
  2. package/{dist/assets → assets}/Images.js +0 -0
  3. package/{dist/components → components}/atoms/Autocomplete/Autocomplete.d.ts +0 -0
  4. package/{dist/components → components}/atoms/Autocomplete/Autocomplete.js +0 -0
  5. package/{dist/components → components}/atoms/Button/Button.d.ts +0 -0
  6. package/{dist/components → components}/atoms/Button/Button.js +0 -0
  7. package/{dist/components → components}/atoms/Checkbox/Checkbox.d.ts +0 -0
  8. package/{dist/components → components}/atoms/Checkbox/Checkbox.js +0 -0
  9. package/{dist/components → components}/atoms/IconButton/IconButton.d.ts +0 -0
  10. package/{dist/components → components}/atoms/IconButton/IconButton.js +0 -0
  11. package/{dist/components → components}/atoms/Radio/Radio.d.ts +0 -0
  12. package/{dist/components → components}/atoms/Radio/Radio.js +0 -0
  13. package/{dist/components → components}/atoms/Select/Select.d.ts +0 -0
  14. package/{dist/components → components}/atoms/Select/Select.js +0 -0
  15. package/{dist/components → components}/atoms/Slider/Slider.d.ts +0 -0
  16. package/{dist/components → components}/atoms/Slider/Slider.js +0 -0
  17. package/{dist/components → components}/atoms/Switch/Switch.d.ts +0 -0
  18. package/{dist/components → components}/atoms/Switch/Switch.js +0 -0
  19. package/{dist/components → components}/atoms/TextField/TextField.d.ts +0 -0
  20. package/{dist/components → components}/atoms/TextField/TextField.js +0 -0
  21. package/{dist/components → components}/atoms/ToggleButton/ToggleButton.d.ts +0 -0
  22. package/{dist/components → components}/atoms/ToggleButton/ToggleButton.js +0 -0
  23. package/{dist/components → components}/datadisplay/Avatar/Avatar.d.ts +0 -0
  24. package/{dist/components → components}/datadisplay/Avatar/Avatar.js +0 -0
  25. package/{dist/components → components}/datadisplay/Chip/Chip.d.ts +0 -0
  26. package/{dist/components → components}/datadisplay/Chip/Chip.js +0 -0
  27. package/{dist/components → components}/datadisplay/List/List.d.ts +0 -0
  28. package/{dist/components → components}/datadisplay/List/List.js +0 -0
  29. package/{dist/components → components}/datadisplay/Tooltip/Tooltip.d.ts +0 -0
  30. package/{dist/components → components}/datadisplay/Tooltip/Tooltip.js +0 -0
  31. package/{dist/components → components}/feedback/Alert/Alert.d.ts +0 -0
  32. package/{dist/components → components}/feedback/Alert/Alert.js +0 -0
  33. package/{dist/components → components}/landmarks/Header/Header.d.ts +0 -0
  34. package/{dist/components → components}/landmarks/Header/Header.js +0 -0
  35. package/{dist/components → components}/landmarks/Header/HeaderActionButtons.d.ts +0 -0
  36. package/{dist/components → components}/landmarks/Header/HeaderActionButtons.js +0 -0
  37. package/{dist/components → components}/landmarks/Header/HeaderStyles.d.ts +0 -0
  38. package/{dist/components → components}/landmarks/Header/HeaderStyles.js +0 -0
  39. package/{dist/components → components}/navigation/Drawer/Drawer.d.ts +0 -0
  40. package/{dist/components → components}/navigation/Drawer/Drawer.js +0 -0
  41. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigation.d.ts +0 -0
  42. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigation.js +0 -0
  43. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationAvatar.d.ts +0 -0
  44. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationAvatar.js +0 -0
  45. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationAvatarStyles.d.ts +0 -0
  46. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationAvatarStyles.js +0 -0
  47. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationDrawer.d.ts +0 -0
  48. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationDrawer.js +0 -0
  49. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationDrawerStyles.d.ts +0 -0
  50. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationDrawerStyles.js +0 -0
  51. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItem.d.ts +0 -0
  52. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItem.js +0 -0
  53. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItemFlyoutMenu.d.ts +0 -0
  54. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItemFlyoutMenu.js +0 -0
  55. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItemFlyoutMenuStyles.d.ts +0 -0
  56. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItemFlyoutMenuStyles.js +0 -0
  57. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItemStyles.d.ts +0 -0
  58. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItemStyles.js +0 -0
  59. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationMotion.d.ts +0 -0
  60. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationMotion.js +0 -0
  61. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationNotchIndicator.d.ts +0 -0
  62. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationNotchIndicator.js +0 -0
  63. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationSearch.d.ts +0 -0
  64. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationSearch.js +0 -0
  65. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationSearchStyles.d.ts +0 -0
  66. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationSearchStyles.js +0 -0
  67. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationStyles.d.ts +0 -0
  68. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationStyles.js +0 -0
  69. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationToggleSearchX.d.ts +0 -0
  70. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationToggleSearchX.js +0 -0
  71. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationToggleX.d.ts +0 -0
  72. package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationToggleX.js +0 -0
  73. package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigation.d.ts +1 -0
  74. package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigation.js +12 -10
  75. package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationAvatar.d.ts +0 -0
  76. package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationAvatar.js +11 -7
  77. package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationAvatarStyles.d.ts +49 -0
  78. package/components/navigation/VerticalNavigation/VerticalNavigationAvatarStyles.js +33 -0
  79. package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItem.d.ts +0 -0
  80. package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItem.js +0 -0
  81. package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItemFlyoutMenu.d.ts +0 -0
  82. package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItemFlyoutMenu.js +3 -3
  83. package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItemFlyoutMenuStyles.d.ts +1 -0
  84. package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItemFlyoutMenuStyles.js +16 -15
  85. package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItemStyles.d.ts +0 -0
  86. package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItemStyles.js +3 -3
  87. package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationMotion.d.ts +0 -0
  88. package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationMotion.js +0 -0
  89. package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationStyles.d.ts +6 -1
  90. package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationStyles.js +14 -15
  91. package/{dist/components → components}/pages/ErrorPage/ErrorPage.d.ts +0 -0
  92. package/{dist/components → components}/pages/ErrorPage/ErrorPage.js +0 -0
  93. package/{dist/components → components}/pages/ErrorPage/ErrorPageStyles.d.ts +0 -0
  94. package/{dist/components → components}/pages/ErrorPage/ErrorPageStyles.js +0 -0
  95. package/{dist/components → components}/pages/SideInSide/SideInSide.d.ts +0 -0
  96. package/{dist/components → components}/pages/SideInSide/SideInSide.js +0 -0
  97. package/{dist/components → components}/pages/SideInSide/SideInSideStyles.d.ts +0 -0
  98. package/{dist/components → components}/pages/SideInSide/SideInSideStyles.js +0 -0
  99. package/{dist/components → components}/stream/AppSwitcher/AppSwitcher.d.ts +0 -0
  100. package/{dist/components → components}/stream/AppSwitcher/AppSwitcher.js +1 -1
  101. package/{dist/components → components}/stream/AppSwitcher/AppSwitcherItem.d.ts +0 -0
  102. package/{dist/components → components}/stream/AppSwitcher/AppSwitcherItem.js +0 -0
  103. package/{dist/components → components}/stream/AppSwitcher/AppSwitcherStyles.d.ts +0 -0
  104. package/{dist/components → components}/stream/AppSwitcher/AppSwitcherStyles.js +8 -6
  105. package/{dist/components → components}/stream/AppSwitcher/constants.d.ts +0 -0
  106. package/{dist/components → components}/stream/AppSwitcher/constants.js +0 -0
  107. package/{dist/index.d.ts → index.d.ts} +0 -0
  108. package/{dist/index.js → index.js} +0 -0
  109. package/lang/en-us.d.ts +15 -0
  110. package/lang/en-us.js +18 -0
  111. package/package.json +3 -70
  112. package/{dist/types → types}/components/navigation/VerticalNavigation.d.ts +0 -0
  113. package/{dist/types → types}/components/navigation/VerticalNavigation.js +0 -0
  114. package/{dist/types → types}/components/navigation/VerticalNavigationAvatar.d.ts +1 -0
  115. package/{dist/types → types}/components/navigation/VerticalNavigationAvatar.js +0 -0
  116. package/{dist/types → types}/components/stream/AppSwitcher.d.ts +0 -0
  117. package/{dist/types → types}/components/stream/AppSwitcher.js +0 -0
  118. package/{dist/types → types}/index.d.ts +0 -0
  119. package/{dist/types → types}/index.js +0 -0
  120. package/{dist/utils → utils}/constants.d.ts +0 -0
  121. package/{dist/utils → utils}/constants.js +0 -0
  122. package/{dist/utils → utils}/helpers.d.ts +0 -0
  123. package/{dist/utils → utils}/helpers.js +0 -0
  124. package/{dist/utils → utils}/hooks.d.ts +0 -0
  125. package/{dist/utils → utils}/hooks.js +0 -0
  126. package/{dist/utils → utils}/index.d.ts +0 -0
  127. package/{dist/utils → utils}/index.js +0 -0
  128. package/{dist/utils → utils}/theme.d.ts +0 -0
  129. package/{dist/utils → utils}/theme.js +0 -0
  130. package/.eslintrc.js +0 -40
  131. package/.github/pull_request_template.md +0 -23
  132. package/.github/renovate.json +0 -57
  133. package/.github/workflows/integration.yml +0 -53
  134. package/.github/workflows/wss.yml +0 -22
  135. package/.jest-test-results.json +0 -1
  136. package/.releaserc +0 -32
  137. package/.storybook/learningpoolTheme.js +0 -39
  138. package/.storybook/main.js +0 -21
  139. package/.storybook/manager-head.html +0 -175
  140. package/.storybook/manager.js +0 -34
  141. package/.storybook/preview-head.html +0 -212
  142. package/.storybook/preview.js +0 -120
  143. package/.storybook/storybook-sort.js +0 -54
  144. package/CHANGELOG.md +0 -20
  145. package/amplify.yml +0 -16
  146. package/babel.config.json +0 -14
  147. package/dist/components/navigation/VerticalNavigation/VerticalNavigationAvatarStyles.js +0 -31
  148. package/dist/lang/en-us.d.ts +0 -6
  149. package/dist/lang/en-us.js +0 -6
  150. package/dist/package.json +0 -41
  151. package/jest.config.ts +0 -11
  152. package/jest.setup.ts +0 -5
  153. package/license +0 -7
  154. package/merge.js +0 -27
  155. package/public/android-chrome-192x192.png +0 -0
  156. package/public/android-chrome-512x512.png +0 -0
  157. package/public/apple-touch-icon.png +0 -0
  158. package/public/assets/atoms.svg +0 -5
  159. package/public/assets/automation.svg +0 -1
  160. package/public/assets/avatar-1.jpg +0 -0
  161. package/public/assets/avatar-2.jpg +0 -0
  162. package/public/assets/avatar-3.jpg +0 -0
  163. package/public/assets/flux/icon-dark.svg +0 -6
  164. package/public/assets/flux/icon-light.svg +0 -1
  165. package/public/assets/flux/icon-white.svg +0 -6
  166. package/public/assets/flux/icon.svg +0 -6
  167. package/public/assets/flux/logo-dark.svg +0 -22
  168. package/public/assets/flux/logo-light.svg +0 -1
  169. package/public/assets/flux/logo-white.svg +0 -22
  170. package/public/assets/flux/logo.svg +0 -22
  171. package/public/assets/iPhone6.jpg +0 -0
  172. package/public/assets/iPhone6Plus.jpg +0 -0
  173. package/public/assets/lp-logo.png +0 -0
  174. package/public/assets/lplogo.svg +0 -1
  175. package/public/assets/molecules.svg +0 -8
  176. package/public/assets/organisms.svg +0 -21
  177. package/public/assets/pages.svg +0 -4
  178. package/public/assets/particles.svg +0 -3
  179. package/public/assets/stream-dark.png +0 -0
  180. package/public/assets/stream-suite-logo.svg +0 -38
  181. package/public/assets/stream-white.png +0 -0
  182. package/public/assets/stream.png +0 -0
  183. package/public/assets/templates.svg +0 -3
  184. package/public/favicon-16x16.png +0 -0
  185. package/public/favicon-32x32.png +0 -0
  186. package/public/favicon.ico +0 -0
  187. package/public/index.html +0 -43
  188. package/public/logo192.png +0 -0
  189. package/public/logo512.png +0 -0
  190. package/public/manifest.json +0 -25
  191. package/public/robots.txt +0 -3
  192. package/public/site.webmanifest +0 -1
  193. package/readme.md +0 -132
  194. package/src/docs.tsx +0 -167
  195. package/src/lib/assets/Images.tsx +0 -47
  196. package/src/lib/assets/stream-suite-logo.svg +0 -38
  197. package/src/lib/components/atoms/Autocomplete/Autocomplete.test.tsx +0 -179
  198. package/src/lib/components/atoms/Autocomplete/Autocomplete.tsx +0 -14
  199. package/src/lib/components/atoms/Button/Button.test.tsx +0 -166
  200. package/src/lib/components/atoms/Button/Button.tsx +0 -16
  201. package/src/lib/components/atoms/Checkbox/Checkbox.test.tsx +0 -85
  202. package/src/lib/components/atoms/Checkbox/Checkbox.tsx +0 -10
  203. package/src/lib/components/atoms/IconButton/IconButton.test.tsx +0 -60
  204. package/src/lib/components/atoms/IconButton/IconButton.tsx +0 -9
  205. package/src/lib/components/atoms/Radio/Radio.test.tsx +0 -136
  206. package/src/lib/components/atoms/Radio/Radio.tsx +0 -10
  207. package/src/lib/components/atoms/Select/Select.test.tsx +0 -158
  208. package/src/lib/components/atoms/Select/Select.tsx +0 -12
  209. package/src/lib/components/atoms/Slider/Slider.test.tsx +0 -103
  210. package/src/lib/components/atoms/Slider/Slider.tsx +0 -10
  211. package/src/lib/components/atoms/Switch/Switch.test.tsx +0 -96
  212. package/src/lib/components/atoms/Switch/Switch.tsx +0 -10
  213. package/src/lib/components/atoms/TextField/TextField.test.tsx +0 -131
  214. package/src/lib/components/atoms/TextField/TextField.tsx +0 -31
  215. package/src/lib/components/atoms/ToggleButton/ToggleButton.test.tsx +0 -122
  216. package/src/lib/components/atoms/ToggleButton/ToggleButton.tsx +0 -10
  217. package/src/lib/components/datadisplay/Avatar/Avatar.test.tsx +0 -187
  218. package/src/lib/components/datadisplay/Avatar/Avatar.tsx +0 -35
  219. package/src/lib/components/datadisplay/Avatar/avatar-1.jpg +0 -0
  220. package/src/lib/components/datadisplay/Chip/Chip.test.tsx +0 -82
  221. package/src/lib/components/datadisplay/Chip/Chip.tsx +0 -11
  222. package/src/lib/components/datadisplay/List/List.test.tsx +0 -168
  223. package/src/lib/components/datadisplay/List/List.tsx +0 -8
  224. package/src/lib/components/datadisplay/Tooltip/Tooltip.test.tsx +0 -98
  225. package/src/lib/components/datadisplay/Tooltip/Tooltip.tsx +0 -9
  226. package/src/lib/components/feedback/Alert/Alert.test.tsx +0 -139
  227. package/src/lib/components/feedback/Alert/Alert.tsx +0 -10
  228. package/src/lib/components/landmarks/Header/Header.tsx +0 -140
  229. package/src/lib/components/landmarks/Header/HeaderActionButtons.tsx +0 -117
  230. package/src/lib/components/landmarks/Header/HeaderStyles.tsx +0 -62
  231. package/src/lib/components/navigation/Drawer/Drawer.test.tsx +0 -95
  232. package/src/lib/components/navigation/Drawer/Drawer.tsx +0 -21
  233. package/src/lib/components/navigation/MobileNavigation/MobileNavigation.tsx +0 -276
  234. package/src/lib/components/navigation/MobileNavigation/MobileNavigationAvatar.tsx +0 -334
  235. package/src/lib/components/navigation/MobileNavigation/MobileNavigationAvatarStyles.tsx +0 -77
  236. package/src/lib/components/navigation/MobileNavigation/MobileNavigationDrawer.tsx +0 -197
  237. package/src/lib/components/navigation/MobileNavigation/MobileNavigationDrawerStyles.tsx +0 -143
  238. package/src/lib/components/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItem.tsx +0 -192
  239. package/src/lib/components/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItemFlyoutMenu.tsx +0 -67
  240. package/src/lib/components/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItemFlyoutMenuStyles.tsx +0 -192
  241. package/src/lib/components/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItemStyles.tsx +0 -217
  242. package/src/lib/components/navigation/MobileNavigation/MobileNavigationMotion.tsx +0 -119
  243. package/src/lib/components/navigation/MobileNavigation/MobileNavigationNotchIndicator.tsx +0 -35
  244. package/src/lib/components/navigation/MobileNavigation/MobileNavigationSearch.tsx +0 -114
  245. package/src/lib/components/navigation/MobileNavigation/MobileNavigationSearchStyles.tsx +0 -47
  246. package/src/lib/components/navigation/MobileNavigation/MobileNavigationStyles.tsx +0 -320
  247. package/src/lib/components/navigation/MobileNavigation/MobileNavigationToggleSearchX.tsx +0 -59
  248. package/src/lib/components/navigation/MobileNavigation/MobileNavigationToggleX.tsx +0 -51
  249. package/src/lib/components/navigation/VerticalNavigation/VerticalNavigation.tsx +0 -468
  250. package/src/lib/components/navigation/VerticalNavigation/VerticalNavigationAvatar.tsx +0 -208
  251. package/src/lib/components/navigation/VerticalNavigation/VerticalNavigationAvatarStyles.tsx +0 -75
  252. package/src/lib/components/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItem.tsx +0 -196
  253. package/src/lib/components/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItemFlyoutMenu.tsx +0 -94
  254. package/src/lib/components/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItemFlyoutMenuStyles.tsx +0 -212
  255. package/src/lib/components/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItemStyles.tsx +0 -240
  256. package/src/lib/components/navigation/VerticalNavigation/VerticalNavigationMotion.tsx +0 -119
  257. package/src/lib/components/navigation/VerticalNavigation/VerticalNavigationStyles.tsx +0 -302
  258. package/src/lib/components/pages/ErrorPage/ErrorPage.test.tsx +0 -78
  259. package/src/lib/components/pages/ErrorPage/ErrorPage.tsx +0 -50
  260. package/src/lib/components/pages/ErrorPage/ErrorPageStyles.tsx +0 -30
  261. package/src/lib/components/pages/SideInSide/SideInSide.tsx +0 -100
  262. package/src/lib/components/pages/SideInSide/SideInSideStyles.tsx +0 -62
  263. package/src/lib/components/stream/AppSwitcher/AppSwitcher.tsx +0 -381
  264. package/src/lib/components/stream/AppSwitcher/AppSwitcherItem.tsx +0 -84
  265. package/src/lib/components/stream/AppSwitcher/AppSwitcherStyles.tsx +0 -325
  266. package/src/lib/components/stream/AppSwitcher/constants.tsx +0 -28
  267. package/src/lib/index.tsx +0 -148
  268. package/src/lib/lang/en-us.js +0 -6
  269. package/src/lib/types/components/navigation/VerticalNavigation.ts +0 -52
  270. package/src/lib/types/components/navigation/VerticalNavigationAvatar.ts +0 -26
  271. package/src/lib/types/components/stream/AppSwitcher.ts +0 -10
  272. package/src/lib/types/index.ts +0 -9
  273. package/src/lib/utils/constants.tsx +0 -11
  274. package/src/lib/utils/helpers.tsx +0 -77
  275. package/src/lib/utils/hooks.tsx +0 -33
  276. package/src/lib/utils/index.tsx +0 -4
  277. package/src/lib/utils/theme.tsx +0 -79
  278. package/src/react-app-env.d.ts +0 -1
  279. package/src/setupTests.ts +0 -5
  280. package/src/stories/Components/DataDisplay/Avatar/Accessibility.stories.mdx +0 -34
  281. package/src/stories/Components/DataDisplay/Avatar/AllCombinations.tsx +0 -56
  282. package/src/stories/Components/DataDisplay/Avatar/Avatar.stories.tsx +0 -19
  283. package/src/stories/Components/DataDisplay/Avatar/Examples.stories.tsx +0 -278
  284. package/src/stories/Components/DataDisplay/Avatar/Overview.stories.mdx +0 -47
  285. package/src/stories/Components/DataDisplay/Chip/Accessibility.stories.mdx +0 -29
  286. package/src/stories/Components/DataDisplay/Chip/AllCombinations.tsx +0 -58
  287. package/src/stories/Components/DataDisplay/Chip/Chip.stories.tsx +0 -21
  288. package/src/stories/Components/DataDisplay/Chip/Examples.stories.tsx +0 -126
  289. package/src/stories/Components/DataDisplay/Chip/Overview.stories.mdx +0 -57
  290. package/src/stories/Components/DataDisplay/List/Accessibility.stories.mdx +0 -54
  291. package/src/stories/Components/DataDisplay/List/AllCombinations.tsx +0 -396
  292. package/src/stories/Components/DataDisplay/List/Examples.stories.tsx +0 -501
  293. package/src/stories/Components/DataDisplay/List/List.stories.tsx +0 -35
  294. package/src/stories/Components/DataDisplay/List/Overview.stories.mdx +0 -69
  295. package/src/stories/Components/DataDisplay/Table/Overview.stories.mdx +0 -70
  296. package/src/stories/Components/DataDisplay/Tooltip/Accessibility.stories.mdx +0 -39
  297. package/src/stories/Components/DataDisplay/Tooltip/AllCombinations.tsx +0 -134
  298. package/src/stories/Components/DataDisplay/Tooltip/Examples.stories.tsx +0 -237
  299. package/src/stories/Components/DataDisplay/Tooltip/Overview.stories.mdx +0 -58
  300. package/src/stories/Components/DataDisplay/Tooltip/Tooltip.stories.tsx +0 -22
  301. package/src/stories/Components/Feedback/Alert/Accessibility.stories.mdx +0 -25
  302. package/src/stories/Components/Feedback/Alert/Alert.stories.tsx +0 -22
  303. package/src/stories/Components/Feedback/Alert/AllCombinations.tsx +0 -37
  304. package/src/stories/Components/Feedback/Alert/Examples.stories.tsx +0 -137
  305. package/src/stories/Components/Feedback/Alert/Overview.stories.mdx +0 -62
  306. package/src/stories/Components/Inputs/Autocomplete/Accessibility.stories.mdx +0 -31
  307. package/src/stories/Components/Inputs/Autocomplete/AllCombinations.tsx +0 -182
  308. package/src/stories/Components/Inputs/Autocomplete/Autocomplete.stories.tsx +0 -31
  309. package/src/stories/Components/Inputs/Autocomplete/Examples.stories.tsx +0 -233
  310. package/src/stories/Components/Inputs/Autocomplete/Overview.stories.mdx +0 -52
  311. package/src/stories/Components/Inputs/Button/Accessibility.stories.mdx +0 -52
  312. package/src/stories/Components/Inputs/Button/AllCombinations.tsx +0 -53
  313. package/src/stories/Components/Inputs/Button/Button.stories.tsx +0 -23
  314. package/src/stories/Components/Inputs/Button/Examples.stories.tsx +0 -190
  315. package/src/stories/Components/Inputs/Button/Overview.stories.mdx +0 -52
  316. package/src/stories/Components/Inputs/Checkbox/Accessibility.stories.mdx +0 -38
  317. package/src/stories/Components/Inputs/Checkbox/AllCombinations.tsx +0 -55
  318. package/src/stories/Components/Inputs/Checkbox/Checkbox.stories.tsx +0 -22
  319. package/src/stories/Components/Inputs/Checkbox/Examples.stories.tsx +0 -363
  320. package/src/stories/Components/Inputs/Checkbox/Overview.stories.mdx +0 -63
  321. package/src/stories/Components/Inputs/IconButton/Examples.stories.tsx +0 -24
  322. package/src/stories/Components/Inputs/IconButton/IconButton.stories.tsx +0 -26
  323. package/src/stories/Components/Inputs/Radio/Accessibility.stories.mdx +0 -61
  324. package/src/stories/Components/Inputs/Radio/AllCombinations.tsx +0 -75
  325. package/src/stories/Components/Inputs/Radio/Examples.stories.tsx +0 -333
  326. package/src/stories/Components/Inputs/Radio/Overview.stories.mdx +0 -74
  327. package/src/stories/Components/Inputs/Radio/Radio.stories.tsx +0 -22
  328. package/src/stories/Components/Inputs/Select/Accessibility.stories.mdx +0 -51
  329. package/src/stories/Components/Inputs/Select/AllCombinations.tsx +0 -63
  330. package/src/stories/Components/Inputs/Select/Examples.stories.tsx +0 -803
  331. package/src/stories/Components/Inputs/Select/Overview.stories.mdx +0 -73
  332. package/src/stories/Components/Inputs/Select/Select.stories.tsx +0 -22
  333. package/src/stories/Components/Inputs/Slider/Accessibility.stories.mdx +0 -43
  334. package/src/stories/Components/Inputs/Slider/AllCombinations.tsx +0 -30
  335. package/src/stories/Components/Inputs/Slider/Examples.stories.tsx +0 -146
  336. package/src/stories/Components/Inputs/Slider/Overview.stories.mdx +0 -59
  337. package/src/stories/Components/Inputs/Slider/Slider.stories.tsx +0 -27
  338. package/src/stories/Components/Inputs/Switch/Accessibility.stories.mdx +0 -34
  339. package/src/stories/Components/Inputs/Switch/AllCombinations.tsx +0 -45
  340. package/src/stories/Components/Inputs/Switch/Examples.stories.tsx +0 -213
  341. package/src/stories/Components/Inputs/Switch/Overview.stories.mdx +0 -62
  342. package/src/stories/Components/Inputs/Switch/Switch.stories.tsx +0 -22
  343. package/src/stories/Components/Inputs/TextField/Accessibility.stories.mdx +0 -29
  344. package/src/stories/Components/Inputs/TextField/AllCombinations.tsx +0 -57
  345. package/src/stories/Components/Inputs/TextField/Examples.stories.tsx +0 -127
  346. package/src/stories/Components/Inputs/TextField/Overview.stories.mdx +0 -60
  347. package/src/stories/Components/Inputs/TextField/TextField.stories.tsx +0 -261
  348. package/src/stories/Components/Inputs/ToggleButton/Accessibility.stories.mdx +0 -32
  349. package/src/stories/Components/Inputs/ToggleButton/AllCombinations.tsx +0 -113
  350. package/src/stories/Components/Inputs/ToggleButton/Examples.stories.tsx +0 -339
  351. package/src/stories/Components/Inputs/ToggleButton/Overview.stories.mdx +0 -55
  352. package/src/stories/Components/Inputs/ToggleButton/ToggleButton.stories.tsx +0 -19
  353. package/src/stories/Components/Landmarks/Header/Examples.stories.tsx +0 -197
  354. package/src/stories/Components/Landmarks/Header/Header.stories.tsx +0 -34
  355. package/src/stories/Components/Landmarks/Header/Overview.stories.mdx +0 -44
  356. package/src/stories/Components/Navigation/Drawer/Accessibility.stories.mdx +0 -13
  357. package/src/stories/Components/Navigation/Drawer/Drawer.stories.tsx +0 -80
  358. package/src/stories/Components/Navigation/Drawer/Examples.stories.tsx +0 -440
  359. package/src/stories/Components/Navigation/Drawer/Overview.stories.mdx +0 -43
  360. package/src/stories/Components/Navigation/MobileNavigation/Accessibility.stories.mdx +0 -14
  361. package/src/stories/Components/Navigation/MobileNavigation/Examples.stories.tsx +0 -384
  362. package/src/stories/Components/Navigation/MobileNavigation/MobileNavigation.stories.tsx +0 -24
  363. package/src/stories/Components/Navigation/MobileNavigation/Overview.stories.mdx +0 -47
  364. package/src/stories/Components/Navigation/VerticalNavigation/Accessibility.stories.mdx +0 -14
  365. package/src/stories/Components/Navigation/VerticalNavigation/Examples.stories.tsx +0 -307
  366. package/src/stories/Components/Navigation/VerticalNavigation/Overview.stories.mdx +0 -47
  367. package/src/stories/Components/Navigation/VerticalNavigation/VerticalNavigation.stories.tsx +0 -24
  368. package/src/stories/ContactUs.stories.mdx +0 -21
  369. package/src/stories/Experimental/Test.stories.mdx +0 -46
  370. package/src/stories/GettingStarted/Designer.stories.mdx +0 -86
  371. package/src/stories/GettingStarted/Developer.stories.mdx +0 -134
  372. package/src/stories/Guidelines/Accessibility/AssistiveTechnology.stories.mdx +0 -70
  373. package/src/stories/Guidelines/Accessibility/ColorAndContrast.stories.mdx +0 -109
  374. package/src/stories/Guidelines/Accessibility/Hierarchy.stories.mdx +0 -119
  375. package/src/stories/Guidelines/Accessibility/Imagery.stories.mdx +0 -136
  376. package/src/stories/Guidelines/Accessibility/Overview.stories.mdx +0 -44
  377. package/src/stories/Guidelines/Accessibility/Principles.stories.mdx +0 -156
  378. package/src/stories/Guidelines/Accessibility/SoundAndMotion.stories.mdx +0 -59
  379. package/src/stories/Guidelines/Accessibility/Typography.stories.mdx +0 -69
  380. package/src/stories/Guidelines/Accessibility/Writing.stories.mdx +0 -188
  381. package/src/stories/Guidelines/Styleguide/ColorSwatch.tsx +0 -53
  382. package/src/stories/Guidelines/Styleguide/Colors.stories.mdx +0 -118
  383. package/src/stories/Guidelines/Styleguide/Typography.stories.mdx +0 -84
  384. package/src/stories/Introduction.stories.mdx +0 -65
  385. package/src/stories/Pages/ErrorPage.stories.tsx +0 -30
  386. package/src/stories/Pages/SideInSide.stories.tsx +0 -195
  387. package/src/stories/Roadmap.stories.mdx +0 -19
  388. package/src/stories/Templates/Login.stories.mdx +0 -46
  389. package/src/stories/assets/Atomic_Design_Icons-Dark.svg +0 -24
  390. package/src/stories/assets/Atomic_Design_Icons-Light.svg +0 -25
  391. package/src/stories/assets/accessibility-1.png +0 -0
  392. package/src/stories/assets/accessibility-2.png +0 -0
  393. package/src/stories/assets/accessibility-3.png +0 -0
  394. package/src/stories/assets/accessibility-banner.png +0 -0
  395. package/src/stories/assets/atoms.svg +0 -6
  396. package/src/stories/assets/design_system_2022-02-11_12.22pm.png +0 -0
  397. package/src/stories/assets/figma-tokens.png +0 -0
  398. package/src/stories/assets/hierarchy-1.jpg +0 -0
  399. package/src/stories/assets/hierarchy-2.jpg +0 -0
  400. package/src/stories/assets/hierarchy-3.jpg +0 -0
  401. package/src/stories/assets/icon-contrast-1.jpg +0 -0
  402. package/src/stories/assets/icon-contrast-2.jpg +0 -0
  403. package/src/stories/assets/imagery-1.png +0 -0
  404. package/src/stories/assets/imagery-2.png +0 -0
  405. package/src/stories/assets/imagery-3.png +0 -0
  406. package/src/stories/assets/imagery-4.jpg +0 -0
  407. package/src/stories/assets/molecules.svg +0 -9
  408. package/src/stories/assets/organisms.svg +0 -22
  409. package/src/stories/assets/pages.svg +0 -5
  410. package/src/stories/assets/particles.svg +0 -4
  411. package/src/stories/assets/templates.svg +0 -4
  412. package/src/stories/assets/testData.tsx +0 -102
  413. package/src/stories/assets/text-contrast-1.jpg +0 -0
  414. package/src/stories/assets/text-contrast-2.jpg +0 -0
  415. package/src/stories/assets/typography-1.png +0 -0
  416. package/src/stories/assets/visual-clues-1.png +0 -0
  417. package/src/stories/assets/visual-clues-2.png +0 -0
  418. package/src/stories/assets/writing-1.jpg +0 -0
  419. package/src/stories/assets/writing-2.png +0 -0
  420. package/src/stories/assets/writing-3.png +0 -0
  421. package/src/stories/assets/writing-4.png +0 -0
  422. package/src/stories/utils/CustomIcons.tsx +0 -44
  423. package/tsconfig.eslint.json +0 -16
  424. package/tsconfig.json +0 -50
@@ -1,70 +0,0 @@
1
- import { Meta } from '@storybook/addon-docs';
2
- import Button from '@mui/material/Button';
3
- import Alert from '@mui/material/Alert';
4
- import List from '@mui/material/List';
5
- import ListItem from '@mui/material/ListItem';
6
- import AlertTitle from '@mui/material/AlertTitle';
7
- import Divider from '@mui/material/Divider';
8
-
9
- <Meta title="Guidelines/Accessibility/Assistive Technology" />
10
-
11
- # [](#assistive-technology)Assistive technologies ***help people accomplish tasks*** by enhancing a user's capabilities.
12
-
13
- <br/>
14
- <Divider />
15
-
16
- Assistive technologies helps increase, maintain, and improve the functional capabilities of individuals with disabilities, through devices like screen readers, magnification tools, and hearing aids.
17
-
18
- ## [](#screen-readers)Screen Readers
19
- A screen reader is an assistive technology that provides access to digital content to people with certain disabilities. Screen readers work by converting text, images and other interactive UI elements into audible speech or braille output. The main users of screen readers are people with various levels of visual impairment. The Learning Pool design system implements WAI-ARIA standards to properly optimize the user experience for anyone using screen readers. The Accessible Rich Internet Applications (ARIA) standards provide a method for making dynamic web content more accessible to all users of assistive technologies.
20
-
21
- There are a variety of different screen readers available depending on your device and operating system configuration. Some of the most popular and recommended apps are NVDA or JAWS for Windows, TalkBack for Android, or VoiceOver for Mac/iOS.
22
-
23
- <Alert severity="info">
24
- <AlertTitle>Recommended Screen Reader and Browser Combinations</AlertTitle>
25
- <List>
26
- <ListItem>
27
- <Typography>
28
- <b>Windows:</b> Firefox and NVDA
29
- </Typography>
30
- </ListItem>
31
- <ListItem>
32
- <Typography>
33
- <b>Mac:</b> Safari and VoiceOver
34
- </Typography>
35
- </ListItem>
36
- </List>
37
- </Alert>
38
-
39
- [Material Design Accessibility](https://m3.material.io/foundations/accessible-design/accessibility-basics#497996ce-d1f3-4c42-abf2-c6dd1f57d371)
40
-
41
- <br/>
42
-
43
- ## [](#magnification-tools)Magnification Tools
44
- Magnification devices and technologies help users with visual disabilities consume digital content. These tools are mainly utilized by user who have some visual impairment but still have some sight. Magnifies can make it easier for a user to engage with interactive elements on a page by seeing enlarged elements in relation to the rest of the screen. Magnification tools come in many shapes and sizes. Many operating systems and devices provide built in magnification software, which can usually be found in the accessibility settings of your system.
45
-
46
- <Alert severity="info">
47
- <AlertTitle>Built in OS Magnifiers</AlertTitle>
48
- <List>
49
- <ListItem>
50
- <Typography>
51
- <b>Windows:</b> <a href="https://support.microsoft.com/en-us/windows/use-magnifier-to-make-things-on-the-screen-easier-to-see-414948ba-8b1c-d3bd-8615-0e5e32204198">Use Magnifier to make things on the screen easier to see</a>
52
- </Typography>
53
- </ListItem>
54
- <ListItem>
55
- <Typography>
56
- <b>Mac:</b> <a href="https://support.apple.com/en-us/HT201295">How to zoom in and out on your Mac</a>
57
- </Typography>
58
- </ListItem>
59
- </List>
60
- </Alert>
61
-
62
- ## [](#speech-recognition)Speech Recognition
63
- Speech recognition software can be used as an alternative input method for typing and also a method for controlling a device through voice commands. With speech recognition software users are able to issue voice commands to a device which allow for inputting text in a form field or interacting with UI elements. Most devices and operating systems have built-in voice recognition tools and there are also many 3rd party applications that provide additional functionality. People with various physical and cognitive disabilities who may have difficulties with keyboard or mouse controls will benefit from voice recognition software.
64
-
65
- ## [](#alternative-devices)Alternative Input Devices
66
- Some users may not be able to use a mouse or keyboard to work on a computer. These people can use various forms of devices, such as:
67
-
68
- - **Head pointers**: A stick or object mounted directly on the user's head that can be used to push keys on the keyboard. This device is used by individuals who have no use of their hands.
69
- - **Motion or eye tracking**: This can include devices that watch a target or even the eyes of the user to interpret where the user wants to place the mouse pointer and moves it for the user.
70
- - **Switch entry devices**: These kinds of devices can be used with other alternative input devices or by themselves. These are typically used with on-screen keyboards. The on-screen keyboard has a cursor move across the keys, and when the key the user wants is in focus, the user will click the switch. This can also work on a webpage: the cursor can move through the webpage, and if the user wants a to click on a link or button when that link or button is in focus, the user can activate the switch.
@@ -1,109 +0,0 @@
1
- import { Meta } from '@storybook/addon-docs';
2
- import Button from '@mui/material/Button';
3
- import Alert from '@mui/material/Alert';
4
- import List from '@mui/material/List';
5
- import ListItem from '@mui/material/ListItem';
6
- import AlertTitle from '@mui/material/AlertTitle';
7
- import Divider from '@mui/material/Divider';
8
- import Grid from '@mui/material/Grid';
9
- import textContrast1 from '../../assets/text-contrast-1.jpg';
10
- import textContrast2 from '../../assets/text-contrast-2.jpg';
11
- import iconContrast1 from '../../assets/icon-contrast-1.jpg';
12
- import iconContrast2 from '../../assets/icon-contrast-2.jpg';
13
- import visualClues1 from '../../assets/visual-clues-1.png';
14
- import visualClues2 from '../../assets/visual-clues-2.png';
15
- import CheckCircleIcon from '@mui/icons-material/CheckCircle';
16
- import ErrorIcon from '@mui/icons-material/Error';
17
-
18
- <Meta title="Guidelines/Accessibility/Color and Contrast" />
19
-
20
- # [](#understand-actions)Color and contrast helps users interpret content and ***understand actions***.
21
-
22
- <br/>
23
- <Divider />
24
-
25
- ## [](#color-contrast)Color and Contrast
26
- Color and contrast are powerful elements that help visual users interpret content and successfully interact with UI elements. Background and foreground elements must maintain sufficient color contrast levels to ensure usability for all people.
27
-
28
- ### [](#accessible-colors)Accessible colors
29
- Color can be used to help express the tone of content or communicate important information. Our design system utilizes combinations of primary and secondary colors, along with specific UI state colors to increase the overall usability or our products. We utilized an [accessible palette generator](https://accessiblepalette.com/?lightness=96,92,84,71,60,49,43.3,37.6,29,21&dc2626=0,0&B36200=0,0&059669=0,0&0077CC=0,0&C13E95=0,0&adb5bd=0,0) to help with the optimization of our full color palette. This tool helps us maintain consistent lightness and contrast ratios across all color levels.
30
-
31
- ### [](#contrast-ratios)Contrast Ratios
32
- Color contrast is one of the most critical ways that users distinguish text and interactive UI elements. In general, the use of higher contrast levels will make text and UI elements easier for sighted users to see. Low contrast text and elements are challenging for some users with visual disabilities or users in certain lighting conditions.
33
-
34
- The color contrast ratios we use are a representation of how different one color is from another. The ratios are usually expressed as something like **3:1** or **4.5:1**. The greater the difference between the two numbers, the greater the difference in relative luminance between the colors. The contrast ratio between a color and its background ranges from 1-21 based on its luminance (the intensity of light emitted) according to the W3C.
35
-
36
- <br/>
37
-
38
- *WCAG guidelines recommend the following contrast ratios:*
39
-
40
- | Type of content | Minimum ratio (AA rating) | Enhanced ratio (AAA rating) |
41
- | ----------- | ----------- | ----------- |
42
- | Body text | 4.5 : 1 | 7 : 1 |
43
- | Large-scale text | 3 : 1 | 4.5 : 1 |
44
- | Active UI components | 3 : 1 | Not defined |
45
-
46
- <br/>
47
- <br/>
48
-
49
- ### [](#body-text-ratio)Body text should pass the minimum contrast ratio of 4.5:1
50
-
51
- <br/>
52
- <Grid container sx={{ width: '100%' }} spacing={2}>
53
- <Grid item xs={6}>
54
- <img src={textContrast1} alt="Text example with accessible contrast levels" />
55
- <p><CheckCircleIcon color="success" /> <b>Correct</b></p>
56
- <p>These lines of text follow the color contrast ratio recommendations and are legible against their background colors.</p>
57
- </Grid>
58
- <Grid item xs={6}>
59
- <img src={textContrast2} alt="Text example with inaccessible contrast levels" />
60
- <p><ErrorIcon color="error" /> <b>Caution</b></p>
61
- <p>These lines of text don't meet the color contrast ratio recommendations and can be difficult to read against their background colors.</p>
62
- </Grid>
63
- </Grid>
64
-
65
- <br/>
66
- <br/>
67
- <br/>
68
-
69
- ### [](#ui-element-ratio)Icons or other critical UI elements should use the recommended contrast ratios of 3:1.
70
-
71
- <br/>
72
- <Grid container sx={{ width: '100%' }} spacing={2}>
73
- <Grid item xs={6}>
74
- <img src={iconContrast1} alt="Icon example with accessible contrast levels" />
75
- <p><CheckCircleIcon color="success" /> <b>Correct</b></p>
76
- <p>These icons follow the color contrast ratio recommendations and are legible against their backgrounds.</p>
77
- </Grid>
78
- <Grid item xs={6}>
79
- <img src={iconContrast2} alt="Icon example with inaccessible contrast levels" />
80
- <p><ErrorIcon color="error" /> <b>Caution</b></p>
81
- <p>These icons don't follow the color contrast ratio recommendations and may be difficult to discern against their backgrounds.</p>
82
- </Grid>
83
- </Grid>
84
-
85
- <br/>
86
- <br/>
87
- <br/>
88
-
89
- ### [](#visual-clues)Other visual cues
90
- For users who are colorblind, or do not see differences in color, other design elements can help express the same amount of information.
91
-
92
- Because colorblindness takes different forms (including red-green, blue-yellow, and monochromatic), multiple visual cues help communicate important states. Elements such as strokes, indicators, patterns, texture, or text can describe actions and content.
93
-
94
- <Grid container sx={{ width: '100%' }} spacing={2}>
95
- <Grid item xs={6}>
96
- <img src={visualClues1} alt="Accessibile text field example with multiple viusal cues" />
97
- <p><CheckCircleIcon color="success" /> <b>Correct</b></p>
98
- <p>The text field error state is communicated through multiple cues: title color, text field stroke, and an error message below the field.</p>
99
- </Grid>
100
- <Grid item xs={6}>
101
- <img src={visualClues2} alt="Inccessibile text field example with only color cue" />
102
- <p><ErrorIcon color="error" /> <b>Caution</b></p>
103
- <p>The text field error state is only communicated with a colored stroke, which could be missed by a user who cannot perceive color.</p>
104
- </Grid>
105
- </Grid>
106
-
107
- <br/>
108
- <br/>
109
- <br/>
@@ -1,119 +0,0 @@
1
- import { Meta } from '@storybook/addon-docs';
2
- import Button from '@mui/material/Button';
3
- import Alert from '@mui/material/Alert';
4
- import List from '@mui/material/List';
5
- import ListItem from '@mui/material/ListItem';
6
- import AlertTitle from '@mui/material/AlertTitle';
7
- import Divider from '@mui/material/Divider';
8
- import Grid from '@mui/material/Grid';
9
- import hierarchy1 from '../../assets/hierarchy-1.jpg';
10
- import hierarchy2 from '../../assets/hierarchy-2.jpg';
11
- import hierarchy3 from '../../assets/hierarchy-3.jpg';
12
- import CheckCircleIcon from '@mui/icons-material/CheckCircle';
13
- import ErrorIcon from '@mui/icons-material/Error';
14
-
15
- <Meta title="Guidelines/Accessibility/Heirarchy" />
16
-
17
- # [](#Accessible-Hierarchy)When hierarchy is clear, ***users understand*** where they are in your app and what's important.
18
-
19
- <br/>
20
- <Divider />
21
-
22
- ## [](#Accessible-Hierarchy)Accessible Hierarchy
23
- When navigation is clear and easy to use, people understand where they are in the hierarchy of your system. We use visual cues like shape, color, weight and motion to add clarity to focus attention where needed. Since every element added to a page increased the overall complexity of a UI, we strive to keep things simple with cleanly defined visual elements and a clear hierarchy of importance.
24
-
25
- For our products we focus on:
26
- - Clearly styling visual elements
27
- - Utilizing sufficient color contrast
28
- - Defining a logical hierarchy of importance
29
- - Presenting key information that is easily discernable
30
-
31
- ## [](#visual-hierarchy)Visual Hierarchy
32
- It's important for designers and developers to collaborate throughout the product cycle to ensure that a logical hierarchy is maintained to be properly interpreted by screen readers. While CSS determines the layout and appearance of a page, screen readers rely on the top-down structure of HTML on any platform (mobile or web). This structure creates a map for the screen reader to follow when reading the content.
33
-
34
- <br/>
35
- <br/>
36
- <Grid container sx={{ width: '100%' }} spacing={2}>
37
- <Grid item xs={6}>
38
- <img src={hierarchy1} alt="Screenshot showing the correct tab order through page elements" />
39
- <p><CheckCircleIcon color="success" /> <b>Correct</b></p>
40
- <p>The HTML reflects the visual hierarchy by reading the content from the top left (Step 1) to the top right (Step 2), bottom left (Step 3) to bottom right (Step 4).</p>
41
- </Grid>
42
- <Grid item xs={6}>
43
- <code>
44
- <pre>
45
- {`
46
- <section class="container">
47
- <img class="step-1" />
48
- <img class="step-2" />
49
- <img class="step-3" />
50
- <img class="step-4" />
51
- <img class="step-5" />
52
- <img class="step-6" />
53
- </section>
54
- `}
55
- </pre>
56
- </code>
57
- <p>Example code for displaying the images in a screenreader-friendly hierarchy.</p>
58
- </Grid>
59
- </Grid>
60
-
61
- <br/>
62
- <br/>
63
- <br/>
64
-
65
- <Grid container sx={{ width: '100%' }} spacing={2}>
66
- <Grid item xs={6}>
67
- <img src={hierarchy2} alt="Screenshot showing an incorrect tab order through page elements" />
68
- <p><ErrorIcon color="error" /> <b>Caution</b></p>
69
- <p>While some users may look at images in the visual order of the screen from top left to the top right, bottom left to bottom right, screen readers will, by default, verbalize the content in the top-down order of the HTML (Step 1, Step 4, Step 2, Step 5, Step 3, and Step 6).</p>
70
- </Grid>
71
- <Grid item xs={6}>
72
- <code>
73
- <pre>
74
- {`
75
- <section class="container">
76
- <div class="col-left">
77
- <img class="step-1" />
78
- <img class="step-4" />
79
- </div>
80
- <div class="col-center">
81
- <img class="step-2" />
82
- <img class="step-5" />
83
- </div>
84
- <div class="col-right">
85
- <img class="step-3" />
86
- <img class="step-6" />
87
- </div>
88
- </section>
89
- `}
90
- </pre>
91
- </code>
92
- <p>Example code for displaying images in which the screenreader reads the items in the left column before reading the items in the center and right columns.</p>
93
- </Grid>
94
- </Grid>
95
-
96
- <br/>
97
-
98
- ## [](#focus-order)Focus Order
99
- Input focus that follows the order of the visual layout usually flows from the top to the bottom of the screen. It can traverse from the most important to the least important item.
100
-
101
- To help determine your focus points and movements, consider:
102
- - The order in which elements receive focus
103
- - The way in which elements are grouped
104
- - Where focus moves when the element in focus disappears
105
-
106
- The blue circles below indicate the order in which onscreen elements could receive focus:
107
-
108
- <br/>
109
-
110
- <Grid container sx={{ width: '100%' }} spacing={2}>
111
- <Grid item xs={12}>
112
- <img src={hierarchy3} alt="Screenshot showing the tab order through Learning Pool Academy website" />
113
- </Grid>
114
- </Grid>
115
-
116
- <br/>
117
- <br/>
118
-
119
- [Material Design Accessibility](https://m3.material.io/foundations/accessible-design/accessibility-basics#85fd850b-232e-404e-92b3-3619980e0414)
@@ -1,136 +0,0 @@
1
- import { Meta } from '@storybook/addon-docs';
2
- import Button from '@mui/material/Button';
3
- import Alert from '@mui/material/Alert';
4
- import List from '@mui/material/List';
5
- import ListItem from '@mui/material/ListItem';
6
- import AlertTitle from '@mui/material/AlertTitle';
7
- import Divider from '@mui/material/Divider';
8
- import Grid from '@mui/material/Grid';
9
- import imagery1 from '../../assets/imagery-1.png';
10
- import imagery2 from '../../assets/imagery-2.png';
11
- import imagery3 from '../../assets/imagery-3.png';
12
- import imagery4 from '../../assets/imagery-4.jpg';
13
- import CheckCircleIcon from '@mui/icons-material/CheckCircle';
14
- import ErrorIcon from '@mui/icons-material/Error';
15
-
16
- <Meta title="Guidelines/Accessibility/Imagery" />
17
-
18
- # [](#accessible-writing)Accessible images can be either ***decorative or informative*** depending on usage.
19
-
20
- <br/>
21
- <Divider />
22
-
23
- ## [](#imagery-types)Types of Imagery
24
- To know when and how to apply accessibility guidelines to imagery, it's important to understand the differences between image types.
25
-
26
- ### [](#decorative-informative)Decorative vs Informative Images
27
- To find out if an image needs to meet color contrast guidelines and would benefit from a caption, determine if your image is decorative or informative.
28
-
29
- <br/>
30
- <Grid container sx={{ width: '100%' }} spacing={2}>
31
- <Grid item xs={6}>
32
- <h4>Decorative images:</h4>
33
- <ul>
34
- <li>Don't add information to the content of a page</li>
35
- <li>Don't need captions</li>
36
- <li>Don't have to meet color contrast guidelines</li>
37
- <li>Don't need alt text</li>
38
- <li>Should have an empty tag (alt="") in the image label so screen readers skip them</li>
39
- </ul>
40
- </Grid>
41
- <Grid item xs={6}>
42
- <h4>Informative images:</h4>
43
- <ul>
44
- <li>Convey a concept in a short, digestible manner</li>
45
- <li>Relay accurate information that is relevant to the adjacent text</li>
46
- <li>Need captions</li>
47
- <li>Need alt text if the caption or adjacent text does not explain the image</li>
48
- <li>Have to meet color contrast guidelines for essential items</li>
49
- </ul>
50
- </Grid>
51
- </Grid>
52
-
53
- <br/>
54
-
55
- [Material Design](https://m2.material.io/design/usability/accessibility.html#imagery)
56
-
57
- <br/>
58
- <br/>
59
- <br/>
60
-
61
- ### [](#alt-text)Alternative Text (alt text)
62
- Alt text helps translate a visual UI into a text-based UI. Alt text is a short label (up to 125 characters) in the code that describes an image for users who are unable to see them. Since alt text is only for images, there is no need to add “image of” or “picture of” to the alt text. A screen reader will read the alt text aloud in place of the image. Alt text is valuable for sighted users as well as alt text appears if an image fails to load. Include targeted keywords to help inform the user about the image. Keywords can also improve search engine optimization (SEO).
63
-
64
- <br/>
65
- <Grid container sx={{ width: '100%' }} spacing={2}>
66
- <Grid item xs={6}>
67
- <img style={{maxWidth: "400px"}} src={imagery1} alt="Aerial view of people enjoying the beach and ocean in Hawaii" />
68
- <p><b>Alt text: Aerial view of people enjoying the beach and ocean in Hawaii</b></p>
69
- <p><CheckCircleIcon color="success" /> <b>Correct</b></p>
70
- <p>This informative image is a photo that shows what the location looks like.</p>
71
- </Grid>
72
- <Grid item xs={6}>
73
- <img style={{maxWidth: "400px"}} src={imagery2} alt="Close-up view of seashells in the sand" />
74
- <p><b>Alt text: Close-up view of seashells in the sand</b></p>
75
- <p><ErrorIcon color="error" /> <b>Caution</b></p>
76
- <p>Using decorative images, such as a seashells or fish, to show a location may not be useful to screen reader users because it doesn't provide additional information.</p>
77
- </Grid>
78
- </Grid>
79
-
80
- <br/>
81
-
82
- [Material Design](https://m2.material.io/design/usability/accessibility.html#imagery)
83
-
84
- <br/>
85
- <br/>
86
- <br/>
87
-
88
- ### [](#elements)Essential and Non-essential Elements
89
- Informative images have essential and non-essential elements. Essential information should have a **3:1** color contrast ratio for large text and **4.5:1** for small text.
90
-
91
- #### An illustration showing both essential and non-essential information:
92
- <br/>
93
- <img style={{maxWidth: "600px"}} src={imagery3} alt="UI example showing essential and non-essential information" />
94
-
95
- 1. **Essential**: The text meets all contrast ratios and size requirements.
96
- 2. **Essential**: An illustrative visual representation of the instructions that follows color contrast guidelines.
97
- 3. **Non-essential**: The decorative elements create background and personality for the illustration. They do not relay information and do not have to meet contrast requirements.
98
-
99
- <br/>
100
-
101
- [Material Design](https://m2.material.io/design/usability/accessibility.html#imagery)
102
-
103
- <br/>
104
- <br/>
105
- <br/>
106
-
107
- ### [](#functional-images)Functional images
108
- According to the W3C, functional images are logos, icons, images within a button, and images that are actionable, such as a link. The alt text for functional images differs from alt text for other types of imagery because functional imagery alt text depicts the image's function - not its content or what it looks like.
109
-
110
- When the icon or image within a button has a specific function, add an alt tag to it explaining its function with an action verb, not the icon name. See Writing for information on writing more accessible text.
111
-
112
- [Material Design](https://m2.material.io/design/usability/accessibility.html#imagery)
113
-
114
- <br/>
115
-
116
- ### [](#logo-images)Logo Images
117
- Logos may benefit from an alt tag describing their function, but they are a unique kind of functional image because they:
118
-
119
- - Might not meet color contrast ratios
120
- - Might not meet text size requirements
121
-
122
- See Color and Contrast for more information about logos and color contrast.
123
-
124
- However, when a logo is part of a text link and is only decorative without any functionality, add an empty alt tag (alt="").
125
-
126
- <img style={{maxWidth: "400px"}} src={imagery4} alt="Link to Stream home page" />
127
-
128
- **Alt text example: Link to Stream home page**
129
-
130
- The alt text indicates that clicking on the logo will direct the user to the Stream home page.
131
-
132
- <br/>
133
-
134
- [Material Design](https://m2.material.io/design/usability/accessibility.html#imagery)
135
-
136
- <br/>
@@ -1,44 +0,0 @@
1
- import { Meta } from '@storybook/addon-docs'
2
- import Divider from '@mui/material/Divider';
3
-
4
- <Meta title="Guidelines/Accessibility/Overview" />
5
-
6
- # [](#learningpool-accessibility)Accessibility allows users of diverse abilities to ***navigate, understand, and use*** our products
7
-
8
- <br/>
9
- <Divider />
10
-
11
- This page provides an overview of accessibility within the Learning Pool Design System. For more detailed information, each component has an accessibility page that outlines the recommended implementation and best practices.
12
-
13
-
14
- ## [](#accessibility-statement)Accessibility Statement
15
- Learning Pool is committed to providing all users with an accessible experience across our products and services.
16
- The Learning Pool Design System was created to support our commitment to accessibility by providing components, patterns, resources, and guidelines that enable our teams to deliver accessible products for all users.
17
- Using the Web Content Accessibility Guidelines (WCAG 2.1 Level AA), we are continually working to improve our products and deliver the best user experience for everyone.
18
-
19
-
20
- ### [](#our-approach-to-accessibility)Our Approach to Accessibility
21
- The Learning Pool UX team considers accessibility throughout all phases of our design and development process. We believe that when we design to benefit disadvantaged or vulnerable groups we end up creating products that better serve all our users as a whole. We work hard to meet level AA of the WCAG 2.1 standards through a combination of research, implementation techniques, tools, and testing. Our goal is to continuously improve and enhance the experience for all users.
22
-
23
- We build accessibility standards into all the components of our design system to deliver an inclusive experience across products. The following pages provide an overview of the principles of accessibility and how we implement standards throughout our processes. Further information and guidelines are provided in our design system documentation.
24
-
25
- [Material Design Accessibility](https://m3.material.io/foundations/accessible-design)
26
-
27
- ### [](#accessibility-feedback)Accessibility Feedback
28
- At Learning Pool, we make every effort to ensure that our products and services can be used by everyone; however, there may be some parts of our products and services that are not fully accessible at this time.
29
-
30
- We welcome your feedback, issues, or suggestions related to the accessibility of our components and resources. Please submit feedback to [someone@learningpool.com...](mailto:someone@learningpool.com)
31
-
32
- ### [](#accessibility-resources)Accessibility Resources
33
- It is the responsibility of the individual product teams to make sure their product or feature meets accessibility requirements. Research should be conducted throughout the development process to ensure that the product is accessible for all users.
34
-
35
- For support with meeting accessibility requirements, use the resources listed below or contact the UX Team.
36
- * The [World Wide Web Consortium](https://www.w3.org/standards/) (W3C) develops international standards for the Web: HTML, CSS, and many more.
37
- * The [W3C Web Accessibility Initiative](https://www.w3.org/WAI/) (WAI) develops standards and support materials to help you understand and implement accessibility.
38
- * The [WCAG guidelines](https://www.w3.org/WAI/standards-guidelines/#wcag) explain how to make web content more accessible to people with disabilities.
39
- * A [Quick Reference Guide](https://www.w3.org/WAI/WCAG21/quickref/?versions=2.1) on how to meet WCAG 2.1 requirements. WCAG 2.1 a glance in this paraphrased summary of the guidelines.
40
-
41
-
42
- ### [](#accessibility-resources)Accessibility Presentations
43
- - Accessibility Introduction Presentation February 2022
44
- - Accessibility Lunch and Learn Presentation May 2022
@@ -1,156 +0,0 @@
1
- import { Meta } from '@storybook/addon-docs'
2
- import Button from '@mui/material/Button'
3
- import Link from '@mui/material/Link'
4
- import Divider from '@mui/material/Divider'
5
- import Grid from '@mui/material/Grid';
6
- import Stack from '@mui/material/Stack'
7
- import Card from '@mui/material/Card'
8
- import CardContent from '@mui/material/CardContent'
9
- import CardMedia from '@mui/material/CardMedia'
10
- import Typography from '@mui/material/Typography'
11
- import PsychologyIcon from '@mui/icons-material/Psychology'
12
- import EmojiObjectsIcon from '@mui/icons-material/EmojiObjects'
13
- import SettingsAccessibilityIcon from '@mui/icons-material/SettingsAccessibility';
14
- import FitnessCenterIcon from '@mui/icons-material/FitnessCenter';
15
- import DisplaySettingsIcon from '@mui/icons-material/DisplaySettings';
16
-
17
- <Meta title="Guidelines/Accessibility/Principles" />
18
-
19
- # [](#Learning-Pools-Accessibility-Guidelines) Accessibility guidelines are organized around ***4 principles***.
20
-
21
- <br/>
22
- <Divider />
23
-
24
- <Grid sx={{ marginTop: '1rem' }} container spacing={3}>
25
- <Grid item xs={3}>
26
- <Item>
27
- <Card
28
- elevation={2}
29
- sx={{
30
- minHeight: '225px',
31
- ':hover': {
32
- boxShadow: 10, // theme.shadows[10]
33
- },
34
- }}
35
- >
36
- <CardContent sx={{display: 'flex', flexDirection: 'column', justifyContent: 'center', alignItems: 'center', textAlign: 'center'}}>
37
- <SettingsAccessibilityIcon sx={{ fontSize: "4rem", marginBotton: "0.5rem"}}/>
38
- <Typography variant="h5" component="div">
39
- Perceivable
40
- </Typography>
41
- <Typography variant="body2">
42
- Users must be able to identify the information and UI of our products through the use of their senses.
43
- </Typography>
44
- </CardContent>
45
- </Card>
46
- </Item>
47
- </Grid>
48
- <Grid item xs={3}>
49
- <Item>
50
- <Card
51
- elevation={2}
52
- sx={{
53
- minHeight: '225px',
54
- ':hover': {
55
- boxShadow: 10, // theme.shadows[10]
56
- },
57
- }}
58
- >
59
- <CardContent sx={{display: 'flex', flexDirection: 'column', justifyContent: 'center', alignItems: 'center', textAlign: 'center'}}>
60
- <DisplaySettingsIcon sx={{ fontSize: "4rem", marginBotton: "0.5rem"}}/>
61
- <Typography variant="h5" component="div">
62
- Operable
63
- </Typography>
64
- <Typography variant="body2">
65
- Users must be able to successfully use the UI to control the system.
66
- </Typography>
67
- </CardContent>
68
- </Card>
69
- </Item>
70
- </Grid>
71
- <Grid item xs={3}>
72
- <Item>
73
- <Card
74
- elevation={2}
75
- sx={{
76
- minHeight: '225px',
77
- ':hover': {
78
- boxShadow: 10, // theme.shadows[10]
79
- },
80
- }}
81
- >
82
- <CardContent sx={{display: 'flex', flexDirection: 'column', justifyContent: 'center', alignItems: 'center', textAlign: 'center'}}>
83
- <PsychologyIcon sx={{ fontSize: "4rem", marginBotton: "0.5rem"}}/>
84
- <Typography variant="h5" component="div">
85
- Understandable
86
- </Typography>
87
- <Typography variant="body2">
88
- Users must be able to comprehend the UI and content of our products.
89
- </Typography>
90
- </CardContent>
91
- </Card>
92
- </Item>
93
- </Grid>
94
- <Grid item xs={3}>
95
- <Item>
96
- <Card
97
- elevation={2}
98
- sx={{
99
- minHeight: '225px',
100
- ':hover': {
101
- boxShadow: 10, // theme.shadows[10]
102
- },
103
- }}
104
- >
105
- <CardContent sx={{display: 'flex', flexDirection: 'column', justifyContent: 'center', alignItems: 'center', textAlign: 'center'}}>
106
- <FitnessCenterIcon sx={{ fontSize: "4rem", marginBotton: "0.5rem"}}/>
107
- <Typography variant="h5" component="div">
108
- Robust
109
- </Typography>
110
- <Typography variant="body2">
111
- Our products must work with all abilities and technologies to provide consistent information across experiences.
112
- </Typography>
113
- </CardContent>
114
- </Card>
115
- </Item>
116
- </Grid>
117
- </Grid>
118
-
119
- <div id="Perceivable"></div>
120
-
121
- ## [](#Perceivable)Perceivable
122
-
123
- **Perceivable** means users must be able to to identify and process the information in our UI elements and content through the use of their senses. This means all content must be consumable through assistive technologies by means of sight, hearing or touch. At the simplest level, all users mush be able to perceive and process the information provided by our products.
124
-
125
- - An online application form contains numerous input fields. If the field labels are not readable, how can she successfully complete the application form?
126
- - A chart describes the change in a population over time. If a user cannot see the chart, how can she understand the data?
127
- - An online training video narrates a process for completing a task. If the video is uncaptioned, how can a Deaf or Hard of Hearing user learn from the training how to complete the task?
128
- - An online article is presented as a scanned PDF. If a user cannot read the PDF, can he learn the content of the article?
129
- - A website's contact information is displayed in the footer. If the contrast is insufficient to distinguish between background and text, how can a low-vision or color-blind user contact the site owner?
130
- - A kiosk requires users to touch the screen to access an interactive exhibit. If the touch-screen controls are out of reach of the user, how can she interact with the exhibit?
131
-
132
-
133
- ## [](#Operable)Operable
134
- **Operable** means that the UI of our products can easily be controlled by all users. Everyone must be able to successfully operate our products using a variety of assistive technology tools. By conforming to the latest WCAG standards, we ensure that people of all abilities can operate and control our interface.
135
-
136
- - A navigation menu reveals a submenu of links when a user hovers over it with a mouse. If the menu doesn't expand when it receives focus, how can a keyboard user access the submenu?
137
- - A website's social media links can be activated with a click of the mouse. If the links don't receive keyboard focus, how can a keyboard user follow the links to social media?
138
- - An online form permits a user to make multiple selections from a drop-down menu. If the user cannot simultaneously press a Control key and click on the menu, how can she make multiple selections?
139
-
140
-
141
- ## [](#Understandable)Understandable
142
- **Understandable** means a system uses a clear and concise presentation with a consistent design and predictable usage pattern. Our users must be able to comprehend the information of our products and easily learn and remember how to use the system.
143
-
144
- - A website's navigation consists of a number of links that are displayed in a different order from page to page. If a user has to relearn basic navigation for each page, how can she effectively move through the website?
145
- - A PDF registration form contains required email and phone number fields. If the form doesn't inform the user when there is an input error, how can the user understand why the form cannot be submitted?
146
- - A Word document contains a number of non-English words and phrases. If the languages are not indicated, how can assistive technology present the text correctly?
147
- - A technical website makes use of numerous abbreviations, acronyms, and jargon. If these are never defined, how can users with disabilities (and others) understand the content?
148
-
149
-
150
- ## [](#Robust)Robust
151
- **Robust** means our systems are build with standards compliance and function reliably on all technologies. Users must be able to utilize their preferred technologies to interaction with our UI and consume content. By following the WCAG standards, we ensure our products support the widest range of technologies.
152
-
153
- - A website requires a specific version of a web browser to make use of its features. If a user doesn't or can't use that browser, how can that user experience the features of the site?
154
- - A document format is inaccessible to a screen reader on a particular operating system. If a user employs that OS for day-to-day tasks, how can she gain access to the document?
155
- - An online training video requires an inaccessible plug-in to play in the web browser. If the user can't play the video in an accessible video player, how can he participate in the training?
156
- - A web application fails to include features for alternative inputs, such as keyboard or voice commands. Without such features, how can users of those alternative input methods use the application?