@learningpool/ui 1.6.2 → 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.
- package/{dist/assets → assets}/Images.d.ts +0 -0
- package/{dist/assets → assets}/Images.js +0 -0
- package/{dist/components → components}/atoms/Autocomplete/Autocomplete.d.ts +0 -0
- package/{dist/components → components}/atoms/Autocomplete/Autocomplete.js +0 -0
- package/{dist/components → components}/atoms/Button/Button.d.ts +0 -0
- package/{dist/components → components}/atoms/Button/Button.js +0 -0
- package/{dist/components → components}/atoms/Checkbox/Checkbox.d.ts +0 -0
- package/{dist/components → components}/atoms/Checkbox/Checkbox.js +0 -0
- package/{dist/components → components}/atoms/IconButton/IconButton.d.ts +0 -0
- package/{dist/components → components}/atoms/IconButton/IconButton.js +0 -0
- package/{dist/components → components}/atoms/Radio/Radio.d.ts +0 -0
- package/{dist/components → components}/atoms/Radio/Radio.js +0 -0
- package/{dist/components → components}/atoms/Select/Select.d.ts +0 -0
- package/{dist/components → components}/atoms/Select/Select.js +0 -0
- package/{dist/components → components}/atoms/Slider/Slider.d.ts +0 -0
- package/{dist/components → components}/atoms/Slider/Slider.js +0 -0
- package/{dist/components → components}/atoms/Switch/Switch.d.ts +0 -0
- package/{dist/components → components}/atoms/Switch/Switch.js +0 -0
- package/{dist/components → components}/atoms/TextField/TextField.d.ts +0 -0
- package/{dist/components → components}/atoms/TextField/TextField.js +0 -0
- package/{dist/components → components}/atoms/ToggleButton/ToggleButton.d.ts +0 -0
- package/{dist/components → components}/atoms/ToggleButton/ToggleButton.js +0 -0
- package/{dist/components → components}/datadisplay/Avatar/Avatar.d.ts +0 -0
- package/{dist/components → components}/datadisplay/Avatar/Avatar.js +0 -0
- package/{dist/components → components}/datadisplay/Chip/Chip.d.ts +0 -0
- package/{dist/components → components}/datadisplay/Chip/Chip.js +0 -0
- package/{dist/components → components}/datadisplay/List/List.d.ts +0 -0
- package/{dist/components → components}/datadisplay/List/List.js +0 -0
- package/{dist/components → components}/datadisplay/Tooltip/Tooltip.d.ts +0 -0
- package/{dist/components → components}/datadisplay/Tooltip/Tooltip.js +0 -0
- package/{dist/components → components}/feedback/Alert/Alert.d.ts +0 -0
- package/{dist/components → components}/feedback/Alert/Alert.js +0 -0
- package/{dist/components → components}/landmarks/Header/Header.d.ts +0 -0
- package/{dist/components → components}/landmarks/Header/Header.js +0 -0
- package/{dist/components → components}/landmarks/Header/HeaderActionButtons.d.ts +0 -0
- package/{dist/components → components}/landmarks/Header/HeaderActionButtons.js +0 -0
- package/{dist/components → components}/landmarks/Header/HeaderStyles.d.ts +0 -0
- package/{dist/components → components}/landmarks/Header/HeaderStyles.js +0 -0
- package/{dist/components → components}/navigation/Drawer/Drawer.d.ts +0 -0
- package/{dist/components → components}/navigation/Drawer/Drawer.js +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigation.d.ts +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigation.js +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationAvatar.d.ts +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationAvatar.js +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationAvatarStyles.d.ts +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationAvatarStyles.js +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationDrawer.d.ts +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationDrawer.js +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationDrawerStyles.d.ts +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationDrawerStyles.js +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItem.d.ts +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItem.js +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItemFlyoutMenu.d.ts +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItemFlyoutMenu.js +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItemFlyoutMenuStyles.d.ts +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItemFlyoutMenuStyles.js +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItemStyles.d.ts +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItemStyles.js +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationMotion.d.ts +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationMotion.js +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationNotchIndicator.d.ts +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationNotchIndicator.js +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationSearch.d.ts +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationSearch.js +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationSearchStyles.d.ts +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationSearchStyles.js +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationStyles.d.ts +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationStyles.js +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationToggleSearchX.d.ts +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationToggleSearchX.js +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationToggleX.d.ts +0 -0
- package/{dist/components → components}/navigation/MobileNavigation/MobileNavigationToggleX.js +0 -0
- package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigation.d.ts +1 -0
- package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigation.js +12 -10
- package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationAvatar.d.ts +0 -0
- package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationAvatar.js +11 -7
- package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationAvatarStyles.d.ts +49 -0
- package/components/navigation/VerticalNavigation/VerticalNavigationAvatarStyles.js +33 -0
- package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItem.d.ts +0 -0
- package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItem.js +0 -0
- package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItemFlyoutMenu.d.ts +0 -0
- package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItemFlyoutMenu.js +3 -3
- package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItemFlyoutMenuStyles.d.ts +1 -0
- package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItemFlyoutMenuStyles.js +16 -15
- package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItemStyles.d.ts +0 -0
- package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItemStyles.js +3 -3
- package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationMotion.d.ts +0 -0
- package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationMotion.js +0 -0
- package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationStyles.d.ts +6 -1
- package/{dist/components → components}/navigation/VerticalNavigation/VerticalNavigationStyles.js +14 -15
- package/{dist/components → components}/pages/ErrorPage/ErrorPage.d.ts +0 -0
- package/{dist/components → components}/pages/ErrorPage/ErrorPage.js +0 -0
- package/{dist/components → components}/pages/ErrorPage/ErrorPageStyles.d.ts +0 -0
- package/{dist/components → components}/pages/ErrorPage/ErrorPageStyles.js +0 -0
- package/{dist/components → components}/pages/SideInSide/SideInSide.d.ts +0 -0
- package/{dist/components → components}/pages/SideInSide/SideInSide.js +0 -0
- package/{dist/components → components}/pages/SideInSide/SideInSideStyles.d.ts +0 -0
- package/{dist/components → components}/pages/SideInSide/SideInSideStyles.js +0 -0
- package/{dist/components → components}/stream/AppSwitcher/AppSwitcher.d.ts +0 -0
- package/{dist/components → components}/stream/AppSwitcher/AppSwitcher.js +1 -11
- package/{dist/components → components}/stream/AppSwitcher/AppSwitcherItem.d.ts +1 -0
- package/{dist/components → components}/stream/AppSwitcher/AppSwitcherItem.js +14 -14
- package/{dist/components → components}/stream/AppSwitcher/AppSwitcherStyles.d.ts +0 -0
- package/{dist/components → components}/stream/AppSwitcher/AppSwitcherStyles.js +8 -6
- package/{dist/components → components}/stream/AppSwitcher/constants.d.ts +0 -0
- package/{dist/components → components}/stream/AppSwitcher/constants.js +0 -0
- package/{dist/index.d.ts → index.d.ts} +0 -0
- package/{dist/index.js → index.js} +0 -0
- package/lang/en-us.d.ts +15 -0
- package/lang/en-us.js +18 -0
- package/package.json +3 -70
- package/{dist/types → types}/components/navigation/VerticalNavigation.d.ts +0 -0
- package/{dist/types → types}/components/navigation/VerticalNavigation.js +0 -0
- package/{dist/types → types}/components/navigation/VerticalNavigationAvatar.d.ts +1 -0
- package/{dist/types → types}/components/navigation/VerticalNavigationAvatar.js +0 -0
- package/{dist/types → types}/components/stream/AppSwitcher.d.ts +0 -0
- package/{dist/types → types}/components/stream/AppSwitcher.js +0 -0
- package/{dist/types → types}/index.d.ts +0 -0
- package/{dist/types → types}/index.js +0 -0
- package/{dist/utils → utils}/constants.d.ts +0 -0
- package/{dist/utils → utils}/constants.js +0 -0
- package/{dist/utils → utils}/helpers.d.ts +0 -0
- package/{dist/utils → utils}/helpers.js +0 -0
- package/{dist/utils → utils}/hooks.d.ts +0 -0
- package/{dist/utils → utils}/hooks.js +0 -0
- package/{dist/utils → utils}/index.d.ts +0 -0
- package/{dist/utils → utils}/index.js +0 -0
- package/{dist/utils → utils}/theme.d.ts +0 -0
- package/{dist/utils → utils}/theme.js +0 -0
- package/.eslintrc.js +0 -40
- package/.github/pull_request_template.md +0 -23
- package/.github/renovate.json +0 -57
- package/.github/workflows/integration.yml +0 -53
- package/.github/workflows/wss.yml +0 -22
- package/.jest-test-results.json +0 -1
- package/.releaserc +0 -32
- package/.storybook/learningpoolTheme.js +0 -39
- package/.storybook/main.js +0 -21
- package/.storybook/manager-head.html +0 -175
- package/.storybook/manager.js +0 -34
- package/.storybook/preview-head.html +0 -212
- package/.storybook/preview.js +0 -120
- package/.storybook/storybook-sort.js +0 -54
- package/CHANGELOG.md +0 -13
- package/amplify.yml +0 -16
- package/babel.config.json +0 -14
- package/dist/components/navigation/VerticalNavigation/VerticalNavigationAvatarStyles.js +0 -31
- package/dist/lang/en-us.d.ts +0 -6
- package/dist/lang/en-us.js +0 -6
- package/dist/package.json +0 -41
- package/jest.config.ts +0 -11
- package/jest.setup.ts +0 -5
- package/license +0 -7
- package/merge.js +0 -27
- package/public/android-chrome-192x192.png +0 -0
- package/public/android-chrome-512x512.png +0 -0
- package/public/apple-touch-icon.png +0 -0
- package/public/assets/atoms.svg +0 -5
- package/public/assets/automation.svg +0 -1
- package/public/assets/avatar-1.jpg +0 -0
- package/public/assets/avatar-2.jpg +0 -0
- package/public/assets/avatar-3.jpg +0 -0
- package/public/assets/flux/icon-dark.svg +0 -6
- package/public/assets/flux/icon-light.svg +0 -1
- package/public/assets/flux/icon-white.svg +0 -6
- package/public/assets/flux/icon.svg +0 -6
- package/public/assets/flux/logo-dark.svg +0 -22
- package/public/assets/flux/logo-light.svg +0 -1
- package/public/assets/flux/logo-white.svg +0 -22
- package/public/assets/flux/logo.svg +0 -22
- package/public/assets/iPhone6.jpg +0 -0
- package/public/assets/iPhone6Plus.jpg +0 -0
- package/public/assets/lp-logo.png +0 -0
- package/public/assets/lplogo.svg +0 -1
- package/public/assets/molecules.svg +0 -8
- package/public/assets/organisms.svg +0 -21
- package/public/assets/pages.svg +0 -4
- package/public/assets/particles.svg +0 -3
- package/public/assets/stream-dark.png +0 -0
- package/public/assets/stream-suite-logo.svg +0 -38
- package/public/assets/stream-white.png +0 -0
- package/public/assets/stream.png +0 -0
- package/public/assets/templates.svg +0 -3
- package/public/favicon-16x16.png +0 -0
- package/public/favicon-32x32.png +0 -0
- package/public/favicon.ico +0 -0
- package/public/index.html +0 -43
- package/public/logo192.png +0 -0
- package/public/logo512.png +0 -0
- package/public/manifest.json +0 -25
- package/public/robots.txt +0 -3
- package/public/site.webmanifest +0 -1
- package/readme.md +0 -132
- package/src/docs.tsx +0 -167
- package/src/lib/assets/Images.tsx +0 -47
- package/src/lib/assets/stream-suite-logo.svg +0 -38
- package/src/lib/components/atoms/Autocomplete/Autocomplete.test.tsx +0 -179
- package/src/lib/components/atoms/Autocomplete/Autocomplete.tsx +0 -14
- package/src/lib/components/atoms/Button/Button.test.tsx +0 -166
- package/src/lib/components/atoms/Button/Button.tsx +0 -16
- package/src/lib/components/atoms/Checkbox/Checkbox.test.tsx +0 -85
- package/src/lib/components/atoms/Checkbox/Checkbox.tsx +0 -10
- package/src/lib/components/atoms/IconButton/IconButton.test.tsx +0 -60
- package/src/lib/components/atoms/IconButton/IconButton.tsx +0 -9
- package/src/lib/components/atoms/Radio/Radio.test.tsx +0 -136
- package/src/lib/components/atoms/Radio/Radio.tsx +0 -10
- package/src/lib/components/atoms/Select/Select.test.tsx +0 -158
- package/src/lib/components/atoms/Select/Select.tsx +0 -12
- package/src/lib/components/atoms/Slider/Slider.test.tsx +0 -103
- package/src/lib/components/atoms/Slider/Slider.tsx +0 -10
- package/src/lib/components/atoms/Switch/Switch.test.tsx +0 -96
- package/src/lib/components/atoms/Switch/Switch.tsx +0 -10
- package/src/lib/components/atoms/TextField/TextField.test.tsx +0 -131
- package/src/lib/components/atoms/TextField/TextField.tsx +0 -31
- package/src/lib/components/atoms/ToggleButton/ToggleButton.test.tsx +0 -122
- package/src/lib/components/atoms/ToggleButton/ToggleButton.tsx +0 -10
- package/src/lib/components/datadisplay/Avatar/Avatar.test.tsx +0 -187
- package/src/lib/components/datadisplay/Avatar/Avatar.tsx +0 -35
- package/src/lib/components/datadisplay/Avatar/avatar-1.jpg +0 -0
- package/src/lib/components/datadisplay/Chip/Chip.test.tsx +0 -82
- package/src/lib/components/datadisplay/Chip/Chip.tsx +0 -11
- package/src/lib/components/datadisplay/List/List.test.tsx +0 -168
- package/src/lib/components/datadisplay/List/List.tsx +0 -8
- package/src/lib/components/datadisplay/Tooltip/Tooltip.test.tsx +0 -98
- package/src/lib/components/datadisplay/Tooltip/Tooltip.tsx +0 -9
- package/src/lib/components/feedback/Alert/Alert.test.tsx +0 -139
- package/src/lib/components/feedback/Alert/Alert.tsx +0 -10
- package/src/lib/components/landmarks/Header/Header.tsx +0 -140
- package/src/lib/components/landmarks/Header/HeaderActionButtons.tsx +0 -117
- package/src/lib/components/landmarks/Header/HeaderStyles.tsx +0 -62
- package/src/lib/components/navigation/Drawer/Drawer.test.tsx +0 -95
- package/src/lib/components/navigation/Drawer/Drawer.tsx +0 -21
- package/src/lib/components/navigation/MobileNavigation/MobileNavigation.tsx +0 -276
- package/src/lib/components/navigation/MobileNavigation/MobileNavigationAvatar.tsx +0 -334
- package/src/lib/components/navigation/MobileNavigation/MobileNavigationAvatarStyles.tsx +0 -77
- package/src/lib/components/navigation/MobileNavigation/MobileNavigationDrawer.tsx +0 -197
- package/src/lib/components/navigation/MobileNavigation/MobileNavigationDrawerStyles.tsx +0 -143
- package/src/lib/components/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItem.tsx +0 -192
- package/src/lib/components/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItemFlyoutMenu.tsx +0 -67
- package/src/lib/components/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItemFlyoutMenuStyles.tsx +0 -192
- package/src/lib/components/navigation/MobileNavigation/MobileNavigationItem/MobileNavigationItemStyles.tsx +0 -217
- package/src/lib/components/navigation/MobileNavigation/MobileNavigationMotion.tsx +0 -119
- package/src/lib/components/navigation/MobileNavigation/MobileNavigationNotchIndicator.tsx +0 -35
- package/src/lib/components/navigation/MobileNavigation/MobileNavigationSearch.tsx +0 -114
- package/src/lib/components/navigation/MobileNavigation/MobileNavigationSearchStyles.tsx +0 -47
- package/src/lib/components/navigation/MobileNavigation/MobileNavigationStyles.tsx +0 -320
- package/src/lib/components/navigation/MobileNavigation/MobileNavigationToggleSearchX.tsx +0 -59
- package/src/lib/components/navigation/MobileNavigation/MobileNavigationToggleX.tsx +0 -51
- package/src/lib/components/navigation/VerticalNavigation/VerticalNavigation.tsx +0 -468
- package/src/lib/components/navigation/VerticalNavigation/VerticalNavigationAvatar.tsx +0 -208
- package/src/lib/components/navigation/VerticalNavigation/VerticalNavigationAvatarStyles.tsx +0 -75
- package/src/lib/components/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItem.tsx +0 -196
- package/src/lib/components/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItemFlyoutMenu.tsx +0 -94
- package/src/lib/components/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItemFlyoutMenuStyles.tsx +0 -212
- package/src/lib/components/navigation/VerticalNavigation/VerticalNavigationItem/VerticalNavigationItemStyles.tsx +0 -240
- package/src/lib/components/navigation/VerticalNavigation/VerticalNavigationMotion.tsx +0 -119
- package/src/lib/components/navigation/VerticalNavigation/VerticalNavigationStyles.tsx +0 -302
- package/src/lib/components/pages/ErrorPage/ErrorPage.test.tsx +0 -78
- package/src/lib/components/pages/ErrorPage/ErrorPage.tsx +0 -50
- package/src/lib/components/pages/ErrorPage/ErrorPageStyles.tsx +0 -30
- package/src/lib/components/pages/SideInSide/SideInSide.tsx +0 -100
- package/src/lib/components/pages/SideInSide/SideInSideStyles.tsx +0 -62
- package/src/lib/components/stream/AppSwitcher/AppSwitcher.tsx +0 -392
- package/src/lib/components/stream/AppSwitcher/AppSwitcherItem.tsx +0 -83
- package/src/lib/components/stream/AppSwitcher/AppSwitcherStyles.tsx +0 -325
- package/src/lib/components/stream/AppSwitcher/constants.tsx +0 -28
- package/src/lib/index.tsx +0 -148
- package/src/lib/lang/en-us.js +0 -6
- package/src/lib/types/components/navigation/VerticalNavigation.ts +0 -52
- package/src/lib/types/components/navigation/VerticalNavigationAvatar.ts +0 -26
- package/src/lib/types/components/stream/AppSwitcher.ts +0 -10
- package/src/lib/types/index.ts +0 -9
- package/src/lib/utils/constants.tsx +0 -11
- package/src/lib/utils/helpers.tsx +0 -77
- package/src/lib/utils/hooks.tsx +0 -33
- package/src/lib/utils/index.tsx +0 -4
- package/src/lib/utils/theme.tsx +0 -79
- package/src/react-app-env.d.ts +0 -1
- package/src/setupTests.ts +0 -5
- package/src/stories/Components/DataDisplay/Avatar/Accessibility.stories.mdx +0 -34
- package/src/stories/Components/DataDisplay/Avatar/AllCombinations.tsx +0 -56
- package/src/stories/Components/DataDisplay/Avatar/Avatar.stories.tsx +0 -19
- package/src/stories/Components/DataDisplay/Avatar/Examples.stories.tsx +0 -278
- package/src/stories/Components/DataDisplay/Avatar/Overview.stories.mdx +0 -47
- package/src/stories/Components/DataDisplay/Chip/Accessibility.stories.mdx +0 -29
- package/src/stories/Components/DataDisplay/Chip/AllCombinations.tsx +0 -58
- package/src/stories/Components/DataDisplay/Chip/Chip.stories.tsx +0 -21
- package/src/stories/Components/DataDisplay/Chip/Examples.stories.tsx +0 -126
- package/src/stories/Components/DataDisplay/Chip/Overview.stories.mdx +0 -57
- package/src/stories/Components/DataDisplay/List/Accessibility.stories.mdx +0 -54
- package/src/stories/Components/DataDisplay/List/AllCombinations.tsx +0 -396
- package/src/stories/Components/DataDisplay/List/Examples.stories.tsx +0 -501
- package/src/stories/Components/DataDisplay/List/List.stories.tsx +0 -35
- package/src/stories/Components/DataDisplay/List/Overview.stories.mdx +0 -69
- package/src/stories/Components/DataDisplay/Table/Overview.stories.mdx +0 -70
- package/src/stories/Components/DataDisplay/Tooltip/Accessibility.stories.mdx +0 -39
- package/src/stories/Components/DataDisplay/Tooltip/AllCombinations.tsx +0 -134
- package/src/stories/Components/DataDisplay/Tooltip/Examples.stories.tsx +0 -237
- package/src/stories/Components/DataDisplay/Tooltip/Overview.stories.mdx +0 -58
- package/src/stories/Components/DataDisplay/Tooltip/Tooltip.stories.tsx +0 -22
- package/src/stories/Components/Feedback/Alert/Accessibility.stories.mdx +0 -25
- package/src/stories/Components/Feedback/Alert/Alert.stories.tsx +0 -22
- package/src/stories/Components/Feedback/Alert/AllCombinations.tsx +0 -37
- package/src/stories/Components/Feedback/Alert/Examples.stories.tsx +0 -137
- package/src/stories/Components/Feedback/Alert/Overview.stories.mdx +0 -62
- package/src/stories/Components/Inputs/Autocomplete/Accessibility.stories.mdx +0 -31
- package/src/stories/Components/Inputs/Autocomplete/AllCombinations.tsx +0 -182
- package/src/stories/Components/Inputs/Autocomplete/Autocomplete.stories.tsx +0 -31
- package/src/stories/Components/Inputs/Autocomplete/Examples.stories.tsx +0 -233
- package/src/stories/Components/Inputs/Autocomplete/Overview.stories.mdx +0 -52
- package/src/stories/Components/Inputs/Button/Accessibility.stories.mdx +0 -52
- package/src/stories/Components/Inputs/Button/AllCombinations.tsx +0 -53
- package/src/stories/Components/Inputs/Button/Button.stories.tsx +0 -23
- package/src/stories/Components/Inputs/Button/Examples.stories.tsx +0 -190
- package/src/stories/Components/Inputs/Button/Overview.stories.mdx +0 -52
- package/src/stories/Components/Inputs/Checkbox/Accessibility.stories.mdx +0 -38
- package/src/stories/Components/Inputs/Checkbox/AllCombinations.tsx +0 -55
- package/src/stories/Components/Inputs/Checkbox/Checkbox.stories.tsx +0 -22
- package/src/stories/Components/Inputs/Checkbox/Examples.stories.tsx +0 -363
- package/src/stories/Components/Inputs/Checkbox/Overview.stories.mdx +0 -63
- package/src/stories/Components/Inputs/IconButton/Examples.stories.tsx +0 -24
- package/src/stories/Components/Inputs/IconButton/IconButton.stories.tsx +0 -26
- package/src/stories/Components/Inputs/Radio/Accessibility.stories.mdx +0 -61
- package/src/stories/Components/Inputs/Radio/AllCombinations.tsx +0 -75
- package/src/stories/Components/Inputs/Radio/Examples.stories.tsx +0 -333
- package/src/stories/Components/Inputs/Radio/Overview.stories.mdx +0 -74
- package/src/stories/Components/Inputs/Radio/Radio.stories.tsx +0 -22
- package/src/stories/Components/Inputs/Select/Accessibility.stories.mdx +0 -51
- package/src/stories/Components/Inputs/Select/AllCombinations.tsx +0 -63
- package/src/stories/Components/Inputs/Select/Examples.stories.tsx +0 -803
- package/src/stories/Components/Inputs/Select/Overview.stories.mdx +0 -73
- package/src/stories/Components/Inputs/Select/Select.stories.tsx +0 -22
- package/src/stories/Components/Inputs/Slider/Accessibility.stories.mdx +0 -43
- package/src/stories/Components/Inputs/Slider/AllCombinations.tsx +0 -30
- package/src/stories/Components/Inputs/Slider/Examples.stories.tsx +0 -146
- package/src/stories/Components/Inputs/Slider/Overview.stories.mdx +0 -59
- package/src/stories/Components/Inputs/Slider/Slider.stories.tsx +0 -27
- package/src/stories/Components/Inputs/Switch/Accessibility.stories.mdx +0 -34
- package/src/stories/Components/Inputs/Switch/AllCombinations.tsx +0 -45
- package/src/stories/Components/Inputs/Switch/Examples.stories.tsx +0 -213
- package/src/stories/Components/Inputs/Switch/Overview.stories.mdx +0 -62
- package/src/stories/Components/Inputs/Switch/Switch.stories.tsx +0 -22
- package/src/stories/Components/Inputs/TextField/Accessibility.stories.mdx +0 -29
- package/src/stories/Components/Inputs/TextField/AllCombinations.tsx +0 -57
- package/src/stories/Components/Inputs/TextField/Examples.stories.tsx +0 -127
- package/src/stories/Components/Inputs/TextField/Overview.stories.mdx +0 -60
- package/src/stories/Components/Inputs/TextField/TextField.stories.tsx +0 -261
- package/src/stories/Components/Inputs/ToggleButton/Accessibility.stories.mdx +0 -32
- package/src/stories/Components/Inputs/ToggleButton/AllCombinations.tsx +0 -113
- package/src/stories/Components/Inputs/ToggleButton/Examples.stories.tsx +0 -339
- package/src/stories/Components/Inputs/ToggleButton/Overview.stories.mdx +0 -55
- package/src/stories/Components/Inputs/ToggleButton/ToggleButton.stories.tsx +0 -19
- package/src/stories/Components/Landmarks/Header/Examples.stories.tsx +0 -197
- package/src/stories/Components/Landmarks/Header/Header.stories.tsx +0 -34
- package/src/stories/Components/Landmarks/Header/Overview.stories.mdx +0 -44
- package/src/stories/Components/Navigation/Drawer/Accessibility.stories.mdx +0 -13
- package/src/stories/Components/Navigation/Drawer/Drawer.stories.tsx +0 -80
- package/src/stories/Components/Navigation/Drawer/Examples.stories.tsx +0 -440
- package/src/stories/Components/Navigation/Drawer/Overview.stories.mdx +0 -43
- package/src/stories/Components/Navigation/MobileNavigation/Accessibility.stories.mdx +0 -14
- package/src/stories/Components/Navigation/MobileNavigation/Examples.stories.tsx +0 -384
- package/src/stories/Components/Navigation/MobileNavigation/MobileNavigation.stories.tsx +0 -24
- package/src/stories/Components/Navigation/MobileNavigation/Overview.stories.mdx +0 -47
- package/src/stories/Components/Navigation/VerticalNavigation/Accessibility.stories.mdx +0 -14
- package/src/stories/Components/Navigation/VerticalNavigation/Examples.stories.tsx +0 -307
- package/src/stories/Components/Navigation/VerticalNavigation/Overview.stories.mdx +0 -47
- package/src/stories/Components/Navigation/VerticalNavigation/VerticalNavigation.stories.tsx +0 -24
- package/src/stories/ContactUs.stories.mdx +0 -21
- package/src/stories/Experimental/Test.stories.mdx +0 -46
- package/src/stories/GettingStarted/Designer.stories.mdx +0 -86
- package/src/stories/GettingStarted/Developer.stories.mdx +0 -134
- package/src/stories/Guidelines/Accessibility/AssistiveTechnology.stories.mdx +0 -70
- package/src/stories/Guidelines/Accessibility/ColorAndContrast.stories.mdx +0 -109
- package/src/stories/Guidelines/Accessibility/Hierarchy.stories.mdx +0 -119
- package/src/stories/Guidelines/Accessibility/Imagery.stories.mdx +0 -136
- package/src/stories/Guidelines/Accessibility/Overview.stories.mdx +0 -44
- package/src/stories/Guidelines/Accessibility/Principles.stories.mdx +0 -156
- package/src/stories/Guidelines/Accessibility/SoundAndMotion.stories.mdx +0 -59
- package/src/stories/Guidelines/Accessibility/Typography.stories.mdx +0 -69
- package/src/stories/Guidelines/Accessibility/Writing.stories.mdx +0 -188
- package/src/stories/Guidelines/Styleguide/ColorSwatch.tsx +0 -53
- package/src/stories/Guidelines/Styleguide/Colors.stories.mdx +0 -118
- package/src/stories/Guidelines/Styleguide/Typography.stories.mdx +0 -84
- package/src/stories/Introduction.stories.mdx +0 -65
- package/src/stories/Pages/ErrorPage.stories.tsx +0 -30
- package/src/stories/Pages/SideInSide.stories.tsx +0 -195
- package/src/stories/Roadmap.stories.mdx +0 -19
- package/src/stories/Templates/Login.stories.mdx +0 -46
- package/src/stories/assets/Atomic_Design_Icons-Dark.svg +0 -24
- package/src/stories/assets/Atomic_Design_Icons-Light.svg +0 -25
- package/src/stories/assets/accessibility-1.png +0 -0
- package/src/stories/assets/accessibility-2.png +0 -0
- package/src/stories/assets/accessibility-3.png +0 -0
- package/src/stories/assets/accessibility-banner.png +0 -0
- package/src/stories/assets/atoms.svg +0 -6
- package/src/stories/assets/design_system_2022-02-11_12.22pm.png +0 -0
- package/src/stories/assets/figma-tokens.png +0 -0
- package/src/stories/assets/hierarchy-1.jpg +0 -0
- package/src/stories/assets/hierarchy-2.jpg +0 -0
- package/src/stories/assets/hierarchy-3.jpg +0 -0
- package/src/stories/assets/icon-contrast-1.jpg +0 -0
- package/src/stories/assets/icon-contrast-2.jpg +0 -0
- package/src/stories/assets/imagery-1.png +0 -0
- package/src/stories/assets/imagery-2.png +0 -0
- package/src/stories/assets/imagery-3.png +0 -0
- package/src/stories/assets/imagery-4.jpg +0 -0
- package/src/stories/assets/molecules.svg +0 -9
- package/src/stories/assets/organisms.svg +0 -22
- package/src/stories/assets/pages.svg +0 -5
- package/src/stories/assets/particles.svg +0 -4
- package/src/stories/assets/templates.svg +0 -4
- package/src/stories/assets/testData.tsx +0 -102
- package/src/stories/assets/text-contrast-1.jpg +0 -0
- package/src/stories/assets/text-contrast-2.jpg +0 -0
- package/src/stories/assets/typography-1.png +0 -0
- package/src/stories/assets/visual-clues-1.png +0 -0
- package/src/stories/assets/visual-clues-2.png +0 -0
- package/src/stories/assets/writing-1.jpg +0 -0
- package/src/stories/assets/writing-2.png +0 -0
- package/src/stories/assets/writing-3.png +0 -0
- package/src/stories/assets/writing-4.png +0 -0
- package/src/stories/utils/CustomIcons.tsx +0 -44
- package/tsconfig.eslint.json +0 -16
- package/tsconfig.json +0 -50
|
@@ -1,59 +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 writing1 from '../../assets/writing-1.jpg';
|
|
10
|
-
import writing2 from '../../assets/writing-2.png';
|
|
11
|
-
import writing3 from '../../assets/writing-3.png';
|
|
12
|
-
import writing4 from '../../assets/writing-4.png';
|
|
13
|
-
import CheckCircleIcon from '@mui/icons-material/CheckCircle';
|
|
14
|
-
import ErrorIcon from '@mui/icons-material/Error';
|
|
15
|
-
|
|
16
|
-
<Meta title="Guidelines/Accessibility/Sound and Motion" />
|
|
17
|
-
|
|
18
|
-
# [](#sound-and-motion)Sound and motion can ***enhance the user experience*** when used effectively
|
|
19
|
-
|
|
20
|
-
<br/>
|
|
21
|
-
<Divider />
|
|
22
|
-
|
|
23
|
-
## [](#sound-motion)Sound and Motion
|
|
24
|
-
Sound and motion can be used to enhance a user's experience; however, this must be done correctly to not overwhelm users or disrupt expectations.
|
|
25
|
-
|
|
26
|
-
### [](#sound)Sound
|
|
27
|
-
By adding clear and concise labels to UI elements, we can provide users a reliable way to navigate our products using sound. Some assistive technologies like screen readers will announce labels out loud when users navigate through UI elements by touch.
|
|
28
|
-
|
|
29
|
-
Some UI elements can be difficult to use with screen readers when sounds play at the same time as the screen readers announce labels, such as background music or interaction effects.
|
|
30
|
-
|
|
31
|
-
#### [](#sound-alternatives)Sound Alternatives
|
|
32
|
-
Closed captions and transcripts can be used to provide visual alternatives to sounds effects and audio alerts.
|
|
33
|
-
|
|
34
|
-
[Material Design](https://m2.material.io/design/usability/accessibility.html#sound-and-motion)
|
|
35
|
-
|
|
36
|
-
<br/>
|
|
37
|
-
|
|
38
|
-
### [](#motion)Motion
|
|
39
|
-
Motion effects can be used to enhance the experience by guiding a user's focus between UI elements; however, overuse of motion effects can become distracting or disruptive to the overall experience.
|
|
40
|
-
|
|
41
|
-
Material Design provides motion guidance based on the following from the W3C:
|
|
42
|
-
|
|
43
|
-
- Enable content that [moves, scrolls, or blinks](https://www.w3.org/TR/WCAG20/#general-thresholddef) automatically to be paused, stopped, or hidden if it lasts more than five seconds
|
|
44
|
-
- Limit flashing content to three times in a one-second period to meet [flash and red flash thresholds](https://www.w3.org/TR/WCAG20/#general-thresholddef)
|
|
45
|
-
- Avoid [flashing large central regions](https://www.w3.org/TR/2015/NOTE-WCAG20-TECHS-20150226/G176) of the screen
|
|
46
|
-
|
|
47
|
-
[Material Design](https://m2.material.io/design/usability/accessibility.html#sound-and-motion)
|
|
48
|
-
|
|
49
|
-
<br/>
|
|
50
|
-
|
|
51
|
-
### [](#timed-controls)Timed controls
|
|
52
|
-
Controls in an app can be set to disappear after a certain amount of time. For example, five seconds after starting a video, playback controls can fade from the screen.
|
|
53
|
-
|
|
54
|
-
#### [](#high-priority-controls)High-priority controls
|
|
55
|
-
Controls that perform high-priority functions can be missed by users if timers cause them to disappear too quickly. For example, TalkBack reads controls out loud if they are focused on. Placing them on timers can prevent the controls from completing their task.
|
|
56
|
-
|
|
57
|
-
Controls that enable important functions can allow users to turn them on again, or perform the same function in other ways. Learn more in Composition.
|
|
58
|
-
|
|
59
|
-
[Material Design](https://m2.material.io/design/usability/accessibility.html#sound-and-motion)
|
|
@@ -1,69 +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 typography1 from '../../assets/typography-1.png';
|
|
10
|
-
|
|
11
|
-
<Meta title="Guidelines/Accessibility/Typography" />
|
|
12
|
-
|
|
13
|
-
# [](#typography)Typography is a core component of visual accessibility
|
|
14
|
-
|
|
15
|
-
<br/>
|
|
16
|
-
<Divider />
|
|
17
|
-
|
|
18
|
-
## [](#accessible-typography)Accessible Typography
|
|
19
|
-
Typography is the manner in which typefaces and fonts visual present text, and is a core component of visual accessibility.
|
|
20
|
-
|
|
21
|
-
Our design system uses *Roboto* as our primary font for it's clean style, legibility and readability.
|
|
22
|
-
|
|
23
|
-
<br/>
|
|
24
|
-
<br/>
|
|
25
|
-
<Grid container sx={{ width: '100%' }} spacing={2}>
|
|
26
|
-
<Grid item xs={6}>
|
|
27
|
-
<img src={typography1} alt="Roboto font family examples of differnt styles" />
|
|
28
|
-
</Grid>
|
|
29
|
-
<Grid item xs={6}>
|
|
30
|
-
<p><em>"Roboto has a dual nature. It has a mechanical skeleton and the forms are largely geometric. At the same time, the font features friendly and open curves. While some grotesks distort their letterforms to force a rigid rhythm, Roboto doesn't compromise, allowing letters to be settled into their natural width. This makes for a more natural reading rhythm more commonly found in humanist and serif types."</em></p>
|
|
31
|
-
<a href="https://fonts.google.com/specimen/Roboto#about">-Google Fonts</a>
|
|
32
|
-
</Grid>
|
|
33
|
-
</Grid>
|
|
34
|
-
|
|
35
|
-
<br/>
|
|
36
|
-
<br/>
|
|
37
|
-
|
|
38
|
-
## [](#font-size)Font Size
|
|
39
|
-
|
|
40
|
-
Since many factors can impact the overall understandability of a typeface, the WCAG does not specify a minimum font size for web. Instead the WCAG guidelines focus more on contrast as a measure of visual accessibility. The WCAG also states that a user must be able to resize text up to 200% without using assistive technology and without loss of content or functionality.
|
|
41
|
-
|
|
42
|
-
Most modern web browsers set a default font size of 16px on the html element, but this can be changed on the user level. Users change their font size settings for a variety of reasons, so our design system uses rem units when setting font sizes to better accommodate a user's settings and maximize accessibility support.
|
|
43
|
-
|
|
44
|
-
<Alert severity="info">
|
|
45
|
-
<AlertTitle><b>Minimum font size</b></AlertTitle>
|
|
46
|
-
We recommend a <em>minimum font size of <b>14px</b></em> across all Learning Pool products.
|
|
47
|
-
</Alert>
|
|
48
|
-
|
|
49
|
-
<br/>
|
|
50
|
-
<br/>
|
|
51
|
-
|
|
52
|
-
## [](#readability-legibility)Typeface Readability & Legibility
|
|
53
|
-
|
|
54
|
-
Both readability and legibility are related measures of visual clarity. Readability is a measure of how easy a user can read the text and legibility is a measure of how individual words or characters are distinguished by a user.
|
|
55
|
-
|
|
56
|
-
*"When reading text, most people do not read or parse individual characters or even words. Instead, the eye quickly scans through text and parses patterns and groups of characters (typically 6-9 characters at a time) which are nearly instantaneously converted into meaning by the human brain. This subconscious process allows us to read and understand text content very quickly with high degrees of understanding, even though we aren't even seeing or thinking of characters and words.*
|
|
57
|
-
|
|
58
|
-
*It is only when characters or words are unfamiliar or introduce a barrier to that direct pattern-to-meaning process that we must pause to more closely examine or process characters or words. For optimal readability and understandability, the key is to avoid those interruptions."*
|
|
59
|
-
|
|
60
|
-
[**-WebAIM Font Techniques**](https://webaim.org/techniques/fonts/)
|
|
61
|
-
|
|
62
|
-
Some principles to consider:
|
|
63
|
-
1. Use simple, familiar, and easily-parsed fonts.
|
|
64
|
-
2. Avoid character complexity
|
|
65
|
-
3. Avoid character ambiguity
|
|
66
|
-
4. Use a limited number of typefaces, fonts, and font variations.
|
|
67
|
-
5. Consider spacing and weight.
|
|
68
|
-
6. Ensure sufficient, but not too much, contrast between the text and the background.
|
|
69
|
-
7. Avoid small font sizes and other anti-patterns.
|
|
@@ -1,188 +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 writing1 from '../../assets/writing-1.jpg';
|
|
10
|
-
import writing2 from '../../assets/writing-2.png';
|
|
11
|
-
import writing3 from '../../assets/writing-3.png';
|
|
12
|
-
import writing4 from '../../assets/writing-4.png';
|
|
13
|
-
import CheckCircleIcon from '@mui/icons-material/CheckCircle';
|
|
14
|
-
import ErrorIcon from '@mui/icons-material/Error';
|
|
15
|
-
|
|
16
|
-
<Meta title="Guidelines/Accessibility/Writing" />
|
|
17
|
-
|
|
18
|
-
# [](#accessible-writing)Accessibility text is used by assistive technologies to ***communicate information***.
|
|
19
|
-
|
|
20
|
-
<br/>
|
|
21
|
-
<Divider />
|
|
22
|
-
|
|
23
|
-
## [](#accessibility-text)Accessibility Text
|
|
24
|
-
Accessibility text is text that is utilized by assistive technologies such as screen readers like NVDA, JAWS or VoiceOver. These assistive technologies will announce text and UI elements to users, including both on-screen text and visibly hidden alternative text.
|
|
25
|
-
|
|
26
|
-
### [](#visible-non-visible)Visible and Non-Visible Text
|
|
27
|
-
Accessibility text includes both on-screen visible text and UI elements and visually hidden text such as image alt text or aria-label descriptions. We use WAI-ARIA attributes to provide additional information to users when necessary. By utilizing clear and meaningful visible and hidden text, we help all of our users successfully navigate our products and understand our content.
|
|
28
|
-
|
|
29
|
-
### [](#alternative-text)Alternative Text
|
|
30
|
-
*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)."*
|
|
31
|
-
|
|
32
|
-
[Material Design 3](https://m3.material.io/foundations/accessible-design/accessibility-basics)
|
|
33
|
-
|
|
34
|
-
<br/>
|
|
35
|
-
<Grid container sx={{ width: '100%' }} spacing={2}>
|
|
36
|
-
<Grid item xs={6}>
|
|
37
|
-
<img src={writing1} alt="Good example of alternative text on image" />
|
|
38
|
-
<p><em>Alt text: "Person walking on a trail in the mountains"</em></p>
|
|
39
|
-
<p><CheckCircleIcon color="success" /> <b>Correct</b></p>
|
|
40
|
-
<p>Use alt text to convey what the image is showing in an informative, short phrase.</p>
|
|
41
|
-
</Grid>
|
|
42
|
-
<Grid item xs={6}>
|
|
43
|
-
<img src={writing1} alt="Bad example of alternative text on image" />
|
|
44
|
-
<p><em>Alt text: "Landscape photo"</em></p>
|
|
45
|
-
<p><ErrorIcon color="error" /> <b>Caution</b></p>
|
|
46
|
-
<p>Using only one or two words to describe an image may not be informative.</p>
|
|
47
|
-
</Grid>
|
|
48
|
-
</Grid>
|
|
49
|
-
|
|
50
|
-
<br/>
|
|
51
|
-
<br/>
|
|
52
|
-
<br/>
|
|
53
|
-
|
|
54
|
-
### [](#reading-speed)Reading Speed
|
|
55
|
-
Screen reader users hear every UI element read aloud. The shorter the text, the faster a screen reader user can navigate it.
|
|
56
|
-
|
|
57
|
-
[Material Design 3](https://m3.material.io/foundations/accessible-design/accessibility-basics)
|
|
58
|
-
|
|
59
|
-
<br/>
|
|
60
|
-
<Grid container sx={{ width: '100%' }} spacing={2}>
|
|
61
|
-
<Grid item xs={6}>
|
|
62
|
-
<p><b>Switch to user123@learningpool.com</b></p>
|
|
63
|
-
<p><CheckCircleIcon color="success" /> <b>Correct</b></p>
|
|
64
|
-
<p>Write clear and short accessibility text.</p>
|
|
65
|
-
</Grid>
|
|
66
|
-
<Grid item xs={6}>
|
|
67
|
-
<p><b>Account switcher. Switch the active account to user123@learningpool.com</b></p>
|
|
68
|
-
<p><ErrorIcon color="error" /> <b>Caution</b></p>
|
|
69
|
-
<p>Consider rewriting long and less concise accessibility text.</p>
|
|
70
|
-
</Grid>
|
|
71
|
-
</Grid>
|
|
72
|
-
|
|
73
|
-
<br/>
|
|
74
|
-
<br/>
|
|
75
|
-
<br/>
|
|
76
|
-
|
|
77
|
-
### [](#contol-types)Control Types and States
|
|
78
|
-
Screen readers may automatically announce a control's type or state by either speaking the control name or making a sound.
|
|
79
|
-
|
|
80
|
-
[Material Design 3](https://m3.material.io/foundations/accessible-design/accessibility-basics)
|
|
81
|
-
|
|
82
|
-
<br/>
|
|
83
|
-
<Grid container sx={{ width: '100%' }} spacing={2}>
|
|
84
|
-
<Grid item xs={6}>
|
|
85
|
-
<p><b>Search users</b></p>
|
|
86
|
-
<p><CheckCircleIcon color="success" /> <b>Correct</b></p>
|
|
87
|
-
<p>Write clear and short accessibility text.</p>
|
|
88
|
-
</Grid>
|
|
89
|
-
<Grid item xs={6}>
|
|
90
|
-
<p><b>Search users field</b></p>
|
|
91
|
-
<p><ErrorIcon color="error" /> <b>Caution</b></p>
|
|
92
|
-
<p>Usually the control type should not be stated because the ARIA label will announce the control type for screen reader users, making the extra label redundant.</p>
|
|
93
|
-
</Grid>
|
|
94
|
-
<br/>
|
|
95
|
-
<br/>
|
|
96
|
-
<br/>
|
|
97
|
-
<br/>
|
|
98
|
-
<br/>
|
|
99
|
-
<Grid item xs={6}>
|
|
100
|
-
<p><b>Download over Wi-Fi</b></p>
|
|
101
|
-
<p><CheckCircleIcon color="success" /> <b>Correct</b></p>
|
|
102
|
-
<p>Write clear and short accessibility text.</p>
|
|
103
|
-
</Grid>
|
|
104
|
-
<Grid item xs={6}>
|
|
105
|
-
<p><b>Download over Wi-Fi is selected</b></p>
|
|
106
|
-
<p><ErrorIcon color="error" /> <b>Caution</b></p>
|
|
107
|
-
<p>Consider not including the current state, in this case, that Wi-Fi is "selected".</p>
|
|
108
|
-
</Grid>
|
|
109
|
-
</Grid>
|
|
110
|
-
|
|
111
|
-
<br/>
|
|
112
|
-
<br/>
|
|
113
|
-
<br/>
|
|
114
|
-
|
|
115
|
-
### [](#action-elements)Indicating Elements by Action
|
|
116
|
-
Action verbs indicate what an element or link does if activated, rather than what an element looks like. This describes what an element does without relying on visual acuity.
|
|
117
|
-
|
|
118
|
-
[Material Design 3](https://m3.material.io/foundations/accessible-design/accessibility-basics)
|
|
119
|
-
|
|
120
|
-
<br/>
|
|
121
|
-
<Grid container sx={{ width: '100%' }} spacing={2}>
|
|
122
|
-
<Grid item xs={6}>
|
|
123
|
-
<img style={{maxWidth: "100px"}} src={writing2} alt="UI toggle button" />
|
|
124
|
-
<p><b>"Open vertical navigation menu"</b></p>
|
|
125
|
-
<p><CheckCircleIcon color="success" /> <b>Correct</b></p>
|
|
126
|
-
<p>Accessibility text for a navigation menu could be 'Open navigation menu" and "Close navigation menu".</p>
|
|
127
|
-
</Grid>
|
|
128
|
-
<Grid item xs={6}>
|
|
129
|
-
<img style={{maxWidth: "100px"}} src={writing2} alt="UI toggle button" />
|
|
130
|
-
<p><b>"Side menu"</b></p>
|
|
131
|
-
<p><ErrorIcon color="error" /> <b>Caution</b></p>
|
|
132
|
-
<p>Consider revising accessibility text that doesn't indicate what action will occur, such as "Side menu".</p>
|
|
133
|
-
</Grid>
|
|
134
|
-
<br/>
|
|
135
|
-
<br/>
|
|
136
|
-
<br/>
|
|
137
|
-
<br/>
|
|
138
|
-
<br/>
|
|
139
|
-
<Grid item xs={6}>
|
|
140
|
-
<img style={{maxWidth: "100px"}} src={writing3} alt="Edit icon" />
|
|
141
|
-
<p><b>"Edit"</b></p>
|
|
142
|
-
<p><CheckCircleIcon color="success" /> <b>Correct</b></p>
|
|
143
|
-
<p>The description read aloud indicates the action represented by the icon.</p>
|
|
144
|
-
</Grid>
|
|
145
|
-
<Grid item xs={6}>
|
|
146
|
-
<img style={{maxWidth: "100px"}} src={writing3} alt="Edit icon" />
|
|
147
|
-
<p><b>"Pencil"</b></p>
|
|
148
|
-
<p><ErrorIcon color="error" /> <b>Caution</b></p>
|
|
149
|
-
<p>Describing what the icon looks like may not explain what the action does.</p>
|
|
150
|
-
</Grid>
|
|
151
|
-
</Grid>
|
|
152
|
-
|
|
153
|
-
<br/>
|
|
154
|
-
<br/>
|
|
155
|
-
<br/>
|
|
156
|
-
|
|
157
|
-
### [](#state-change)Elements with state changes
|
|
158
|
-
For icons that toggle between values or states, announce the icon according to how it is presented to the user. For example, if a star icon represents the action of adding something to a wishlist, the app could verbalize "Add to wishlist" or "Remove from wishlist".
|
|
159
|
-
|
|
160
|
-
- If the icon is a property of an item, screen readers will verbalize the current state (such as "on" or "off") if coded as a checkbox.
|
|
161
|
-
- If the icon is an action and is selected, the text label can specify the action that occurs, such as "Add to wishlist".
|
|
162
|
-
|
|
163
|
-
[Material Design 3](https://m3.material.io/foundations/accessible-design/accessibility-basics)
|
|
164
|
-
|
|
165
|
-
<br/>
|
|
166
|
-
<br/>
|
|
167
|
-
<br/>
|
|
168
|
-
|
|
169
|
-
### [](#control-interactions)Control Interactions
|
|
170
|
-
Users might navigate with a keyboard or other device, not with their fingers or a mouse, which should be considered when describing for users how to interact with a control. Accessibility software will describe the correct interaction for the user.
|
|
171
|
-
|
|
172
|
-
[Material Design 3](https://m3.material.io/foundations/accessible-design/accessibility-basics)
|
|
173
|
-
|
|
174
|
-
<br/>
|
|
175
|
-
<Grid container sx={{ width: '100%' }} spacing={2}>
|
|
176
|
-
<Grid item xs={6}>
|
|
177
|
-
<img style={{maxWidth: "100px"}} src={writing4} alt="UI toggle button" />
|
|
178
|
-
<p><b>"Voice Search"</b></p>
|
|
179
|
-
<p><CheckCircleIcon color="success" /> <b>Correct</b></p>
|
|
180
|
-
<p>The command "voice search" describes the user task (search) paired with the input method (voice).</p>
|
|
181
|
-
</Grid>
|
|
182
|
-
<Grid item xs={6}>
|
|
183
|
-
<img style={{maxWidth: "100px"}} src={writing4} alt="UI toggle button" />
|
|
184
|
-
<p><b>"Tap to speak"</b></p>
|
|
185
|
-
<p><ErrorIcon color="error" /> <b>Caution</b></p>
|
|
186
|
-
<p>Consider revising commands that don't fully express how to activate a control. This voice command says "tap", even though it could be selected via a keyboard press, switch device, or braille display. Because this is a task to perform a search, the action could be mentioned instead of "speak".</p>
|
|
187
|
-
</Grid>
|
|
188
|
-
</Grid>
|
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
import React from 'react'
|
|
2
|
-
import Card from '@mui/material/Card'
|
|
3
|
-
import CardContent from '@mui/material/CardContent'
|
|
4
|
-
import CardMedia from '@mui/material/CardMedia'
|
|
5
|
-
import Typography from '@mui/material/Typography'
|
|
6
|
-
import { rgbToHex } from '@mui/material/'
|
|
7
|
-
|
|
8
|
-
export default function ColorSwatch ({ colorValue, colorTheme }): JSX.Element {
|
|
9
|
-
return (
|
|
10
|
-
<Card
|
|
11
|
-
sx={{
|
|
12
|
-
minWidth: '250px'
|
|
13
|
-
}}
|
|
14
|
-
>
|
|
15
|
-
<CardMedia
|
|
16
|
-
sx={{
|
|
17
|
-
backgroundColor: colorValue,
|
|
18
|
-
width: '100%',
|
|
19
|
-
height: '100px'
|
|
20
|
-
}}
|
|
21
|
-
/>
|
|
22
|
-
<CardContent>
|
|
23
|
-
<Typography
|
|
24
|
-
sx={{
|
|
25
|
-
fontSize: '1.1rem',
|
|
26
|
-
fontWeight: 'bold',
|
|
27
|
-
marginBottom: '.25rem'
|
|
28
|
-
}}
|
|
29
|
-
component="div"
|
|
30
|
-
>
|
|
31
|
-
{rgbToHex(colorValue)}
|
|
32
|
-
</Typography>
|
|
33
|
-
<Typography
|
|
34
|
-
sx={{
|
|
35
|
-
fontSize: '1rem'
|
|
36
|
-
}}
|
|
37
|
-
component='div'
|
|
38
|
-
>
|
|
39
|
-
{colorValue}
|
|
40
|
-
</Typography>
|
|
41
|
-
<Typography
|
|
42
|
-
sx={{
|
|
43
|
-
color: 'text.secondary',
|
|
44
|
-
fontSize: '1rem'
|
|
45
|
-
}}
|
|
46
|
-
component='div'
|
|
47
|
-
>
|
|
48
|
-
{String(colorTheme)}
|
|
49
|
-
</Typography>
|
|
50
|
-
</CardContent>
|
|
51
|
-
</Card>
|
|
52
|
-
)
|
|
53
|
-
}
|
|
@@ -1,118 +0,0 @@
|
|
|
1
|
-
import { Canvas, Meta, Story } from '@storybook/addon-docs'
|
|
2
|
-
import Card from '@mui/material/Card'
|
|
3
|
-
import Box from '@mui/material/Box'
|
|
4
|
-
import Grid from '@mui/material/Grid'
|
|
5
|
-
import Typography from '@mui/material/Typography'
|
|
6
|
-
import ColorSwatch from './ColorSwatch'
|
|
7
|
-
import DesignTokens from '@learningpool/design-tokens'
|
|
8
|
-
import Chip from '../../../lib/components/datadisplay/Chip/Chip'
|
|
9
|
-
import Stack from '@mui/material/Stack'
|
|
10
|
-
import { MUIIcon, MaterialDesignIcon, W3CIcon, FigmaIcon, GithubIcon } from '../../utils/CustomIcons';
|
|
11
|
-
|
|
12
|
-
<Meta title="Guidelines/Styleguide/Colors" />
|
|
13
|
-
|
|
14
|
-
[](#design-system-colors)Colors
|
|
15
|
-
=================================================================================
|
|
16
|
-
The Design System uses design tokens and themes to consistenly manage colors across products.
|
|
17
|
-
|
|
18
|
-
<Stack direction="row" spacing={1}>
|
|
19
|
-
<Chip clickable component="a" href="https://mui.com/material-ui/customization/color/" size="small" icon={<MUIIcon viewBox="-5 0 40 30" />} label="Material UI Color" variant="outlined" />
|
|
20
|
-
</Stack>
|
|
21
|
-
|
|
22
|
-
## [](#palette)Palette
|
|
23
|
-
<Typography mt={4} mb={1} variant="h5">Primary</Typography>
|
|
24
|
-
<Grid container spacing={2} direction="row">
|
|
25
|
-
<Grid item>
|
|
26
|
-
<ColorSwatch colorValue={DesignTokens.palette.primary.light} colorTheme="theme.palette.primary.light"/>
|
|
27
|
-
</Grid>
|
|
28
|
-
<Grid item>
|
|
29
|
-
<ColorSwatch colorValue={DesignTokens.palette.primary.main} colorTheme="theme.palette.primary.main"/>
|
|
30
|
-
</Grid>
|
|
31
|
-
<Grid item>
|
|
32
|
-
<ColorSwatch colorValue={DesignTokens.palette.primary.dark} colorTheme="theme.palette.primary.dark"/>
|
|
33
|
-
</Grid>
|
|
34
|
-
</Grid>
|
|
35
|
-
|
|
36
|
-
<Typography mt={4} mb={1} variant="h5">Secondary</Typography>
|
|
37
|
-
<Grid container spacing={2} direction="row">
|
|
38
|
-
<Grid item>
|
|
39
|
-
<ColorSwatch colorValue={DesignTokens.palette.secondary.light} colorTheme="theme.palette.secondary.light"/>
|
|
40
|
-
</Grid>
|
|
41
|
-
<Grid item>
|
|
42
|
-
<ColorSwatch colorValue={DesignTokens.palette.secondary.main} colorTheme="theme.palette.secondary.main"/>
|
|
43
|
-
</Grid>
|
|
44
|
-
<Grid item>
|
|
45
|
-
<ColorSwatch colorValue={DesignTokens.palette.secondary.dark} colorTheme="theme.palette.secondary.dark"/>
|
|
46
|
-
</Grid>
|
|
47
|
-
</Grid>
|
|
48
|
-
|
|
49
|
-
<Typography mt={4} mb={1} variant="h5">Error</Typography>
|
|
50
|
-
<Grid container spacing={2} direction="row">
|
|
51
|
-
<Grid item>
|
|
52
|
-
<ColorSwatch colorValue={DesignTokens.palette.error.light} colorTheme="theme.palette.error.light"/>
|
|
53
|
-
</Grid>
|
|
54
|
-
<Grid item>
|
|
55
|
-
<ColorSwatch colorValue={DesignTokens.palette.error.main} colorTheme="theme.palette.error.main"/>
|
|
56
|
-
</Grid>
|
|
57
|
-
<Grid item>
|
|
58
|
-
<ColorSwatch colorValue={DesignTokens.palette.error.dark} colorTheme="theme.palette.error.dark"/>
|
|
59
|
-
</Grid>
|
|
60
|
-
</Grid>
|
|
61
|
-
|
|
62
|
-
<Typography mt={4} mb={1} variant="h5">Warning</Typography>
|
|
63
|
-
<Grid container spacing={2} direction="row">
|
|
64
|
-
<Grid item>
|
|
65
|
-
<ColorSwatch colorValue={DesignTokens.palette.warning.light} colorTheme="theme.palette.warning.light"/>
|
|
66
|
-
</Grid>
|
|
67
|
-
<Grid item>
|
|
68
|
-
<ColorSwatch colorValue={DesignTokens.palette.warning.main} colorTheme="theme.palette.warning.main"/>
|
|
69
|
-
</Grid>
|
|
70
|
-
<Grid item>
|
|
71
|
-
<ColorSwatch colorValue={DesignTokens.palette.warning.dark} colorTheme="theme.palette.warning.dark"/>
|
|
72
|
-
</Grid>
|
|
73
|
-
</Grid>
|
|
74
|
-
|
|
75
|
-
<Typography mt={4} mb={1} variant="h5">Info</Typography>
|
|
76
|
-
<Grid container spacing={2} direction="row">
|
|
77
|
-
<Grid item>
|
|
78
|
-
<ColorSwatch colorValue={DesignTokens.palette.info.light} colorTheme="theme.palette.info.light"/>
|
|
79
|
-
</Grid>
|
|
80
|
-
<Grid item>
|
|
81
|
-
<ColorSwatch colorValue={DesignTokens.palette.info.main} colorTheme="theme.palette.info.main"/>
|
|
82
|
-
</Grid>
|
|
83
|
-
<Grid item>
|
|
84
|
-
<ColorSwatch colorValue={DesignTokens.palette.info.dark} colorTheme="theme.palette.info.dark"/>
|
|
85
|
-
</Grid>
|
|
86
|
-
</Grid>
|
|
87
|
-
|
|
88
|
-
<Typography mt={4} mb={1} variant="h5">Success</Typography>
|
|
89
|
-
<Grid container mb={8} spacing={2} direction="row">
|
|
90
|
-
<Grid item>
|
|
91
|
-
<ColorSwatch colorValue={DesignTokens.palette.success.light} colorTheme="theme.palette.success.light"/>
|
|
92
|
-
</Grid>
|
|
93
|
-
<Grid item>
|
|
94
|
-
<ColorSwatch colorValue={DesignTokens.palette.success.main} colorTheme="theme.palette.success.main"/>
|
|
95
|
-
</Grid>
|
|
96
|
-
<Grid item>
|
|
97
|
-
<ColorSwatch colorValue={DesignTokens.palette.success.dark} colorTheme="theme.palette.success.dark"/>
|
|
98
|
-
</Grid>
|
|
99
|
-
</Grid>
|
|
100
|
-
|
|
101
|
-
## [](#guidelines)Color Guidelines
|
|
102
|
-
The theme exposes the following palette colors (*accessible under theme.palette.*):
|
|
103
|
-
|
|
104
|
-
- **primary** - Used to represent primary UI elements. It's the color displayed most frequently across our system.
|
|
105
|
-
- **secondary** - Used to represent secondary UI elements. It provides ways to accent elements. Using it is optional.
|
|
106
|
-
- **error** - Used to represent interface elements that the user should be made aware of.
|
|
107
|
-
- **warning** - Used to represent potentially dangerous actions or important messages.
|
|
108
|
-
- **info** - Used to present information to the user that is neutral and not necessarily important.
|
|
109
|
-
- **success** - Used to indicate the successful completion of an action that user triggered.
|
|
110
|
-
|
|
111
|
-
For more information about color, check out the [MUI color section](https://mui.com/material-ui/customization/color/).
|
|
112
|
-
|
|
113
|
-
## [](#accessibility)Color Accessibility
|
|
114
|
-
Contrast must always pass the WCAG AA requirements for text and background colors.
|
|
115
|
-
The size of the text is an import factor when determining the proper accessibile contrast ratio.
|
|
116
|
-
For example, light text on a dark background may pass AA guidelines at 16px, but it may require a higher font weight or size for 13px text using the same color combinations.
|
|
117
|
-
|
|
118
|
-
See [Material Design Color and Contrast](https://material.io/design/usability/accessibility.html#color-and-contrast) for more information.
|
|
@@ -1,84 +0,0 @@
|
|
|
1
|
-
import { Canvas, Meta, Story } from '@storybook/addon-docs'
|
|
2
|
-
import Card from '@mui/material/Card'
|
|
3
|
-
import Box from '@mui/material/Box'
|
|
4
|
-
import Grid from '@mui/material/Grid'
|
|
5
|
-
import Typography from '@mui/material/Typography'
|
|
6
|
-
import ColorSwatch from './ColorSwatch'
|
|
7
|
-
import DesignTokens from '@learningpool/design-tokens'
|
|
8
|
-
import Chip from '../../../lib/components/datadisplay/Chip/Chip'
|
|
9
|
-
import Stack from '@mui/material/Stack'
|
|
10
|
-
import { MUIIcon, MaterialDesignIcon, W3CIcon, FigmaIcon, GithubIcon } from '../../utils/CustomIcons';
|
|
11
|
-
|
|
12
|
-
<Meta title="Guidelines/Styleguide/Typography" />
|
|
13
|
-
|
|
14
|
-
[](#design-system-typography)Typography
|
|
15
|
-
=================================================================================
|
|
16
|
-
The Design System uses design tokens and themes to consistenly manage typography across products.
|
|
17
|
-
|
|
18
|
-
<Stack direction="row" spacing={1}>
|
|
19
|
-
<Chip clickable component="a" href="https://mui.com/material-ui/react-typography/" size="small" icon={<MUIIcon viewBox="-5 0 40 30" />} label="Material UI Typography" variant="outlined" />
|
|
20
|
-
</Stack>
|
|
21
|
-
|
|
22
|
-
## [](#typography-general)General
|
|
23
|
-
The Roboto font will not be automatically loaded by MUI. You are responsible for loading any fonts used in your application. Roboto Font has a few easy ways to get started.
|
|
24
|
-
|
|
25
|
-
## Roboto Font CDN
|
|
26
|
-
Shown below is a sample link markup used to load the Roboto font from a CDN:
|
|
27
|
-
|
|
28
|
-
```
|
|
29
|
-
<link
|
|
30
|
-
rel="stylesheet"
|
|
31
|
-
href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap"
|
|
32
|
-
/>
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
## [](#typography-variants)Variants
|
|
36
|
-
<Box sx={{ width: '100%', maxWidth: 500 }}>
|
|
37
|
-
<Typography variant="h1" gutterBottom>
|
|
38
|
-
h1. Heading
|
|
39
|
-
</Typography>
|
|
40
|
-
<Typography variant="h2" gutterBottom>
|
|
41
|
-
h2. Heading
|
|
42
|
-
</Typography>
|
|
43
|
-
<Typography variant="h3" gutterBottom>
|
|
44
|
-
h3. Heading
|
|
45
|
-
</Typography>
|
|
46
|
-
<Typography variant="h4" gutterBottom>
|
|
47
|
-
h4. Heading
|
|
48
|
-
</Typography>
|
|
49
|
-
<Typography variant="h5" gutterBottom>
|
|
50
|
-
h5. Heading
|
|
51
|
-
</Typography>
|
|
52
|
-
<Typography variant="h6" gutterBottom>
|
|
53
|
-
h6. Heading
|
|
54
|
-
</Typography>
|
|
55
|
-
<Typography variant="subtitle1" gutterBottom>
|
|
56
|
-
subtitle1. Lorem ipsum dolor sit amet, consectetur adipisicing elit. Quos
|
|
57
|
-
blanditiis tenetur
|
|
58
|
-
</Typography>
|
|
59
|
-
<Typography variant="subtitle2" gutterBottom>
|
|
60
|
-
subtitle2. Lorem ipsum dolor sit amet, consectetur adipisicing elit. Quos
|
|
61
|
-
blanditiis tenetur
|
|
62
|
-
</Typography>
|
|
63
|
-
<Typography variant="body1" gutterBottom>
|
|
64
|
-
body1. Lorem ipsum dolor sit amet, consectetur adipisicing elit. Quos
|
|
65
|
-
blanditiis tenetur unde suscipit, quam beatae rerum inventore consectetur,
|
|
66
|
-
neque doloribus, cupiditate numquam dignissimos laborum fugiat deleniti? Eum
|
|
67
|
-
quasi quidem quibusdam.
|
|
68
|
-
</Typography>
|
|
69
|
-
<Typography variant="body2" gutterBottom>
|
|
70
|
-
body2. Lorem ipsum dolor sit amet, consectetur adipisicing elit. Quos
|
|
71
|
-
blanditiis tenetur unde suscipit, quam beatae rerum inventore consectetur,
|
|
72
|
-
neque doloribus, cupiditate numquam dignissimos laborum fugiat deleniti? Eum
|
|
73
|
-
quasi quidem quibusdam.
|
|
74
|
-
</Typography>
|
|
75
|
-
<Typography variant="button" display="block" gutterBottom>
|
|
76
|
-
button text
|
|
77
|
-
</Typography>
|
|
78
|
-
<Typography variant="caption" display="block" gutterBottom>
|
|
79
|
-
caption text
|
|
80
|
-
</Typography>
|
|
81
|
-
<Typography variant="overline" display="block" gutterBottom>
|
|
82
|
-
overline text
|
|
83
|
-
</Typography>
|
|
84
|
-
</Box>
|
|
@@ -1,65 +0,0 @@
|
|
|
1
|
-
import { Meta } from '@storybook/addon-docs';
|
|
2
|
-
import AtomicDesign from './assets/Atomic_Design_Icons-Dark.svg';
|
|
3
|
-
import Atoms from './assets/atoms.svg';
|
|
4
|
-
import Molecules from './assets/molecules.svg';
|
|
5
|
-
import Organisms from './assets/organisms.svg';
|
|
6
|
-
import Templates from './assets/templates.svg';
|
|
7
|
-
import Pages from './assets/pages.svg';
|
|
8
|
-
|
|
9
|
-
<Meta title="Introduction" />
|
|
10
|
-
|
|
11
|
-
[](#introduction-to-the-learning-pool-design-system)Introduction to the Learning Pool Design System
|
|
12
|
-
=================================================================================
|
|
13
|
-
|
|
14
|
-
The Learning Pool Design System was created to help us build products for our customers more efficiently. Established to be the single source of truth for product teams working on Learning Pool products across the globe, the Learning Pool Design System contains everything from Getting Started guides through to Core Components intended for adoption within each product. It enables product teams to design and develop with speed, consistency, and quality. Our dedicated Design System team works with the individual product teams across Learning Pool to ensure the system continues to evolve to meet the needs of our designers, developers, and customers.
|
|
15
|
-
|
|
16
|
-
## [](#atomic-design)Atomic Design
|
|
17
|
-
<div class="sbdocs-section-container">
|
|
18
|
-
<a href=".?path=/docs/components-atoms-button-overview--page"><img src={Atoms} alt="Atomic Design - Atoms" /></a>
|
|
19
|
-
<a href=".?path=/docs/components-molecules-button-overview--page"><img src={Molecules} alt="Atomic Design - Molecules" /></a>
|
|
20
|
-
<a href=".?path=/docs/components-organisms-button-overview--page"><img src={Organisms} alt="Atomic Design - Organisms" /></a>
|
|
21
|
-
<a href=".?path=/docs/components-templates-button-overview--page"><img src={Templates} alt="Atomic Design - Templates" /></a>
|
|
22
|
-
<a href=".?path=/docs/components-pages-button-overview--page"><img src={Pages} alt="Atomic Design - Pages" /></a>
|
|
23
|
-
</div>
|
|
24
|
-
|
|
25
|
-
----------------------------------------------
|
|
26
|
-
|
|
27
|
-
## [](#styleguide)Style Guide
|
|
28
|
-
|
|
29
|
-
Our Design Tokens can be viewed on the design file on [**Figma DS: Design Tokens**](https://www.figma.com/file/8iprnWcQv5V6y9lKbKY6N3/DS%3A-Design-Tokens?node-id=0%3A1).
|
|
30
|
-
|
|
31
|
-
These are synced up with the Github repo found here [**learningpool/design-tokens**](https://github.com/learningpool/design-tokens).
|
|
32
|
-
|
|
33
|
-
_There is further work to be done to separate the tokens into light/dark/global JSON files and potentially the same will be done when we get to client themes_
|
|
34
|
-
|
|
35
|
-
----------------------------------------------
|
|
36
|
-
|
|
37
|
-
Style guides contain specific implementation guidelines, visual references, and design principles for creating interfaces or other design deliverables. The most common style guides tend to focus on branding (colours, typography, trademarks, logos, and print media), but style guides also offer guidance on content (such as tone of voice and language recommendations) and visual- and interaction-design standards (also known as front-end style guides). These guidelines are sometimes incorporated into the component library as well, to provide relevant guidance in context.
|
|
38
|
-
|
|
39
|
-
## [](#component-library)Component Library
|
|
40
|
-
|
|
41
|
-
Our Component Library is currently in development but it will be built using [**Storybook**](https://storybook.js.org) and have its own subdomain for access, currently at [**storybook.learningpool.com**](https://storybook.learningpool.com).
|
|
42
|
-
|
|
43
|
-
The component library will contain Components ready to be used in our projects.
|
|
44
|
-
|
|
45
|
-
It is built upon Material UI [**MUI**](https://mui.com) and only extended to meet the Design requirements for our usage.
|
|
46
|
-
|
|
47
|
-
----------------------------------------------
|
|
48
|
-
|
|
49
|
-
Component libraries (also known as design libraries) are what many people associate with design systems: these thorough libraries house predetermined, reusable UI elements and serve as a one-stop-shop for designers and developers alike to learn about and implement specific UI elements. Creating these libraries takes significant time and resources. In addition to visual examples of components, they include:
|
|
50
|
-
* Component name: a specific and unique UI component name, to avoid miscommunication between designers and developers
|
|
51
|
-
* Description: a clear explanation for what this element is and how it is typically used, occasionally accompanied by do’s and don’ts for context and clarification
|
|
52
|
-
* Attributes: variables or adjustments that can be made to customize or adapt the component for specific needs (i.e., color, size, shape, copy)
|
|
53
|
-
* State: recommended defaults and the subsequent changes in appearance
|
|
54
|
-
* Code snippets: the actual code excerpt for the element (some design systems go as far as sharing multiple examples and offering a “sandbox” environment to try out different component customizations)
|
|
55
|
-
* Front-end & backend frameworks to implement the library (if applicable), to avoid painful and unnecessary debugging
|
|
56
|
-
|
|
57
|
-
## [](#pattern-library)Pattern Library
|
|
58
|
-
|
|
59
|
-
Our Pattern Library is currently in development but it will be built using [**Storybook**](https://storybook.js.org) and have its own subdomain for access, currently at [**storybook.learningpool.com**](https://storybook.learningpool.com).
|
|
60
|
-
|
|
61
|
-
The pattern library will contain Templates and Pages ready to be used in our projects.
|
|
62
|
-
|
|
63
|
-
----------------------------------------------
|
|
64
|
-
|
|
65
|
-
Sometimes, the terms ‘component library’ and ‘pattern library’ are used synonymously; however, there is a distinction between these two types of libraries. Component libraries specify individual UI elements, while pattern libraries feature collections of UI-element groupings or layouts. Pattern libraries are often thought of as less robust compared to component libraries, but they can be as thorough or as high-level as needed. They typically feature content structures, layouts, and/or templates. Much like the components, the patterns are meant to be reused and adapted.
|