@learningpool/ui 1.6.0-beta.4 → 1.6.0-beta.6

package/components/navigation/VerticalNavigation/VerticalNavigation.d.ts

@@ -1,5 +1,6 @@
 import React from 'react';
 import { IVerticalNavigationItemProps } from './VerticalNavigationItem/VerticalNavigationItem';
+import { IAvatarMenuItemProps } from './VerticalNavigationAvatar';
 interface VerticalNavigationProps {
     logo?: string;
     logoText?: string;
@@ -14,6 +15,18 @@ interface VerticalNavigationProps {
     isDrawerOpen?: boolean;
     isPersistent?: boolean;
     setIsPersistent?: any;
+    appRootID?: string;
+    hasAvatar?: boolean;
+    avatarPanelOnClickSwitchDirection?: any;
+    avatarPanelOnClickLogout?: any;
+    avatarPanelOnClickViewProfile?: any;
+    avatarPanelViewProfileString?: string;
+    avatarPanelOnClickEditProfile?: any;
+    avatarPanelEditProfileString?: string;
+    avatarPanelMenuItems?: Array<IAvatarMenuItemProps>;
+    avatarPanelOnClickMainAction?: any;
+    avatarPanelMainActionString?: string;
+    avatarPanelSettingItems?: Array<IAvatarMenuItemProps>;
 }
 declare const VerticalNavigation: (props: VerticalNavigationProps) => React.ReactElement;
 export default VerticalNavigation;

package/components/navigation/VerticalNavigation/VerticalNavigation.js

@@ -9,10 +9,21 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import React, { useEffect } from 'react';
 import { useTheme } from '@mui/material/styles';
-import { Avatar, Modal, List, Tooltip } from '../../../index';
+import { Avatar, List, Tooltip } from '../../../index';
 import { Box } from '@mui/material';
 import { StreamSuiteLogo, NotchSVG, NotchExtendSVG } from '../../../assets/Images';
 import { AppSwitcher } from '@learningpool/app-switcher';
@@ -20,13 +31,14 @@ import { ChevronLeft, ChevronRight, PushPin } from '@mui/icons-material';
 import VerticalNavigationItem from './VerticalNavigationItem/VerticalNavigationItem';
 import { DRAWER_WIDTH, DrawerHeader, DrawerToggle, DrawerToggleHitboxContent, StyledDivider, StyledNav, StyledNavSecondary, DrawerShadow, StyledAside, NotchContainer, NotchBackground, NotchBackgroundClip, NotchSeemMask, StyledDrawer } from './VerticalNavigationStyles';
 import { ListItem, ListItemButton, ListItemIcon, ListItemText } from './VerticalNavigationItem/VerticalNavigationItemStyles';
-import AvatarPanel from './AvatarPanel';
+import AvatarPanel from './VerticalNavigationAvatar';
 import { motion } from '../../../utils/theme';
 import { handleAvatarInitials } from '../../../utils/helpers';
+import { DEFAULT_REACT_APP_ID } from '../../../utils/constants';
 var VerticalNavigation = function (props) {
     var _a, _b;
     var theme = useTheme();
-    var items = props.items, secondaryItems = props.secondaryItems, logo = props.logo, logoText = props.logoText, logoOnClick = props.logoOnClick, hasStreamHome = props.hasStreamHome, streamHomeApiKey = props.streamHomeApiKey, streamHomeBaseUrl = props.streamHomeBaseUrl, streamHomeAccessToken = props.streamHomeAccessToken;
+    var items = props.items, secondaryItems = props.secondaryItems, logo = props.logo, logoText = props.logoText, logoOnClick = props.logoOnClick, appRootID = props.appRootID, hasStreamHome = props.hasStreamHome, streamHomeApiKey = props.streamHomeApiKey, streamHomeBaseUrl = props.streamHomeBaseUrl, streamHomeAccessToken = props.streamHomeAccessToken, rest = __rest(props, ["items", "secondaryItems", "logo", "logoText", "logoOnClick", "appRootID", "hasStreamHome", "streamHomeApiKey", "streamHomeBaseUrl", "streamHomeAccessToken"]);
     var propIsDrawerOpen = typeof (props === null || props === void 0 ? void 0 : props.isDrawerOpen) === 'boolean' ? props.isDrawerOpen : undefined;
     var propIsPersistent = typeof (props === null || props === void 0 ? void 0 : props.isPersistent) === 'boolean' ? props.isPersistent : undefined;
     var avatarName = (_a = props === null || props === void 0 ? void 0 : props.avatarName) !== null && _a !== void 0 ? _a : 'Avatar name';
@@ -37,6 +49,18 @@ var VerticalNavigation = function (props) {
     useEffect(function () { return setIsDrawerOpen(propIsDrawerOpen !== null && propIsDrawerOpen !== void 0 ? propIsDrawerOpen : false); }, [propIsDrawerOpen]);
     useEffect(function () { return setIsDrawerOpen(propIsPersistent !== null && propIsPersistent !== void 0 ? propIsPersistent : false); }, [propIsPersistent]);
     useEffect(function () { return setAvatarInitials(handleAvatarInitials(avatarName)); }, [avatarName]);
+    // This fixes an issue with how MUI handles the modal and aria-hidden.
+    // When open, the Modal adds aria-hidden="true" to a top-level element,
+    // which causes some screen readers to annouce the elements as "blank".
+    // This fix just overrides the default aria-hidden attribute.
+    //
+    // https://github.com/mui/material-ui/issues/19450
+    useEffect(function () {
+        if (isDrawerOpen) {
+            var root = window.document.getElementById(appRootID !== null && appRootID !== void 0 ? appRootID : DEFAULT_REACT_APP_ID);
+            root === null || root === void 0 ? void 0 : root.removeAttribute('aria-hidden');
+        }
+    }, [isDrawerOpen]);
     var handleIsPersistent = function () {
         var _a, _b;
         if (props === null || props === void 0 ? void 0 : props.setIsPersistent) {
@@ -88,7 +112,7 @@ var VerticalNavigation = function (props) {
                                         fill: theme.palette.mode === 'dark'
                                             ? theme.palette.primary.contrastText
                                             : theme.palette.primary.main
-                                    } })) })), _jsx(ListItemText, { primary: logoText !== null && logoText !== void 0 ? logoText : '', isDrawerOpen: isDrawerOpen || isPersistent })] })) })), _jsxs("div", __assign({ className: 'wrapper' }, { children: [_jsxs(NotchContainer, __assign({ sx: { height: '85px', position: 'relative !important' } }, { children: [_jsx(NotchBackground, {}), !isPersistent && _jsx(NotchBackgroundClip, {}), _jsx(NotchSeemMask, {})] })), !isPersistent && _jsx(DrawerToggle, __assign({ onClick: toggleDrawer(!isDrawerOpen), "aria-label": isDrawerOpen ? 'Close Navigation Menus' : 'Open Navigation Menus', "aria-expanded": isDrawerOpen ? 'true' : 'false', "aria-controls": "vertical-navigation" }, { children: _jsx(DrawerToggleHitboxContent, { children: isDrawerOpen
+                                    } })) })), _jsx(ListItemText, { primary: logoText !== null && logoText !== void 0 ? logoText : '', isDrawerOpen: isDrawerOpen || isPersistent })] })) })), _jsxs("div", __assign({ className: 'wrapper' }, { children: [_jsxs(NotchContainer, __assign({ sx: { height: '85px', position: 'relative !important' } }, { children: [_jsx(NotchBackground, {}), !isPersistent && _jsx(NotchBackgroundClip, {}), _jsx(NotchSeemMask, {})] })), !isPersistent && _jsx(DrawerToggle, __assign({ onClick: toggleDrawer(!isDrawerOpen), "aria-label": isDrawerOpen ? 'Close Navigation' : 'Open Navigation', "aria-expanded": isDrawerOpen ? 'true' : 'false', "aria-controls": "vertical-navigation" }, { children: _jsx(DrawerToggleHitboxContent, { children: isDrawerOpen
                                 ? (_jsx(ChevronLeft, { style: {
                                         fontSize: '1.75rem',
                                         height: '1.75rem',
@@ -109,7 +133,7 @@ var VerticalNavigation = function (props) {
                             top: '50%',
                             transform: 'translate(50%, -50%)',
                             width: '50px'
-                        } }), _jsxs(DrawerToggle, __assign({ onClick: handleIsPersistent, "aria-label": isDrawerOpen ? 'Close Navigation Menus' : 'Open Navigation Menus', "aria-expanded": isDrawerOpen ? 'true' : 'false', "aria-controls": "vertical-navigation", style: {
+                        } }), _jsxs(DrawerToggle, __assign({ onClick: handleIsPersistent, "aria-label": isDrawerOpen ? 'Close Navigation' : 'Open Navigation', "aria-expanded": isDrawerOpen ? 'true' : 'false', "aria-controls": "vertical-navigation", style: {
                             display: 'none',
                             position: 'fixed',
                             top: '50%',
@@ -160,7 +184,7 @@ var VerticalNavigation = function (props) {
                     backgroundColor: theme.palette.mode === 'dark'
                         ? theme.palette.primary.main
                         : theme.palette.background.paper
-                } }, { children: _jsxs(StyledNavSecondary, __assign({ "aria-label": 'Secondary navigation menu' }, { children: [_jsx(StyledDivider, { isDrawerOpen: isDrawerOpen || isPersistent }), _jsxs(List, __assign({ style: {
+                } }, { children: _jsxs(StyledNavSecondary, __assign({ "aria-label": 'Secondary' }, { children: [_jsx(StyledDivider, { isDrawerOpen: isDrawerOpen || isPersistent }), _jsxs(List, __assign({ style: {
                                 width: DRAWER_WIDTH.Expanded,
                                 backgroundColor: theme.palette.mode === 'dark'
                                     ? theme.palette.primary.main
@@ -175,7 +199,7 @@ var VerticalNavigation = function (props) {
                                                             justifyContent: 'center'
                                                         } }, { children: _jsx(AppSwitcher, { apiKey: streamHomeApiKey !== null && streamHomeApiKey !== void 0 ? streamHomeApiKey : '', baseUrl: streamHomeBaseUrl !== null && streamHomeBaseUrl !== void 0 ? streamHomeBaseUrl : '', token: streamHomeAccessToken !== null && streamHomeAccessToken !== void 0 ? streamHomeAccessToken : '' }) })) })), _jsx(ListItemText, { primary: 'App switcher', isDrawerOpen: isDrawerOpen || isPersistent })] })) })))
                                     : null, secondaryItems && secondaryItems.length > 0 && secondaryItems.map(function (item, index) { return (_jsx(VerticalNavigationItem, __assign({}, item, { index: index, isDrawerOpen: isDrawerOpen || isPersistent, isSecondary: true }))); }), avatarName
-                                    ? (_jsx(VerticalNavigationItem, { label: avatarName, icon: _jsx(Avatar, __assign({ style: {
+                                    ? (_jsx(VerticalNavigationItem, { label: avatarName, "aria-controls": 'avatar-panel', icon: _jsx(Avatar, __assign({ style: {
                                                 // backgroundColor: mainTheme.colorButtonText,
                                                 // color: mainTheme.colorButton,
                                                 fontSize: '0.75rem',
@@ -187,14 +211,15 @@ var VerticalNavigation = function (props) {
                                             padding: 0,
                                             minHeight: 52,
                                             transition: "max-height 225ms ".concat(motion.easeInOut, " 0ms !important")
-                                        }, hasFlyout: true, fullHeightFlyout: true, content: _jsx(AvatarPanel, { avatarName: avatarName }), isDrawerOpen: isDrawerOpen }))
+                                        }, hasFlyout: true, fullHeightFlyout: true, content: _jsx(AvatarPanel, __assign({ avatarName: avatarName }, rest)), isDrawerOpen: isDrawerOpen }))
                                     : null] }))] })) }))] }))); };
-    return (_jsxs(StyledAside, { children: [_jsx(DrawerShadow, { className: 'drawerShadow', "aria-hidden": 'true', isDrawerOpen: isDrawerOpen || isPersistent, style: {
+    return (_jsxs(StyledAside, __assign({ "aria-label": "Site navigation" }, { children: [_jsx(DrawerShadow, { className: 'drawerShadow', "aria-hidden": 'true', isDrawerOpen: isDrawerOpen || isPersistent, style: {
                     display: isPersistent ? 'none' : 'block'
-                } }), _jsx(Modal, __assign({ "aria-hidden": false, keepMounted: true, disablePortal: true, open: isDrawerOpen || isPersistent, onClose: toggleDrawer(false), hideBackdrop: isPersistent, disableScrollLock: isPersistent, disableEnforceFocus: isPersistent, style: {
-                    right: isPersistent ? 'auto' : 0 // @TODO: rtl support
-                } }, { children: _jsx(StyledDrawer, __assign({ "aria-label": 'Navigation Menus', id: 'vertical-navigation', anchor: 'left', open: isDrawerOpen || isPersistent, onClose: toggleDrawer(false), ModalProps: {
-                        keepMounted: true
-                    }, variant: 'permanent' }, { children: listContent() })) }))] }));
+                } }), _jsx(StyledDrawer, __assign({ id: 'vertical-navigation', anchor: 'left', open: isDrawerOpen || isPersistent, onClose: toggleDrawer(false), variant: isDrawerOpen ? 'temporary' : 'permanent', ModalProps: {
+                    keepMounted: true,
+                    disablePortal: true,
+                    open: isDrawerOpen,
+                    onClose: toggleDrawer(false)
+                } }, { children: listContent() }))] })));
 };
 export default VerticalNavigation;

package/components/navigation/VerticalNavigation/VerticalNavigationAvatar.d.ts

@@ -0,0 +1,24 @@
+import React from 'react';
+export interface IAvatarMenuItemProps {
+    label: string;
+    icon: any;
+    onClick: any;
+}
+export interface IAvatarPanelProps {
+    avatarName: string;
+    editProfileText?: string;
+    logoutText?: string;
+    avatarPanelOnClickSwitchDirection?: any;
+    avatarPanelOnClickLogout?: any;
+    avatarPanelOnClickViewProfile?: any;
+    avatarPanelViewProfileString?: string;
+    avatarPanelOnClickEditProfile?: any;
+    avatarPanelEditProfileString?: string;
+    avatarPanelMenuItems?: Array<IAvatarMenuItemProps>;
+    avatarPanelOnClickMainAction?: any;
+    avatarPanelMainActionString?: string;
+    avatarPanelSettingItems?: Array<IAvatarMenuItemProps>;
+    avatarPanelInvertNavString?: string;
+}
+declare const AvatarPanel: (props: IAvatarPanelProps) => React.ReactElement;
+export default AvatarPanel;

package/components/navigation/VerticalNavigation/VerticalNavigationAvatar.js

@@ -0,0 +1,84 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import React, { useEffect } from 'react';
+import { Box, ButtonGroup, Button, Link, List, ListItem, ListItemIcon, ListItemText } from '../../../index';
+import { StyledBox, StyledBoxProfile, StyledAvatarName, StyledAvatar, StyledOutlineButton, StyledBoxProfileEdit, StyledListItemButton } from './VerticalNavigationAvatarStyles';
+import { useTheme } from '@mui/material/styles';
+import EditIcon from '@mui/icons-material/Edit';
+import LogoutIcon from '@mui/icons-material/Logout';
+import { motion } from 'framer-motion';
+import { motionParent, motionFadeIn, motionFadeInUp, motionWhileHover, motionWhileTap } from './VerticalNavigationMotion';
+import { handleAvatarInitials } from '../../../utils/helpers';
+import { Person, Settings } from '@mui/icons-material';
+var AvatarPanel = function (props) {
+    var _a;
+    var theme = useTheme();
+    var avatarName = props.avatarName, avatarPanelOnClickLogout = props.avatarPanelOnClickLogout, logoutText = props.logoutText, avatarPanelOnClickViewProfile = props.avatarPanelOnClickViewProfile, avatarPanelViewProfileString = props.avatarPanelViewProfileString, avatarPanelOnClickEditProfile = props.avatarPanelOnClickEditProfile, avatarPanelEditProfileString = props.avatarPanelEditProfileString, avatarPanelMenuItems = props.avatarPanelMenuItems, avatarPanelOnClickMainAction = props.avatarPanelOnClickMainAction, avatarPanelMainActionString = props.avatarPanelMainActionString, avatarPanelSettingItems = props.avatarPanelSettingItems;
+    useEffect(function () { return setAvatarInitials(handleAvatarInitials(avatarName)); }, [
+        avatarName
+    ]);
+    var _b = React.useState((_a = handleAvatarInitials(avatarName)) !== null && _a !== void 0 ? _a : 'AN'), avatarInitials = _b[0], setAvatarInitials = _b[1];
+    return (_jsxs(StyledBox
+    // TODO: add check for isAvatarOpen to trigger animation effects
+    // animate={ isAvatarOpen ? 'open' : 'closed' }
+    , __assign({ 
+        // TODO: add check for isAvatarOpen to trigger animation effects
+        // animate={ isAvatarOpen ? 'open' : 'closed' }
+        variants: motionParent }, { children: [avatarPanelOnClickLogout && (_jsx(Button
+            // @ts-expect-error
+            , __assign({ 
+                // @ts-expect-error
+                component: motion.button, variants: motionFadeIn, style: {
+                    left: theme.direction === 'rtl' ? theme.spacing(1) : 'auto',
+                    position: 'absolute',
+                    right: theme.direction === 'rtl' ? 'auto' : theme.spacing(1),
+                    top: theme.spacing(1)
+                }, onClick: avatarPanelOnClickLogout, startIcon: _jsx(LogoutIcon, {}), variant: 'text', color: 'inherit' }, { children: logoutText !== null && logoutText !== void 0 ? logoutText : 'Logout' }))), _jsxs(Box, __assign({ style: {
+                    alignItems: 'center',
+                    display: 'flex',
+                    flexDirection: 'column'
+                } }, { children: [_jsxs(StyledBoxProfile, __assign({ variants: motionFadeInUp }, { children: [_jsx(StyledAvatar, __assign({ style: { marginRight: '0.5rem' } }, { children: avatarInitials })), _jsxs(StyledAvatarName, { children: [_jsx("span", __assign({ style: { fontWeight: 300 } }, { children: "Hi," })), " ", _jsx("strong", { children: avatarName.split(' ')[0] })] })] })), avatarPanelOnClickViewProfile && (_jsx(StyledBoxProfileEdit, __assign({ variants: motionFadeInUp, style: {
+                            flexDirection: 'row',
+                            marginBottom: theme.spacing(1)
+                        } }, { children: _jsxs(ButtonGroup, __assign({ variant: "contained", "aria-label": "split button" }, { children: [_jsx(Button, __assign({ variant: 'contained', color: 'primary', size: 'medium', onClick: avatarPanelOnClickViewProfile, startIcon: _jsx(Person, {}) }, { children: avatarPanelViewProfileString !== null && avatarPanelViewProfileString !== void 0 ? avatarPanelViewProfileString : 'View Profile' })), avatarPanelOnClickEditProfile && (_jsx(Button, __assign({ size: 'medium', "aria-label": avatarPanelEditProfileString !== null && avatarPanelEditProfileString !== void 0 ? avatarPanelEditProfileString : 'Edit Profile', onClick: avatarPanelOnClickEditProfile }, { children: _jsx(EditIcon, {}) })))] })) })))] })), _jsxs(Box, __assign({ style: {
+                    alignItems: 'center',
+                    display: 'flex',
+                    flexDirection: 'column'
+                } }, { children: [avatarPanelMenuItems && avatarPanelMenuItems.length > 0 && (_jsx(List, __assign({ style: {
+                            marginBottom: theme.spacing(2),
+                            maxWidth: '14rem'
+                        } }, { children: avatarPanelMenuItems.map(function (avatarMenuItem) { return (_jsx(ListItem, __assign({ component: motion.div, variants: motionFadeInUp, whileHover: motionWhileHover, whileTap: motionWhileTap, disablePadding: true }, { children: _jsxs(StyledListItemButton
+                            // TODO: figure out if these are links or buttons
+                            // @ts-expect-error
+                            , __assign({ 
+                                // TODO: figure out if these are links or buttons
+                                // @ts-expect-error
+                                component: Link, role: 'link', onClick: avatarMenuItem.onClick }, { children: [_jsx(ListItemIcon, __assign({ "aria-hidden": true, style: {
+                                            minWidth: theme.spacing(5)
+                                        } }, { children: avatarMenuItem.icon })), _jsx(ListItemText, { primary: avatarMenuItem.label })] })) }))); }) }))), avatarPanelOnClickMainAction && _jsx(StyledOutlineButton
+                    // @ts-expect-error
+                    , __assign({ 
+                        // @ts-expect-error
+                        component: motion.button, variants: motionFadeInUp, disablePadding: true, variant: 'outlined', color: 'primary', size: 'medium', onClick: avatarPanelOnClickMainAction, startIcon: _jsx(Settings, {}) }, { children: avatarPanelMainActionString })), _jsx(List, __assign({ style: { marginBottom: theme.spacing(2) } }, { children: avatarPanelSettingItems &&
+                            avatarPanelSettingItems.length > 0 &&
+                            avatarPanelSettingItems.map(function (avatarMenuItem) { return (_jsx(ListItem, __assign({ component: motion.div, variants: motionFadeInUp, whileHover: motionWhileHover, whileTap: motionWhileTap, disablePadding: true }, { children: _jsxs(StyledListItemButton
+                                // TODO: figure out if these are links or buttons
+                                // @ts-expect-error
+                                , __assign({ 
+                                    // TODO: figure out if these are links or buttons
+                                    // @ts-expect-error
+                                    component: Link, role: 'link', onClick: avatarMenuItem.onClick }, { children: [_jsx(ListItemIcon, __assign({ "aria-hidden": true, style: {
+                                                minWidth: theme.spacing(5)
+                                            } }, { children: avatarMenuItem.icon })), _jsx(ListItemText, { primary: avatarMenuItem.label })] })) }))); }) }))] }))] })));
+};
+export default AvatarPanel;