-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: In-page editor navigation menus (#3336)
Co-authored-by: Dafydd Llŷr Pearson <[email protected]>
- Loading branch information
1 parent
e1bc433
commit b484df1
Showing
27 changed files
with
529 additions
and
832 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,232 @@ | ||
| import AdminPanelSettingsIcon from "@mui/icons-material/AdminPanelSettings"; | ||
| import FactCheckIcon from "@mui/icons-material/FactCheck"; | ||
| import FormatListBulletedIcon from "@mui/icons-material/FormatListBulleted"; | ||
| import GroupIcon from "@mui/icons-material/Group"; | ||
| import PaletteIcon from "@mui/icons-material/Palette"; | ||
| import RateReviewIcon from "@mui/icons-material/RateReview"; | ||
| import TuneIcon from "@mui/icons-material/Tune"; | ||
| import Box from "@mui/material/Box"; | ||
| import IconButton from "@mui/material/IconButton"; | ||
| import { styled } from "@mui/material/styles"; | ||
| import Tooltip, { tooltipClasses, TooltipProps } from "@mui/material/Tooltip"; | ||
| import Typography from "@mui/material/Typography"; | ||
| import { Role } from "@opensystemslab/planx-core/types"; | ||
| import { useStore } from "pages/FlowEditor/lib/store"; | ||
| import React from "react"; | ||
| import { useCurrentRoute, useNavigation } from "react-navi"; | ||
| import { FONT_WEIGHT_SEMI_BOLD } from "theme"; | ||
| import EditorIcon from "ui/icons/Editor"; | ||
|
|
||
| interface Route { | ||
| title: string; | ||
| Icon: React.ElementType; | ||
| route: string; | ||
| accessibleBy: Role[]; | ||
| } | ||
|
|
||
| const MENU_WIDTH_COMPACT = "52px"; | ||
| const MENU_WIDTH_FULL = "178px"; | ||
|
|
||
| const Root = styled(Box, { | ||
| shouldForwardProp: (prop) => prop !== "compact", | ||
| })<{ compact?: boolean }>(({ theme, compact }) => ({ | ||
| width: compact ? MENU_WIDTH_COMPACT : MENU_WIDTH_FULL, | ||
| flexShrink: 0, | ||
| background: theme.palette.background.paper, | ||
| borderRight: `1px solid ${theme.palette.border.light}`, | ||
| })); | ||
|
|
||
| const MenuWrap = styled("ul")(({ theme }) => ({ | ||
| listStyle: "none", | ||
| margin: 0, | ||
| padding: theme.spacing(1, 0.4, 0, 0.4), | ||
| position: "sticky", | ||
| top: 0, | ||
| })); | ||
|
|
||
| const MenuItem = styled("li")(({ theme }) => ({ | ||
| margin: theme.spacing(0.75, 0), | ||
| padding: 0, | ||
| })); | ||
|
|
||
| const MenuTitle = styled(Typography)(({ theme }) => ({ | ||
| fontWeight: FONT_WEIGHT_SEMI_BOLD, | ||
| paddingLeft: theme.spacing(0.5), | ||
| textAlign: "left", | ||
| })) as typeof Typography; | ||
|
|
||
| const TooltipWrap = styled(({ className, ...props }: TooltipProps) => ( | ||
| <Tooltip {...props} arrow placement="right" classes={{ popper: className }} /> | ||
| ))(() => ({ | ||
| [`& .${tooltipClasses.arrow}`]: { | ||
| color: "#2c2c2c", | ||
| }, | ||
| [`& .${tooltipClasses.tooltip}`]: { | ||
| backgroundColor: "#2c2c2c", | ||
| left: "-5px", | ||
| fontSize: "0.8em", | ||
| borderRadius: 0, | ||
| fontWeight: FONT_WEIGHT_SEMI_BOLD, | ||
| }, | ||
| })); | ||
|
|
||
| const MenuButton = styled(IconButton, { | ||
| shouldForwardProp: (prop) => prop !== "isActive", | ||
| })<{ isActive: boolean }>(({ theme, isActive }) => ({ | ||
| color: theme.palette.text.primary, | ||
| width: "100%", | ||
| border: "1px solid transparent", | ||
| justifyContent: "flex-start", | ||
| borderRadius: "3px", | ||
| "&:hover": { | ||
| background: "white", | ||
| borderColor: theme.palette.border.light, | ||
| }, | ||
| ...(isActive && { | ||
| background: theme.palette.common.white, | ||
| color: theme.palette.text.primary, | ||
| border: `1px solid ${theme.palette.border.main}`, | ||
| }), | ||
| "& > svg": { | ||
| opacity: 0.8, | ||
| }, | ||
| })); | ||
|
|
||
| function EditorNavMenu() { | ||
| const { navigate } = useNavigation(); | ||
| const { url } = useCurrentRoute(); | ||
| const [teamSlug, flowSlug, user, canUserEditTeam] = useStore((state) => [ | ||
| state.teamSlug, | ||
| state.flowSlug, | ||
| state.user, | ||
| state.canUserEditTeam, | ||
| ]); | ||
|
|
||
| const isActive = (route: string) => url.href.endsWith(route); | ||
|
|
||
| const handleClick = (route: string) => { | ||
| if (isActive(route)) return; | ||
| navigate(route); | ||
| }; | ||
|
|
||
| const globalLayoutRoutes: Route[] = [ | ||
| { | ||
| title: "Select a team", | ||
| Icon: FormatListBulletedIcon, | ||
| route: "/", | ||
| accessibleBy: ["platformAdmin", "teamEditor", "teamViewer"], | ||
| }, | ||
| { | ||
| title: "Admin panel", | ||
| Icon: AdminPanelSettingsIcon, | ||
| route: "admin-panel", | ||
| accessibleBy: ["platformAdmin"], | ||
| }, | ||
| { | ||
| title: "Global settings", | ||
| Icon: TuneIcon, | ||
| route: "global-settings", | ||
| accessibleBy: ["platformAdmin"], | ||
| }, | ||
| ]; | ||
|
|
||
| const teamLayoutRoutes: Route[] = [ | ||
| { | ||
| title: "Services", | ||
| Icon: FormatListBulletedIcon, | ||
| route: `/${teamSlug}`, | ||
| accessibleBy: ["platformAdmin", "teamEditor", "teamViewer"], | ||
| }, | ||
| { | ||
| title: "Team members", | ||
| Icon: GroupIcon, | ||
| route: `/${teamSlug}/members`, | ||
| accessibleBy: ["platformAdmin", "teamEditor"], | ||
| }, | ||
| { | ||
| title: "Design", | ||
| Icon: PaletteIcon, | ||
| route: `/${teamSlug}/design`, | ||
| accessibleBy: ["platformAdmin", "teamEditor"], | ||
| }, | ||
| { | ||
| title: "Settings", | ||
| Icon: TuneIcon, | ||
| route: `/${teamSlug}/general-settings`, | ||
| accessibleBy: ["platformAdmin", "teamEditor"], | ||
| }, | ||
| ]; | ||
|
|
||
| const flowLayoutRoutes: Route[] = [ | ||
| { | ||
| title: "Editor", | ||
| Icon: EditorIcon, | ||
| route: `/${teamSlug}/${flowSlug}`, | ||
| accessibleBy: ["platformAdmin", "teamEditor", "teamViewer"], | ||
| }, | ||
| { | ||
| title: "Service settings", | ||
| Icon: TuneIcon, | ||
| route: `/${teamSlug}/${flowSlug}/service`, | ||
| accessibleBy: ["platformAdmin", "teamEditor"], | ||
| }, | ||
| { | ||
| title: "Submissions log", | ||
| Icon: FactCheckIcon, | ||
| route: `/${teamSlug}/${flowSlug}/submissions-log`, | ||
| accessibleBy: ["platformAdmin", "teamEditor"], | ||
| }, | ||
| { | ||
| title: "Feedback", | ||
| Icon: RateReviewIcon, | ||
| route: `/${teamSlug}/${flowSlug}/feedback`, | ||
| accessibleBy: ["platformAdmin", "teamEditor"], | ||
| }, | ||
| ]; | ||
|
|
||
| const getRoutesForUrl = ( | ||
| url: string, | ||
| ): { routes: Route[]; compact: boolean } => { | ||
| if (flowSlug && url.includes(flowSlug)) | ||
| return { routes: flowLayoutRoutes, compact: true }; | ||
| if (teamSlug && url.includes(teamSlug)) | ||
| return { routes: teamLayoutRoutes, compact: false }; | ||
| return { routes: globalLayoutRoutes, compact: false }; | ||
| }; | ||
|
|
||
| const { routes, compact } = getRoutesForUrl(url.href); | ||
|
|
||
| const visibleRoutes = routes.filter(({ accessibleBy }) => { | ||
| if (user?.isPlatformAdmin) return accessibleBy.includes("platformAdmin"); | ||
| if (canUserEditTeam(teamSlug)) return accessibleBy.includes("teamEditor"); | ||
| return accessibleBy.includes("teamViewer"); | ||
| }); | ||
|
|
||
| // Hide menu if the user does not have a selection of items | ||
| if (visibleRoutes.length < 2) return null; | ||
|
|
||
| return ( | ||
| <Root compact={compact}> | ||
| <MenuWrap> | ||
| {visibleRoutes.map(({ title, Icon, route }) => ( | ||
| <MenuItem onClick={() => handleClick(route)} key={title}> | ||
| {compact ? ( | ||
| <TooltipWrap title={title}> | ||
| <MenuButton isActive={isActive(route)} disableRipple> | ||
| <Icon /> | ||
| </MenuButton> | ||
| </TooltipWrap> | ||
| ) : ( | ||
| <MenuButton isActive={isActive(route)} disableRipple> | ||
| <Icon /> | ||
| <MenuTitle variant="body2">{title}</MenuTitle> | ||
| </MenuButton> | ||
| )} | ||
| </MenuItem> | ||
| ))} | ||
| </MenuWrap> | ||
| </Root> | ||
| ); | ||
| } | ||
|
|
||
| export default EditorNavMenu; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.